npm package: @p7m/phone-backend
Description: ## 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.
Latest version: 0.3.2

# @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](https://openapi-generator.tech) 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](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @p7m/phone-backend --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

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


## Documentation for Models

 - [PhoneBackend.ContactEntry](docs/ContactEntry.md)
 - [PhoneBackend.ContactList](docs/ContactList.md)
 - [PhoneBackend.KeyType](docs/KeyType.md)
 - [PhoneBackend.ListWrapperContactEntry](docs/ListWrapperContactEntry.md)
 - [PhoneBackend.ListWrapperContactEntryDataInner](docs/ListWrapperContactEntryDataInner.md)
 - [PhoneBackend.ListWrapperContactList](docs/ListWrapperContactList.md)
 - [PhoneBackend.ListWrapperContactListDataInner](docs/ListWrapperContactListDataInner.md)
 - [PhoneBackend.ListWrapperPhone](docs/ListWrapperPhone.md)
 - [PhoneBackend.ListWrapperPhoneAccount](docs/ListWrapperPhoneAccount.md)
 - [PhoneBackend.ListWrapperPhoneAccountDataInner](docs/ListWrapperPhoneAccountDataInner.md)
 - [PhoneBackend.ListWrapperPhoneDataInner](docs/ListWrapperPhoneDataInner.md)
 - [PhoneBackend.ListWrapperPhoneKey](docs/ListWrapperPhoneKey.md)
 - [PhoneBackend.ListWrapperPhoneKeyDataInner](docs/ListWrapperPhoneKeyDataInner.md)
 - [PhoneBackend.ListWrapperPhoneType](docs/ListWrapperPhoneType.md)
 - [PhoneBackend.ListWrapperPhoneTypeDataInner](docs/ListWrapperPhoneTypeDataInner.md)
 - [PhoneBackend.NewContactEntry](docs/NewContactEntry.md)
 - [PhoneBackend.NewContactList](docs/NewContactList.md)
 - [PhoneBackend.NewPhone](docs/NewPhone.md)
 - [PhoneBackend.NewPhoneAccount](docs/NewPhoneAccount.md)
 - [PhoneBackend.NewPhoneKey](docs/NewPhoneKey.md)
 - [PhoneBackend.Phone](docs/Phone.md)
 - [PhoneBackend.PhoneAccount](docs/PhoneAccount.md)
 - [PhoneBackend.PhoneKey](docs/PhoneKey.md)
 - [PhoneBackend.PhoneType](docs/PhoneType.md)


## 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