p7m-phone

Crates.iop7m-phone
lib.rsp7m-phone
version0.5.0
sourcesrc
created_at2022-07-31 17:44:00.312268
updated_at2024-07-05 01:25:02.85291
descriptionRust bindings for the telephone and queue services API of P7M
homepage
repositoryhttps://github.com/projekt7m/phone-rust
max_upload_size
id636243
size117,921
Matthias Wimmer (mawis)

documentation

README

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.5.0
  • Package version: 0.5.0
  • 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 QueueApi | delete_queue_openings_id | DELETE /queues/{qid}/openings/{qoid} | Delete a queue opening interval by its ID 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 | post_queue_openings | POST /queues/{qid}/openings | Create a new queue opening interval QueueApi | put_queue_openings_id | PUT /queues/{qid}/openings/{qoid} | Update an existing queue opening interval 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

To get access to the crate's generated documentation, use:

cargo doc --open

Author

tech@p7m.de

Commit count: 9

cargo fmt