@p7m/queue-backend v0.7.0

@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.

Attention: this API will probably still change a lot in the future, it's not at all stable yet This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.7.0
• Package version: 0.7.0
• Generator version: 7.11.0-SNAPSHOT
• 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 OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new QueueBackend.BlockApi()
var id = "id_example"; // {String} ID of the block
api.deleteBlockById(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Documentation for Models

• QueueBackend.AlarmCall
• QueueBackend.AlarmCallState
• QueueBackend.AlarmCallUpdate
• QueueBackend.Block
• QueueBackend.CallState
• QueueBackend.CodeCallRequest
• QueueBackend.CodeCallResult
• QueueBackend.LegacyQueue
• QueueBackend.ListWrapperAlarmCall
• QueueBackend.ListWrapperAlarmCallDataInner
• QueueBackend.ListWrapperNumberConfiguration
• QueueBackend.ListWrapperNumberConfigurationDataInner
• QueueBackend.ListWrapperQueueCaller
• QueueBackend.ListWrapperQueueCallerDataInner
• QueueBackend.ListWrapperQueueOpening
• QueueBackend.ListWrapperQueueOpeningDataInner
• QueueBackend.NewAlarmCall
• QueueBackend.NewBlock
• QueueBackend.NewNumberConfiguration
• QueueBackend.NewQueueCaller
• QueueBackend.NewQueueDestination
• QueueBackend.NewQueueNumber
• QueueBackend.NewQueueOpening
• QueueBackend.NumberConfiguration
• QueueBackend.Queue
• QueueBackend.QueueCall
• QueueBackend.QueueCaller
• QueueBackend.QueueCallerUpdate
• QueueBackend.QueueDestination
• QueueBackend.QueueNumber
• QueueBackend.QueueOpening
• QueueBackend.QueuePrio
• QueueBackend.WeekdayHoliday

Documentation for Authorization

Authentication schemes defined for the API:

oauth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://login.p7m.de/auth/authorize
• Scopes: N/A