yellowgrid-api-ts 3.2.244 → 3.2.246-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 (145) hide show
  1. package/.openapi-generator/FILES +369 -318
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +123 -3
  4. package/api.ts +14410 -953
  5. package/base.ts +26 -2
  6. package/common.ts +39 -16
  7. package/config.json +4 -3
  8. package/configuration.ts +21 -27
  9. package/dist/api.d.ts +15808 -5240
  10. package/dist/api.js +8872 -2842
  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/ConnectionTypeEnum.d.ts +73 -0
  20. package/dist/models/ConnectionTypeEnum.js +75 -0
  21. package/dist/models/GroupEnum.d.ts +43 -0
  22. package/dist/models/GroupEnum.js +45 -0
  23. package/dist/models/HostingPriceListEnum.d.ts +5 -0
  24. package/dist/models/HostingPriceListEnum.js +5 -0
  25. package/dist/models/ReportEnum.d.ts +15 -0
  26. package/dist/models/ReportEnum.js +15 -0
  27. package/docs/AbstractItemDiscountModel.md +21 -0
  28. package/docs/AbstractOrderRequestDTO.md +1 -1
  29. package/docs/AccountDetailedSummaryDTO.md +2 -0
  30. package/docs/AccountsApi.md +1 -1
  31. package/docs/AdminOrderRequestDTO.md +1 -1
  32. package/docs/BaseService.md +36 -0
  33. package/docs/BillingApi.md +3631 -26
  34. package/docs/Bundle.md +34 -0
  35. package/docs/BundleCustomer.md +34 -0
  36. package/docs/CRMApi.md +1 -1
  37. package/docs/CallTariff.md +34 -0
  38. package/docs/CallTariffPlan.md +36 -0
  39. package/docs/CallTariffResponse.md +26 -0
  40. package/docs/Cdr.md +112 -0
  41. package/docs/Class3CXApi.md +1 -1
  42. package/docs/Class3CXInstallationWizardApi.md +1 -1
  43. package/docs/Class3CXInstallationsApi.md +1 -1
  44. package/docs/Class3CXIntegrationsApi.md +1 -1
  45. package/docs/Class3CXMultiTenantApi.md +1 -1
  46. package/docs/ConnectionRequest.md +36 -0
  47. package/docs/ConnectionType.md +28 -0
  48. package/docs/ContactDetail.md +58 -0
  49. package/docs/CrmActivityDTO.md +1 -1
  50. package/docs/CrmDateActivitiesDTO.md +1 -1
  51. package/docs/Customer.md +98 -0
  52. package/docs/CustomerOrderRequestDTO.md +1 -1
  53. package/docs/CustomerRate.md +22 -0
  54. package/docs/CustomerRateType.md +12 -0
  55. package/docs/DetailedOrderRequestDTO.md +1 -1
  56. package/docs/GetDisconnectDDIRequest.md +20 -0
  57. package/docs/InboundCli.md +50 -0
  58. package/docs/InboundTariffPlan.md +32 -0
  59. package/docs/InboundTariffPlanResponse.md +28 -0
  60. package/docs/MiscApi.md +1 -1
  61. package/docs/MultiTenantSipTrunkRequest.md +22 -0
  62. package/docs/MyPBXToolsApi.md +1 -1
  63. package/docs/NumberPortModel.md +51 -0
  64. package/docs/NumberPortingApi.md +1 -1
  65. package/docs/OAuth20Api.md +1 -1
  66. package/docs/OrdersApi.md +1 -1
  67. package/docs/OutboundCli.md +70 -0
  68. package/docs/PartnerDTO.md +1 -1
  69. package/docs/PasswordSenderDTO.md +1 -1
  70. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  71. package/docs/PostAddAdminNoteRequest.md +20 -0
  72. package/docs/PostAddBroadbandRequest.md +28 -0
  73. package/docs/PostAddCallTariffToCallTariffPlanRequest.md +34 -0
  74. package/docs/PostAddEthernetRequest.md +28 -0
  75. package/docs/PostAddRecurringChargeRequest.md +30 -0
  76. package/docs/PostAddServiceToServicePlanRequest.md +30 -0
  77. package/docs/PostAddSipTrunkDDIsRequest.md +30 -0
  78. package/docs/PostDisconnectDDIRequest.md +20 -0
  79. package/docs/PostGetBaseServicesRequest.md +22 -0
  80. package/docs/PostGetPriceGroupsRequest.md +22 -0
  81. package/docs/PostGetProductRequest.md +24 -0
  82. package/docs/PostGetServicePlansRequest.md +22 -0
  83. package/docs/PostGetSipTrunksBillingRequest.md +34 -0
  84. package/docs/PostUpdateConnectionRequest.md +22 -0
  85. package/docs/PostUpdateRecurringChargeRequest.md +30 -0
  86. package/docs/PriceGroup.md +30 -0
  87. package/docs/PriceGroupResponse.md +24 -0
  88. package/docs/PricingApi.md +1 -1
  89. package/docs/ProcessedCdr.md +96 -0
  90. package/docs/ProductDetailedSummaryDTO.md +2 -2
  91. package/docs/ProductSearchDTO.md +37 -0
  92. package/docs/ProductSummaryDTO.md +1 -1
  93. package/docs/ProductsApi.md +1 -1
  94. package/docs/PromoCodesEntity.md +6 -6
  95. package/docs/PromoItemModel.md +35 -0
  96. package/docs/PromoModel.md +45 -0
  97. package/docs/PromoSummariesModel.md +27 -0
  98. package/docs/PromoSummaryDTO.md +29 -0
  99. package/docs/PromotionsApi.md +241 -0
  100. package/docs/ProspectDTO.md +2 -2
  101. package/docs/ProspectsApi.md +1 -1
  102. package/docs/ProvisioningApi.md +1 -1
  103. package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
  104. package/docs/PutAddServiceToServicePlanRequest.md +26 -0
  105. package/docs/PutConnectionSearchRequest.md +20 -0
  106. package/docs/PutGetBaseServicesRequest.md +28 -0
  107. package/docs/PutGetCallTariffPlanRequest.md +28 -0
  108. package/docs/PutGetPriceGroupsRequest.md +28 -0
  109. package/docs/RecordingsBackupInfoDTO.md +2 -2
  110. package/docs/RecurringCharge.md +48 -0
  111. package/docs/ReportRequestDTO.md +2 -2
  112. package/docs/ReportsApi.md +1 -1
  113. package/docs/SIPTrunksApi.md +1 -1
  114. package/docs/SMSApi.md +1 -1
  115. package/docs/Sdr.md +66 -0
  116. package/docs/SdrReferenceType.md +24 -0
  117. package/docs/Service.md +42 -0
  118. package/docs/ServicePlan.md +36 -0
  119. package/docs/ServicesApi.md +1 -1
  120. package/docs/ShipmentRequestDTO.md +2 -2
  121. package/docs/ShippingApi.md +1 -1
  122. package/docs/SpecialService.md +40 -0
  123. package/docs/StockManagementApi.md +1 -1
  124. package/docs/SuppliersApi.md +1 -1
  125. package/docs/SystemApi.md +1 -1
  126. package/docs/TariffRate.md +30 -0
  127. package/docs/TcxHostingPricingEntity.md +35 -0
  128. package/docs/TcxInstallationDetailsModel.md +45 -0
  129. package/docs/TcxKeySummaryDTO.md +1 -1
  130. package/docs/TelephonySupportTicketModel.md +41 -0
  131. package/docs/TicketsApi.md +1 -1
  132. package/docs/UnconnectedSdr.md +68 -0
  133. package/docs/WebhooksApi.md +1 -1
  134. package/getEnums.php +31 -31
  135. package/hs_err_pid16044.log +249 -0
  136. package/hs_err_pid44560.log +249 -0
  137. package/hs_err_pid53988.log +249 -0
  138. package/hs_err_pid58728.log +40 -0
  139. package/index.ts +1 -1
  140. package/models/ConnectionTypeEnum.ts +74 -0
  141. package/models/GroupEnum.ts +44 -0
  142. package/models/HostingPriceListEnum.ts +5 -0
  143. package/models/ReportEnum.ts +15 -0
  144. package/openapitools.json +1 -1
  145. package/package.json +2 -2
