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

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

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 → PatchUpdateCreditLimitRequest.md}

@@ -1,19 +1,19 @@
-# PatchSetTcxWizardCnameRequest
+# PatchUpdateCreditLimitRequest
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**cname** | **string** | CNAME | [optional] [default to undefined]
+**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
+import { PatchUpdateCreditLimitRequest } from 'yellowgrid-api-ts';
 
-const instance: PatchSetTcxWizardCnameRequest = {
-    cname,
+const instance: PatchUpdateCreditLimitRequest = {
+    creditLimit,
 };
 ```
 

package/docs/{PostCreateCrmNoteRequest.md → PatchUpdatePriceListRequest.md}

@@ -1,19 +1,19 @@
-# PostCreateCrmNoteRequest
+# PatchUpdatePriceListRequest
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**note** | **string** | Note | [optional] [default to undefined]
+**priceList** | **string** | Price List | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { PostCreateCrmNoteRequest } from 'yellowgrid-api-ts';
+import { PatchUpdatePriceListRequest } from 'yellowgrid-api-ts';
 
-const instance: PostCreateCrmNoteRequest = {
-    note,
+const instance: PatchUpdatePriceListRequest = {
+    priceList,
 };
 ```
 

package/docs/{PostAddAdminNoteRequest.md → PatchUpdateSipChannelCostRequest.md}

@@ -1,19 +1,19 @@
-# PostAddAdminNoteRequest
+# PatchUpdateSipChannelCostRequest
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**note** | **string** | Note | [optional] [default to undefined]
+**channelCost** | **number** | SIP Channel Cost | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
+import { PatchUpdateSipChannelCostRequest } from 'yellowgrid-api-ts';
 
-const instance: PostAddAdminNoteRequest = {
-    note,
+const instance: PatchUpdateSipChannelCostRequest = {
+    channelCost,
 };
 ```
 

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/{PatchSendWelcomeEmailRequest.md → PatchUpdateTcxPartnerIdRequest.md}

@@ -1,19 +1,19 @@
-# PatchSendWelcomeEmailRequest
+# PatchUpdateTcxPartnerIdRequest
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **string** | email | [optional] [default to undefined]
+**partnerId** | **string** | Set Account 3CX Partner ID | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { PatchSendWelcomeEmailRequest } from 'yellowgrid-api-ts';
+import { PatchUpdateTcxPartnerIdRequest } from 'yellowgrid-api-ts';
 
-const instance: PatchSendWelcomeEmailRequest = {
-    email,
+const instance: PatchUpdateTcxPartnerIdRequest = {
+    partnerId,
 };
 ```
 

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/PostGetProductForCustomerRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years (Upgrade Only) | [optional] [default to undefined]
 
 ## Example
 
@@ -20,6 +21,7 @@ const instance: PostGetProductForCustomerRequest = {
     licenceKey,
     hosting,
     tcxSalesCode,
+    renewalYears,
 };
 ```
 

package/docs/PricingApi.md

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://localhost*
+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://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -422,7 +422,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)
 
 # **postGetProduct**
-> ProductSummaryDTO postGetProduct(postGetProductRequest)
+> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
 Get Product
 
@@ -432,18 +432,18 @@ Get Product
 import {
     ProductsApi,
     Configuration,
-    PostGetProductRequest
+    PostGetProductForCustomerRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
 let sku: string; //Product SKU (default to undefined)
-let postGetProductRequest: PostGetProductRequest; //Product search criteria
+let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
 
 const { status, data } = await apiInstance.postGetProduct(
     sku,
-    postGetProductRequest
+    postGetProductForCustomerRequest
 );
 ```
 
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.postGetProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postGetProductRequest** | **PostGetProductRequest**| Product search criteria | |
+| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **sku** | [**string**] | Product SKU | defaults to undefined|
 
 

package/docs/ProspectDTO.md

@@ -8,8 +8,8 @@ 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]

package/docs/ProspectsApi.md

@@ -1,6 +1,6 @@
 # ProspectsApi
 
-All URIs are relative to *https://localhost*
+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://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

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://localhost*
+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://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SbcDTO.md

@@ -0,0 +1,35 @@
+# SbcDTO
+
+Legacy Portal SBC
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**noConfig** | **boolean** | No Config | [optional] [default to undefined]
+**dhcp** | **boolean** | DHCP | [optional] [default to undefined]
+**url** | **boolean** | 3CX URL | [optional] [default to undefined]
+**authKey** | **boolean** | 3CX SBC Auth Key | [optional] [default to undefined]
+**ipAddress** | **boolean** | LAN IP Address | [optional] [default to undefined]
+**subnetMask** | **boolean** | LAN Subnet Mask | [optional] [default to undefined]
+**defaultGateway** | **boolean** | LAN Default Gateway | [optional] [default to undefined]
+**dns** | **boolean** | DNS | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SbcDTO } from 'yellowgrid-api-ts';
+
+const instance: SbcDTO = {
+    noConfig,
+    dhcp,
+    url,
+    authKey,
+    ipAddress,
+    subnetMask,
+    defaultGateway,
+    dns,
+};
+```
+
+[[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/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://localhost*
+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