yellowgrid-api-ts 3.2.232-dev.0 → 3.2.233-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/api.ts +521 -443
  2. package/dist/api.d.ts +419 -425
  3. package/dist/api.js +276 -192
  4. package/docs/AbstractOrderRequestDTO.md +3 -3
  5. package/docs/AccountDetailedSummaryDTO.md +1 -1
  6. package/docs/AccountRequestModel.md +6 -6
  7. package/docs/AddressDTO.md +3 -3
  8. package/docs/AdminNumberPortDTO.md +11 -11
  9. package/docs/AdminOrderRequestDTO.md +3 -3
  10. package/docs/AdminRmaDTO.md +3 -3
  11. package/docs/AdminRmaItemDTO.md +2 -2
  12. package/docs/AdminUserModel.md +5 -5
  13. package/docs/AuthCodeResponseModel.md +2 -2
  14. package/docs/AxisDataDTO.md +2 -2
  15. package/docs/CreditNoteItemDTO.md +2 -2
  16. package/docs/CreditStatusDTO.md +3 -3
  17. package/docs/CrmActivityDTO.md +4 -4
  18. package/docs/CrmDateActivitiesDTO.md +1 -1
  19. package/docs/CustomerCoordinatesDTO.md +1 -1
  20. package/docs/CustomerOrderRequestDTO.md +3 -3
  21. package/docs/DetailedOrderRequestDTO.md +3 -3
  22. package/docs/DivertRequestModel.md +1 -1
  23. package/docs/DivertResponseModel.md +1 -1
  24. package/docs/EdTechProClientEntity.md +1 -1
  25. package/docs/EdTechProSchoolModel.md +2 -2
  26. package/docs/FreshdeskTicketEntity.md +1 -1
  27. package/docs/GraphDTO.md +1 -1
  28. package/docs/InstallationDetailsDTO.md +7 -7
  29. package/docs/ItemDiscountEntity.md +1 -1
  30. package/docs/ItemEntity.md +1 -1
  31. package/docs/NumberPortDTO.md +11 -11
  32. package/docs/NumberPortRangeDTO.md +5 -5
  33. package/docs/NumberPortRangeRequestDTO.md +4 -4
  34. package/docs/NumberPortingApi.md +69 -69
  35. package/docs/OAuth20Api.md +24 -24
  36. package/docs/OpayoRedirectDTO.md +5 -5
  37. package/docs/OrderDetailsDTO.md +6 -6
  38. package/docs/OrderEntity.md +2 -2
  39. package/docs/OrderRequestModel.md +7 -7
  40. package/docs/OrderResponseDTO.md +3 -3
  41. package/docs/OrderSummaryDTO.md +6 -6
  42. package/docs/OrderTotalModel.md +1 -1
  43. package/docs/PartnerDTO.md +2 -2
  44. package/docs/PasswordSenderDTO.md +7 -7
  45. package/docs/PostGenerateReport200Response.md +1 -1
  46. package/docs/PriceListItemModel.md +3 -3
  47. package/docs/ProductPriceListItemModel.md +3 -3
  48. package/docs/ProductSerialInfoModel.md +1 -1
  49. package/docs/ProspectDTO.md +3 -3
  50. package/docs/RecordingBackupAzureModel.md +1 -1
  51. package/docs/RecordingsBackupInfoDTO.md +2 -2
  52. package/docs/ReportRequestDTO.md +8 -8
  53. package/docs/RmaDTO.md +1 -1
  54. package/docs/RmaItemDTO.md +2 -2
  55. package/docs/RmaItemRequestDTO.md +2 -2
  56. package/docs/SbcDTO.md +8 -8
  57. package/docs/ScannedItemModel.md +4 -4
  58. package/docs/SeriesDTO.md +1 -1
  59. package/docs/ShipmentDTO.md +7 -7
  60. package/docs/ShipmentRequestDTO.md +2 -2
  61. package/docs/ShippingAddressDTO.md +8 -8
  62. package/docs/ShippingRequestDTO.md +2 -2
  63. package/docs/ShippingServiceModel.md +2 -2
  64. package/docs/SmsAccountEntity.md +1 -1
  65. package/docs/SmsPhoneNumberModel.md +1 -1
  66. package/docs/StockOrderModel.md +1 -1
  67. package/docs/StockProductPriceModel.md +1 -1
  68. package/docs/SupportTicketModel.md +1 -1
  69. package/docs/TcxInstallationModel.md +15 -15
  70. package/docs/TcxKeySummaryDTO.md +2 -2
  71. package/docs/TcxMultiTenantModel.md +7 -7
  72. package/docs/TcxSbcDTO.md +1 -1
  73. package/docs/TcxSetupEntity.md +1 -1
  74. package/docs/TcxWizardModel.md +5 -5
  75. package/docs/TicketSummaryModel.md +1 -1
  76. package/docs/UserEntity.md +2 -2
  77. package/package.json +1 -1
