yellowgrid-api-ts 3.2.222-dev.0 → 3.2.223-dev.0

package/docs/MacAddressRequestModel.md

@@ -0,0 +1,21 @@
+# MacAddressRequestModel
+
+RMA Item MAC Address Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MacAddressRequestModel } from 'yellowgrid-api-ts';
+
+const instance: MacAddressRequestModel = {
+    macAddress,
+};
+```
+
+[[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/{AbstractItemDiscountModel.md → NameRequestModel.md}

@@ -1,20 +1,20 @@
-# AbstractItemDiscountModel
+# NameRequestModel
 
-Item Discount
+Name Request
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | **string** | Description | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AbstractItemDiscountModel } from 'yellowgrid-api-ts';
+import { NameRequestModel } from 'yellowgrid-api-ts';
 
-const instance: AbstractItemDiscountModel = {
-    description,
+const instance: NameRequestModel = {
+    name,
 };
 ```
 

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

@@ -1,5 +1,6 @@
-# PostAddAdminNoteRequest
+# NoteRequestModel
 
+Note Request
 
 ## Properties
 
@@ -10,9 +11,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
+import { NoteRequestModel } from 'yellowgrid-api-ts';
 
-const instance: PostAddAdminNoteRequest = {
+const instance: NoteRequestModel = {
     note,
 };
 ```

package/docs/OAuth20Api.md

@@ -158,7 +158,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;sms.read&#39; &#124; &#39;sms.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;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;rma.read&#39; &#124; &#39;rma.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.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|
@@ -211,7 +211,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' | 'sms.read' | 'sms.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' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'rma.read' | 'rma.write' | 'sms.read' | 'sms.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)
@@ -234,7 +234,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;sms.read&#39; | &#39;sms.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;sms.read&#39; &#124; &#39;sms.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;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;rma.read&#39; | &#39;rma.write&#39; | &#39;sms.read&#39; | &#39;sms.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;rma.read&#39; &#124; &#39;rma.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.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/PartnerDTO.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
 **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
 **aligned** | **boolean** | Aligned | [optional] [default to undefined]
-**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |  | [optional] [default to undefined]
+**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
 
 ## Example
 

package/docs/PasswordSenderDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **password** | **string** | Password | [optional] [default to undefined]
 **expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
 **intervalType** | **string** | Interval Type | [optional] [default to undefined]
-**expiry** | **string** | Date Time | [optional] [default to undefined]
+**expiry** | **string** | Expiry | [optional] [default to undefined]
 **recipient** | **Array<string>** | Recipient | [optional] [default to undefined]
 **url** | **string** | URL | [optional] [default to undefined]
 **description** | **string** | Description | [optional] [default to undefined]

package/docs/{GetDisconnectDDIRequest.md → PostDisconnectDDIRequest.md}

@@ -1,4 +1,4 @@
-# GetDisconnectDDIRequest
+# PostDisconnectDDIRequest
 
 
 ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GetDisconnectDDIRequest } from 'yellowgrid-api-ts';
+import { PostDisconnectDDIRequest } from 'yellowgrid-api-ts';
 
-const instance: GetDisconnectDDIRequest = {
+const instance: PostDisconnectDDIRequest = {
     id,
 };
 ```

package/docs/ProductDetailedSummaryDTO.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 **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]
-**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Due Date | [optional] [default to undefined]
 **onOrder** | **number** | On Order | [optional] [default to undefined]
 
 ## Example

package/docs/ProductSerialInfoDTO.md

@@ -0,0 +1,27 @@
+# ProductSerialInfoDTO
+
+Product Serial Info Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**title** | **string** | Product Title | [optional] [default to undefined]
+**mac** | **boolean** | Has MAC Address | [optional] [default to undefined]
+**serialPrefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSerialInfoDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductSerialInfoDTO = {
+    sku,
+    title,
+    mac,
+    serialPrefixes,
+};
+```
+
+[[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/ProductSummaryDTO.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **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/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]