@@ -0,0 +1,43 @@
1
+ export declare const GroupEnum: {
2
+ readonly ACCOUNTS: {
3
+ readonly name: "ACCOUNTS";
4
+ readonly value: "Accounts";
5
+ readonly publicValue: "Accounts";
6
+ };
7
+ readonly ALL: {
8
+ readonly name: "ALL";
9
+ readonly value: "All";
10
+ readonly publicValue: "All";
11
+ };
12
+ readonly BOARD: {
13
+ readonly name: "BOARD";
14
+ readonly value: "Board";
15
+ readonly publicValue: "Board";
16
+ };
17
+ readonly DEVELOPMENT: {
18
+ readonly name: "DEVELOPMENT";
19
+ readonly value: "Development";
20
+ readonly publicValue: "Development";
21
+ };
22
+ readonly SALES_MARKETING: {
23
+ readonly name: "SALES_MARKETING";
24
+ readonly value: "SalesMarketing";
25
+ readonly publicValue: "SalesMarketing";
26
+ };
27
+ readonly TELEPHONY: {
28
+ readonly name: "TELEPHONY";
29
+ readonly value: "Telephony";
30
+ readonly publicValue: "Telephony";
31
+ };
32
+ readonly TELESALES: {
33
+ readonly name: "TELESALES";
34
+ readonly value: "Telesales";
35
+ readonly publicValue: "Telesales";
36
+ };
37
+ readonly TECH: {
38
+ readonly name: "TECH";
39
+ readonly value: "Tech";
40
+ readonly publicValue: "Tech";
41
+ };
42
+ };
43
+ export type GroupEnum = typeof GroupEnum;
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.GroupEnum = void 0;
4
+ exports.GroupEnum = {
5
+ "ACCOUNTS": {
6
+ "name": "ACCOUNTS",
7
+ "value": "Accounts",
8
+ "publicValue": "Accounts"
9
+ },
10
+ "ALL": {
11
+ "name": "ALL",
12
+ "value": "All",
13
+ "publicValue": "All"
14
+ },
15
+ "BOARD": {
16
+ "name": "BOARD",
17
+ "value": "Board",
18
+ "publicValue": "Board"
19
+ },
20
+ "DEVELOPMENT": {
21
+ "name": "DEVELOPMENT",
22
+ "value": "Development",
23
+ "publicValue": "Development"
24
+ },
25
+ "SALES_MARKETING": {
26
+ "name": "SALES_MARKETING",
27
+ "value": "SalesMarketing",
28
+ "publicValue": "SalesMarketing"
29
+ },
30
+ "TELEPHONY": {
31
+ "name": "TELEPHONY",
32
+ "value": "Telephony",
33
+ "publicValue": "Telephony"
34
+ },
35
+ "TELESALES": {
36
+ "name": "TELESALES",
37
+ "value": "Telesales",
38
+ "publicValue": "Telesales"
39
+ },
40
+ "TECH": {
41
+ "name": "TECH",
42
+ "value": "Tech",
43
+ "publicValue": "Tech"
44
+ }
45
+ };
@@ -29,5 +29,10 @@ export declare const HostingPriceListEnum: {
29
29
  readonly value: 6;
30
30
  readonly publicValue: "Hosting Only (Wholesale)";
31
31
  };
