yellowgrid-api-ts 3.2.156-dev.0 → 3.2.156

package/docs/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -401,7 +401,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **postAddAdminNote**
-> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
+> AdminNumberPortDTO postAddAdminNote(numberPortAdminNoteBody)
 
 
 ### Example
@@ -410,18 +410,18 @@ No authorization required
 import {
     NumberPortingApi,
     Configuration,
-    PostAddAdminNoteRequest
+    NumberPortAdminNoteBody
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
-let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
+let numberPortAdminNoteBody: NumberPortAdminNoteBody; //Number Port Note Request
 
 const { status, data } = await apiInstance.postAddAdminNote(
     id,
-    postAddAdminNoteRequest
+    numberPortAdminNoteBody
 );
 ```
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**|  | |
+| **numberPortAdminNoteBody** | **NumberPortAdminNoteBody**| Number Port Note Request | |
 | **id** | [**number**] | Number Port ID | defaults to undefined|
 
 

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
 |[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
 |[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
+|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
 |[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
 
 # **getGetMfaQrCode**
@@ -311,6 +312,53 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **postLogout**
+> postLogout()
+
+Remove Oauth 2.0 Cookies
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.postLogout();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **postPortalLogin**
 > AuthCodeResponseModel postPortalLogin()
 

package/docs/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/PartnerDTO.md

@@ -0,0 +1,39 @@
+# PartnerDTO
+
+3CX Partner Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
+**companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
+**contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
+**contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
+**contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
+**partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
+**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
+**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
+**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
+**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PartnerDTO } from 'yellowgrid-api-ts';
+
+const instance: PartnerDTO = {
+    partnerId,
+    companyName,
+    contactName,
+    contactPhone,
+    contactEmail,
+    partnerLevel,
+    licenceDiscountPercent,
+    hostingDisountPercent,
+    hostingPriceListId,
+    installationUrl,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{PatchSetTcxWizardCnameRequest.md → PatchUpdateAccountCnameRequest.md}

@@ -1,4 +1,4 @@
-# PatchSetTcxWizardCnameRequest
+# PatchUpdateAccountCnameRequest
 
 
 ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
+import { PatchUpdateAccountCnameRequest } from 'yellowgrid-api-ts';
 
-const instance: PatchSetTcxWizardCnameRequest = {
+const instance: PatchUpdateAccountCnameRequest = {
     cname,
 };
 ```

package/docs/PatchUpdateAccountCompanyNumberRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateAccountCompanyNumberRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyNumber** | **string** | Company Number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateAccountCompanyNumberRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateAccountCompanyNumberRequest = {
+    companyNumber,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdateAccountPhoneRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateAccountPhoneRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone** | **string** | Phone | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateAccountPhoneRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateAccountPhoneRequest = {
+    phone,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdateAccountVatNumberRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateAccountVatNumberRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateAccountVatNumberRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateAccountVatNumberRequest = {
+    vatNumber,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdateCreditLimitRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateCreditLimitRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateCreditLimitRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateCreditLimitRequest = {
+    creditLimit,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdatePriceListRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdatePriceListRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priceList** | **string** | Price List | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdatePriceListRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdatePriceListRequest = {
+    priceList,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdateSipChannelCostRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateSipChannelCostRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channelCost** | **number** | SIP Channel Cost | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateSipChannelCostRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateSipChannelCostRequest = {
+    channelCost,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdateTcxHostingPriceListRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateTcxHostingPriceListRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priceList** | **string** | Price List | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateTcxHostingPriceListRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateTcxHostingPriceListRequest = {
+    priceList,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PatchUpdateTcxPartnerIdRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateTcxPartnerIdRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partnerId** | **string** | Set Account 3CX Partner ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateTcxPartnerIdRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateTcxPartnerIdRequest = {
+    partnerId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PortalAccountModel.md

@@ -27,9 +27,10 @@ Name | Type | Description | Notes
 **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
 **creationDate** | **string** | Creation Date | [optional] [default to undefined]
 **prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
+**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
 **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
 **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
-**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
 
 ## Example
 
@@ -58,9 +59,10 @@ const instance: PortalAccountModel = {
     resellerId,
     creationDate,
     prizePromo,
+    portalAccess,
+    cname,
     directDebitMandate,
     navigation,
-    cname,
 };
 ```
 

package/docs/PostSendWelcomeEmailRequest.md

@@ -0,0 +1,20 @@
+# PostSendWelcomeEmailRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | email | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostSendWelcomeEmailRequest } from 'yellowgrid-api-ts';
+
+const instance: PostSendWelcomeEmailRequest = {
+    email,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PricingApi.md

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProductSummaryDTO.md

@@ -10,11 +10,11 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
-**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Due Date | [optional] [default to undefined]
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProspectDTO.md

@@ -8,11 +8,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **companyName** | **string** | Company Name | [optional] [default to undefined]
 **telephone** | **string** | Telephone | [optional] [default to undefined]
-**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
-**callbackDate** | **string** | Date Time | [optional] [default to undefined]
+**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
+**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
 **xeroId** | **string** | Xero ID | [optional] [default to undefined]
 **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
 **status** | **string** | Status | [optional] [default to undefined]
+**orderCount** | **number** | Order Count | [optional] [default to undefined]
 
 ## Example
 
@@ -27,6 +28,7 @@ const instance: ProspectDTO = {
     xeroId,
     removed,
     status,
+    orderCount,
 };
 ```
 

package/docs/ProspectsApi.md

@@ -1,6 +1,6 @@
 # ProspectsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/RecordingBackupAzureModel.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **name** | **string** | Storage Account Name | [optional] [default to undefined]
 **key** | **string** | Storage Account Key | [optional] [default to undefined]
 **connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
+**sasUrl** | **string** | SAS Url | [optional] [default to undefined]
 **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
 
 ## Example
@@ -20,6 +21,7 @@ const instance: RecordingBackupAzureModel = {
     name,
     key,
     connection_string,
+    sasUrl,
     recordings_path,
 };
 ```

package/docs/RecordingsBackupInfoDTO.md

@@ -6,8 +6,8 @@ Recordings Backup Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |  | [optional] [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |  | [optional] [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
 
 ## Example
 

package/docs/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SMSApi.md

@@ -1,6 +1,6 @@
 # SMSApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShipmentRequestDTO.md

@@ -7,10 +7,10 @@ Shipment Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **courier** | **string** | Courier | [optional] [default to undefined]
-**address** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
 **scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
 **service** | **string** | Service | [optional] [default to undefined]
-**shipDate** | **string** | Date Time | [optional] [default to undefined]
+**shipDate** | **string** | Ship Date | [optional] [default to undefined]
 **items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
 
 ## Example

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/StockManagementApi.md

@@ -1,6 +1,6 @@
 # StockManagementApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SystemApi.md

@@ -1,6 +1,6 @@
 # SystemApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/TableHistoryEntity.md

@@ -0,0 +1,35 @@
+# TableHistoryEntity
+
+TableAttribsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ownerId** | **string** | ownerId | [optional] [default to undefined]
+**dbTable** | **string** | table | [optional] [default to undefined]
+**orderingField** | **string** | orderingField | [optional] [default to undefined]
+**asc** | **number** | asc | [optional] [default to undefined]
+**perPage** | **number** | perPage | [optional] [default to undefined]
+**currPage** | **number** | currPage | [optional] [default to undefined]
+**filter** | **string** | filter | [optional] [default to undefined]
+**page** | **number** | page | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableHistoryEntity } from 'yellowgrid-api-ts';
+
+const instance: TableHistoryEntity = {
+    ownerId,
+    dbTable,
+    orderingField,
+    asc,
+    perPage,
+    currPage,
+    filter,
+    page,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TcxKeySummaryDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **endUser** | **string** | End User | [optional] [default to undefined]
 **sc** | **number** | Simultaneous Calls | [optional] [default to undefined]
 **edition** | **string** | Edition | [optional] [default to undefined]
-**expiry** | **string** | Date Time | [optional] [default to undefined]
+**expiry** | **string** | Expiry Date | [optional] [default to undefined]
 
 ## Example
 

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/WebhooksApi.md

@@ -1,6 +1,6 @@
 # WebhooksApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|