yellowgrid-api-ts 3.2.178 → 3.2.180-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 (88) hide show
  1. package/.openapi-generator/FILES +302 -294
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +17 -3
  4. package/api.ts +6266 -605
  5. package/base.ts +26 -2
  6. package/common.ts +39 -16
  7. package/config.json +3 -3
  8. package/configuration.ts +21 -27
  9. package/dist/api.d.ts +5341 -96
  10. package/dist/api.js +1322 -468
  11. package/dist/base.d.ts +25 -1
  12. package/dist/base.js +21 -2
  13. package/dist/common.d.ts +36 -5
  14. package/dist/common.js +39 -17
  15. package/dist/configuration.d.ts +18 -25
  16. package/dist/configuration.js +4 -4
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/GroupEnum.d.ts +43 -0
  20. package/dist/models/GroupEnum.js +45 -0
  21. package/dist/models/HostingPriceListEnum.d.ts +5 -0
  22. package/dist/models/HostingPriceListEnum.js +5 -0
  23. package/docs/AbstractItemDiscountModel.md +21 -0
  24. package/docs/AbstractOrderRequestDTO.md +1 -1
  25. package/docs/AccountsApi.md +60 -1
  26. package/docs/AdminOrderRequestDTO.md +1 -1
  27. package/docs/BillingApi.md +1 -1
  28. package/docs/CRMApi.md +1 -1
  29. package/docs/Class3CXApi.md +51 -3
  30. package/docs/Class3CXInstallationWizardApi.md +1 -1
  31. package/docs/Class3CXInstallationsApi.md +1 -1
  32. package/docs/Class3CXIntegrationsApi.md +1 -1
  33. package/docs/Class3CXMultiTenantApi.md +1 -1
  34. package/docs/CrmActivityDTO.md +1 -1
  35. package/docs/CrmDateActivitiesDTO.md +1 -1
  36. package/docs/CustomerOrderRequestDTO.md +1 -1
  37. package/docs/DetailedOrderRequestDTO.md +1 -1
  38. package/docs/ExpiringKeyDTO.md +29 -0
  39. package/docs/GetCheckMacExists200Response.md +20 -0
  40. package/docs/MacAddressDTO.md +23 -0
  41. package/docs/MyPBXToolsApi.md +1 -1
  42. package/docs/NumberPortModel.md +51 -0
  43. package/docs/NumberPortingApi.md +1 -1
  44. package/docs/OAuth20Api.md +1 -1
  45. package/docs/OpayoRedirectDTO.md +29 -0
  46. package/docs/OrdersApi.md +5 -2
  47. package/docs/PartnerDTO.md +1 -1
  48. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  49. package/docs/PatchUpdateAccountNameRequest.md +20 -0
  50. package/docs/PostAddAdminNoteRequest.md +20 -0
  51. package/docs/PostGetProductRequest.md +24 -0
  52. package/docs/PricingApi.md +1 -1
  53. package/docs/ProductDetailedSummaryDTO.md +41 -0
  54. package/docs/ProductSearchDTO.md +37 -0
  55. package/docs/ProductSummaryDTO.md +1 -3
  56. package/docs/ProductsApi.md +13 -7
  57. package/docs/ProspectDTO.md +2 -2
  58. package/docs/ProspectsApi.md +1 -1
  59. package/docs/ProvisioningApi.md +167 -1
  60. package/docs/RecordingsBackupInfoDTO.md +2 -2
  61. package/docs/SIPTrunksApi.md +1 -1
  62. package/docs/SMSApi.md +1 -1
  63. package/docs/ServicesApi.md +1 -1
  64. package/docs/ShipmentRequestDTO.md +2 -2
  65. package/docs/ShippingApi.md +1 -1
  66. package/docs/StockManagementApi.md +1 -1
  67. package/docs/SupplierItemModel.md +2 -0
  68. package/docs/SupplierItemsResultsDTO.md +21 -0
  69. package/docs/SupplierProductModel.md +25 -0
  70. package/docs/SupplierProductResultsModel.md +21 -0
  71. package/docs/SuppliersApi.md +68 -0
  72. package/docs/SystemApi.md +1 -1
  73. package/docs/TcxInstallationDetailsModel.md +45 -0
  74. package/docs/TcxInstallationModel.md +4 -0
  75. package/docs/TcxKeySummaryDTO.md +1 -1
  76. package/docs/TelephonySupportTicketModel.md +41 -0
  77. package/docs/TicketsApi.md +1 -1
  78. package/docs/WebhooksApi.md +1 -1
  79. package/getEnums.php +31 -31
  80. package/hs_err_pid16044.log +249 -0
  81. package/hs_err_pid44560.log +249 -0
  82. package/hs_err_pid53988.log +249 -0
  83. package/hs_err_pid58728.log +40 -0
  84. package/index.ts +1 -1
  85. package/models/GroupEnum.ts +44 -0
  86. package/models/HostingPriceListEnum.ts +5 -0
  87. package/openapitools.json +1 -1
  88. package/package.json +2 -2