package/docs/AbstractOrderRequestDTO.md CHANGED
@@ -6,11 +6,11 @@ Order Request
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
9
+ **orderReference** | **string** | Order Reference | [default to undefined]
10
10
  **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
12
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
12
+ **provisioningUrl** | **string** | Provisioning URL | [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [default to undefined]
15
15
  **quote** | **boolean** | Quote | [default to undefined]
16
16
 
package/docs/AccountDetailedSummaryDTO.md CHANGED
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  **addresses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [default to undefined]
16
16
  **provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [default to undefined]
17
17
  **onHold** | **boolean** | On Hold | [default to undefined]
18
- **balance** | **number** | Balance (£) | [optional] [default to undefined]
18
+ **balance** | **number** | Balance (£) | [default to undefined]
19
19
 
20
20
  ## Example
21
21
 
package/docs/AccountRequestModel.md CHANGED
@@ -11,16 +11,16 @@ Name | Type | Description | Notes
11
11
  **lastName** | **string** | Last Name | [default to undefined]
12
12
  **telephone** | **string** | Telephone | [default to undefined]
13
13
  **addressLine1** | **string** | Address Line 1 | [default to undefined]
14
- **addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
14
+ **addressLine2** | **string** | Address Line 2 | [default to undefined]
15
15
  **town** | **string** | Town/City | [default to undefined]
16
16
  **postCode** | **string** | Post Code | [default to undefined]
17
17
  **country** | **string** | Country ISO | [default to undefined]
18
- **companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
19
- **preferredPbx** | **string** | Preferred PBX | [optional] [default to undefined]
20
- **vatNumber** | **string** | VAT Number | [optional] [default to undefined]
18
+ **companyNumber** | **string** | Company Registration Number | [default to undefined]
19
+ **preferredPbx** | **string** | Preferred PBX | [default to undefined]
20
+ **vatNumber** | **string** | VAT Number | [default to undefined]
21
21
  **email** | **string** | Email Address | [default to undefined]
22
- **source** | **string** | Source | [optional] [default to undefined]
23
- **creditRequired** | **number** | Credit Limit Required | [optional] [default to undefined]
22
+ **source** | **string** | Source | [default to undefined]
23
+ **creditRequired** | **number** | Credit Limit Required | [default to undefined]
24
24
  **marketing** | **boolean** | Marketing Opt-In | [default to false]
25
25
  **reseller** | **boolean** | Reseller | [default to false]
26
26
 
package/docs/AddressDTO.md CHANGED
@@ -6,15 +6,15 @@ Address
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **company** | **string** | Company | [optional] [default to undefined]
9
+ **company** | **string** | Company | [default to undefined]
10
10
  **addressLine1** | **string** | Address Line 1 | [default to undefined]
11
11
  **addressLine2** | **string** | Address Line 2 | [default to undefined]
12
12
  **city** | **string** | City | [default to undefined]
13
13
  **region** | **string** | Region | [default to undefined]
14
14
  **postalCode** | **string** | Postal Code | [default to undefined]
15
15
  **iso** | **string** | Country | [default to undefined]
16
- **phone** | **string** | Telephone | [optional] [default to undefined]
17
- **name** | **string** | Name | [optional] [default to undefined]
16
+ **phone** | **string** | Telephone | [default to undefined]
17
+ **name** | **string** | Name | [default to undefined]
18
18
 
19
19
  ## Example
20
20
 
package/docs/AdminNumberPortDTO.md CHANGED
@@ -6,16 +6,16 @@ Admin Number Port Response
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **companyName** | **string** | Company Name | [optional] [default to undefined]
10
- **addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
11
- **addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
12
- **city** | **string** | City | [optional] [default to undefined]
13
- **postCode** | **string** | Post Code | [optional] [default to undefined]
14
- **trunkId** | **number** | Trunk ID | [optional] [default to undefined]
15
- **tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
16
- **requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
17
- **asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
18
- **comment** | **string** | Comment | [optional] [default to undefined]
9
+ **companyName** | **string** | Company Name | [default to undefined]
10
+ **addressLine1** | **string** | Address Line 1 | [default to undefined]
11
+ **addressLine2** | **string** | Address Line 2 | [default to undefined]
12
+ **city** | **string** | City | [default to undefined]
13
+ **postCode** | **string** | Post Code | [default to undefined]
14
+ **trunkId** | **number** | Trunk ID | [default to undefined]
15
+ **tenantId** | **string** | Starter Bundle ID | [default to undefined]
16
+ **requestedPortDate** | **string** | Requested Port Date | [default to undefined]
17
+ **asap** | **boolean** | Port Date ASAP | [default to undefined]
18
+ **comment** | **string** | Comment | [default to undefined]
19
19
  **id** | **number** | Number Port ID | [default to undefined]
20
20
  **customerId** | **number** | Reseller ID | [default to undefined]
21
21
  **customerName** | **string** | Customer Name | [default to undefined]
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
23
23
  **numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [default to undefined]
24
24
  **status** | **number** | Status | [default to undefined]
25
25
  **statusText** | **string** | Status Text | [default to undefined]
26
- **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
26
+ **ticketId** | **number** | Ticket ID | [default to undefined]
27
27
  **notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
28
28
  **cloas** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
29
29
  **createdAt** | **string** | Created At | [optional] [default to undefined]
package/docs/AdminOrderRequestDTO.md CHANGED
@@ -6,11 +6,11 @@ Admin Order Request
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
9
+ **orderReference** | **string** | Order Reference | [default to undefined]
10
10
  **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
12
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
12
+ **provisioningUrl** | **string** | Provisioning URL | [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [default to undefined]
15
15
  **quote** | **boolean** | Quote | [default to undefined]
16
16
  **customerId** | **number** | Customer ID | [optional] [default to undefined]
package/docs/AdminRmaDTO.md CHANGED
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
17
17
  **status** | **number** | RMA Status | [default to undefined]
18
18
  **statusText** | **string** | RMA Status Text | [default to undefined]
19
19
  **approved** | **boolean** | RMA Approval Status | [default to undefined]
20
- **address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
20
+ **address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
21
21
  **customerId** | **number** | Customer ID | [default to undefined]
22
22
  **xeroId** | **string** | Customer Xero ID | [default to undefined]
23
23
  **customerName** | **string** | Customer Name | [default to undefined]
@@ -26,8 +26,8 @@ Name | Type | Description | Notes
26
26
  **notes** | [**Array<AdminRmaNoteDTO>**](AdminRmaNoteDTO.md) | RMA Notes | [default to undefined]
27
27
  **replacementOrders** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Replacement Order | [default to undefined]
28
28
  **creditNotes** | [**Array<CreditNoteDTO>**](CreditNoteDTO.md) | Credit Notes | [default to undefined]
29
- **collectionTrackingUrl** | **string** | Collection Tracking URL | [optional] [default to undefined]
30
- **returnTrackingUrl** | **string** | Return Tracking URL | [optional] [default to undefined]
29
+ **collectionTrackingUrl** | **string** | Collection Tracking URL | [default to undefined]
30
+ **returnTrackingUrl** | **string** | Return Tracking URL | [default to undefined]
31
31
 
32
32
  ## Example
33
33
 
package/docs/AdminRmaItemDTO.md CHANGED
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
9
9
  **id** | **number** | RMA Item ID | [default to undefined]
10
10
  **itemId** | **number** | RMA Order Item ID | [default to undefined]
11
11
  **itemName** | **string** | RMA Item Name | [default to undefined]
12
- **macAddress** | **string** | RMA Item MAC Address | [optional] [default to undefined]
13
- **serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
12
+ **macAddress** | **string** | RMA Item MAC Address | [default to undefined]
13
+ **serialNumber** | **string** | RMA Item Serial Number | [default to undefined]
14
14
  **received** | **boolean** | RMA Item Received Status | [default to undefined]
15
15
  **status** | **number** | RMA Item Status | [default to undefined]
16
16
  **statusText** | **string** | RMA Item Status Text | [default to undefined]
package/docs/AdminUserModel.md CHANGED
@@ -9,12 +9,12 @@ Name | Type | Description | Notes
9
9
  **id** | **number** | ID | [default to undefined]
10
10
  **firstName** | **string** | First Name | [default to undefined]
11
11
  **lastName** | **string** | Last Name | [default to undefined]
12
- **avatar** | **string** | Avatar | [optional] [default to undefined]
12
+ **avatar** | **string** | Avatar | [default to undefined]
13
13
  **role** | **number** | Role | [default to undefined]
14
- **email** | **string** | Email | [optional] [default to undefined]
15
- **primaryHex** | **string** | Primary Colour | [optional] [default to undefined]
16
- **secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
17
- **scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
14
+ **email** | **string** | Email | [default to undefined]
15
+ **primaryHex** | **string** | Primary Colour | [default to undefined]
16
+ **secondaryHex** | **string** | Secondary Colour | [default to undefined]
17
+ **scopes** | **Array<string>** | Scopes | [default to undefined]
18
18
  **permissions** | **Array<string>** | Groups | [default to undefined]
19
19
 
20
20
  ## Example
package/docs/AuthCodeResponseModel.md CHANGED
@@ -7,8 +7,8 @@ OAuth Auth Code Response
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **code** | **string** | Auth Code | [default to undefined]
10
- **state** | **string** | State | [optional] [default to undefined]
11
- **redirect_uri** | **string** | Redirect URI | [optional] [default to undefined]
10
+ **state** | **string** | State | [default to undefined]
11
+ **redirect_uri** | **string** | Redirect URI | [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
package/docs/AxisDataDTO.md CHANGED
@@ -7,8 +7,8 @@ Graph Axis Data
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **type** | **string** | Type | [default to undefined]
10
- **data** | **Array<string>** | Data | [optional] [default to undefined]
11
- **name** | **string** | Name | [optional] [default to undefined]
10
+ **data** | **Array<string>** | Data | [default to undefined]
11
+ **name** | **string** | Name | [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
package/docs/CreditNoteItemDTO.md CHANGED
@@ -7,8 +7,8 @@ Credit Note Item
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **itemId** | **number** | Item ID | [default to undefined]
10
- **quantity** | **number** | Quantity | [optional] [default to undefined]
11
- **amount** | **number** | Amount | [optional] [default to undefined]
10
+ **quantity** | **number** | Quantity | [default to undefined]
11
+ **amount** | **number** | Amount | [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
package/docs/CreditStatusDTO.md CHANGED
@@ -6,9 +6,9 @@
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **CurrencyCode** | **string** | Currency Code | [optional] [default to undefined]
10
- **CreditLimit** | **number** | Credit Limit | [optional] [default to undefined]
11
- **Credit** | **number** | Credit | [optional] [default to undefined]
9
+ **CurrencyCode** | **string** | Currency Code | [default to undefined]
10
+ **CreditLimit** | **number** | Credit Limit | [default to undefined]
11
+ **Credit** | **number** | Credit | [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
package/docs/CrmActivityDTO.md CHANGED
@@ -7,12 +7,12 @@ CRM Activity
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **type** | **string** | Activity Type | [default to undefined]
10
- **timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
10
+ **timestamp** | **string** | Activity Timestamp | [default to undefined]
11
11
  **title** | **string** | Activity Title | [default to undefined]
12
12
  **description** | **string** | Activity Description | [default to undefined]
13
- **user** | **string** | Activity User Name | [optional] [default to undefined]
14
- **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
15
- **orderId** | **number** | Activity Order ID | [optional] [default to undefined]
13
+ **user** | **string** | Activity User Name | [default to undefined]
14
+ **contact** | **string** | Activity Contact Name | [default to undefined]
15
+ **orderId** | **number** | Activity Order ID | [default to undefined]
16
16
 
17
17
  ## Example
18
18
 
package/docs/CrmDateActivitiesDTO.md CHANGED
@@ -6,7 +6,7 @@ CRM Date Activities
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **date** | **string** | Date | [optional] [default to undefined]
9
+ **date** | **string** | Date | [default to undefined]
10
10
  **activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [default to undefined]
11
11
 
12
12
  ## Example
package/docs/CustomerCoordinatesDTO.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **id** | **string** | ID | [default to undefined]
10
10
  **company** | **string** | Company | [default to undefined]
11
- **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
11
+ **resellerId** | **string** | 3CX Reseller ID | [default to undefined]
12
12
  **postCode** | **string** | Post Code | [default to undefined]
13
13
  **latitude** | **string** | Latitude | [default to undefined]
14
14
  **longitude** | **string** | Longitude | [default to undefined]
package/docs/CustomerOrderRequestDTO.md CHANGED
@@ -6,11 +6,11 @@ Order Request
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
9
+ **orderReference** | **string** | Order Reference | [default to undefined]
10
10
  **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
12
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
12
+ **provisioningUrl** | **string** | Provisioning URL | [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [default to undefined]
15
15
  **quote** | **boolean** | Quote | [default to undefined]
16
16
 
package/docs/DetailedOrderRequestDTO.md CHANGED
@@ -6,11 +6,11 @@ Detailed Order Request
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
9
+ **orderReference** | **string** | Order Reference | [default to undefined]
10
10
  **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
12
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
12
+ **provisioningUrl** | **string** | Provisioning URL | [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [default to undefined]
15
15
  **quote** | **boolean** | Quote | [default to undefined]
16
16
 
package/docs/DivertRequestModel.md CHANGED
@@ -7,7 +7,7 @@ Divert Request
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **numbers** | **Array<string>** | Numbers to divert | [default to undefined]
10
- **destination** | **string** | Destination | [optional] [default to undefined]
10
+ **destination** | **string** | Destination | [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
package/docs/DivertResponseModel.md CHANGED
@@ -7,7 +7,7 @@ Divert
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **number** | **string** | Number | [default to undefined]
10
- **destination** | **string** | Divert Destination | [optional] [default to undefined]
10
+ **destination** | **string** | Divert Destination | [default to undefined]
11
11
  **status** | **string** | Divert Status | [default to undefined]
12
12
 
13
13
  ## Example
package/docs/EdTechProClientEntity.md CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **clientId** | **number** | Client ID | [default to undefined]
11
11
  **customerId** | **number** | Customer ID | [default to undefined]
12
12
  **clientName** | **string** | Client/Trust Name | [default to undefined]
13
- **apiKey** | **string** | Client API Key | [optional] [default to undefined]
13
+ **apiKey** | **string** | Client API Key | [default to undefined]
14
14
 
15
15
  ## Example
16
16
 
package/docs/EdTechProSchoolModel.md CHANGED
@@ -11,14 +11,14 @@ Name | Type | Description | Notes
11
11
  **schoolId** | **number** | School ID | [default to undefined]
12
12
  **schoolName** | **string** | School Name | [default to undefined]
13
13
  **sku** | **string** | Product Sku | [default to undefined]
14
- **orderReference** | **string** | Order Reference | [optional] [default to undefined]
14
+ **orderReference** | **string** | Order Reference | [default to undefined]
15
15
  **creationDate** | **string** | Creation Date | [default to undefined]
16
16
  **price** | **number** | School Annual Price | [default to undefined]
17
17
  **rrp** | **number** | School Annual Price (RRP) | [default to undefined]
18
18
  **templateUrl** | **string** | Integration Template URL | [default to undefined]
19
19
  **clientName** | **string** | Client/Trust Name | [default to undefined]
20
20
  **customerId** | **number** | Customer ID | [default to undefined]
21
- **apiKey** | **string** | API Key | [optional] [default to undefined]
21
+ **apiKey** | **string** | API Key | [default to undefined]
22
22
 
23
23
  ## Example
24
24
 
package/docs/FreshdeskTicketEntity.md CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
  **companyId** | **number** | companyId | [default to undefined]
12
12
  **groupId** | **number** | groupId | [default to undefined]
13
13
  **productId** | **number** | productId | [default to undefined]
14
- **statusId** | **number** | status | [optional] [default to undefined]
14
+ **statusId** | **number** | status | [default to undefined]
15
15
  **lastUpdated** | **string** | lastUpdated | [default to undefined]
16
16
 
17
17
  ## Example
package/docs/GraphDTO.md CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
  **yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
12
12
  **legend** | **Array<string>** | Legend | [default to undefined]
13
13
  **series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
14
- **currency** | **string** | Currency | [optional] [default to undefined]
14
+ **currency** | **string** | Currency | [default to undefined]
15
15
  **locale** | **string** | Locale | [default to undefined]
16
16
 
17
17
  ## Example
package/docs/InstallationDetailsDTO.md CHANGED
@@ -6,15 +6,15 @@ Installation Passwords
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
10
- **failoverIpAddress** | **string** | PBX Failover IP Address | [optional] [default to undefined]
11
- **instanceId** | **string** | Instance ID | [optional] [default to undefined]
12
- **project** | **string** | Project ID | [optional] [default to undefined]
9
+ **ipAddress** | **string** | PBX IP Address | [default to undefined]
10
+ **failoverIpAddress** | **string** | PBX Failover IP Address | [default to undefined]
11
+ **instanceId** | **string** | Instance ID | [default to undefined]
12
+ **project** | **string** | Project ID | [default to undefined]
13
13
  **sshKey** | [**GenericFileModel**](GenericFileModel.md) | | [default to undefined]
14
- **osPassword** | **string** | Root Password | [optional] [default to undefined]
14
+ **osPassword** | **string** | Root Password | [default to undefined]
15
15
  **systemOwner** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [default to undefined]
16
- **email** | **string** | Admin Email | [optional] [default to undefined]
17
- **url** | **string** | 3CX Console URL | [optional] [default to undefined]
16
+ **email** | **string** | Admin Email | [default to undefined]
17
+ **url** | **string** | 3CX Console URL | [default to undefined]
18
18
  **backup** | [**RemoteStorageDTO**](RemoteStorageDTO.md) | | [default to undefined]
19
19
 
20
20
  ## Example
package/docs/ItemDiscountEntity.md CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **itemId** | **number** | itemId | [default to undefined]
11
11
  **priceList** | **string** | priceList | [default to undefined]
12
12
  **discount** | **number** | discount | [default to undefined]
13
- **type** | **string** | type | [optional] [default to undefined]
13
+ **type** | **string** | type | [default to undefined]
14
14
  **description** | **string** | description | [default to undefined]
15
15
  **priority** | **number** | priority | [default to undefined]
16
16
 
package/docs/ItemEntity.md CHANGED
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
27
27
  **licenceExpiryDate** | **string** | licenceExpiryDate | [default to undefined]
28
28
  **processDate** | **string** | processDate | [default to undefined]
29
29
  **promoItem** | **number** | promo | [default to undefined]
30
- **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
30
+ **tcxSalesCode** | **string** | 3CX Sales Code | [default to undefined]
31
31
 
32
32
  ## Example
33
33
 
package/docs/NumberPortDTO.md CHANGED
@@ -6,16 +6,16 @@ Number Port Response
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **companyName** | **string** | Company Name | [optional] [default to undefined]
10
- **addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
11
- **addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
12
- **city** | **string** | City | [optional] [default to undefined]
13
- **postCode** | **string** | Post Code | [optional] [default to undefined]
14
- **trunkId** | **number** | Trunk ID | [optional] [default to undefined]
15
- **tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
16
- **requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
17
- **asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
18
- **comment** | **string** | Comment | [optional] [default to undefined]
9
+ **companyName** | **string** | Company Name | [default to undefined]
10
+ **addressLine1** | **string** | Address Line 1 | [default to undefined]
11
+ **addressLine2** | **string** | Address Line 2 | [default to undefined]
12
+ **city** | **string** | City | [default to undefined]
13
+ **postCode** | **string** | Post Code | [default to undefined]
14
+ **trunkId** | **number** | Trunk ID | [default to undefined]
15
+ **tenantId** | **string** | Starter Bundle ID | [default to undefined]
16
+ **requestedPortDate** | **string** | Requested Port Date | [default to undefined]
17
+ **asap** | **boolean** | Port Date ASAP | [default to undefined]
18
+ **comment** | **string** | Comment | [default to undefined]
19
19
  **id** | **number** | Number Port ID | [default to undefined]
20
20
  **customerId** | **number** | Reseller ID | [default to undefined]
21
21
  **customerName** | **string** | Customer Name | [default to undefined]
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
23
23
  **numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [default to undefined]
24
24
  **status** | **number** | Status | [default to undefined]
25
25
  **statusText** | **string** | Status Text | [default to undefined]
26
- **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
26
+ **ticketId** | **number** | Ticket ID | [default to undefined]
27
27
 
28
28
  ## Example
29
29
 
package/docs/NumberPortRangeDTO.md CHANGED
@@ -6,13 +6,13 @@ Number Port Range Response
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **rangeStart** | **string** | Range Start Number | [optional] [default to undefined]
10
- **rangeEnd** | **string** | Range End Number | [optional] [default to undefined]
11
- **lcp** | **string** | Losing Communications Provider | [optional] [default to undefined]
12
- **postCode** | **string** | Range Post Code | [optional] [default to undefined]
9
+ **rangeStart** | **string** | Range Start Number | [default to undefined]
10
+ **rangeEnd** | **string** | Range End Number | [default to undefined]
11
+ **lcp** | **string** | Losing Communications Provider | [default to undefined]
12
+ **postCode** | **string** | Range Post Code | [default to undefined]
13
13
  **id** | **number** | Number Port Range ID | [default to undefined]
14
14
  **portId** | **number** | Number Port ID | [default to undefined]
15
- **rangeHolder** | **string** | Range Holder | [optional] [default to undefined]
15
+ **rangeHolder** | **string** | Range Holder | [default to undefined]
16
16
 
17
17
  ## Example
18
18
 
package/docs/NumberPortRangeRequestDTO.md CHANGED
@@ -6,10 +6,10 @@ NumberPortRangeDTO
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **rangeStart** | **string** | Range Start Number | [optional] [default to undefined]
10
- **rangeEnd** | **string** | Range End Number | [optional] [default to undefined]
11
- **lcp** | **string** | Losing Communications Provider | [optional] [default to undefined]
12
- **postCode** | **string** | Range Post Code | [optional] [default to undefined]
9
+ **rangeStart** | **string** | Range Start Number | [default to undefined]
10
+ **rangeEnd** | **string** | Range End Number | [default to undefined]
11
+ **lcp** | **string** | Losing Communications Provider | [default to undefined]
12
+ **postCode** | **string** | Range Post Code | [default to undefined]
13
13
 
14
14
  ## Example
15
15