@p7m/phone-backend

PhoneBackend - JavaScript client for @p7m/phone-backend

API for managing phones connected to P7M cloud PBX

The purpose of this API is mainly to manage the configuration of phones that use P7M auto provisioning. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.3.2
• Package version: 0.3.2
• Generator version: 7.13.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/phone-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/phone-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 PhoneBackend = require('@p7m/phone-backend');

var defaultClient = PhoneBackend.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PhoneBackend.ContactListApi()
var cid = "cid_example"; // {String} ID of the contact list
api.deleteContactlistsId(cid).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- PhoneBackend.ContactListApi | deleteContactlistsId | DELETE /contactlists/{cid} | Delete a contact list by its ID PhoneBackend.ContactListApi | deleteContactlistsIdEntriesId | DELETE /contactlists/{cid}/entries/{eid} | Delete a contact list entry by its ID PhoneBackend.ContactListApi | getContactLists | GET /contactlists | Get all contact lists PhoneBackend.ContactListApi | getContactlistsId | GET /contactlists/{cid} | Get a contact list by its ID PhoneBackend.ContactListApi | getContactlistsIdEntries | GET /contactlists/{cid}/entries | Get all entries of a contact list PhoneBackend.ContactListApi | getContactlistsIdEntriesId | GET /contactlists/{cid}/entries/{eid} | Get a single contact list entry by its ID PhoneBackend.ContactListApi | postContactlists | POST /contactlists | Create a new contact list PhoneBackend.ContactListApi | postContactlistsIdEntries | POST /contactlists/{cid}/entries | Add an entry to a contact list PhoneBackend.ContactListApi | putContactlistsId | PUT /contactlists/{cid} | Update an existing contact list PhoneBackend.ContactListApi | putContactlistsIdEntriesId | PUT /contactlists/{cid}/entries/{eid} | Update an exising contact list entry PhoneBackend.PhoneApi | deletePhonesId | DELETE /phones/{id} | Delete a phone by its ID PhoneBackend.PhoneApi | getPhones | GET /phones | Get the list of all phones PhoneBackend.PhoneApi | getPhonesId | GET /phones/{id} | Get a single phone by its ID PhoneBackend.PhoneApi | postPhones | POST /phones | Create a new phone PhoneBackend.PhoneApi | putPhonesId | PUT /phones/{id} | Update an existing phone PhoneBackend.PhoneAccountApi | deletePhonesIdAccountsId | DELETE /phones/{pid}/accounts/{aid} | Delete a phone account by its ID PhoneBackend.PhoneAccountApi | getPhonesIdAccounts | GET /phones/{pid}/accounts | Get list of all phone accounts of a phone PhoneBackend.PhoneAccountApi | getPhonesIdAccountsId | GET /phones/{pid}/accounts/{aid} | Request a single phone account by its ID PhoneBackend.PhoneAccountApi | postPhonesIdAccounts | POST /phones/{pid}/accounts | Create a new phone account PhoneBackend.PhoneAccountApi | putPhonesIdAccountsId | PUT /phones/{pid}/accounts/{aid} | Update an existing phone account PhoneBackend.PhoneKeyApi | getPhonesIdKeys | GET /phones/{pid}/keys | Get all the key configuration of a phone PhoneBackend.PhoneKeyApi | getPhonesIdKeysId | GET /phones/{pid}/keys/{kid} | Get a single phone key by its ID PhoneBackend.PhoneKeyApi | postPhonesIdKeys | POST /phones/{pid}/keys | Create a new phone key PhoneBackend.PhoneKeyApi | putPhonesIdKeysId | PUT /phones/{pid}/keys/{kid} | Update an existing phone key PhoneBackend.PhoneTypeApi | getPhoneTypes | GET /phonetypes | Get the list of all phone types PhoneBackend.PhoneTypeApi | getPhoneTypesId | GET /phonetypes/{ptid} | Get a single phone type by its ID

Documentation for Models

• PhoneBackend.ContactEntry
• PhoneBackend.ContactList
• PhoneBackend.KeyType
• PhoneBackend.ListWrapperContactEntry
• PhoneBackend.ListWrapperContactEntryDataInner
• PhoneBackend.ListWrapperContactList
• PhoneBackend.ListWrapperContactListDataInner
• PhoneBackend.ListWrapperPhone
• PhoneBackend.ListWrapperPhoneAccount
• PhoneBackend.ListWrapperPhoneAccountDataInner
• PhoneBackend.ListWrapperPhoneDataInner
• PhoneBackend.ListWrapperPhoneKey
• PhoneBackend.ListWrapperPhoneKeyDataInner
• PhoneBackend.ListWrapperPhoneType
• PhoneBackend.ListWrapperPhoneTypeDataInner
• PhoneBackend.NewContactEntry
• PhoneBackend.NewContactList
• PhoneBackend.NewPhone
• PhoneBackend.NewPhoneAccount
• PhoneBackend.NewPhoneKey
• PhoneBackend.Phone
• PhoneBackend.PhoneAccount
• PhoneBackend.PhoneKey
• PhoneBackend.PhoneType

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