@p7m/queue-backend

QueueBackend - JavaScript client for @p7m/queue-backend

API for managing phone services

This is the API of the service at P7M that manages phone services.

For all current endpoints, the caller has to be authenticated with the system and provide a JWT token in the Authorization header of the HTTP request. If your interacting with this API using the Swagger interface, you need to set the JWT token by clicking on the Authorize button on the right side of the header. As the value don't forget that the Authorization header starts with the fixed value Bearer followed by a space followed by the actual JWT token value.

Attention: this API will probably still change a lot in the future, it's not at all stable yet

If anything is unclear or you found a bug in the documentation, please contact tech@p7m.de.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.3.1
Package version: 0.3.1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @p7m/queue-backend --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @p7m/queue-backend from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var QueueBackend = require('@p7m/queue-backend');

var defaultClient = QueueBackend.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new QueueBackend.BlockApi()
api.blockGet().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://sip.p7m.de/v1

Class	Method	HTTP request
QueueBackend.BlockApi	blockGet	GET /block
QueueBackend.BlockApi	blockIdDelete	DELETE /block/{id}
QueueBackend.BlockApi	blockIdGet	GET /block/{id}
QueueBackend.BlockApi	blockIdPut	PUT /block/{id}
QueueBackend.BlockApi	blockPost	POST /block
QueueBackend.InternalApi	alarmTriggerPost	POST /alarm/trigger
QueueBackend.InternalApi	blockCheckPendingGet	GET /block/check_pending
QueueBackend.QueueApi	queueAnnounceGet	GET /queue/announce
QueueBackend.QueueApi	queueGet	GET /queue
QueueBackend.StatusApi	statusQueueGet	GET /status/{queue}

Documentation for Models

Documentation for Authorization

Bearer

Type: API key
API key parameter name: Authorization
Location: HTTP header