10 unstable releases (3 breaking)
| new 0.7.0 | Apr 18, 2025 |
|---|---|
| 0.6.1 | Apr 13, 2025 |
| 0.5.2 | Jan 25, 2025 |
| 0.5.0 | Jul 5, 2024 |
| 0.3.2 | Jul 31, 2022 |
#75 in Configuration
247 downloads per month
155KB
2.5K
SLoC
Rust API client for p7m-phone
API for managing phone services
This is the API of the service at P7M that manages phone services.
Attention: this API will probably still change a lot in the future, it's not at all stable yet
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 0.6.1
- Package version: 0.6.1
- Generator version: 7.11.0-SNAPSHOT
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named p7m-phone and add the following to Cargo.toml under [dependencies]:
p7m-phone = { path = "./p7m-phone" }
Documentation for API Endpoints
All URIs are relative to https://yser.p7m.de/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BlockApi | delete_block_by_id | DELETE /block/{id} | Delete a block by its ID |
| BlockApi | get_block_by_id | GET /block/{id} | Get a single block by its ID |
| BlockApi | get_blocks | GET /block | Get the list of all waiting queue blocks |
| BlockApi | post_block | POST /block | Create a new block for a waiting queue |
| BlockApi | put_block_by_id | PUT /block/{id} | Update an existing block |
| CallApi | get_call_alarm | GET /call/alarm | Get the list of all alarm calls |
| CallApi | get_call_alarm_by_callee_e164_unsecure | GET /call/alarm/by-callee/{e164} | Get the alarm calls for a given telephone number |
| CallApi | post_call_alarm | POST /call/alarm | Create a new alarm call |
| CallApi | post_call_code | POST /call/code | RPC to trigger an outgoing call to send a PIN code to a user |
| CallApi | put_call_alarm_id | PUT /call/alarm/{id} | Update the state of an existing alarm call |
| InternalApi | check_pending_blocks | GET /block/check_pending | Internal call: check for blocks that are pending and have to be started/stopped |
| NumberConfigurationApi | delete_number_configurations_number_configuration_id | DELETE /numberconfigurations/{ncid} | Delete a number configuration |
| NumberConfigurationApi | get_number_configurations_number_configuration_id | GET /numberconfigurations/{ncid} | Get a single number configuration |
| NumberConfigurationApi | get_number_configurations_number_superadmin | GET /numberconfigurations/{phone_number} | Get a number configuration for a given phone number |
| NumberConfigurationApi | get_number_configurations_superadmin | GET /numberconfigurations | Get the list of all number configurations |
| NumberConfigurationApi | post_number_configurations | POST /numberconfigurations | Create a new number configuration |
| QueueApi | delete_queue_openings_id | DELETE /queues/{qid}/openings/{qoid} | Delete a queue opening interval by its ID |
| QueueApi | delete_queue_queue_id_callers_queue_caller_id | DELETE /queues/{qid}/callers/{qcid} | Remove a caller from a queue |
| QueueApi | delete_queues_queue_id_numbers_queue_number_id | DELETE /queues/{qid}/numbers/{qnid} | Delete a number from a queue |
| QueueApi | get_queue_opening | GET /queues/{qid}/openings | Get the list of intervals where the waiting queue is opened |
| QueueApi | get_queue_openings_id | GET /queues/{qid}/openings/{qoid} | Get an opening interval by its ID |
| QueueApi | get_queue_queue_id_callers | GET /queues/{qid}/callers | Get the list of callers in a waiting queue |
| QueueApi | get_queues | GET /queues | Get the list of all waiting queues |
| QueueApi | get_queues_by_number_phone_number | GET /queues/bynumber/{phone_number} | Find a queue by its number |
| QueueApi | get_queues_queue_id | GET /queues/{qid} | Get a single queue by its ID |
| QueueApi | get_queues_queue_id_callers_queue_caller_id | GET /queues/{qid}/callers/{qcid} | Get an invidivual caller in a queue |
| QueueApi | get_queues_queue_id_queue_number_id | GET /queues/{qid}/numbers/{qnid} | Get a single queue number |
| QueueApi | post_queue_openings | POST /queues/{qid}/openings | Create a new queue opening interval |
| QueueApi | post_queues_queue_id_callers | POST /queues/{qid}/callers | Add a caller to a waiting queue |
| QueueApi | post_queues_queue_id_number | POST /queues/{qid}/numbers | Add a number to a queue |
| QueueApi | put_queue_openings_id | PUT /queues/{qid}/openings/{qoid} | Update an existing queue opening interval |
| QueueApi | put_queue_queue_id_callers_queue_caller_id | PUT /queues/{qid}/callers/{qcid} | Update or just keep-alive for a queue caller |
| QueueApi | put_queues_queue_id_numbers_queue_number_id | PUT /queues/{qid}/numbers/{qnid} | Update a number configuration of a queue |
| QueueApi | queue | GET /queue | Get the list of all waiting queues |
| StatusApi | status | GET /status/{queue} | Get the current calls present in a queue |
Documentation For Models
- AlarmCall
- AlarmCallState
- AlarmCallUpdate
- Block
- CallState
- CodeCallRequest
- CodeCallResult
- LegacyQueue
- ListWrapperAlarmCall
- ListWrapperAlarmCallDataInner
- ListWrapperNumberConfiguration
- ListWrapperNumberConfigurationDataInner
- ListWrapperQueueCaller
- ListWrapperQueueCallerDataInner
- ListWrapperQueueOpening
- ListWrapperQueueOpeningDataInner
- NewAlarmCall
- NewBlock
- NewNumberConfiguration
- NewQueueCaller
- NewQueueNumber
- NewQueueOpening
- NumberConfiguration
- Queue
- QueueCall
- QueueCaller
- QueueCallerUpdate
- QueueNumber
- QueueOpening
- QueuePrio
- WeekdayHoliday
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~8–24MB
~276K SLoC