@@ -1,6 +1,6 @@
1
1
  # AccountsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -29,6 +29,7 @@ All URIs are relative to *https://bitbucket.org*
29
29
  |[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
30
30
  |[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
31
31
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
32
+ |[**patchUpdateAccountName**](#patchupdateaccountname) | **PATCH** /admin/accounts/{id}/name | |
32
33
  |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
33
34
  |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
34
35
  |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
@@ -1402,6 +1403,64 @@ No authorization required
1402
1403
 
1403
1404
  [[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)
1404
1405
 
1406
+ # **patchUpdateAccountName**
1407
+ > patchUpdateAccountName()
1408
+
1409
+ Set Account Name
1410
+
1411
+ ### Example
1412
+
1413
+ ```typescript
1414
+ import {
1415
+ AccountsApi,
1416
+ Configuration,
1417
+ PatchUpdateAccountNameRequest
1418
+ } from 'yellowgrid-api-ts';
1419
+
1420
+ const configuration = new Configuration();
1421
+ const apiInstance = new AccountsApi(configuration);
1422
+
1423
+ let id: string; //Xero ID (default to undefined)
1424
+ let patchUpdateAccountNameRequest: PatchUpdateAccountNameRequest; //Account Name Request (optional)
1425
+
1426
+ const { status, data } = await apiInstance.patchUpdateAccountName(
1427
+ id,
1428
+ patchUpdateAccountNameRequest
1429
+ );
1430
+ ```
1431
+
1432
+ ### Parameters
1433
+
1434
+ |Name | Type | Description | Notes|
1435
+ |------------- | ------------- | ------------- | -------------|
1436
+ | **patchUpdateAccountNameRequest** | **PatchUpdateAccountNameRequest**| Account Name Request | |
1437
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1438
+
1439
+
1440
+ ### Return type
1441
+
1442
+ void (empty response body)
1443
+
1444
+ ### Authorization
1445
+
1446
+ No authorization required
1447
+
1448
+ ### HTTP request headers
1449
+
1450
+ - **Content-Type**: application/json
1451
+ - **Accept**: Not defined
1452
+
1453
+
1454
+ ### HTTP response details
1455
+ | Status code | Description | Response headers |
1456
+ |-------------|-------------|------------------|
1457
+ |**204** | No Response | - |
1458
+ |**400** | Bad Request | - |
1459
+ |**401** | Unauthorised | - |
1460
+ |**403** | Access Denied | - |
1461
+
1462
+ [[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)
1463
+
1405
1464
  # **patchUpdateAccountPhone**
1406
1465
  > patchUpdateAccountPhone()
1407
1466
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
  **customerId** | **number** | Customer ID | [optional] [default to undefined]
@@ -1,6 +1,6 @@
1
1
  # BillingApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/CRMApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # CRMApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,12 +1,13 @@
1
1
  # Class3CXApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
8
8
  |[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
9
- |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
9
+ |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
10
+ |[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
10
11
  |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
11
12
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
12
13
 
@@ -112,7 +113,7 @@ No authorization required
112
113
  [[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)
113
114
 
114
115
  # **getGetTcxExpiringKeys**
115
- > string getGetTcxExpiringKeys()
116
+ > Array<ExpiringKeyDTO> getGetTcxExpiringKeys()
116
117
 
117
118
  Get 3CX Expiring Keys
118
119
 
@@ -134,6 +135,53 @@ const { status, data } = await apiInstance.getGetTcxExpiringKeys();
134
135
  This endpoint does not have any parameters.
135
136
 
136
137
 
138
+ ### Return type
139
+
140
+ **Array<ExpiringKeyDTO>**
141
+
142
+ ### Authorization
143
+
144
+ No authorization required
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: Not defined
149
+ - **Accept**: application/json
150
+
151
+
152
+ ### HTTP response details
153
+ | Status code | Description | Response headers |
154
+ |-------------|-------------|------------------|
155
+ |**200** | 3CX Expiring Key | - |
156
+ |**400** | Bad Request | - |
157
+ |**401** | Unauthorised | - |
158
+ |**403** | Access Denied | - |
159
+
160
+ [[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)
161
+
162
+ # **getGetTcxExpiringKeysCsv**
163
+ > string getGetTcxExpiringKeysCsv()
164
+
165
+ Get 3CX Expiring Keys
166
+
167
+ ### Example
168
+
169
+ ```typescript
170
+ import {
171
+ Class3CXApi,
172
+ Configuration
173
+ } from 'yellowgrid-api-ts';
174
+
175
+ const configuration = new Configuration();
176
+ const apiInstance = new Class3CXApi(configuration);
177
+
178
+ const { status, data } = await apiInstance.getGetTcxExpiringKeysCsv();
179
+ ```
180
+
181
+ ### Parameters
182
+ This endpoint does not have any parameters.
183
+
184
+
137
185
  ### Return type
138
186
 
139
187
  **string**
@@ -1,6 +1,6 @@
1
1
  # Class3CXInstallationWizardApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXInstallationsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXIntegrationsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXMultiTenantApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -7,7 +7,7 @@ CRM Activity
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **type** | **string** | Activity Type | [optional] [default to undefined]
10
- **timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
10
+ **timestamp** | **string** | Date Time | [optional] [default to undefined]
11
11
  **title** | **string** | Activity Title | [optional] [default to undefined]
12
12
  **description** | **string** | Activity Description | [optional] [default to undefined]
13
13
  **url** | **string** | Activity URL | [optional] [default to undefined]
@@ -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 Time | [optional] [default to undefined]
10
10
  **activities** | [**Array&lt;CrmActivityDTO&gt;**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
11
11
 
12
12
  ## Example
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array&lt;CustomerItemRequestDTO&gt;**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array&lt;DetailedItemRequestDTO&gt;**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
- **shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
14
  **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
15
  **quote** | **boolean** | Quote | [optional] [default to undefined]
16
16
 
@@ -0,0 +1,29 @@
1
+ # ExpiringKeyDTO
2
+
3
+ 3CX Expiring Key
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **expiryDate** | **string** | Date Time | [optional] [default to undefined]
10
+ **licenceKey** | **string** | Licence Key | [optional] [default to undefined]
11
+ **edition** | **string** | Edition | [optional] [default to undefined]
12
+ **type** | **string** | Type | [optional] [default to undefined]
13
+ **partner** | [**PartnerDTO**](PartnerDTO.md) | | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { ExpiringKeyDTO } from 'yellowgrid-api-ts';
19
+
20
+ const instance: ExpiringKeyDTO = {
21
+ expiryDate,
22
+ licenceKey,
23
+ edition,
24
+ type,
25
+ partner,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # GetCheckMacExists200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **found** | **boolean** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GetCheckMacExists200Response } from 'yellowgrid-api-ts';
14
+
15
+ const instance: GetCheckMacExists200Response = {
16
+ found,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # MacAddressDTO
2
+
3
+ MAC Address DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **groupId** | **number** | Group ID | [optional] [default to undefined]
10
+ **macAddress** | **string** | MAC Address | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { MacAddressDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: MacAddressDTO = {
18
+ groupId,
19
+ macAddress,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,6 +1,6 @@
1
1
  # MyPBXToolsApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -0,0 +1,51 @@
1
+ # NumberPortModel
2
+
3
+ Number Port Model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | Number Port ID | [optional] [default to undefined]
10
+ **customerId** | **number** | Customer ID | [optional] [default to undefined]
11
+ **endUser** | **string** | End User | [optional] [default to undefined]
12
+ **addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
13
+ **addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
14
+ **city** | **string** | City | [optional] [default to undefined]
15
+ **postCode** | **string** | Post Code | [optional] [default to undefined]
16
+ **trunkId** | **number** | Trunk ID | [optional] [default to undefined]
17
+ **tenantId** | **string** | Tenant ID | [optional] [default to undefined]
18
+ **requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
19
+ **portDate** | **string** | Port Date | [optional] [default to undefined]
20
+ **comment** | **string** | Comment | [optional] [default to undefined]
21
+ **status** | **number** | Status | [optional] [default to undefined]
22
+ **ticketId** | **number** | Ticket ID | [optional] [default to undefined]
23
+ **ranges** | **Array&lt;any&gt;** | Number Port Ranges | [optional] [default to undefined]
24
+ **customerName** | **string** | Customer Company Name | [optional] [default to undefined]
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import { NumberPortModel } from 'yellowgrid-api-ts';
30
+
31
+ const instance: NumberPortModel = {
32
+ id,
33
+ customerId,
34
+ endUser,
35
+ addressLine1,
36
+ addressLine2,
37
+ city,
38
+ postCode,
39
+ trunkId,
40
+ tenantId,
41
+ requestedPortDate,
42
+ portDate,
43
+ comment,
44
+ status,
45
+ ticketId,
46
+ ranges,
47
+ customerName,
48
+ };
49
+ ```
50
+
51
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,6 +1,6 @@
1
1
  # NumberPortingApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # OAuth20Api
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -0,0 +1,29 @@
1
+ # OpayoRedirectDTO
2
+
3
+ Opayo Redirect
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **acsUrl** | **string** | acsUrl | [optional] [default to undefined]
10
+ **paReq** | **string** | paReq | [optional] [default to undefined]
11
+ **transactionId** | **string** | Transaction ID | [optional] [default to undefined]
12
+ **dsTranId** | **string** | dsTranId | [optional] [default to undefined]
13
+ **cReq** | **string** | cReq | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { OpayoRedirectDTO } from 'yellowgrid-api-ts';
19
+
20
+ const instance: OpayoRedirectDTO = {
21
+ acsUrl,
22
+ paReq,
23
+ transactionId,
24
+ dsTranId,
25
+ cReq,
26
+ };
27
+ ```
28
+
29
+ [[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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -683,9 +683,11 @@ const configuration = new Configuration();
683
683
  const apiInstance = new OrdersApi(configuration);
684
684
 
685
685
  let id: number; //Order ID (default to undefined)
686
+ let complete: boolean; //Complete Status (default to undefined)
686
687
 
687
688
  const { status, data } = await apiInstance.patchCompleteOrder(
688
- id
689
+ id,
690
+ complete
689
691
  );
690
692
  ```
691
693
 
@@ -694,6 +696,7 @@ const { status, data } = await apiInstance.patchCompleteOrder(
694
696
  |Name | Type | Description | Notes|
695
697
  |------------- | ------------- | ------------- | -------------|
696
698
  | **id** | [**number**] | Order ID | defaults to undefined|
699
+ | **complete** | [**boolean**] | Complete Status | defaults to undefined|
697
700
 
698
701
 
699
702
  ### Return type
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
17
17
  **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
18
18
  **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
19
19
  **aligned** | **boolean** | Aligned | [optional] [default to undefined]
20
- **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | Customer | [optional] [default to undefined]
20
+ **customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [optional] [default to undefined]
21
21
 
22
22
  ## Example
23
23
 
@@ -0,0 +1,20 @@
1
+ # PatchSetTcxWizardCnameRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **cname** | **string** | CNAME | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchSetTcxWizardCnameRequest = {
16
+ cname,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # PatchUpdateAccountNameRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | Company Name | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountNameRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountNameRequest = {
16
+ name,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # PostAddAdminNoteRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **note** | **string** | Note | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PostAddAdminNoteRequest = {
16
+ note,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # PostGetProductRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **quantity** | **number** | Quantity | [optional] [default to undefined]
9
+ **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
10
+ **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { PostGetProductRequest } from 'yellowgrid-api-ts';
16
+
17
+ const instance: PostGetProductRequest = {
18
+ quantity,
19
+ licenceKey,
20
+ hosting,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,6 +1,6 @@
1
1
  # PricingApi
2
2
 
3
- All URIs are relative to *https://bitbucket.org*
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -0,0 +1,41 @@
1
+ # ProductDetailedSummaryDTO
2
+
3
+ Product Detailed Summary
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **title** | **string** | Title | [optional] [default to undefined]
11
+ **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
+ **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
+ **price** | **number** | Price | [optional] [default to undefined]
14
+ **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
15
+ **rrp** | **number** | RRP Price | [optional] [default to undefined]
16
+ **licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | | [optional] [default to undefined]
17
+ **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
18
+ **dueDate** | **string** | Date Time | [optional] [default to undefined]
19
+ **onOrder** | **number** | On Order | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { ProductDetailedSummaryDTO } from 'yellowgrid-api-ts';
25
+
26
+ const instance: ProductDetailedSummaryDTO = {
27
+ sku,
28
+ title,
29
+ quantity,
30
+ stockProduct,
31
+ price,
32
+ cartonSize,
33
+ rrp,
34
+ licenceDetails,
35
+ hosting,
36
+ dueDate,
37
+ onOrder,
38
+ };
39
+ ```
40
+
41
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,37 @@
1
+ # ProductSearchDTO
2
+
3
+ Product Search
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **quantity** | **number** | Quantity | [optional] [default to undefined]
11
+ **licenceKey** | **string** | Licence Key | [optional] [default to undefined]
12
+ **hosting** | **boolean** | Hosting | [optional] [default to undefined]
13
+ **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
14
+ **renewalYears** | **number** | 3CX Renewal Years | [optional] [default to undefined]
15
+ **orderId** | **number** | Order ID | [optional] [default to undefined]
16
+ **items** | [**Array&lt;CustomerItemRequestDTO&gt;**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
17
+ **discount** | **number** | Discount | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { ProductSearchDTO } from 'yellowgrid-api-ts';
23
+
24
+ const instance: ProductSearchDTO = {
25
+ sku,
26
+ quantity,
27
+ licenceKey,
28
+ hosting,
29
+ tcxSalesCode,
30
+ renewalYears,
31
+ orderId,
32
+ items,
33
+ discount,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)