32
+ readonly HOSTING_ITSP: {
33
+ readonly name: "HOSTING_ITSP";
34
+ readonly value: 7;
35
+ readonly publicValue: "Hosting Only (ITSP)";
36
+ };
32
37
  };
33
38
  export type HostingPriceListEnum = typeof HostingPriceListEnum;
@@ -31,5 +31,10 @@ exports.HostingPriceListEnum = {
31
31
  "name": "HOSTING_WHOLESALE",
32
32
  "value": 6,
33
33
  "publicValue": "Hosting Only (Wholesale)"
34
+ },
35
+ "HOSTING_ITSP": {
36
+ "name": "HOSTING_ITSP",
37
+ "value": 7,
38
+ "publicValue": "Hosting Only (ITSP)"
34
39
  }
35
40
  };
@@ -49,5 +49,20 @@ export declare const ReportEnum: {
49
49
  readonly value: 10;
50
50
  readonly publicValue: "Tech Support Customers";
51
51
  };
52
+ readonly BILLING_BUNDLE_CALLS: {
53
+ readonly name: "BILLING_BUNDLE_CALLS";
54
+ readonly value: 11;
55
+ readonly publicValue: "Billing - Bundle Calls With Cost";
56
+ };
57
+ readonly BILLING_UNCONNECTED_CALLS: {
58
+ readonly name: "BILLING_UNCONNECTED_CALLS";
59
+ readonly value: 12;
60
+ readonly publicValue: "Billing - Unconnected Calls";
61
+ };
62
+ readonly BILLING_UNCONNECTED_SERVICES: {
63
+ readonly name: "BILLING_UNCONNECTED_SERVICES";
64
+ readonly value: 13;
65
+ readonly publicValue: "Billing - Unconnected Services";
66
+ };
52
67
  };
