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

package/docs/AccountsApi.md

@@ -1,6 +1,6 @@
 # AccountsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -10,12 +10,15 @@ All URIs are relative to *https://localhost*
 |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
 |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
 |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
+|[**getGetAccountAddresses**](#getgetaccountaddresses) | **GET** /admin/accounts/{id}/addresses | |
 |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
 |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
-|[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | |
 |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
+|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
+|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
+|[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
 |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
 |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
@@ -28,6 +31,8 @@ All URIs are relative to *https://localhost*
 |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
 |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
 |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
+|[**patchUpdateTcxHostingPriceList**](#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | |
+|[**patchUpdateTcxPartnerId**](#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | |
 |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
 |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
 |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
@@ -362,10 +367,10 @@ 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)
 
-# **getGetAccountContacts**
-> Array<AccountContactModel> getGetAccountContacts()
+# **getGetAccountAddresses**
+> AccountAddressesDTO getGetAccountAddresses()
 
-Get Account Contacts
+Get Account Addresses
 
 ### Example
 
@@ -378,10 +383,10 @@ import {
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
-let email: string; //Contact Email Address (optional) (default to undefined)
+let id: string; //Xero ID (default to undefined)
 
-const { status, data } = await apiInstance.getGetAccountContacts(
-    email
+const { status, data } = await apiInstance.getGetAccountAddresses(
+    id
 );
 ```
 
@@ -389,12 +394,12 @@ const { status, data } = await apiInstance.getGetAccountContacts(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **email** | [**string**] | Contact Email Address | (optional) defaults to undefined|
+| **id** | [**string**] | Xero ID | defaults to undefined|
 
 
 ### Return type
 
-**Array<AccountContactModel>**
+**AccountAddressesDTO**
 
 ### Authorization
 
@@ -409,17 +414,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Account Contacts |  -  |
+|**200** | Account Addresses |  -  |
 |**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)
 
-# **getGetAccountDetailedSummary**
-> AccountDetailedSummaryDTO getGetAccountDetailedSummary()
+# **getGetAccountContacts**
+> Array<AccountContactModel> getGetAccountContacts()
 
-Get Account Detailed Summary
+Get Account Contacts
 
 ### Example
 
@@ -432,10 +437,10 @@ import {
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
-let id: number; //Customer ID (default to undefined)
+let email: string; //Contact Email Address (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getGetAccountDetailedSummary(
-    id
+const { status, data } = await apiInstance.getGetAccountContacts(
+    email
 );
 ```
 
@@ -443,12 +448,12 @@ const { status, data } = await apiInstance.getGetAccountDetailedSummary(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Customer ID | defaults to undefined|
+| **email** | [**string**] | Contact Email Address | (optional) defaults to undefined|
 
 
 ### Return type
 
-**AccountDetailedSummaryDTO**
+**Array<AccountContactModel>**
 
 ### Authorization
 
@@ -463,17 +468,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Account Detailed Summary |  -  |
+|**200** | Account Contacts |  -  |
 |**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)
 
-# **getGetAccountPageInfo**
-> AccountPageDetailsDTO getGetAccountPageInfo()
+# **getGetAccountDetailedSummary**
+> AccountDetailedSummaryDTO getGetAccountDetailedSummary()
 
-Get Account Page Details
+Get Account Detailed Summary
 
 ### Example
 
@@ -486,9 +491,9 @@ import {
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
-let id: string; //Xero ID (default to undefined)
+let id: number; //Customer ID (default to undefined)
 
-const { status, data } = await apiInstance.getGetAccountPageInfo(
+const { status, data } = await apiInstance.getGetAccountDetailedSummary(
     id
 );
 ```
@@ -497,12 +502,12 @@ const { status, data } = await apiInstance.getGetAccountPageInfo(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
+| **id** | [**number**] | Customer ID | defaults to undefined|
 
 
 ### Return type
 
-**AccountPageDetailsDTO**
+**AccountDetailedSummaryDTO**
 
 ### Authorization
 
@@ -517,7 +522,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Accounts Page Details |  -  |
+|**200** | Account Detailed Summary |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
@@ -681,6 +686,161 @@ 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)
 
+# **getGetFinanceSettings**
+> AccountFinanceDTO getGetFinanceSettings()
+
+Get Account Finance
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Account Xero ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetFinanceSettings(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Account Xero ID | defaults to undefined|
+
+
+### Return type
+
+**AccountFinanceDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts Finance Details |  -  |
+|**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)
+
+# **getGetLastAccount**
+> AccountSummaryDTO getGetLastAccount()
+
+Get Last Account
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+const { status, data } = await apiInstance.getGetLastAccount();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AccountSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account Summary |  -  |
+|**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)
+
+# **getGetTcxPartnerDetails**
+> PartnerDTO getGetTcxPartnerDetails()
+
+Get Account 3CX Details
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetTcxPartnerDetails(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**PartnerDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account 3CX Partner Details |  -  |
+|**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)
+
 # **getVerifyEmailAddress**
 > getVerifyEmailAddress()
 
@@ -1368,6 +1528,122 @@ 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)
 
+# **patchUpdateTcxHostingPriceList**
+> PartnerDTO patchUpdateTcxHostingPriceList()
+
+Set Account 3CX Hosting Price List
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    PatchUpdateTcxHostingPriceListRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
+
+const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
+    id,
+    patchUpdateTcxHostingPriceListRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **patchUpdateTcxHostingPriceListRequest** | **PatchUpdateTcxHostingPriceListRequest**| 3CX Hosting Price List Request | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**PartnerDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account 3CX Partner Details |  -  |
+|**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)
+
+# **patchUpdateTcxPartnerId**
+> PartnerDTO patchUpdateTcxPartnerId()
+
+Set Account 3CX Partner ID
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration,
+    PatchUpdateTcxPartnerIdRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
+
+const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
+    id,
+    patchUpdateTcxPartnerIdRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **patchUpdateTcxPartnerIdRequest** | **PatchUpdateTcxPartnerIdRequest**| Set Account 3CX Partner ID | |
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**PartnerDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account 3CX Partner Details |  -  |
+|**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)
+
 # **postAdminCreateAccountContact**
 > postAdminCreateAccountContact()
 

package/docs/AdminOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
 **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
-**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
 **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
 **quote** | **boolean** | Quote | [optional] [default to undefined]
 **customerId** | **number** | Customer ID | [optional] [default to undefined]
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
 **carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
 **sendOrderEmail** | **boolean** | Send Order Email | [optional] [default to undefined]
+**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
 
 ## Example
 
@@ -41,6 +42,7 @@ const instance: AdminOrderRequestDTO = {
     includeNfrPromos,
     carriageCharge,
     sendOrderEmail,
+    paymentMethod,
 };
 ```
 

package/docs/AdminUserModel.md

@@ -14,6 +14,8 @@ Name | Type | Description | Notes
 **email** | **string** | Email | [optional] [default to undefined]
 **primaryHex** | **string** | Primary Colour | [optional] [default to undefined]
 **secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
+**scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
+**permissions** | **Array<string>** | Groups | [optional] [default to undefined]
 
 ## Example
 
@@ -29,6 +31,8 @@ const instance: AdminUserModel = {
     email,
     primaryHex,
     secondaryHex,
+    scopes,
+    permissions,
 };
 ```
 

package/docs/BillingApi.md

@@ -0,0 +1,55 @@
+# BillingApi
+
+All URIs are relative to *https://bitbucket.org*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
+
+# **getGetAllCustomer**
+> { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
+
+Get Billing Customers
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+const { status, data } = await apiInstance.getGetAllCustomer();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**{ [key: string]: { [key: string]: string; }; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Billing Customer List |  -  |
+|**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)
+

package/docs/CRMApi.md

@@ -1,6 +1,6 @@
 # CRMApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -25,7 +25,7 @@ const configuration = new Configuration();
 const apiInstance = new CRMApi(configuration);
 
 let id: number; //Account ID (default to undefined)
-let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
+let type: 'alert' | 'call' | 'email' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
 let userId: number; //Activity Created By (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetCrmActivities(
@@ -40,7 +40,7 @@ const { status, data } = await apiInstance.getGetCrmActivities(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Account ID | defaults to undefined|
-| **type** | [**&#39;alert&#39; | &#39;call&#39; | &#39;note&#39; | &#39;order&#39; | &#39;quote&#39; | &#39;tcx_order&#39;**]**Array<&#39;alert&#39; &#124; &#39;call&#39; &#124; &#39;note&#39; &#124; &#39;order&#39; &#124; &#39;quote&#39; &#124; &#39;tcx_order&#39;>** | Activity Type | (optional) defaults to undefined|
+| **type** | [**&#39;alert&#39; | &#39;call&#39; | &#39;email&#39; | &#39;note&#39; | &#39;order&#39; | &#39;quote&#39; | &#39;tcx_order&#39;**]**Array<&#39;alert&#39; &#124; &#39;call&#39; &#124; &#39;email&#39; &#124; &#39;note&#39; &#124; &#39;order&#39; &#124; &#39;quote&#39; &#124; &#39;tcx_order&#39;>** | Activity Type | (optional) defaults to undefined|
 | **userId** | [**number**] | Activity Created By | (optional) defaults to undefined|
 
 

package/docs/Class3CXApi.md

@@ -1,6 +1,6 @@
 # Class3CXApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationWizardApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationWizardApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|