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

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 (98) hide show
  1. package/.openapi-generator/FILES +291 -269
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +53 -4
  4. package/api.ts +3229 -5350
  5. package/base.ts +2 -26
  6. package/common.ts +16 -39
  7. package/config.json +3 -3
  8. package/configuration.ts +27 -21
  9. package/dist/api.d.ts +1497 -4566
  10. package/dist/api.js +3165 -973
  11. package/dist/base.d.ts +1 -25
  12. package/dist/base.js +2 -21
  13. package/dist/common.d.ts +5 -36
  14. package/dist/common.js +17 -39
  15. package/dist/configuration.d.ts +25 -18
  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/HostingPriceListEnum.d.ts +28 -0
  20. package/dist/models/HostingPriceListEnum.js +30 -0
  21. package/dist/models/PaymentMethodEnum.d.ts +13 -0
  22. package/dist/models/PaymentMethodEnum.js +15 -0
  23. package/dist/models/UserGroupEnum.d.ts +28 -0
  24. package/dist/models/UserGroupEnum.js +30 -0
  25. package/docs/AbstractOrderRequestDTO.md +1 -1
  26. package/docs/AccountAddressesDTO.md +25 -0
  27. package/docs/AccountFinanceDTO.md +37 -0
  28. package/docs/AccountsApi.md +1380 -54
  29. package/docs/AddressDTO.md +31 -0
  30. package/docs/AdminOrderRequestDTO.md +3 -1
  31. package/docs/AdminUserModel.md +6 -0
  32. package/docs/BillingApi.md +55 -0
  33. package/docs/CRMApi.md +121 -1
  34. package/docs/Class3CXApi.md +49 -1
  35. package/docs/Class3CXInstallationWizardApi.md +1 -1
  36. package/docs/Class3CXInstallationsApi.md +56 -1
  37. package/docs/Class3CXIntegrationsApi.md +1 -1
  38. package/docs/Class3CXMultiTenantApi.md +1 -1
  39. package/docs/{PostAddAdminNoteRequest.md → CreateCrmNoteBody.md} +3 -3
  40. package/docs/CreditAccountEntity.md +4 -0
  41. package/docs/CrmActivitiesResponseDTO.md +23 -0
  42. package/docs/CrmActivityDTO.md +33 -0
  43. package/docs/CrmDateActivitiesDTO.md +23 -0
  44. package/docs/CrmNoteEntity.md +39 -0
  45. package/docs/CrmNoteModel.md +39 -0
  46. package/docs/CustomerOrderRequestDTO.md +1 -1
  47. package/docs/DetailedOrderRequestDTO.md +1 -1
  48. package/docs/MyPBXToolsApi.md +1 -1
  49. package/docs/NumberPortAdminNoteBody.md +20 -0
  50. package/docs/NumberPortingApi.md +6 -6
  51. package/docs/OAuth20Api.md +49 -1
  52. package/docs/OrdersApi.md +57 -57
  53. package/docs/PartnerDTO.md +39 -0
  54. package/docs/{PatchSetTcxWizardCnameRequest.md → PatchUpdateAccountCnameRequest.md} +3 -3
  55. package/docs/PatchUpdateAccountCompanyNumberRequest.md +20 -0
  56. package/docs/PatchUpdateAccountPhoneRequest.md +20 -0
  57. package/docs/PatchUpdateAccountVatNumberRequest.md +20 -0
  58. package/docs/PatchUpdateCreditLimitRequest.md +20 -0
  59. package/docs/PatchUpdatePriceListRequest.md +20 -0
  60. package/docs/PatchUpdateSipChannelCostRequest.md +20 -0
  61. package/docs/PatchUpdateTcxHostingPriceListRequest.md +20 -0
  62. package/docs/PatchUpdateTcxPartnerIdRequest.md +20 -0
  63. package/docs/PortalAccountModel.md +4 -2
  64. package/docs/PostSendWelcomeEmailRequest.md +20 -0
  65. package/docs/PricingApi.md +1 -1
  66. package/docs/ProductSummaryDTO.md +2 -2
  67. package/docs/ProductsApi.md +1 -1
  68. package/docs/ProspectDTO.md +4 -2
  69. package/docs/ProspectsApi.md +1 -1
  70. package/docs/ProvisioningApi.md +1 -1
  71. package/docs/RecordingBackupAzureModel.md +2 -0
  72. package/docs/RecordingsBackupInfoDTO.md +2 -2
  73. package/docs/SIPTrunksApi.md +1 -1
  74. package/docs/SMSApi.md +1 -1
  75. package/docs/ServicesApi.md +1 -1
  76. package/docs/ShipmentRequestDTO.md +2 -2
  77. package/docs/ShippingApi.md +1 -1
  78. package/docs/StockManagementApi.md +1 -1
  79. package/docs/SystemApi.md +1 -1
  80. package/docs/TableHistoryEntity.md +35 -0
  81. package/docs/TcxKeySummaryDTO.md +1 -1
  82. package/docs/TicketsApi.md +1 -1
  83. package/docs/WebhooksApi.md +1 -1
  84. package/getEnums.php +31 -31
  85. package/index.ts +1 -1
  86. package/models/HostingPriceListEnum.ts +29 -0
  87. package/models/PaymentMethodEnum.ts +14 -0
  88. package/models/UserGroupEnum.ts +29 -0
  89. package/openapitools.json +1 -1
  90. package/package.json +2 -2
  91. package/docs/NumberPortModel.md +0 -51
  92. package/docs/PostGetProductRequest.md +0 -24
  93. package/docs/TcxInstallationDetailsModel.md +0 -45
  94. package/docs/TelephonySupportTicketModel.md +0 -41
  95. package/hs_err_pid16044.log +0 -249
  96. package/hs_err_pid44560.log +0 -249
  97. package/hs_err_pid53988.log +0 -249
  98. package/hs_err_pid58728.log +0 -40