53
68
  export type ReportEnum = typeof ReportEnum;
@@ -51,5 +51,20 @@ exports.ReportEnum = {
51
51
  "name": "TECH_SUPPORT_CUSTOMERS",
52
52
  "value": 10,
53
53
  "publicValue": "Tech Support Customers"
54
+ },
55
+ "BILLING_BUNDLE_CALLS": {
56
+ "name": "BILLING_BUNDLE_CALLS",
57
+ "value": 11,
58
+ "publicValue": "Billing - Bundle Calls With Cost"
59
+ },
60
+ "BILLING_UNCONNECTED_CALLS": {
61
+ "name": "BILLING_UNCONNECTED_CALLS",
62
+ "value": 12,
63
+ "publicValue": "Billing - Unconnected Calls"
64
+ },
65
+ "BILLING_UNCONNECTED_SERVICES": {
66
+ "name": "BILLING_UNCONNECTED_SERVICES",
67
+ "value": 13,
68
+ "publicValue": "Billing - Unconnected Services"
54
69
  }
55
70
  };
@@ -0,0 +1,21 @@
1
+ # AbstractItemDiscountModel
2
+
3
+ Item Discount
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **description** | **string** | Description | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { AbstractItemDiscountModel } from 'yellowgrid-api-ts';
15
+
16
+ const instance: AbstractItemDiscountModel = {
17
+ description,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **items** | [**Array<CustomerItemRequestDTO>**](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
 
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
16
16
  **provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [optional] [default to undefined]
17
17
  **onHold** | **boolean** | On Hold | [optional] [default to undefined]
18
18
  **balance** | **number** | Balance (£) | [optional] [default to undefined]
19
+ **firstOrder** | **boolean** | First Order | [optional] [default to undefined]
19
20
 
20
21
  ## Example
21
22
 
@@ -33,6 +34,7 @@ const instance: AccountDetailedSummaryDTO = {
33
34
  provisioningUrls,
34
35
  onHold,
35
36
  balance,
37
+ firstOrder,
36
38
  };
37
39
  ```
38
40
 
@@ -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
  |------------- | ------------- | -------------|
@@ -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]
@@ -0,0 +1,36 @@
1
+ # BaseService
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdDate** | **string** | | [optional] [default to undefined]
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **serviceCode** | **string** | | [optional] [default to undefined]
11
+ **dataType** | **string** | | [default to undefined]
12
+ **originalDescription** | **string** | | [default to undefined]
13
+ **cost** | **number** | | [optional] [default to undefined]
14
+ **startDate** | **string** | | [optional] [default to undefined]
15
+ **endDate** | **string** | | [optional] [default to undefined]
16
+ **filePeriod** | **string** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { BaseService } from 'yellowgrid-api-ts';
22
+
23
+ const instance: BaseService = {
24
+ createdDate,
25
+ id,
26
+ serviceCode,
27
+ dataType,
28
+ originalDescription,
29
+ cost,
30
+ startDate,
31
+ endDate,
32
+ filePeriod,
33
+ };
34
+ ```
35
+
36
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)