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

package/docs/AdminUserModel.md

@@ -6,7 +6,6 @@ Admin User
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
 **firstName** | **string** | First Name | [optional] [default to undefined]
 **lastName** | **string** | Last Name | [optional] [default to undefined]
 **avatar** | **string** | Avatar | [optional] [default to undefined]
@@ -14,6 +13,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
 
@@ -21,7 +22,6 @@ Name | Type | Description | Notes
 import { AdminUserModel } from 'yellowgrid-api-ts';
 
 const instance: AdminUserModel = {
-    id,
     firstName,
     lastName,
     avatar,
@@ -29,6 +29,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,72 +1,10 @@
 # CRMApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
 |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
-|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
-
-# **getGetCrmActivities**
-> CrmActivitiesResponseDTO getGetCrmActivities()
-
-Get Customer CRM Activities
-
-### Example
-
-```typescript
-import {
-    CRMApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-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 userId: number; //Activity Created By (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGetCrmActivities(
-    id,
-    type,
-    userId
-);
-```
-
-### Parameters
-
-|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|
-| **userId** | [**number**] | Activity Created By | (optional) defaults to undefined|
-
-
-### Return type
-
-**CrmActivitiesResponseDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | CRM Activities |  -  |
-|**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)
 
 # **getSearchByPhone**
 > CrmContactDTO getSearchByPhone()
@@ -115,61 +53,3 @@ 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)
 
-# **postCreateCrmNote**
-> CrmActivityDTO postCreateCrmNote()
-
-Create CRM Note
-
-### Example
-
-```typescript
-import {
-    CRMApi,
-    Configuration,
-    PostCreateCrmNoteRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new CRMApi(configuration);
-
-let id: number; //Account ID (default to undefined)
-let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //CRM Note Request (optional)
-
-const { status, data } = await apiInstance.postCreateCrmNote(
-    id,
-    postCreateCrmNoteRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**| CRM Note Request | |
-| **id** | [**number**] | Account ID | defaults to undefined|
-
-
-### Return type
-
-**CrmActivityDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | CRM Activity |  -  |
-|**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/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|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationsApi.md

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

package/docs/Class3CXIntegrationsApi.md

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

package/docs/Class3CXMultiTenantApi.md

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

package/docs/CustomerItemRequestDTO.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **id** | **number** | ID | [optional] [default to undefined]
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
 **processDate** | **string** | Date Time | [optional] [default to undefined]
 **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
 **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
@@ -27,6 +28,7 @@ const instance: CustomerItemRequestDTO = {
     id,
     licenceKey,
     hosting,
+    renewalYears,
     processDate,
     tcxSalesCode,
     sbcs,

package/docs/CustomerOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.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]
 

package/docs/DetailedItemRequestDTO.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **id** | **number** | ID | [optional] [default to undefined]
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
 **processDate** | **string** | Date Time | [optional] [default to undefined]
 **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
 **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
@@ -30,6 +31,7 @@ const instance: DetailedItemRequestDTO = {
     id,
     licenceKey,
     hosting,
+    renewalYears,
     processDate,
     tcxSalesCode,
     sbcs,

package/docs/DetailedOrderRequestDTO.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]
 

package/docs/ItemDTO.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
 **processDate** | **string** | Date Time | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade only) | [optional] [default to undefined]
 **promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
 **refunded** | **number** | Refunded | [optional] [default to undefined]
 **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
@@ -38,6 +39,7 @@ const instance: ItemDTO = {
     licenceExpiry,
     processDate,
     hosting,
+    renewalYears,
     promoItem,
     refunded,
     sbcs,

package/docs/MyPBXToolsApi.md

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

package/docs/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://localhost*
+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(postCreateCrmNoteRequest)
+> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
 
 
 ### Example
@@ -410,18 +410,18 @@ No authorization required
 import {
     NumberPortingApi,
     Configuration,
-    PostCreateCrmNoteRequest
+    PostAddAdminNoteRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
-let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //
+let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
 
 const { status, data } = await apiInstance.postAddAdminNote(
     id,
-    postCreateCrmNoteRequest
+    postAddAdminNoteRequest
 );
 ```
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**|  | |
+| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**|  | |
 | **id** | [**number**] | Number Port ID | defaults to undefined|
 
 

package/docs/OAuth20Api.md

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

package/docs/OrderDTO.md

@@ -0,0 +1,25 @@
+# OrderDTO
+
+Legacy Portal Order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**basket** | [**Array<ItemDTO>**](ItemDTO.md) | Basket | [optional] [default to undefined]
+**shippingAddress** | [**ShippingAddressDTO**](ShippingAddressDTO.md) |  | [optional] [default to undefined]
+**orderDetails** | [**OrderDetailsDTO**](OrderDetailsDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderDTO = {
+    basket,
+    shippingAddress,
+    orderDetails,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)