yellowgrid-api-ts 3.2.52-dev.0 → 3.2.54-dev.0

package/docs/Class3CXMultiTenantApi.md

@@ -5,7 +5,6 @@ All URIs are relative to *http://api.yellowgrid.local*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteGetTenant**](#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant|
-|[**getGetAdminTenants**](#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants|
 |[**getGetTenant**](#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant|
 |[**getGetTenants**](#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants|
 |[**postAddMtDdi**](#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI|
@@ -67,60 +66,6 @@ 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)
 
-# **getGetAdminTenants**
-> Array<TcxMultiTenantModel> getGetAdminTenants()
-
-Get 3CX Starter Bundle Tenants
-
-### Example
-
-```typescript
-import {
-    Class3CXMultiTenantApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new Class3CXMultiTenantApi(configuration);
-
-let customerId: number; // (default to undefined)
-
-const { status, data } = await apiInstance.getGetAdminTenants(
-    customerId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **customerId** | [**number**] |  | defaults to undefined|
-
-
-### Return type
-
-**Array<TcxMultiTenantModel>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | 3CX Starter Bundle Tenant |  -  |
-|**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)
-
 # **getGetTenant**
 > TcxMultiTenantModel getGetTenant()
 

package/docs/CreditNoteDTO.md

@@ -0,0 +1,21 @@
+# CreditNoteDTO
+
+Credit Note
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<CreditNoteItemDTO>**](CreditNoteItemDTO.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteDTO } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteDTO = {
+    items,
+};
+```
+
+[[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/CreditNoteEntity.md

@@ -0,0 +1,29 @@
+# CreditNoteEntity
+
+CreditNotesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**transactionId** | **string** | transactionId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteEntity } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteEntity = {
+    id,
+    orderId,
+    transactionId,
+    amount,
+    timestamp,
+};
+```
+
+[[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/CreditNoteItemDTO.md

@@ -0,0 +1,25 @@
+# CreditNoteItemDTO
+
+Credit Note Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemId** | **number** | Item ID | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**amount** | **number** | Amount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteItemDTO } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteItemDTO = {
+    itemId,
+    quantity,
+    amount,
+};
+```
+
+[[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/CreditNoteItemEntity.md

@@ -0,0 +1,29 @@
+# CreditNoteItemEntity
+
+CreditNotesItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteItemEntity } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteItemEntity = {
+    id,
+    creditNoteId,
+    orderId,
+    itemId,
+    amount,
+};
+```
+
+[[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/CreditNoteModel.md

@@ -0,0 +1,29 @@
+# CreditNoteModel
+
+Credit Note Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**transactionId** | **string** | transactionId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditNoteModel } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteModel = {
+    id,
+    orderId,
+    transactionId,
+    amount,
+    timestamp,
+};
+```
+
+[[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/OAuth20Api.md

@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
 | **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
 | **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
 | **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
-| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
+| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
 | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
 | **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
 | **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
 
 let clientId: string; //OAuth 2.0 Client ID (default to undefined)
 let responseType: string; //OAuth 2.0 Response Type (default to 'code')
-let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
+let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
 let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
 let state: string; //OAuth 2.0 State (optional) (default to undefined)
 let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
 |------------- | ------------- | ------------- | -------------|
 | **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
 | **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
-| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
+| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
 | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
 | **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
 | **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|

package/docs/OrderDetailsDTO.md

@@ -0,0 +1,63 @@
+# OrderDetailsDTO
+
+Order Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**reference** | **string** | Reference | [optional] [default to undefined]
+**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**invoiceId** | **string** | Invoice ID | [optional] [default to undefined]
+**orderDate** | **string** | Date Time | [optional] [default to undefined]
+**paid** | **boolean** | Paid | [optional] [default to undefined]
+**complete** | **boolean** | Complete | [optional] [default to undefined]
+**quote** | **boolean** | Quote | [optional] [default to undefined]
+**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [optional] [default to undefined]
+**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
+**fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
+**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
+**readonly** | **boolean** | Readonly | [optional] [default to undefined]
+**detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
+**batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]
+**logEntries** | [**Array<AuditLogEntity>**](AuditLogEntity.md) | Audit Log | [optional] [default to undefined]
+**paymentLink** | **string** | Card Payment Link | [optional] [default to undefined]
+**credits** | [**Array<CreditNoteModel>**](CreditNoteModel.md) | Credits | [optional] [default to undefined]
+**customerEmail** | **string** | Customer Email | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderDetailsDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderDetailsDTO = {
+    id,
+    reference,
+    invoiceNumber,
+    invoiceId,
+    orderDate,
+    paid,
+    complete,
+    quote,
+    customer,
+    shippingAddress,
+    items,
+    carriageCharge,
+    fulfillable,
+    provisioningUrl,
+    shippingService,
+    readonly,
+    detailedItems,
+    batches,
+    logEntries,
+    paymentLink,
+    credits,
+    customerEmail,
+};
+```
+
+[[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

@@ -0,0 +1,51 @@
+# OrderItemDTO
+
+Order Item Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**id** | **number** | ID | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
+**processDate** | **string** | Date Time | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [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]
+**readonly** | **boolean** | Readonly | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**suppliers** | [**Array<SupplierModel>**](SupplierModel.md) | Suppliers | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItemDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderItemDTO = {
+    sku,
+    quantity,
+    id,
+    orderId,
+    title,
+    price,
+    licenceKey,
+    licenceExpiry,
+    processDate,
+    hosting,
+    promoItem,
+    refunded,
+    sbcs,
+    readonly,
+    tcxSalesCode,
+    suppliers,
+};
+```
+
+[[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/OrderedItemModel.md

@@ -0,0 +1,47 @@
+# OrderedItemModel
+
+Ordered Item Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**orderedQuantity** | **number** | orderedQuantity | [optional] [default to undefined]
+**itemStatus** | **number** | itemStatus | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [optional] [default to undefined]
+**supplierItemId** | **number** | supplierItemId | [optional] [default to undefined]
+**supplierPrice** | **number** | supplierPrice | [optional] [default to undefined]
+**statusDate** | **string** | statusDate | [optional] [default to undefined]
+**statusAuthor** | **number** | statusAuthor | [optional] [default to undefined]
+**supplierPaid** | **number** | supplierPaid | [optional] [default to undefined]
+**supplierCreditDue** | **number** | supplierCreditDue | [optional] [default to undefined]
+**supplierCreditReceived** | **number** | supplierCreditReceived | [optional] [default to undefined]
+**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
+**returnedStock** | **number** | returnedStock | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderedItemModel } from 'yellowgrid-api-ts';
+
+const instance: OrderedItemModel = {
+    id,
+    itemId,
+    orderedQuantity,
+    itemStatus,
+    supplierId,
+    supplierItemId,
+    supplierPrice,
+    statusDate,
+    statusAuthor,
+    supplierPaid,
+    supplierCreditDue,
+    supplierCreditReceived,
+    supplierSku,
+    returnedStock,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)