@@ -0,0 +1,20 @@
1
+ # NumberPortAdminNoteBody
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 { NumberPortAdminNoteBody } from 'yellowgrid-api-ts';
14
+
15
+ const instance: NumberPortAdminNoteBody = {
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)
@@ -1,6 +1,6 @@
1
1
  # NumberPortingApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -401,7 +401,7 @@ No authorization required
401
401
  [[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)
402
402
 
403
403
  # **postAddAdminNote**
404
- > AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
404
+ > AdminNumberPortDTO postAddAdminNote(numberPortAdminNoteBody)
405
405
 
406
406
 
407
407
  ### Example
@@ -410,18 +410,18 @@ No authorization required
410
410
  import {
411
411
  NumberPortingApi,
412
412
  Configuration,
413
- PostAddAdminNoteRequest
413
+ NumberPortAdminNoteBody
414
414
  } from 'yellowgrid-api-ts';
415
415
 
416
416
  const configuration = new Configuration();
417
417
  const apiInstance = new NumberPortingApi(configuration);
418
418
 
419
419
  let id: number; //Number Port ID (default to undefined)
420
- let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
420
+ let numberPortAdminNoteBody: NumberPortAdminNoteBody; //Number Port Note Request
421
421
 
422
422
  const { status, data } = await apiInstance.postAddAdminNote(
423
423
  id,
424
- postAddAdminNoteRequest
424
+ numberPortAdminNoteBody
425
425
  );
426
426
  ```
427
427
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
429
429
 
430
430
  |Name | Type | Description | Notes|
431
431
  |------------- | ------------- | ------------- | -------------|
432
- | **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
432
+ | **numberPortAdminNoteBody** | **NumberPortAdminNoteBody**| Number Port Note Request | |
433
433
  | **id** | [**number**] | Number Port ID | defaults to undefined|
434
434
 
435
435
 
@@ -1,6 +1,6 @@
1
1
  # OAuth20Api
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
9
9
  |[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
10
10
  |[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
11
11
  |[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
12
+ |[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
12
13
  |[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
13
14
 
14
15
  # **getGetMfaQrCode**
@@ -311,6 +312,53 @@ No authorization required
311
312
 
312
313
  [[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)
313
314
 
315
+ # **postLogout**
316
+ > postLogout()
317
+
318
+ Remove Oauth 2.0 Cookies
319
+
320
+ ### Example
321
+
322
+ ```typescript
323
+ import {
324
+ OAuth20Api,
325
+ Configuration
326
+ } from 'yellowgrid-api-ts';
327
+
328
+ const configuration = new Configuration();
329
+ const apiInstance = new OAuth20Api(configuration);
330
+
331
+ const { status, data } = await apiInstance.postLogout();
332
+ ```
333
+
334
+ ### Parameters
335
+ This endpoint does not have any parameters.
336
+
337
+
338
+ ### Return type
339
+
340
+ void (empty response body)
341
+
342
+ ### Authorization
343
+
344
+ No authorization required
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: Not defined
349
+ - **Accept**: Not defined
350
+
351
+
352
+ ### HTTP response details
353
+ | Status code | Description | Response headers |
354
+ |-------------|-------------|------------------|
355
+ |**200** | No Response | - |
356
+ |**400** | Bad Request | - |
357
+ |**401** | Unauthorised | - |
358
+ |**403** | Access Denied | - |
359
+
360
+ [[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)
361
+
314
362
  # **postPortalLogin**
315
363
  > AuthCodeResponseModel postPortalLogin()
316
364
 
package/docs/OrdersApi.md CHANGED
@@ -1,13 +1,12 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
8
8
  |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
9
9
  |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
10
- |[**getCreatePortalOrderLegacy**](#getcreateportalorderlegacy) | **GET** /orders/portal/legacy | Create an order via the legacy portal|
11
10
  |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
12
11
  |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
13
12
  |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
@@ -20,6 +19,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
20
19
  |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
21
20
  |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
22
21
  |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
22
+ |[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
23
23
  |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
24
24
  |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
25
25
  |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
@@ -207,61 +207,6 @@ No authorization required
207
207
 
208
208
  [[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)
209
209
 
210
- # **getCreatePortalOrderLegacy**
211
- > OrderResponseDTO getCreatePortalOrderLegacy()
212
-
213
- Create an order via the legacy portal
214
-
215
- ### Example
216
-
217
- ```typescript
218
- import {
219
- OrdersApi,
220
- Configuration,
221
- OrderDTO
222
- } from 'yellowgrid-api-ts';
223
-
224
- const configuration = new Configuration();
225
- const apiInstance = new OrdersApi(configuration);
226
-
227
- let orderDTO: OrderDTO; //Legacy Portal Order (optional)
228
-
229
- const { status, data } = await apiInstance.getCreatePortalOrderLegacy(
230
- orderDTO
231
- );
232
- ```
233
-
234
- ### Parameters
235
-
236
- |Name | Type | Description | Notes|
237
- |------------- | ------------- | ------------- | -------------|
238
- | **orderDTO** | **OrderDTO**| Legacy Portal Order | |
239
-
240
-
241
- ### Return type
242
-
243
- **OrderResponseDTO**
244
-
245
- ### Authorization
246
-
247
- No authorization required
248
-
249
- ### HTTP request headers
250
-
251
- - **Content-Type**: application/json
252
- - **Accept**: application/json
253
-
254
-
255
- ### HTTP response details
256
- | Status code | Description | Response headers |
257
- |-------------|-------------|------------------|
258
- |**200** | Legacy Portal Order Response | - |
259
- |**400** | Bad Request | - |
260
- |**401** | Unauthorised | - |
261
- |**403** | Access Denied | - |
262
-
263
- [[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)
264
-
265
210
  # **getGetAdminEditableOrder**
266
211
  > AdminOrderRequestDTO getGetAdminEditableOrder()
267
212
 
@@ -952,6 +897,61 @@ No authorization required
952
897
 
953
898
  [[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)
954
899
 
900
+ # **postCreatePortalOrderLegacy**
901
+ > OrderResponseDTO postCreatePortalOrderLegacy()
902
+
903
+ Create an order via the legacy portal
904
+
905
+ ### Example
906
+
907
+ ```typescript
908
+ import {
909
+ OrdersApi,
910
+ Configuration,
911
+ OrderDTO
912
+ } from 'yellowgrid-api-ts';
913
+
914
+ const configuration = new Configuration();
915
+ const apiInstance = new OrdersApi(configuration);
916
+
917
+ let orderDTO: OrderDTO; //Legacy Portal Order (optional)
918
+
919
+ const { status, data } = await apiInstance.postCreatePortalOrderLegacy(
920
+ orderDTO
921
+ );
922
+ ```
923
+
924
+ ### Parameters
925
+
926
+ |Name | Type | Description | Notes|
927
+ |------------- | ------------- | ------------- | -------------|
928
+ | **orderDTO** | **OrderDTO**| Legacy Portal Order | |
929
+
930
+
931
+ ### Return type
932
+
933
+ **OrderResponseDTO**
934
+
935
+ ### Authorization
936
+
937
+ No authorization required
938
+
939
+ ### HTTP request headers
940
+
941
+ - **Content-Type**: application/json
942
+ - **Accept**: application/json
943
+
944
+
945
+ ### HTTP response details
946
+ | Status code | Description | Response headers |
947
+ |-------------|-------------|------------------|
948
+ |**200** | Legacy Portal Order Response | - |
949
+ |**400** | Bad Request | - |
950
+ |**401** | Unauthorised | - |
951
+ |**403** | Access Denied | - |
952
+
953
+ [[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)
954
+
955
955
  # **postCreateShipment**
956
956
  > ShipmentDTO postCreateShipment()
957
957
 
@@ -0,0 +1,39 @@
1
+ # PartnerDTO
2
+
3
+ 3CX Partner Details
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
10
+ **companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
11
+ **contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
12
+ **contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
13
+ **contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
14
+ **partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
15
+ **licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
16
+ **hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
17
+ **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
18
+ **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { PartnerDTO } from 'yellowgrid-api-ts';
24
+
25
+ const instance: PartnerDTO = {
26
+ partnerId,
27
+ companyName,
28
+ contactName,
29
+ contactPhone,
30
+ contactEmail,
31
+ partnerLevel,
32
+ licenceDiscountPercent,
33
+ hostingDisountPercent,
34
+ hostingPriceListId,
35
+ installationUrl,
36
+ };
37
+ ```
38
+
39
+ [[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,4 +1,4 @@
1
- # PatchSetTcxWizardCnameRequest
1
+ # PatchUpdateAccountCnameRequest
2
2
 
3
3
 
4
4
  ## Properties
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
13
+ import { PatchUpdateAccountCnameRequest } from 'yellowgrid-api-ts';
14
14
 
15
- const instance: PatchSetTcxWizardCnameRequest = {
15
+ const instance: PatchUpdateAccountCnameRequest = {
16
16
  cname,
17
17
  };
18
18
  ```
@@ -0,0 +1,20 @@
1
+ # PatchUpdateAccountCompanyNumberRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **companyNumber** | **string** | Company Number | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountCompanyNumberRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountCompanyNumberRequest = {
16
+ companyNumber,
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
+ # PatchUpdateAccountPhoneRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **phone** | **string** | Phone | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountPhoneRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountPhoneRequest = {
16
+ phone,
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
+ # PatchUpdateAccountVatNumberRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **vatNumber** | **string** | VAT Number | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountVatNumberRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountVatNumberRequest = {
16
+ vatNumber,
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
+ # PatchUpdateCreditLimitRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateCreditLimitRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateCreditLimitRequest = {
16
+ creditLimit,
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
+ # PatchUpdatePriceListRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **priceList** | **string** | Price List | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdatePriceListRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdatePriceListRequest = {
16
+ priceList,
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
+ # PatchUpdateSipChannelCostRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **channelCost** | **number** | SIP Channel Cost | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateSipChannelCostRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateSipChannelCostRequest = {
16
+ channelCost,
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
+ # PatchUpdateTcxHostingPriceListRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **priceList** | **string** | Price List | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateTcxHostingPriceListRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateTcxHostingPriceListRequest = {
16
+ priceList,
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
+ # PatchUpdateTcxPartnerIdRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **partnerId** | **string** | Set Account 3CX Partner ID | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateTcxPartnerIdRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateTcxPartnerIdRequest = {
16
+ partnerId,
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)
@@ -27,9 +27,10 @@ Name | Type | Description | Notes
27
27
  **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
28
28
  **creationDate** | **string** | Creation Date | [optional] [default to undefined]
29
29
  **prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
30
+ **portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
31
+ **cname** | **string** | Wizard CNAME | [optional] [default to undefined]
30
32
  **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
31
33
  **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
32
- **cname** | **string** | Wizard CNAME | [optional] [default to undefined]
33
34
 
34
35
  ## Example
35
36
 
@@ -58,9 +59,10 @@ const instance: PortalAccountModel = {
58
59
  resellerId,
59
60
  creationDate,
60
61
  prizePromo,
62
+ portalAccess,
63
+ cname,
61
64
  directDebitMandate,
62
65
  navigation,
63
- cname,
64
66
  };
65
67
  ```
66
68
 
@@ -0,0 +1,20 @@
1
+ # PostSendWelcomeEmailRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **email** | **string** | email | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PostSendWelcomeEmailRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PostSendWelcomeEmailRequest = {
16
+ email,
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)
@@ -1,6 +1,6 @@
1
1
  # PricingApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -10,11 +10,11 @@ Name | Type | Description | Notes
10
10
  **title** | **string** | Title | [optional] [default to undefined]
11
11
  **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
- **dueDate** | **string** | Date Time | [optional] [default to undefined]
13
+ **dueDate** | **string** | Due Date | [optional] [default to undefined]
14
14
  **price** | **number** | Price | [optional] [default to undefined]
15
15
  **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
16
16
  **rrp** | **number** | RRP Price | [optional] [default to undefined]
17
- **licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | | [optional] [default to undefined]
17
+ **licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
18
18
  **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
19
19
 
20
20
  ## Example
@@ -1,6 +1,6 @@
1
1
  # ProductsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -8,11 +8,12 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **companyName** | **string** | Company Name | [optional] [default to undefined]
10
10
  **telephone** | **string** | Telephone | [optional] [default to undefined]
11
- **lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
12
- **callbackDate** | **string** | Date Time | [optional] [default to undefined]
11
+ **lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
12
+ **callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
13
13
  **xeroId** | **string** | Xero ID | [optional] [default to undefined]
14
14
  **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
15
15
  **status** | **string** | Status | [optional] [default to undefined]
16
+ **orderCount** | **number** | Order Count | [optional] [default to undefined]
16
17
 
17
18
  ## Example
18
19
 
@@ -27,6 +28,7 @@ const instance: ProspectDTO = {
27
28
  xeroId,
28
29
  removed,
29
30
  status,
31
+ orderCount,
30
32
  };
31
33
  ```
32
34
 
@@ -1,6 +1,6 @@
1
1
  # ProspectsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # ProvisioningApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **name** | **string** | Storage Account Name | [optional] [default to undefined]
10
10
  **key** | **string** | Storage Account Key | [optional] [default to undefined]
11
11
  **connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
12
+ **sasUrl** | **string** | SAS Url | [optional] [default to undefined]
12
13
  **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
13
14
 
14
15
  ## Example
@@ -20,6 +21,7 @@ const instance: RecordingBackupAzureModel = {
20
21
  name,
21
22
  key,
22
23
  connection_string,
24
+ sasUrl,
23
25
  recordings_path,
24
26
  };
25
27
  ```
@@ -6,8 +6,8 @@ Recordings Backup Info
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | | [optional] [default to undefined]
10
- **storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | | [optional] [default to undefined]
9
+ **backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
10
+ **storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -1,6 +1,6 @@
1
1
  # SIPTrunksApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|