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

package/docs/AdminUserModel.md

@@ -13,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
 
@@ -27,6 +29,8 @@ const instance: AdminUserModel = {
     email,
     primaryHex,
     secondaryHex,
+    scopes,
+    permissions,
 };
 ```
 

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

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|
 |------------- | ------------- | -------------|
@@ -22,6 +22,7 @@ All URIs are relative to *https://localhost*
 |[**postTestLoginCredentials**](#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials|
 |[**postUnsuspendInstance**](#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance|
 |[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
+|[**putGetDetails**](#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details|
 
 # **getGetDetails**
 > InstallationDetailsDTO getGetDetails()
@@ -1052,3 +1053,61 @@ 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)
 
+# **putGetDetails**
+> InstallationDetailsDTO putGetDetails()
+
+Update 3CX Installation Details
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationsApi,
+    Configuration,
+    InstallationDetailsDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationsApi(configuration);
+
+let wizardId: number; //Wizard ID (default to undefined)
+let installationDetailsDTO: InstallationDetailsDTO; //Installation Details (optional)
+
+const { status, data } = await apiInstance.putGetDetails(
+    wizardId,
+    installationDetailsDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **installationDetailsDTO** | **InstallationDetailsDTO**| Installation Details | |
+| **wizardId** | [**number**] | Wizard ID | defaults to undefined|
+
+
+### Return type
+
+**InstallationDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Installation 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)
+

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

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)

package/docs/OrderItemDTO.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]
@@ -41,6 +42,7 @@ const instance: OrderItemDTO = {
     licenceExpiry,
     processDate,
     hosting,
+    renewalYears,
     promoItem,
     refunded,
     sbcs,

package/docs/OrderResponseDTO.md

@@ -0,0 +1,25 @@
+# OrderResponseDTO
+
+Legacy Portal Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | URL | [optional] [default to undefined]
+**orderID** | **string** | Order ID | [optional] [default to undefined]
+**uniqueID** | **string** | Unique ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderResponseDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderResponseDTO = {
+    url,
+    orderID,
+    uniqueID,
+};
+```
+
+[[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/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -19,6 +19,7 @@ All URIs are relative to *https://localhost*
 |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
 |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
+|[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
 |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
 |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
@@ -896,6 +897,61 @@ 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)
 
+# **postCreatePortalOrderLegacy**
+> OrderResponseDTO postCreatePortalOrderLegacy()
+
+Create an order via the legacy portal
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrderDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let orderDTO: OrderDTO; //Legacy Portal Order (optional)
+
+const { status, data } = await apiInstance.postCreatePortalOrderLegacy(
+    orderDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderDTO** | **OrderDTO**| Legacy Portal Order | |
+
+
+### Return type
+
+**OrderResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Legacy Portal Order 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)
+
 # **postCreateShipment**
 > ShipmentDTO postCreateShipment()