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
@@ -1,16 +1,3335 @@
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
  |------------- | ------------- | -------------|
7
+ |[**deleteAddCallTariffToCallTariffPlan**](#deleteaddcalltarifftocalltariffplan) | **DELETE** /billing/admin/callTariffPlan/callTariff | |
8
+ |[**deleteAddRecurringCharge**](#deleteaddrecurringcharge) | **DELETE** /billing/customer/recurringCharges | |
9
+ |[**deleteAddServiceToServicePlan**](#deleteaddservicetoserviceplan) | **DELETE** /billing/admin/servicePlan/service | |
10
+ |[**deleteCloseAccount**](#deletecloseaccount) | **DELETE** /billing/customer/customer | |
11
+ |[**deleteDeleteCallTariffId**](#deletedeletecalltariffid) | **DELETE** /billing/admin/callTariffPlan/callTariff/{id} | |
12
+ |[**deleteGetBaseServices**](#deletegetbaseservices) | **DELETE** /billing/admin/baseServices | |
13
+ |[**deleteGetCallTariffPlan**](#deletegetcalltariffplan) | **DELETE** /billing/admin/callTariffPlan | |
14
+ |[**deleteGetPriceGroups**](#deletegetpricegroups) | **DELETE** /billing/admin/priceGroups | |
15
+ |[**deleteGetServicePlan**](#deletegetserviceplan) | **DELETE** /billing/admin/servicePlan | |
16
+ |[**getAddRecurringCharge**](#getaddrecurringcharge) | **GET** /billing/customer/recurringCharges | |
17
+ |[**getAddServiceToServicePlan**](#getaddservicetoserviceplan) | **GET** /billing/admin/servicePlan/service | |
18
+ |[**getAddSipTrunkDDIs**](#getaddsiptrunkddis) | **GET** /billing/customer/sipTrunkDDIs | |
19
+ |[**getConnectionSearch**](#getconnectionsearch) | **GET** /billing/admin/connections | |
7
20
  |[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
8
- |[**putTransferConnection**](#puttransferconnection) | **PUT** /billing/admin/connections | |
21
+ |[**getGetAllMtSipTrunks**](#getgetallmtsiptrunks) | **GET** /billing/customer/list/allMtSipTrunks | |
22
+ |[**getGetAllSipTrunks**](#getgetallsiptrunks) | **GET** /billing/customer/list/allSipTrunks | |
23
+ |[**getGetBaseServices**](#getgetbaseservices) | **GET** /billing/admin/baseServices | |
24
+ |[**getGetBillingCustomerDetails**](#getgetbillingcustomerdetails) | **GET** /billing/customer/details | |
25
+ |[**getGetBundleCallsWithCost**](#getgetbundlecallswithcost) | **GET** /billing/admin/bundleCallsWithCost | |
26
+ |[**getGetCallTariffPlan**](#getgetcalltariffplan) | **GET** /billing/admin/callTariffPlan | |
27
+ |[**getGetCallTariffs**](#getgetcalltariffs) | **GET** /billing/admin/callTariffs | |
28
+ |[**getGetCallTariffsDetails**](#getgetcalltariffsdetails) | **GET** /billing/admin/callTariffs/details | |
29
+ |[**getGetChildren**](#getgetchildren) | **GET** /billing/customer/children | |
30
+ |[**getGetConnection**](#getgetconnection) | **GET** /billing/customer/connections/{id} | |
31
+ |[**getGetConnections**](#getgetconnections) | **GET** /billing/customer/connections | |
32
+ |[**getGetCustomer**](#getgetcustomer) | **GET** /billing/admin/customer | |
33
+ |[**getGetInboundTariffs**](#getgetinboundtariffs) | **GET** /billing/admin/inboundTariffs | |
34
+ |[**getGetInboundTariffsDetails**](#getgetinboundtariffsdetails) | **GET** /billing/admin/inboundTariffs/details | |
35
+ |[**getGetPriceGroups**](#getgetpricegroups) | **GET** /billing/admin/priceGroups | |
36
+ |[**getGetServicePlan**](#getgetserviceplan) | **GET** /billing/admin/servicePlan | |
37
+ |[**getGetServicePlans**](#getgetserviceplans) | **GET** /billing/admin/servicePlans | |
38
+ |[**getGetServicesPlanDetails**](#getgetservicesplandetails) | **GET** /billing/admin/servicePlans/details | |
39
+ |[**getGetSipTrunkList**](#getgetsiptrunklist) | **GET** /billing/customer/list/sipTrunks | |
40
+ |[**getGetSipTrunksBilling**](#getgetsiptrunksbilling) | **GET** /billing/customer/sipTrunks | |
41
+ |[**getGetUnconnectedCalls**](#getgetunconnectedcalls) | **GET** /billing/admin/unconnectedCalls | |
42
+ |[**getGetUnconnectedServices**](#getgetunconnectedservices) | **GET** /billing/admin/unconnectedServices | |
43
+ |[**getIsBundleCustomer**](#getisbundlecustomer) | **GET** /billing/customer/bundleCustomer | |
44
+ |[**postAddBroadband**](#postaddbroadband) | **POST** /billing/customer/broadband | |
45
+ |[**postAddCallTariffToCallTariffPlan**](#postaddcalltarifftocalltariffplan) | **POST** /billing/admin/callTariffPlan/callTariff | |
46
+ |[**postAddChildCustomer**](#postaddchildcustomer) | **POST** /billing/customer/child | |
47
+ |[**postAddEthernet**](#postaddethernet) | **POST** /billing/customer/ethernet | |
48
+ |[**postAddRecurringCharge**](#postaddrecurringcharge) | **POST** /billing/customer/recurringCharges | |
49
+ |[**postAddServiceToServicePlan**](#postaddservicetoserviceplan) | **POST** /billing/admin/servicePlan/service | |
50
+ |[**postAddSipTrunkDDIs**](#postaddsiptrunkddis) | **POST** /billing/customer/sipTrunkDDIs | |
51
+ |[**postDisconnectConnection**](#postdisconnectconnection) | **POST** /billing/customer/disconnectConnection | |
52
+ |[**postDisconnectDDI**](#postdisconnectddi) | **POST** /billing/customer/disconnectDDI | |
53
+ |[**postGetBaseServices**](#postgetbaseservices) | **POST** /billing/admin/baseServices | |
54
+ |[**postGetCallTariffPlan**](#postgetcalltariffplan) | **POST** /billing/admin/callTariffPlan | |
55
+ |[**postGetConnections**](#postgetconnections) | **POST** /billing/customer/connections | |
56
+ |[**postGetPriceGroups**](#postgetpricegroups) | **POST** /billing/admin/priceGroups | |
57
+ |[**postGetServicePlans**](#postgetserviceplans) | **POST** /billing/admin/servicePlans | |
58
+ |[**postGetSipTrunksBilling**](#postgetsiptrunksbilling) | **POST** /billing/customer/sipTrunks | |
59
+ |[**postSendInvoices**](#postsendinvoices) | **POST** /billing/admin/sendInvoices | |
60
+ |[**postUpdateConnection**](#postupdateconnection) | **POST** /billing/customer/updateConnection | |
61
+ |[**postUpdateRecurringCharge**](#postupdaterecurringcharge) | **POST** /billing/customer/updateRecurringCharges | |
62
+ |[**putAddCallTariffToCallTariffPlan**](#putaddcalltarifftocalltariffplan) | **PUT** /billing/admin/callTariffPlan/callTariff | |
63
+ |[**putAddServiceToServicePlan**](#putaddservicetoserviceplan) | **PUT** /billing/admin/servicePlan/service | |
64
+ |[**putConnectionSearch**](#putconnectionsearch) | **PUT** /billing/admin/connections | |
65
+ |[**putConvertChildToParent**](#putconvertchildtoparent) | **PUT** /billing/customer/makeParent | |
66
+ |[**putDisableBundles**](#putdisablebundles) | **PUT** /billing/customer/disableBundles | |
67
+ |[**putDisableDdiBilling**](#putdisableddibilling) | **PUT** /billing/customer/disableDdiBilling | |
68
+ |[**putEnableBundles**](#putenablebundles) | **PUT** /billing/customer/enableBundles | |
69
+ |[**putEnableDdiBilling**](#putenableddibilling) | **PUT** /billing/customer/enableDdiBilling | |
70
+ |[**putGetBaseServices**](#putgetbaseservices) | **PUT** /billing/admin/baseServices | |
71
+ |[**putGetCallTariffPlan**](#putgetcalltariffplan) | **PUT** /billing/admin/callTariffPlan | |
72
+ |[**putGetConnections**](#putgetconnections) | **PUT** /billing/customer/connections | |
73
+ |[**putGetPriceGroups**](#putgetpricegroups) | **PUT** /billing/admin/priceGroups | |
74
+
75
+ # **deleteAddCallTariffToCallTariffPlan**
76
+ > boolean deleteAddCallTariffToCallTariffPlan()
77
+
78
+ Delete Call Tariff
79
+
80
+ ### Example
81
+
82
+ ```typescript
83
+ import {
84
+ BillingApi,
85
+ Configuration
86
+ } from 'yellowgrid-api-ts';
87
+
88
+ const configuration = new Configuration();
89
+ const apiInstance = new BillingApi(configuration);
90
+
91
+ let priceGroupName: string; //Price Group Name (default to undefined)
92
+
93
+ const { status, data } = await apiInstance.deleteAddCallTariffToCallTariffPlan(
94
+ priceGroupName
95
+ );
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ |Name | Type | Description | Notes|
101
+ |------------- | ------------- | ------------- | -------------|
102
+ | **priceGroupName** | [**string**] | Price Group Name | defaults to undefined|
103
+
104
+
105
+ ### Return type
106
+
107
+ **boolean**
108
+
109
+ ### Authorization
110
+
111
+ No authorization required
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: application/json
117
+
118
+
119
+ ### HTTP response details
120
+ | Status code | Description | Response headers |
121
+ |-------------|-------------|------------------|
122
+ |**200** | Successful | - |
123
+ |**400** | Bad Request | - |
124
+ |**401** | Unauthorised | - |
125
+ |**403** | Access Denied | - |
126
+
127
+ [[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)
128
+
129
+ # **deleteAddRecurringCharge**
130
+ > number deleteAddRecurringCharge()
131
+
132
+ Delete Recurring Charges
133
+
134
+ ### Example
135
+
136
+ ```typescript
137
+ import {
138
+ BillingApi,
139
+ Configuration
140
+ } from 'yellowgrid-api-ts';
141
+
142
+ const configuration = new Configuration();
143
+ const apiInstance = new BillingApi(configuration);
144
+
145
+ let id: number; //Recurring Charge ID (default to undefined)
146
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
147
+
148
+ const { status, data } = await apiInstance.deleteAddRecurringCharge(
149
+ id,
150
+ billCustomerId
151
+ );
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ |Name | Type | Description | Notes|
157
+ |------------- | ------------- | ------------- | -------------|
158
+ | **id** | [**number**] | Recurring Charge ID | defaults to undefined|
159
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
160
+
161
+
162
+ ### Return type
163
+
164
+ **number**
165
+
166
+ ### Authorization
167
+
168
+ No authorization required
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: Not defined
173
+ - **Accept**: application/json
174
+
175
+
176
+ ### HTTP response details
177
+ | Status code | Description | Response headers |
178
+ |-------------|-------------|------------------|
179
+ |**200** | Recurring Charge ID | - |
180
+ |**400** | Bad Request | - |
181
+ |**401** | Unauthorised | - |
182
+ |**403** | Access Denied | - |
183
+
184
+ [[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)
185
+
186
+ # **deleteAddServiceToServicePlan**
187
+ > boolean deleteAddServiceToServicePlan()
188
+
189
+ Delete Service
190
+
191
+ ### Example
192
+
193
+ ```typescript
194
+ import {
195
+ BillingApi,
196
+ Configuration
197
+ } from 'yellowgrid-api-ts';
198
+
199
+ const configuration = new Configuration();
200
+ const apiInstance = new BillingApi(configuration);
201
+
202
+ let planGroup: string; //Plan Group (default to undefined)
203
+ let serviceCode: string; //Service Code (default to undefined)
204
+
205
+ const { status, data } = await apiInstance.deleteAddServiceToServicePlan(
206
+ planGroup,
207
+ serviceCode
208
+ );
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ |Name | Type | Description | Notes|
214
+ |------------- | ------------- | ------------- | -------------|
215
+ | **planGroup** | [**string**] | Plan Group | defaults to undefined|
216
+ | **serviceCode** | [**string**] | Service Code | defaults to undefined|
217
+
218
+
219
+ ### Return type
220
+
221
+ **boolean**
222
+
223
+ ### Authorization
224
+
225
+ No authorization required
226
+
227
+ ### HTTP request headers
228
+
229
+ - **Content-Type**: Not defined
230
+ - **Accept**: application/json
231
+
232
+
233
+ ### HTTP response details
234
+ | Status code | Description | Response headers |
235
+ |-------------|-------------|------------------|
236
+ |**200** | Successful | - |
237
+ |**400** | Bad Request | - |
238
+ |**401** | Unauthorised | - |
239
+ |**403** | Access Denied | - |
240
+
241
+ [[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)
242
+
243
+ # **deleteCloseAccount**
244
+ > number deleteCloseAccount()
245
+
246
+ Delete Customer
247
+
248
+ ### Example
249
+
250
+ ```typescript
251
+ import {
252
+ BillingApi,
253
+ Configuration
254
+ } from 'yellowgrid-api-ts';
255
+
256
+ const configuration = new Configuration();
257
+ const apiInstance = new BillingApi(configuration);
258
+
259
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
260
+
261
+ const { status, data } = await apiInstance.deleteCloseAccount(
262
+ billCustomerId
263
+ );
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+ |Name | Type | Description | Notes|
269
+ |------------- | ------------- | ------------- | -------------|
270
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
271
+
272
+
273
+ ### Return type
274
+
275
+ **number**
276
+
277
+ ### Authorization
278
+
279
+ No authorization required
280
+
281
+ ### HTTP request headers
282
+
283
+ - **Content-Type**: Not defined
284
+ - **Accept**: application/json
285
+
286
+
287
+ ### HTTP response details
288
+ | Status code | Description | Response headers |
289
+ |-------------|-------------|------------------|
290
+ |**200** | Customer ID | - |
291
+ |**400** | Bad Request | - |
292
+ |**401** | Unauthorised | - |
293
+ |**403** | Access Denied | - |
294
+
295
+ [[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)
296
+
297
+ # **deleteDeleteCallTariffId**
298
+ > boolean deleteDeleteCallTariffId()
299
+
300
+ Delete Call Tariff By ID
301
+
302
+ ### Example
303
+
304
+ ```typescript
305
+ import {
306
+ BillingApi,
307
+ Configuration
308
+ } from 'yellowgrid-api-ts';
309
+
310
+ const configuration = new Configuration();
311
+ const apiInstance = new BillingApi(configuration);
312
+
313
+ let id: number; //Call Tariff ID (default to undefined)
314
+
315
+ const { status, data } = await apiInstance.deleteDeleteCallTariffId(
316
+ id
317
+ );
318
+ ```
319
+
320
+ ### Parameters
321
+
322
+ |Name | Type | Description | Notes|
323
+ |------------- | ------------- | ------------- | -------------|
324
+ | **id** | [**number**] | Call Tariff ID | defaults to undefined|
325
+
326
+
327
+ ### Return type
328
+
329
+ **boolean**
330
+
331
+ ### Authorization
332
+
333
+ No authorization required
334
+
335
+ ### HTTP request headers
336
+
337
+ - **Content-Type**: Not defined
338
+ - **Accept**: application/json
339
+
340
+
341
+ ### HTTP response details
342
+ | Status code | Description | Response headers |
343
+ |-------------|-------------|------------------|
344
+ |**200** | Successful | - |
345
+ |**400** | Bad Request | - |
346
+ |**401** | Unauthorised | - |
347
+ |**403** | Access Denied | - |
348
+
349
+ [[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)
350
+
351
+ # **deleteGetBaseServices**
352
+ > boolean deleteGetBaseServices()
353
+
354
+ Delete Base Service
355
+
356
+ ### Example
357
+
358
+ ```typescript
359
+ import {
360
+ BillingApi,
361
+ Configuration
362
+ } from 'yellowgrid-api-ts';
363
+
364
+ const configuration = new Configuration();
365
+ const apiInstance = new BillingApi(configuration);
366
+
367
+ let baseServiceId: number; //Base Service Plan ID (default to undefined)
368
+
369
+ const { status, data } = await apiInstance.deleteGetBaseServices(
370
+ baseServiceId
371
+ );
372
+ ```
373
+
374
+ ### Parameters
375
+
376
+ |Name | Type | Description | Notes|
377
+ |------------- | ------------- | ------------- | -------------|
378
+ | **baseServiceId** | [**number**] | Base Service Plan ID | defaults to undefined|
379
+
380
+
381
+ ### Return type
382
+
383
+ **boolean**
384
+
385
+ ### Authorization
386
+
387
+ No authorization required
388
+
389
+ ### HTTP request headers
390
+
391
+ - **Content-Type**: Not defined
392
+ - **Accept**: application/json
393
+
394
+
395
+ ### HTTP response details
396
+ | Status code | Description | Response headers |
397
+ |-------------|-------------|------------------|
398
+ |**200** | Successful | - |
399
+ |**400** | Bad Request | - |
400
+ |**401** | Unauthorised | - |
401
+ |**403** | Access Denied | - |
402
+
403
+ [[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)
404
+
405
+ # **deleteGetCallTariffPlan**
406
+ > boolean deleteGetCallTariffPlan()
407
+
408
+ Delete Call Tariff Plan
409
+
410
+ ### Example
411
+
412
+ ```typescript
413
+ import {
414
+ BillingApi,
415
+ Configuration
416
+ } from 'yellowgrid-api-ts';
417
+
418
+ const configuration = new Configuration();
419
+ const apiInstance = new BillingApi(configuration);
420
+
421
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
422
+
423
+ const { status, data } = await apiInstance.deleteGetCallTariffPlan(
424
+ callTariffPlanId
425
+ );
426
+ ```
427
+
428
+ ### Parameters
429
+
430
+ |Name | Type | Description | Notes|
431
+ |------------- | ------------- | ------------- | -------------|
432
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
433
+
434
+
435
+ ### Return type
436
+
437
+ **boolean**
438
+
439
+ ### Authorization
440
+
441
+ No authorization required
442
+
443
+ ### HTTP request headers
444
+
445
+ - **Content-Type**: Not defined
446
+ - **Accept**: application/json
447
+
448
+
449
+ ### HTTP response details
450
+ | Status code | Description | Response headers |
451
+ |-------------|-------------|------------------|
452
+ |**200** | Successful | - |
453
+ |**400** | Bad Request | - |
454
+ |**401** | Unauthorised | - |
455
+ |**403** | Access Denied | - |
456
+
457
+ [[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)
458
+
459
+ # **deleteGetPriceGroups**
460
+ > boolean deleteGetPriceGroups()
461
+
462
+ Delete Price Group
463
+
464
+ ### Example
465
+
466
+ ```typescript
467
+ import {
468
+ BillingApi,
469
+ Configuration
470
+ } from 'yellowgrid-api-ts';
471
+
472
+ const configuration = new Configuration();
473
+ const apiInstance = new BillingApi(configuration);
474
+
475
+ let priceGroupId: number; //Price Group ID (default to undefined)
476
+
477
+ const { status, data } = await apiInstance.deleteGetPriceGroups(
478
+ priceGroupId
479
+ );
480
+ ```
481
+
482
+ ### Parameters
483
+
484
+ |Name | Type | Description | Notes|
485
+ |------------- | ------------- | ------------- | -------------|
486
+ | **priceGroupId** | [**number**] | Price Group ID | defaults to undefined|
487
+
488
+
489
+ ### Return type
490
+
491
+ **boolean**
492
+
493
+ ### Authorization
494
+
495
+ No authorization required
496
+
497
+ ### HTTP request headers
498
+
499
+ - **Content-Type**: Not defined
500
+ - **Accept**: application/json
501
+
502
+
503
+ ### HTTP response details
504
+ | Status code | Description | Response headers |
505
+ |-------------|-------------|------------------|
506
+ |**200** | Successful | - |
507
+ |**400** | Bad Request | - |
508
+ |**401** | Unauthorised | - |
509
+ |**403** | Access Denied | - |
510
+
511
+ [[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)
512
+
513
+ # **deleteGetServicePlan**
514
+ > number deleteGetServicePlan()
515
+
516
+ Delete Service Plan
517
+
518
+ ### Example
519
+
520
+ ```typescript
521
+ import {
522
+ BillingApi,
523
+ Configuration
524
+ } from 'yellowgrid-api-ts';
525
+
526
+ const configuration = new Configuration();
527
+ const apiInstance = new BillingApi(configuration);
528
+
529
+ let servicePlanId: number; //Service Plan ID (default to undefined)
530
+
531
+ const { status, data } = await apiInstance.deleteGetServicePlan(
532
+ servicePlanId
533
+ );
534
+ ```
535
+
536
+ ### Parameters
537
+
538
+ |Name | Type | Description | Notes|
539
+ |------------- | ------------- | ------------- | -------------|
540
+ | **servicePlanId** | [**number**] | Service Plan ID | defaults to undefined|
541
+
542
+
543
+ ### Return type
544
+
545
+ **number**
546
+
547
+ ### Authorization
548
+
549
+ No authorization required
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: Not defined
554
+ - **Accept**: application/json
555
+
556
+
557
+ ### HTTP response details
558
+ | Status code | Description | Response headers |
559
+ |-------------|-------------|------------------|
560
+ |**200** | Service Plan ID | - |
561
+ |**400** | Bad Request | - |
562
+ |**401** | Unauthorised | - |
563
+ |**403** | Access Denied | - |
564
+
565
+ [[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)
566
+
567
+ # **getAddRecurringCharge**
568
+ > Array<RecurringCharge> getAddRecurringCharge()
569
+
570
+ Get Recurring Charges
571
+
572
+ ### Example
573
+
574
+ ```typescript
575
+ import {
576
+ BillingApi,
577
+ Configuration
578
+ } from 'yellowgrid-api-ts';
579
+
580
+ const configuration = new Configuration();
581
+ const apiInstance = new BillingApi(configuration);
582
+
583
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
584
+
585
+ const { status, data } = await apiInstance.getAddRecurringCharge(
586
+ billCustomerId
587
+ );
588
+ ```
589
+
590
+ ### Parameters
591
+
592
+ |Name | Type | Description | Notes|
593
+ |------------- | ------------- | ------------- | -------------|
594
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
595
+
596
+
597
+ ### Return type
598
+
599
+ **Array<RecurringCharge>**
600
+
601
+ ### Authorization
602
+
603
+ No authorization required
604
+
605
+ ### HTTP request headers
606
+
607
+ - **Content-Type**: Not defined
608
+ - **Accept**: application/json
609
+
610
+
611
+ ### HTTP response details
612
+ | Status code | Description | Response headers |
613
+ |-------------|-------------|------------------|
614
+ |**200** | Recurring Charge | - |
615
+ |**400** | Bad Request | - |
616
+ |**401** | Unauthorised | - |
617
+ |**403** | Access Denied | - |
618
+
619
+ [[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)
620
+
621
+ # **getAddServiceToServicePlan**
622
+ > Service getAddServiceToServicePlan()
623
+
624
+ Get Service
625
+
626
+ ### Example
627
+
628
+ ```typescript
629
+ import {
630
+ BillingApi,
631
+ Configuration
632
+ } from 'yellowgrid-api-ts';
633
+
634
+ const configuration = new Configuration();
635
+ const apiInstance = new BillingApi(configuration);
636
+
637
+ let id: number; //Service ID (default to undefined)
638
+
639
+ const { status, data } = await apiInstance.getAddServiceToServicePlan(
640
+ id
641
+ );
642
+ ```
643
+
644
+ ### Parameters
645
+
646
+ |Name | Type | Description | Notes|
647
+ |------------- | ------------- | ------------- | -------------|
648
+ | **id** | [**number**] | Service ID | defaults to undefined|
649
+
650
+
651
+ ### Return type
652
+
653
+ **Service**
654
+
655
+ ### Authorization
656
+
657
+ No authorization required
658
+
659
+ ### HTTP request headers
660
+
661
+ - **Content-Type**: Not defined
662
+ - **Accept**: application/json
663
+
664
+
665
+ ### HTTP response details
666
+ | Status code | Description | Response headers |
667
+ |-------------|-------------|------------------|
668
+ |**200** | Service | - |
669
+ |**400** | Bad Request | - |
670
+ |**401** | Unauthorised | - |
671
+ |**403** | Access Denied | - |
672
+
673
+ [[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)
674
+
675
+ # **getAddSipTrunkDDIs**
676
+ > Array<OutboundCli> getAddSipTrunkDDIs()
677
+
678
+ Get SIP Trunk DDIs
679
+
680
+ ### Example
681
+
682
+ ```typescript
683
+ import {
684
+ BillingApi,
685
+ Configuration
686
+ } from 'yellowgrid-api-ts';
687
+
688
+ const configuration = new Configuration();
689
+ const apiInstance = new BillingApi(configuration);
690
+
691
+ let connectionId: number; //Connection ID (optional) (default to undefined)
692
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
693
+
694
+ const { status, data } = await apiInstance.getAddSipTrunkDDIs(
695
+ connectionId,
696
+ billCustomerId
697
+ );
698
+ ```
699
+
700
+ ### Parameters
701
+
702
+ |Name | Type | Description | Notes|
703
+ |------------- | ------------- | ------------- | -------------|
704
+ | **connectionId** | [**number**] | Connection ID | (optional) defaults to undefined|
705
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
706
+
707
+
708
+ ### Return type
709
+
710
+ **Array<OutboundCli>**
711
+
712
+ ### Authorization
713
+
714
+ No authorization required
715
+
716
+ ### HTTP request headers
717
+
718
+ - **Content-Type**: Not defined
719
+ - **Accept**: application/json
720
+
721
+
722
+ ### HTTP response details
723
+ | Status code | Description | Response headers |
724
+ |-------------|-------------|------------------|
725
+ |**200** | Connection | - |
726
+ |**400** | Bad Request | - |
727
+ |**401** | Unauthorised | - |
728
+ |**403** | Access Denied | - |
729
+
730
+ [[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)
731
+
732
+ # **getConnectionSearch**
733
+ > Array<OutboundCli> getConnectionSearch()
734
+
735
+ Connection Search
736
+
737
+ ### Example
738
+
739
+ ```typescript
740
+ import {
741
+ BillingApi,
742
+ Configuration
743
+ } from 'yellowgrid-api-ts';
744
+
745
+ const configuration = new Configuration();
746
+ const apiInstance = new BillingApi(configuration);
747
+
748
+ let search: string; //Search (default to undefined)
749
+
750
+ const { status, data } = await apiInstance.getConnectionSearch(
751
+ search
752
+ );
753
+ ```
754
+
755
+ ### Parameters
756
+
757
+ |Name | Type | Description | Notes|
758
+ |------------- | ------------- | ------------- | -------------|
759
+ | **search** | [**string**] | Search | defaults to undefined|
760
+
761
+
762
+ ### Return type
763
+
764
+ **Array<OutboundCli>**
765
+
766
+ ### Authorization
767
+
768
+ No authorization required
769
+
770
+ ### HTTP request headers
771
+
772
+ - **Content-Type**: Not defined
773
+ - **Accept**: application/json
774
+
775
+
776
+ ### HTTP response details
777
+ | Status code | Description | Response headers |
778
+ |-------------|-------------|------------------|
779
+ |**200** | Connection | - |
780
+ |**400** | Bad Request | - |
781
+ |**401** | Unauthorised | - |
782
+ |**403** | Access Denied | - |
783
+
784
+ [[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)
9
785
 
10
786
  # **getGetAllCustomer**
11
787
  > { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
12
788
 
13
- Get Billing Customers
789
+ Get Billing Customers
790
+
791
+ ### Example
792
+
793
+ ```typescript
794
+ import {
795
+ BillingApi,
796
+ Configuration
797
+ } from 'yellowgrid-api-ts';
798
+
799
+ const configuration = new Configuration();
800
+ const apiInstance = new BillingApi(configuration);
801
+
802
+ const { status, data } = await apiInstance.getGetAllCustomer();
803
+ ```
804
+
805
+ ### Parameters
806
+ This endpoint does not have any parameters.
807
+
808
+
809
+ ### Return type
810
+
811
+ **{ [key: string]: { [key: string]: string; }; }**
812
+
813
+ ### Authorization
814
+
815
+ No authorization required
816
+
817
+ ### HTTP request headers
818
+
819
+ - **Content-Type**: Not defined
820
+ - **Accept**: application/json
821
+
822
+
823
+ ### HTTP response details
824
+ | Status code | Description | Response headers |
825
+ |-------------|-------------|------------------|
826
+ |**200** | Billing Customer List | - |
827
+ |**400** | Bad Request | - |
828
+ |**401** | Unauthorised | - |
829
+ |**403** | Access Denied | - |
830
+
831
+ [[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)
832
+
833
+ # **getGetAllMtSipTrunks**
834
+ > Array<Array<string>> getGetAllMtSipTrunks()
835
+
836
+ Get All MT SIP Trunks
837
+
838
+ ### Example
839
+
840
+ ```typescript
841
+ import {
842
+ BillingApi,
843
+ Configuration
844
+ } from 'yellowgrid-api-ts';
845
+
846
+ const configuration = new Configuration();
847
+ const apiInstance = new BillingApi(configuration);
848
+
849
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
850
+
851
+ const { status, data } = await apiInstance.getGetAllMtSipTrunks(
852
+ billCustomerId
853
+ );
854
+ ```
855
+
856
+ ### Parameters
857
+
858
+ |Name | Type | Description | Notes|
859
+ |------------- | ------------- | ------------- | -------------|
860
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
861
+
862
+
863
+ ### Return type
864
+
865
+ **Array<Array<string>>**
866
+
867
+ ### Authorization
868
+
869
+ No authorization required
870
+
871
+ ### HTTP request headers
872
+
873
+ - **Content-Type**: Not defined
874
+ - **Accept**: application/json
875
+
876
+
877
+ ### HTTP response details
878
+ | Status code | Description | Response headers |
879
+ |-------------|-------------|------------------|
880
+ |**200** | List Of MT Trunks | - |
881
+ |**400** | Bad Request | - |
882
+ |**401** | Unauthorised | - |
883
+ |**403** | Access Denied | - |
884
+
885
+ [[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)
886
+
887
+ # **getGetAllSipTrunks**
888
+ > Array<Array<string>> getGetAllSipTrunks()
889
+
890
+ Get All SIP Trunks
891
+
892
+ ### Example
893
+
894
+ ```typescript
895
+ import {
896
+ BillingApi,
897
+ Configuration
898
+ } from 'yellowgrid-api-ts';
899
+
900
+ const configuration = new Configuration();
901
+ const apiInstance = new BillingApi(configuration);
902
+
903
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
904
+
905
+ const { status, data } = await apiInstance.getGetAllSipTrunks(
906
+ billCustomerId
907
+ );
908
+ ```
909
+
910
+ ### Parameters
911
+
912
+ |Name | Type | Description | Notes|
913
+ |------------- | ------------- | ------------- | -------------|
914
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
915
+
916
+
917
+ ### Return type
918
+
919
+ **Array<Array<string>>**
920
+
921
+ ### Authorization
922
+
923
+ No authorization required
924
+
925
+ ### HTTP request headers
926
+
927
+ - **Content-Type**: Not defined
928
+ - **Accept**: application/json
929
+
930
+
931
+ ### HTTP response details
932
+ | Status code | Description | Response headers |
933
+ |-------------|-------------|------------------|
934
+ |**200** | List Of Trunks | - |
935
+ |**400** | Bad Request | - |
936
+ |**401** | Unauthorised | - |
937
+ |**403** | Access Denied | - |
938
+
939
+ [[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)
940
+
941
+ # **getGetBaseServices**
942
+ > Array<BaseService> getGetBaseServices()
943
+
944
+ Get Base Services
945
+
946
+ ### Example
947
+
948
+ ```typescript
949
+ import {
950
+ BillingApi,
951
+ Configuration
952
+ } from 'yellowgrid-api-ts';
953
+
954
+ const configuration = new Configuration();
955
+ const apiInstance = new BillingApi(configuration);
956
+
957
+ const { status, data } = await apiInstance.getGetBaseServices();
958
+ ```
959
+
960
+ ### Parameters
961
+ This endpoint does not have any parameters.
962
+
963
+
964
+ ### Return type
965
+
966
+ **Array<BaseService>**
967
+
968
+ ### Authorization
969
+
970
+ No authorization required
971
+
972
+ ### HTTP request headers
973
+
974
+ - **Content-Type**: Not defined
975
+ - **Accept**: application/json
976
+
977
+
978
+ ### HTTP response details
979
+ | Status code | Description | Response headers |
980
+ |-------------|-------------|------------------|
981
+ |**200** | Base Service | - |
982
+ |**400** | Bad Request | - |
983
+ |**401** | Unauthorised | - |
984
+ |**403** | Access Denied | - |
985
+
986
+ [[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)
987
+
988
+ # **getGetBillingCustomerDetails**
989
+ > Customer getGetBillingCustomerDetails()
990
+
991
+ Get Customer
992
+
993
+ ### Example
994
+
995
+ ```typescript
996
+ import {
997
+ BillingApi,
998
+ Configuration
999
+ } from 'yellowgrid-api-ts';
1000
+
1001
+ const configuration = new Configuration();
1002
+ const apiInstance = new BillingApi(configuration);
1003
+
1004
+ let billCustomerId: string; //Customer ID (optional) (default to undefined)
1005
+
1006
+ const { status, data } = await apiInstance.getGetBillingCustomerDetails(
1007
+ billCustomerId
1008
+ );
1009
+ ```
1010
+
1011
+ ### Parameters
1012
+
1013
+ |Name | Type | Description | Notes|
1014
+ |------------- | ------------- | ------------- | -------------|
1015
+ | **billCustomerId** | [**string**] | Customer ID | (optional) defaults to undefined|
1016
+
1017
+
1018
+ ### Return type
1019
+
1020
+ **Customer**
1021
+
1022
+ ### Authorization
1023
+
1024
+ No authorization required
1025
+
1026
+ ### HTTP request headers
1027
+
1028
+ - **Content-Type**: Not defined
1029
+ - **Accept**: application/json
1030
+
1031
+
1032
+ ### HTTP response details
1033
+ | Status code | Description | Response headers |
1034
+ |-------------|-------------|------------------|
1035
+ |**200** | Customer | - |
1036
+ |**400** | Bad Request | - |
1037
+ |**401** | Unauthorised | - |
1038
+ |**403** | Access Denied | - |
1039
+
1040
+ [[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)
1041
+
1042
+ # **getGetBundleCallsWithCost**
1043
+ > Array<ProcessedCdr> getGetBundleCallsWithCost()
1044
+
1045
+ Get Bundle Calls With Cost
1046
+
1047
+ ### Example
1048
+
1049
+ ```typescript
1050
+ import {
1051
+ BillingApi,
1052
+ Configuration
1053
+ } from 'yellowgrid-api-ts';
1054
+
1055
+ const configuration = new Configuration();
1056
+ const apiInstance = new BillingApi(configuration);
1057
+
1058
+ const { status, data } = await apiInstance.getGetBundleCallsWithCost();
1059
+ ```
1060
+
1061
+ ### Parameters
1062
+ This endpoint does not have any parameters.
1063
+
1064
+
1065
+ ### Return type
1066
+
1067
+ **Array<ProcessedCdr>**
1068
+
1069
+ ### Authorization
1070
+
1071
+ No authorization required
1072
+
1073
+ ### HTTP request headers
1074
+
1075
+ - **Content-Type**: Not defined
1076
+ - **Accept**: application/json
1077
+
1078
+
1079
+ ### HTTP response details
1080
+ | Status code | Description | Response headers |
1081
+ |-------------|-------------|------------------|
1082
+ |**200** | Process CDR | - |
1083
+ |**400** | Bad Request | - |
1084
+ |**401** | Unauthorised | - |
1085
+ |**403** | Access Denied | - |
1086
+
1087
+ [[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)
1088
+
1089
+ # **getGetCallTariffPlan**
1090
+ > CallTariffPlan getGetCallTariffPlan()
1091
+
1092
+ Get Call Tariff
1093
+
1094
+ ### Example
1095
+
1096
+ ```typescript
1097
+ import {
1098
+ BillingApi,
1099
+ Configuration
1100
+ } from 'yellowgrid-api-ts';
1101
+
1102
+ const configuration = new Configuration();
1103
+ const apiInstance = new BillingApi(configuration);
1104
+
1105
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
1106
+
1107
+ const { status, data } = await apiInstance.getGetCallTariffPlan(
1108
+ callTariffPlanId
1109
+ );
1110
+ ```
1111
+
1112
+ ### Parameters
1113
+
1114
+ |Name | Type | Description | Notes|
1115
+ |------------- | ------------- | ------------- | -------------|
1116
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
1117
+
1118
+
1119
+ ### Return type
1120
+
1121
+ **CallTariffPlan**
1122
+
1123
+ ### Authorization
1124
+
1125
+ No authorization required
1126
+
1127
+ ### HTTP request headers
1128
+
1129
+ - **Content-Type**: Not defined
1130
+ - **Accept**: application/json
1131
+
1132
+
1133
+ ### HTTP response details
1134
+ | Status code | Description | Response headers |
1135
+ |-------------|-------------|------------------|
1136
+ |**200** | Call Tariff Plan | - |
1137
+ |**400** | Bad Request | - |
1138
+ |**401** | Unauthorised | - |
1139
+ |**403** | Access Denied | - |
1140
+
1141
+ [[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)
1142
+
1143
+ # **getGetCallTariffs**
1144
+ > Array<CallTariffPlan> getGetCallTariffs()
1145
+
1146
+ Get Call Tariffs
1147
+
1148
+ ### Example
1149
+
1150
+ ```typescript
1151
+ import {
1152
+ BillingApi,
1153
+ Configuration
1154
+ } from 'yellowgrid-api-ts';
1155
+
1156
+ const configuration = new Configuration();
1157
+ const apiInstance = new BillingApi(configuration);
1158
+
1159
+ const { status, data } = await apiInstance.getGetCallTariffs();
1160
+ ```
1161
+
1162
+ ### Parameters
1163
+ This endpoint does not have any parameters.
1164
+
1165
+
1166
+ ### Return type
1167
+
1168
+ **Array<CallTariffPlan>**
1169
+
1170
+ ### Authorization
1171
+
1172
+ No authorization required
1173
+
1174
+ ### HTTP request headers
1175
+
1176
+ - **Content-Type**: Not defined
1177
+ - **Accept**: application/json
1178
+
1179
+
1180
+ ### HTTP response details
1181
+ | Status code | Description | Response headers |
1182
+ |-------------|-------------|------------------|
1183
+ |**200** | Call Tariff Plan | - |
1184
+ |**400** | Bad Request | - |
1185
+ |**401** | Unauthorised | - |
1186
+ |**403** | Access Denied | - |
1187
+
1188
+ [[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)
1189
+
1190
+ # **getGetCallTariffsDetails**
1191
+ > Array<CallTariffPlan> getGetCallTariffsDetails()
1192
+
1193
+ Get Call Tariffs Detailed
1194
+
1195
+ ### Example
1196
+
1197
+ ```typescript
1198
+ import {
1199
+ BillingApi,
1200
+ Configuration
1201
+ } from 'yellowgrid-api-ts';
1202
+
1203
+ const configuration = new Configuration();
1204
+ const apiInstance = new BillingApi(configuration);
1205
+
1206
+ const { status, data } = await apiInstance.getGetCallTariffsDetails();
1207
+ ```
1208
+
1209
+ ### Parameters
1210
+ This endpoint does not have any parameters.
1211
+
1212
+
1213
+ ### Return type
1214
+
1215
+ **Array<CallTariffPlan>**
1216
+
1217
+ ### Authorization
1218
+
1219
+ No authorization required
1220
+
1221
+ ### HTTP request headers
1222
+
1223
+ - **Content-Type**: Not defined
1224
+ - **Accept**: application/json
1225
+
1226
+
1227
+ ### HTTP response details
1228
+ | Status code | Description | Response headers |
1229
+ |-------------|-------------|------------------|
1230
+ |**200** | Call Tariff Plan | - |
1231
+ |**400** | Bad Request | - |
1232
+ |**401** | Unauthorised | - |
1233
+ |**403** | Access Denied | - |
1234
+
1235
+ [[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)
1236
+
1237
+ # **getGetChildren**
1238
+ > Array<object> getGetChildren()
1239
+
1240
+ Get Children
1241
+
1242
+ ### Example
1243
+
1244
+ ```typescript
1245
+ import {
1246
+ BillingApi,
1247
+ Configuration
1248
+ } from 'yellowgrid-api-ts';
1249
+
1250
+ const configuration = new Configuration();
1251
+ const apiInstance = new BillingApi(configuration);
1252
+
1253
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1254
+
1255
+ const { status, data } = await apiInstance.getGetChildren(
1256
+ billCustomerId
1257
+ );
1258
+ ```
1259
+
1260
+ ### Parameters
1261
+
1262
+ |Name | Type | Description | Notes|
1263
+ |------------- | ------------- | ------------- | -------------|
1264
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1265
+
1266
+
1267
+ ### Return type
1268
+
1269
+ **Array<object>**
1270
+
1271
+ ### Authorization
1272
+
1273
+ No authorization required
1274
+
1275
+ ### HTTP request headers
1276
+
1277
+ - **Content-Type**: Not defined
1278
+ - **Accept**: application/json
1279
+
1280
+
1281
+ ### HTTP response details
1282
+ | Status code | Description | Response headers |
1283
+ |-------------|-------------|------------------|
1284
+ |**200** | Child Names | - |
1285
+ |**400** | Bad Request | - |
1286
+ |**401** | Unauthorised | - |
1287
+ |**403** | Access Denied | - |
1288
+
1289
+ [[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)
1290
+
1291
+ # **getGetConnection**
1292
+ > OutboundCli getGetConnection()
1293
+
1294
+ Get Connection
1295
+
1296
+ ### Example
1297
+
1298
+ ```typescript
1299
+ import {
1300
+ BillingApi,
1301
+ Configuration
1302
+ } from 'yellowgrid-api-ts';
1303
+
1304
+ const configuration = new Configuration();
1305
+ const apiInstance = new BillingApi(configuration);
1306
+
1307
+ let id: number; //Connection ID (default to undefined)
1308
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1309
+
1310
+ const { status, data } = await apiInstance.getGetConnection(
1311
+ id,
1312
+ billCustomerId
1313
+ );
1314
+ ```
1315
+
1316
+ ### Parameters
1317
+
1318
+ |Name | Type | Description | Notes|
1319
+ |------------- | ------------- | ------------- | -------------|
1320
+ | **id** | [**number**] | Connection ID | defaults to undefined|
1321
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1322
+
1323
+
1324
+ ### Return type
1325
+
1326
+ **OutboundCli**
1327
+
1328
+ ### Authorization
1329
+
1330
+ No authorization required
1331
+
1332
+ ### HTTP request headers
1333
+
1334
+ - **Content-Type**: Not defined
1335
+ - **Accept**: application/json
1336
+
1337
+
1338
+ ### HTTP response details
1339
+ | Status code | Description | Response headers |
1340
+ |-------------|-------------|------------------|
1341
+ |**200** | Connection | - |
1342
+ |**400** | Bad Request | - |
1343
+ |**401** | Unauthorised | - |
1344
+ |**403** | Access Denied | - |
1345
+
1346
+ [[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)
1347
+
1348
+ # **getGetConnections**
1349
+ > Array<OutboundCli> getGetConnections()
1350
+
1351
+ Get Connections
1352
+
1353
+ ### Example
1354
+
1355
+ ```typescript
1356
+ import {
1357
+ BillingApi,
1358
+ Configuration
1359
+ } from 'yellowgrid-api-ts';
1360
+
1361
+ const configuration = new Configuration();
1362
+ const apiInstance = new BillingApi(configuration);
1363
+
1364
+ let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
1365
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1366
+
1367
+ const { status, data } = await apiInstance.getGetConnections(
1368
+ type,
1369
+ billCustomerId
1370
+ );
1371
+ ```
1372
+
1373
+ ### Parameters
1374
+
1375
+ |Name | Type | Description | Notes|
1376
+ |------------- | ------------- | ------------- | -------------|
1377
+ | **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
1378
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1379
+
1380
+
1381
+ ### Return type
1382
+
1383
+ **Array<OutboundCli>**
1384
+
1385
+ ### Authorization
1386
+
1387
+ No authorization required
1388
+
1389
+ ### HTTP request headers
1390
+
1391
+ - **Content-Type**: Not defined
1392
+ - **Accept**: application/json
1393
+
1394
+
1395
+ ### HTTP response details
1396
+ | Status code | Description | Response headers |
1397
+ |-------------|-------------|------------------|
1398
+ |**200** | Connection | - |
1399
+ |**400** | Bad Request | - |
1400
+ |**401** | Unauthorised | - |
1401
+ |**403** | Access Denied | - |
1402
+
1403
+ [[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
+ # **getGetCustomer**
1406
+ > Customer getGetCustomer()
1407
+
1408
+ Get Customer (Global)
1409
+
1410
+ ### Example
1411
+
1412
+ ```typescript
1413
+ import {
1414
+ BillingApi,
1415
+ Configuration
1416
+ } from 'yellowgrid-api-ts';
1417
+
1418
+ const configuration = new Configuration();
1419
+ const apiInstance = new BillingApi(configuration);
1420
+
1421
+ let accountId: string; //Account ID (optional) (default to undefined)
1422
+ let customerId: number; //Customer ID (optional) (default to undefined)
1423
+ let customerCode: string; //Customer Code (optional) (default to undefined)
1424
+
1425
+ const { status, data } = await apiInstance.getGetCustomer(
1426
+ accountId,
1427
+ customerId,
1428
+ customerCode
1429
+ );
1430
+ ```
1431
+
1432
+ ### Parameters
1433
+
1434
+ |Name | Type | Description | Notes|
1435
+ |------------- | ------------- | ------------- | -------------|
1436
+ | **accountId** | [**string**] | Account ID | (optional) defaults to undefined|
1437
+ | **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1438
+ | **customerCode** | [**string**] | Customer Code | (optional) defaults to undefined|
1439
+
1440
+
1441
+ ### Return type
1442
+
1443
+ **Customer**
1444
+
1445
+ ### Authorization
1446
+
1447
+ No authorization required
1448
+
1449
+ ### HTTP request headers
1450
+
1451
+ - **Content-Type**: Not defined
1452
+ - **Accept**: application/json
1453
+
1454
+
1455
+ ### HTTP response details
1456
+ | Status code | Description | Response headers |
1457
+ |-------------|-------------|------------------|
1458
+ |**200** | Customer | - |
1459
+ |**400** | Bad Request | - |
1460
+ |**401** | Unauthorised | - |
1461
+ |**403** | Access Denied | - |
1462
+
1463
+ [[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)
1464
+
1465
+ # **getGetInboundTariffs**
1466
+ > Array<string> getGetInboundTariffs()
1467
+
1468
+ Get Inbound Tariffs
1469
+
1470
+ ### Example
1471
+
1472
+ ```typescript
1473
+ import {
1474
+ BillingApi,
1475
+ Configuration
1476
+ } from 'yellowgrid-api-ts';
1477
+
1478
+ const configuration = new Configuration();
1479
+ const apiInstance = new BillingApi(configuration);
1480
+
1481
+ const { status, data } = await apiInstance.getGetInboundTariffs();
1482
+ ```
1483
+
1484
+ ### Parameters
1485
+ This endpoint does not have any parameters.
1486
+
1487
+
1488
+ ### Return type
1489
+
1490
+ **Array<string>**
1491
+
1492
+ ### Authorization
1493
+
1494
+ No authorization required
1495
+
1496
+ ### HTTP request headers
1497
+
1498
+ - **Content-Type**: Not defined
1499
+ - **Accept**: application/json
1500
+
1501
+
1502
+ ### HTTP response details
1503
+ | Status code | Description | Response headers |
1504
+ |-------------|-------------|------------------|
1505
+ |**200** | Tariff Names | - |
1506
+ |**400** | Bad Request | - |
1507
+ |**401** | Unauthorised | - |
1508
+ |**403** | Access Denied | - |
1509
+
1510
+ [[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)
1511
+
1512
+ # **getGetInboundTariffsDetails**
1513
+ > Array<InboundTariffPlanResponse> getGetInboundTariffsDetails()
1514
+
1515
+ Get Inbound Tariffs Detailed
1516
+
1517
+ ### Example
1518
+
1519
+ ```typescript
1520
+ import {
1521
+ BillingApi,
1522
+ Configuration
1523
+ } from 'yellowgrid-api-ts';
1524
+
1525
+ const configuration = new Configuration();
1526
+ const apiInstance = new BillingApi(configuration);
1527
+
1528
+ const { status, data } = await apiInstance.getGetInboundTariffsDetails();
1529
+ ```
1530
+
1531
+ ### Parameters
1532
+ This endpoint does not have any parameters.
1533
+
1534
+
1535
+ ### Return type
1536
+
1537
+ **Array<InboundTariffPlanResponse>**
1538
+
1539
+ ### Authorization
1540
+
1541
+ No authorization required
1542
+
1543
+ ### HTTP request headers
1544
+
1545
+ - **Content-Type**: Not defined
1546
+ - **Accept**: application/json
1547
+
1548
+
1549
+ ### HTTP response details
1550
+ | Status code | Description | Response headers |
1551
+ |-------------|-------------|------------------|
1552
+ |**200** | Inbound Tariff | - |
1553
+ |**400** | Bad Request | - |
1554
+ |**401** | Unauthorised | - |
1555
+ |**403** | Access Denied | - |
1556
+
1557
+ [[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)
1558
+
1559
+ # **getGetPriceGroups**
1560
+ > Array<PriceGroup> getGetPriceGroups()
1561
+
1562
+ Get Price Groups
1563
+
1564
+ ### Example
1565
+
1566
+ ```typescript
1567
+ import {
1568
+ BillingApi,
1569
+ Configuration
1570
+ } from 'yellowgrid-api-ts';
1571
+
1572
+ const configuration = new Configuration();
1573
+ const apiInstance = new BillingApi(configuration);
1574
+
1575
+ const { status, data } = await apiInstance.getGetPriceGroups();
1576
+ ```
1577
+
1578
+ ### Parameters
1579
+ This endpoint does not have any parameters.
1580
+
1581
+
1582
+ ### Return type
1583
+
1584
+ **Array<PriceGroup>**
1585
+
1586
+ ### Authorization
1587
+
1588
+ No authorization required
1589
+
1590
+ ### HTTP request headers
1591
+
1592
+ - **Content-Type**: Not defined
1593
+ - **Accept**: application/json
1594
+
1595
+
1596
+ ### HTTP response details
1597
+ | Status code | Description | Response headers |
1598
+ |-------------|-------------|------------------|
1599
+ |**200** | Price Group | - |
1600
+ |**400** | Bad Request | - |
1601
+ |**401** | Unauthorised | - |
1602
+ |**403** | Access Denied | - |
1603
+
1604
+ [[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)
1605
+
1606
+ # **getGetServicePlan**
1607
+ > ServicePlan getGetServicePlan()
1608
+
1609
+ Get Service Plan
1610
+
1611
+ ### Example
1612
+
1613
+ ```typescript
1614
+ import {
1615
+ BillingApi,
1616
+ Configuration
1617
+ } from 'yellowgrid-api-ts';
1618
+
1619
+ const configuration = new Configuration();
1620
+ const apiInstance = new BillingApi(configuration);
1621
+
1622
+ let servicePlanId: number; //Service Plan ID (default to undefined)
1623
+
1624
+ const { status, data } = await apiInstance.getGetServicePlan(
1625
+ servicePlanId
1626
+ );
1627
+ ```
1628
+
1629
+ ### Parameters
1630
+
1631
+ |Name | Type | Description | Notes|
1632
+ |------------- | ------------- | ------------- | -------------|
1633
+ | **servicePlanId** | [**number**] | Service Plan ID | defaults to undefined|
1634
+
1635
+
1636
+ ### Return type
1637
+
1638
+ **ServicePlan**
1639
+
1640
+ ### Authorization
1641
+
1642
+ No authorization required
1643
+
1644
+ ### HTTP request headers
1645
+
1646
+ - **Content-Type**: Not defined
1647
+ - **Accept**: application/json
1648
+
1649
+
1650
+ ### HTTP response details
1651
+ | Status code | Description | Response headers |
1652
+ |-------------|-------------|------------------|
1653
+ |**200** | Service Plan | - |
1654
+ |**400** | Bad Request | - |
1655
+ |**401** | Unauthorised | - |
1656
+ |**403** | Access Denied | - |
1657
+
1658
+ [[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)
1659
+
1660
+ # **getGetServicePlans**
1661
+ > Array<ServicePlan> getGetServicePlans()
1662
+
1663
+ Get Service Plans
1664
+
1665
+ ### Example
1666
+
1667
+ ```typescript
1668
+ import {
1669
+ BillingApi,
1670
+ Configuration
1671
+ } from 'yellowgrid-api-ts';
1672
+
1673
+ const configuration = new Configuration();
1674
+ const apiInstance = new BillingApi(configuration);
1675
+
1676
+ const { status, data } = await apiInstance.getGetServicePlans();
1677
+ ```
1678
+
1679
+ ### Parameters
1680
+ This endpoint does not have any parameters.
1681
+
1682
+
1683
+ ### Return type
1684
+
1685
+ **Array<ServicePlan>**
1686
+
1687
+ ### Authorization
1688
+
1689
+ No authorization required
1690
+
1691
+ ### HTTP request headers
1692
+
1693
+ - **Content-Type**: Not defined
1694
+ - **Accept**: application/json
1695
+
1696
+
1697
+ ### HTTP response details
1698
+ | Status code | Description | Response headers |
1699
+ |-------------|-------------|------------------|
1700
+ |**200** | Service Plan | - |
1701
+ |**400** | Bad Request | - |
1702
+ |**401** | Unauthorised | - |
1703
+ |**403** | Access Denied | - |
1704
+
1705
+ [[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)
1706
+
1707
+ # **getGetServicesPlanDetails**
1708
+ > Array<ServicePlan> getGetServicesPlanDetails()
1709
+
1710
+ Get Service Plans Detailed
1711
+
1712
+ ### Example
1713
+
1714
+ ```typescript
1715
+ import {
1716
+ BillingApi,
1717
+ Configuration
1718
+ } from 'yellowgrid-api-ts';
1719
+
1720
+ const configuration = new Configuration();
1721
+ const apiInstance = new BillingApi(configuration);
1722
+
1723
+ let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
1724
+
1725
+ const { status, data } = await apiInstance.getGetServicesPlanDetails(
1726
+ type
1727
+ );
1728
+ ```
1729
+
1730
+ ### Parameters
1731
+
1732
+ |Name | Type | Description | Notes|
1733
+ |------------- | ------------- | ------------- | -------------|
1734
+ | **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
1735
+
1736
+
1737
+ ### Return type
1738
+
1739
+ **Array<ServicePlan>**
1740
+
1741
+ ### Authorization
1742
+
1743
+ No authorization required
1744
+
1745
+ ### HTTP request headers
1746
+
1747
+ - **Content-Type**: Not defined
1748
+ - **Accept**: application/json
1749
+
1750
+
1751
+ ### HTTP response details
1752
+ | Status code | Description | Response headers |
1753
+ |-------------|-------------|------------------|
1754
+ |**200** | Service Plan | - |
1755
+ |**400** | Bad Request | - |
1756
+ |**401** | Unauthorised | - |
1757
+ |**403** | Access Denied | - |
1758
+
1759
+ [[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)
1760
+
1761
+ # **getGetSipTrunkList**
1762
+ > Array<Array<string>> getGetSipTrunkList()
1763
+
1764
+ Get SIP Trunk List
1765
+
1766
+ ### Example
1767
+
1768
+ ```typescript
1769
+ import {
1770
+ BillingApi,
1771
+ Configuration
1772
+ } from 'yellowgrid-api-ts';
1773
+
1774
+ const configuration = new Configuration();
1775
+ const apiInstance = new BillingApi(configuration);
1776
+
1777
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1778
+
1779
+ const { status, data } = await apiInstance.getGetSipTrunkList(
1780
+ billCustomerId
1781
+ );
1782
+ ```
1783
+
1784
+ ### Parameters
1785
+
1786
+ |Name | Type | Description | Notes|
1787
+ |------------- | ------------- | ------------- | -------------|
1788
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1789
+
1790
+
1791
+ ### Return type
1792
+
1793
+ **Array<Array<string>>**
1794
+
1795
+ ### Authorization
1796
+
1797
+ No authorization required
1798
+
1799
+ ### HTTP request headers
1800
+
1801
+ - **Content-Type**: Not defined
1802
+ - **Accept**: application/json
1803
+
1804
+
1805
+ ### HTTP response details
1806
+ | Status code | Description | Response headers |
1807
+ |-------------|-------------|------------------|
1808
+ |**200** | List Of SIP Trunks | - |
1809
+ |**400** | Bad Request | - |
1810
+ |**401** | Unauthorised | - |
1811
+ |**403** | Access Denied | - |
1812
+
1813
+ [[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)
1814
+
1815
+ # **getGetSipTrunksBilling**
1816
+ > Array<string> getGetSipTrunksBilling()
1817
+
1818
+ Get SIP Trunk Billing
1819
+
1820
+ ### Example
1821
+
1822
+ ```typescript
1823
+ import {
1824
+ BillingApi,
1825
+ Configuration
1826
+ } from 'yellowgrid-api-ts';
1827
+
1828
+ const configuration = new Configuration();
1829
+ const apiInstance = new BillingApi(configuration);
1830
+
1831
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1832
+
1833
+ const { status, data } = await apiInstance.getGetSipTrunksBilling(
1834
+ billCustomerId
1835
+ );
1836
+ ```
1837
+
1838
+ ### Parameters
1839
+
1840
+ |Name | Type | Description | Notes|
1841
+ |------------- | ------------- | ------------- | -------------|
1842
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1843
+
1844
+
1845
+ ### Return type
1846
+
1847
+ **Array<string>**
1848
+
1849
+ ### Authorization
1850
+
1851
+ No authorization required
1852
+
1853
+ ### HTTP request headers
1854
+
1855
+ - **Content-Type**: Not defined
1856
+ - **Accept**: application/json
1857
+
1858
+
1859
+ ### HTTP response details
1860
+ | Status code | Description | Response headers |
1861
+ |-------------|-------------|------------------|
1862
+ |**200** | Trunk References | - |
1863
+ |**400** | Bad Request | - |
1864
+ |**401** | Unauthorised | - |
1865
+ |**403** | Access Denied | - |
1866
+
1867
+ [[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)
1868
+
1869
+ # **getGetUnconnectedCalls**
1870
+ > Array<ProcessedCdr> getGetUnconnectedCalls()
1871
+
1872
+ Get Unconnected Calls
1873
+
1874
+ ### Example
1875
+
1876
+ ```typescript
1877
+ import {
1878
+ BillingApi,
1879
+ Configuration
1880
+ } from 'yellowgrid-api-ts';
1881
+
1882
+ const configuration = new Configuration();
1883
+ const apiInstance = new BillingApi(configuration);
1884
+
1885
+ const { status, data } = await apiInstance.getGetUnconnectedCalls();
1886
+ ```
1887
+
1888
+ ### Parameters
1889
+ This endpoint does not have any parameters.
1890
+
1891
+
1892
+ ### Return type
1893
+
1894
+ **Array<ProcessedCdr>**
1895
+
1896
+ ### Authorization
1897
+
1898
+ No authorization required
1899
+
1900
+ ### HTTP request headers
1901
+
1902
+ - **Content-Type**: Not defined
1903
+ - **Accept**: application/json
1904
+
1905
+
1906
+ ### HTTP response details
1907
+ | Status code | Description | Response headers |
1908
+ |-------------|-------------|------------------|
1909
+ |**200** | Process CDR | - |
1910
+ |**400** | Bad Request | - |
1911
+ |**401** | Unauthorised | - |
1912
+ |**403** | Access Denied | - |
1913
+
1914
+ [[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)
1915
+
1916
+ # **getGetUnconnectedServices**
1917
+ > Array<UnconnectedSdr> getGetUnconnectedServices()
1918
+
1919
+ Get Unconnected Services
1920
+
1921
+ ### Example
1922
+
1923
+ ```typescript
1924
+ import {
1925
+ BillingApi,
1926
+ Configuration
1927
+ } from 'yellowgrid-api-ts';
1928
+
1929
+ const configuration = new Configuration();
1930
+ const apiInstance = new BillingApi(configuration);
1931
+
1932
+ const { status, data } = await apiInstance.getGetUnconnectedServices();
1933
+ ```
1934
+
1935
+ ### Parameters
1936
+ This endpoint does not have any parameters.
1937
+
1938
+
1939
+ ### Return type
1940
+
1941
+ **Array<UnconnectedSdr>**
1942
+
1943
+ ### Authorization
1944
+
1945
+ No authorization required
1946
+
1947
+ ### HTTP request headers
1948
+
1949
+ - **Content-Type**: Not defined
1950
+ - **Accept**: application/json
1951
+
1952
+
1953
+ ### HTTP response details
1954
+ | Status code | Description | Response headers |
1955
+ |-------------|-------------|------------------|
1956
+ |**200** | Unconnected SDR | - |
1957
+ |**400** | Bad Request | - |
1958
+ |**401** | Unauthorised | - |
1959
+ |**403** | Access Denied | - |
1960
+
1961
+ [[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)
1962
+
1963
+ # **getIsBundleCustomer**
1964
+ > boolean getIsBundleCustomer()
1965
+
1966
+ Is Bundle Customer
1967
+
1968
+ ### Example
1969
+
1970
+ ```typescript
1971
+ import {
1972
+ BillingApi,
1973
+ Configuration
1974
+ } from 'yellowgrid-api-ts';
1975
+
1976
+ const configuration = new Configuration();
1977
+ const apiInstance = new BillingApi(configuration);
1978
+
1979
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1980
+
1981
+ const { status, data } = await apiInstance.getIsBundleCustomer(
1982
+ billCustomerId
1983
+ );
1984
+ ```
1985
+
1986
+ ### Parameters
1987
+
1988
+ |Name | Type | Description | Notes|
1989
+ |------------- | ------------- | ------------- | -------------|
1990
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1991
+
1992
+
1993
+ ### Return type
1994
+
1995
+ **boolean**
1996
+
1997
+ ### Authorization
1998
+
1999
+ No authorization required
2000
+
2001
+ ### HTTP request headers
2002
+
2003
+ - **Content-Type**: Not defined
2004
+ - **Accept**: application/json
2005
+
2006
+
2007
+ ### HTTP response details
2008
+ | Status code | Description | Response headers |
2009
+ |-------------|-------------|------------------|
2010
+ |**200** | Successful | - |
2011
+ |**400** | Bad Request | - |
2012
+ |**401** | Unauthorised | - |
2013
+ |**403** | Access Denied | - |
2014
+
2015
+ [[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)
2016
+
2017
+ # **postAddBroadband**
2018
+ > OutboundCli postAddBroadband(postAddBroadbandRequest)
2019
+
2020
+ Add Broadband
2021
+
2022
+ ### Example
2023
+
2024
+ ```typescript
2025
+ import {
2026
+ BillingApi,
2027
+ Configuration,
2028
+ PostAddBroadbandRequest
2029
+ } from 'yellowgrid-api-ts';
2030
+
2031
+ const configuration = new Configuration();
2032
+ const apiInstance = new BillingApi(configuration);
2033
+
2034
+ let postAddBroadbandRequest: PostAddBroadbandRequest; //
2035
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2036
+
2037
+ const { status, data } = await apiInstance.postAddBroadband(
2038
+ postAddBroadbandRequest,
2039
+ billCustomerId
2040
+ );
2041
+ ```
2042
+
2043
+ ### Parameters
2044
+
2045
+ |Name | Type | Description | Notes|
2046
+ |------------- | ------------- | ------------- | -------------|
2047
+ | **postAddBroadbandRequest** | **PostAddBroadbandRequest**| | |
2048
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2049
+
2050
+
2051
+ ### Return type
2052
+
2053
+ **OutboundCli**
2054
+
2055
+ ### Authorization
2056
+
2057
+ No authorization required
2058
+
2059
+ ### HTTP request headers
2060
+
2061
+ - **Content-Type**: application/json
2062
+ - **Accept**: application/json
2063
+
2064
+
2065
+ ### HTTP response details
2066
+ | Status code | Description | Response headers |
2067
+ |-------------|-------------|------------------|
2068
+ |**200** | Connection | - |
2069
+ |**400** | Bad Request | - |
2070
+ |**401** | Unauthorised | - |
2071
+ |**403** | Access Denied | - |
2072
+
2073
+ [[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)
2074
+
2075
+ # **postAddCallTariffToCallTariffPlan**
2076
+ > CallTariffPlan postAddCallTariffToCallTariffPlan(postAddCallTariffToCallTariffPlanRequest)
2077
+
2078
+ Add Call Tariff To Call Tariff Plan
2079
+
2080
+ ### Example
2081
+
2082
+ ```typescript
2083
+ import {
2084
+ BillingApi,
2085
+ Configuration,
2086
+ PostAddCallTariffToCallTariffPlanRequest
2087
+ } from 'yellowgrid-api-ts';
2088
+
2089
+ const configuration = new Configuration();
2090
+ const apiInstance = new BillingApi(configuration);
2091
+
2092
+ let postAddCallTariffToCallTariffPlanRequest: PostAddCallTariffToCallTariffPlanRequest; //
2093
+
2094
+ const { status, data } = await apiInstance.postAddCallTariffToCallTariffPlan(
2095
+ postAddCallTariffToCallTariffPlanRequest
2096
+ );
2097
+ ```
2098
+
2099
+ ### Parameters
2100
+
2101
+ |Name | Type | Description | Notes|
2102
+ |------------- | ------------- | ------------- | -------------|
2103
+ | **postAddCallTariffToCallTariffPlanRequest** | **PostAddCallTariffToCallTariffPlanRequest**| | |
2104
+
2105
+
2106
+ ### Return type
2107
+
2108
+ **CallTariffPlan**
2109
+
2110
+ ### Authorization
2111
+
2112
+ No authorization required
2113
+
2114
+ ### HTTP request headers
2115
+
2116
+ - **Content-Type**: application/json
2117
+ - **Accept**: application/json
2118
+
2119
+
2120
+ ### HTTP response details
2121
+ | Status code | Description | Response headers |
2122
+ |-------------|-------------|------------------|
2123
+ |**200** | Call Tariff Plan | - |
2124
+ |**400** | Bad Request | - |
2125
+ |**401** | Unauthorised | - |
2126
+ |**403** | Access Denied | - |
2127
+
2128
+ [[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)
2129
+
2130
+ # **postAddChildCustomer**
2131
+ > Customer postAddChildCustomer(contactDetail)
2132
+
2133
+ Add Child Customer
2134
+
2135
+ ### Example
2136
+
2137
+ ```typescript
2138
+ import {
2139
+ BillingApi,
2140
+ Configuration,
2141
+ ContactDetail
2142
+ } from 'yellowgrid-api-ts';
2143
+
2144
+ const configuration = new Configuration();
2145
+ const apiInstance = new BillingApi(configuration);
2146
+
2147
+ let contactDetail: ContactDetail; //
2148
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2149
+ let customerId: number; //Child Customer ID (optional) (default to undefined)
2150
+
2151
+ const { status, data } = await apiInstance.postAddChildCustomer(
2152
+ contactDetail,
2153
+ billCustomerId,
2154
+ customerId
2155
+ );
2156
+ ```
2157
+
2158
+ ### Parameters
2159
+
2160
+ |Name | Type | Description | Notes|
2161
+ |------------- | ------------- | ------------- | -------------|
2162
+ | **contactDetail** | **ContactDetail**| | |
2163
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2164
+ | **customerId** | [**number**] | Child Customer ID | (optional) defaults to undefined|
2165
+
2166
+
2167
+ ### Return type
2168
+
2169
+ **Customer**
2170
+
2171
+ ### Authorization
2172
+
2173
+ No authorization required
2174
+
2175
+ ### HTTP request headers
2176
+
2177
+ - **Content-Type**: application/json
2178
+ - **Accept**: application/json
2179
+
2180
+
2181
+ ### HTTP response details
2182
+ | Status code | Description | Response headers |
2183
+ |-------------|-------------|------------------|
2184
+ |**200** | Customer | - |
2185
+ |**400** | Bad Request | - |
2186
+ |**401** | Unauthorised | - |
2187
+ |**403** | Access Denied | - |
2188
+
2189
+ [[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)
2190
+
2191
+ # **postAddEthernet**
2192
+ > OutboundCli postAddEthernet(postAddEthernetRequest)
2193
+
2194
+ Add Ethernet
2195
+
2196
+ ### Example
2197
+
2198
+ ```typescript
2199
+ import {
2200
+ BillingApi,
2201
+ Configuration,
2202
+ PostAddEthernetRequest
2203
+ } from 'yellowgrid-api-ts';
2204
+
2205
+ const configuration = new Configuration();
2206
+ const apiInstance = new BillingApi(configuration);
2207
+
2208
+ let postAddEthernetRequest: PostAddEthernetRequest; //
2209
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2210
+
2211
+ const { status, data } = await apiInstance.postAddEthernet(
2212
+ postAddEthernetRequest,
2213
+ billCustomerId
2214
+ );
2215
+ ```
2216
+
2217
+ ### Parameters
2218
+
2219
+ |Name | Type | Description | Notes|
2220
+ |------------- | ------------- | ------------- | -------------|
2221
+ | **postAddEthernetRequest** | **PostAddEthernetRequest**| | |
2222
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2223
+
2224
+
2225
+ ### Return type
2226
+
2227
+ **OutboundCli**
2228
+
2229
+ ### Authorization
2230
+
2231
+ No authorization required
2232
+
2233
+ ### HTTP request headers
2234
+
2235
+ - **Content-Type**: application/json
2236
+ - **Accept**: application/json
2237
+
2238
+
2239
+ ### HTTP response details
2240
+ | Status code | Description | Response headers |
2241
+ |-------------|-------------|------------------|
2242
+ |**200** | Connection | - |
2243
+ |**400** | Bad Request | - |
2244
+ |**401** | Unauthorised | - |
2245
+ |**403** | Access Denied | - |
2246
+
2247
+ [[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)
2248
+
2249
+ # **postAddRecurringCharge**
2250
+ > RecurringCharge postAddRecurringCharge(postAddRecurringChargeRequest)
2251
+
2252
+ Add Recurring Charge
2253
+
2254
+ ### Example
2255
+
2256
+ ```typescript
2257
+ import {
2258
+ BillingApi,
2259
+ Configuration,
2260
+ PostAddRecurringChargeRequest
2261
+ } from 'yellowgrid-api-ts';
2262
+
2263
+ const configuration = new Configuration();
2264
+ const apiInstance = new BillingApi(configuration);
2265
+
2266
+ let postAddRecurringChargeRequest: PostAddRecurringChargeRequest; //
2267
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2268
+
2269
+ const { status, data } = await apiInstance.postAddRecurringCharge(
2270
+ postAddRecurringChargeRequest,
2271
+ billCustomerId
2272
+ );
2273
+ ```
2274
+
2275
+ ### Parameters
2276
+
2277
+ |Name | Type | Description | Notes|
2278
+ |------------- | ------------- | ------------- | -------------|
2279
+ | **postAddRecurringChargeRequest** | **PostAddRecurringChargeRequest**| | |
2280
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2281
+
2282
+
2283
+ ### Return type
2284
+
2285
+ **RecurringCharge**
2286
+
2287
+ ### Authorization
2288
+
2289
+ No authorization required
2290
+
2291
+ ### HTTP request headers
2292
+
2293
+ - **Content-Type**: application/json
2294
+ - **Accept**: application/json
2295
+
2296
+
2297
+ ### HTTP response details
2298
+ | Status code | Description | Response headers |
2299
+ |-------------|-------------|------------------|
2300
+ |**200** | Recurring Charge | - |
2301
+ |**400** | Bad Request | - |
2302
+ |**401** | Unauthorised | - |
2303
+ |**403** | Access Denied | - |
2304
+
2305
+ [[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)
2306
+
2307
+ # **postAddServiceToServicePlan**
2308
+ > Service postAddServiceToServicePlan(postAddServiceToServicePlanRequest)
2309
+
2310
+ Add Service To Service Plan
2311
+
2312
+ ### Example
2313
+
2314
+ ```typescript
2315
+ import {
2316
+ BillingApi,
2317
+ Configuration,
2318
+ PostAddServiceToServicePlanRequest
2319
+ } from 'yellowgrid-api-ts';
2320
+
2321
+ const configuration = new Configuration();
2322
+ const apiInstance = new BillingApi(configuration);
2323
+
2324
+ let postAddServiceToServicePlanRequest: PostAddServiceToServicePlanRequest; //
2325
+
2326
+ const { status, data } = await apiInstance.postAddServiceToServicePlan(
2327
+ postAddServiceToServicePlanRequest
2328
+ );
2329
+ ```
2330
+
2331
+ ### Parameters
2332
+
2333
+ |Name | Type | Description | Notes|
2334
+ |------------- | ------------- | ------------- | -------------|
2335
+ | **postAddServiceToServicePlanRequest** | **PostAddServiceToServicePlanRequest**| | |
2336
+
2337
+
2338
+ ### Return type
2339
+
2340
+ **Service**
2341
+
2342
+ ### Authorization
2343
+
2344
+ No authorization required
2345
+
2346
+ ### HTTP request headers
2347
+
2348
+ - **Content-Type**: application/json
2349
+ - **Accept**: application/json
2350
+
2351
+
2352
+ ### HTTP response details
2353
+ | Status code | Description | Response headers |
2354
+ |-------------|-------------|------------------|
2355
+ |**200** | Service | - |
2356
+ |**400** | Bad Request | - |
2357
+ |**401** | Unauthorised | - |
2358
+ |**403** | Access Denied | - |
2359
+
2360
+ [[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)
2361
+
2362
+ # **postAddSipTrunkDDIs**
2363
+ > Array<OutboundCli> postAddSipTrunkDDIs(postAddSipTrunkDDIsRequest)
2364
+
2365
+ Add SIP Trunk DDIs
2366
+
2367
+ ### Example
2368
+
2369
+ ```typescript
2370
+ import {
2371
+ BillingApi,
2372
+ Configuration,
2373
+ PostAddSipTrunkDDIsRequest
2374
+ } from 'yellowgrid-api-ts';
2375
+
2376
+ const configuration = new Configuration();
2377
+ const apiInstance = new BillingApi(configuration);
2378
+
2379
+ let postAddSipTrunkDDIsRequest: PostAddSipTrunkDDIsRequest; //
2380
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2381
+
2382
+ const { status, data } = await apiInstance.postAddSipTrunkDDIs(
2383
+ postAddSipTrunkDDIsRequest,
2384
+ billCustomerId
2385
+ );
2386
+ ```
2387
+
2388
+ ### Parameters
2389
+
2390
+ |Name | Type | Description | Notes|
2391
+ |------------- | ------------- | ------------- | -------------|
2392
+ | **postAddSipTrunkDDIsRequest** | **PostAddSipTrunkDDIsRequest**| | |
2393
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2394
+
2395
+
2396
+ ### Return type
2397
+
2398
+ **Array<OutboundCli>**
2399
+
2400
+ ### Authorization
2401
+
2402
+ No authorization required
2403
+
2404
+ ### HTTP request headers
2405
+
2406
+ - **Content-Type**: application/json
2407
+ - **Accept**: application/json
2408
+
2409
+
2410
+ ### HTTP response details
2411
+ | Status code | Description | Response headers |
2412
+ |-------------|-------------|------------------|
2413
+ |**200** | Connection | - |
2414
+ |**400** | Bad Request | - |
2415
+ |**401** | Unauthorised | - |
2416
+ |**403** | Access Denied | - |
2417
+
2418
+ [[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)
2419
+
2420
+ # **postDisconnectConnection**
2421
+ > number postDisconnectConnection(postDisconnectDDIRequest)
2422
+
2423
+ Disconnect Connection
2424
+
2425
+ ### Example
2426
+
2427
+ ```typescript
2428
+ import {
2429
+ BillingApi,
2430
+ Configuration,
2431
+ PostDisconnectDDIRequest
2432
+ } from 'yellowgrid-api-ts';
2433
+
2434
+ const configuration = new Configuration();
2435
+ const apiInstance = new BillingApi(configuration);
2436
+
2437
+ let postDisconnectDDIRequest: PostDisconnectDDIRequest; //
2438
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2439
+
2440
+ const { status, data } = await apiInstance.postDisconnectConnection(
2441
+ postDisconnectDDIRequest,
2442
+ billCustomerId
2443
+ );
2444
+ ```
2445
+
2446
+ ### Parameters
2447
+
2448
+ |Name | Type | Description | Notes|
2449
+ |------------- | ------------- | ------------- | -------------|
2450
+ | **postDisconnectDDIRequest** | **PostDisconnectDDIRequest**| | |
2451
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2452
+
2453
+
2454
+ ### Return type
2455
+
2456
+ **number**
2457
+
2458
+ ### Authorization
2459
+
2460
+ No authorization required
2461
+
2462
+ ### HTTP request headers
2463
+
2464
+ - **Content-Type**: application/json
2465
+ - **Accept**: application/json
2466
+
2467
+
2468
+ ### HTTP response details
2469
+ | Status code | Description | Response headers |
2470
+ |-------------|-------------|------------------|
2471
+ |**200** | Connection ID | - |
2472
+ |**400** | Bad Request | - |
2473
+ |**401** | Unauthorised | - |
2474
+ |**403** | Access Denied | - |
2475
+
2476
+ [[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)
2477
+
2478
+ # **postDisconnectDDI**
2479
+ > number postDisconnectDDI(postDisconnectDDIRequest)
2480
+
2481
+ Disconnect DDI
2482
+
2483
+ ### Example
2484
+
2485
+ ```typescript
2486
+ import {
2487
+ BillingApi,
2488
+ Configuration,
2489
+ PostDisconnectDDIRequest
2490
+ } from 'yellowgrid-api-ts';
2491
+
2492
+ const configuration = new Configuration();
2493
+ const apiInstance = new BillingApi(configuration);
2494
+
2495
+ let postDisconnectDDIRequest: PostDisconnectDDIRequest; //
2496
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2497
+
2498
+ const { status, data } = await apiInstance.postDisconnectDDI(
2499
+ postDisconnectDDIRequest,
2500
+ billCustomerId
2501
+ );
2502
+ ```
2503
+
2504
+ ### Parameters
2505
+
2506
+ |Name | Type | Description | Notes|
2507
+ |------------- | ------------- | ------------- | -------------|
2508
+ | **postDisconnectDDIRequest** | **PostDisconnectDDIRequest**| | |
2509
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2510
+
2511
+
2512
+ ### Return type
2513
+
2514
+ **number**
2515
+
2516
+ ### Authorization
2517
+
2518
+ No authorization required
2519
+
2520
+ ### HTTP request headers
2521
+
2522
+ - **Content-Type**: application/json
2523
+ - **Accept**: application/json
2524
+
2525
+
2526
+ ### HTTP response details
2527
+ | Status code | Description | Response headers |
2528
+ |-------------|-------------|------------------|
2529
+ |**200** | DDI ID | - |
2530
+ |**400** | Bad Request | - |
2531
+ |**401** | Unauthorised | - |
2532
+ |**403** | Access Denied | - |
2533
+
2534
+ [[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)
2535
+
2536
+ # **postGetBaseServices**
2537
+ > Service postGetBaseServices(postGetBaseServicesRequest)
2538
+
2539
+ Add Base Service
2540
+
2541
+ ### Example
2542
+
2543
+ ```typescript
2544
+ import {
2545
+ BillingApi,
2546
+ Configuration,
2547
+ PostGetBaseServicesRequest
2548
+ } from 'yellowgrid-api-ts';
2549
+
2550
+ const configuration = new Configuration();
2551
+ const apiInstance = new BillingApi(configuration);
2552
+
2553
+ let postGetBaseServicesRequest: PostGetBaseServicesRequest; //
2554
+
2555
+ const { status, data } = await apiInstance.postGetBaseServices(
2556
+ postGetBaseServicesRequest
2557
+ );
2558
+ ```
2559
+
2560
+ ### Parameters
2561
+
2562
+ |Name | Type | Description | Notes|
2563
+ |------------- | ------------- | ------------- | -------------|
2564
+ | **postGetBaseServicesRequest** | **PostGetBaseServicesRequest**| | |
2565
+
2566
+
2567
+ ### Return type
2568
+
2569
+ **Service**
2570
+
2571
+ ### Authorization
2572
+
2573
+ No authorization required
2574
+
2575
+ ### HTTP request headers
2576
+
2577
+ - **Content-Type**: application/json
2578
+ - **Accept**: application/json
2579
+
2580
+
2581
+ ### HTTP response details
2582
+ | Status code | Description | Response headers |
2583
+ |-------------|-------------|------------------|
2584
+ |**200** | Service | - |
2585
+ |**400** | Bad Request | - |
2586
+ |**401** | Unauthorised | - |
2587
+ |**403** | Access Denied | - |
2588
+
2589
+ [[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)
2590
+
2591
+ # **postGetCallTariffPlan**
2592
+ > CallTariffPlan postGetCallTariffPlan(putGetCallTariffPlanRequest)
2593
+
2594
+ Add Call Tariff
2595
+
2596
+ ### Example
2597
+
2598
+ ```typescript
2599
+ import {
2600
+ BillingApi,
2601
+ Configuration,
2602
+ PutGetCallTariffPlanRequest
2603
+ } from 'yellowgrid-api-ts';
2604
+
2605
+ const configuration = new Configuration();
2606
+ const apiInstance = new BillingApi(configuration);
2607
+
2608
+ let putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest; //
2609
+
2610
+ const { status, data } = await apiInstance.postGetCallTariffPlan(
2611
+ putGetCallTariffPlanRequest
2612
+ );
2613
+ ```
2614
+
2615
+ ### Parameters
2616
+
2617
+ |Name | Type | Description | Notes|
2618
+ |------------- | ------------- | ------------- | -------------|
2619
+ | **putGetCallTariffPlanRequest** | **PutGetCallTariffPlanRequest**| | |
2620
+
2621
+
2622
+ ### Return type
2623
+
2624
+ **CallTariffPlan**
2625
+
2626
+ ### Authorization
2627
+
2628
+ No authorization required
2629
+
2630
+ ### HTTP request headers
2631
+
2632
+ - **Content-Type**: application/json
2633
+ - **Accept**: application/json
2634
+
2635
+
2636
+ ### HTTP response details
2637
+ | Status code | Description | Response headers |
2638
+ |-------------|-------------|------------------|
2639
+ |**200** | Call Tariff Plan | - |
2640
+ |**400** | Bad Request | - |
2641
+ |**401** | Unauthorised | - |
2642
+ |**403** | Access Denied | - |
2643
+
2644
+ [[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)
2645
+
2646
+ # **postGetConnections**
2647
+ > OutboundCli postGetConnections()
2648
+
2649
+ Add Connection
2650
+
2651
+ ### Example
2652
+
2653
+ ```typescript
2654
+ import {
2655
+ BillingApi,
2656
+ Configuration,
2657
+ ConnectionRequest
2658
+ } from 'yellowgrid-api-ts';
2659
+
2660
+ const configuration = new Configuration();
2661
+ const apiInstance = new BillingApi(configuration);
2662
+
2663
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2664
+ let connectionRequest: ConnectionRequest; // (optional)
2665
+
2666
+ const { status, data } = await apiInstance.postGetConnections(
2667
+ billCustomerId,
2668
+ connectionRequest
2669
+ );
2670
+ ```
2671
+
2672
+ ### Parameters
2673
+
2674
+ |Name | Type | Description | Notes|
2675
+ |------------- | ------------- | ------------- | -------------|
2676
+ | **connectionRequest** | **ConnectionRequest**| | |
2677
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2678
+
2679
+
2680
+ ### Return type
2681
+
2682
+ **OutboundCli**
2683
+
2684
+ ### Authorization
2685
+
2686
+ No authorization required
2687
+
2688
+ ### HTTP request headers
2689
+
2690
+ - **Content-Type**: application/json
2691
+ - **Accept**: application/json
2692
+
2693
+
2694
+ ### HTTP response details
2695
+ | Status code | Description | Response headers |
2696
+ |-------------|-------------|------------------|
2697
+ |**200** | Connection | - |
2698
+ |**400** | Bad Request | - |
2699
+ |**401** | Unauthorised | - |
2700
+ |**403** | Access Denied | - |
2701
+
2702
+ [[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)
2703
+
2704
+ # **postGetPriceGroups**
2705
+ > PriceGroup postGetPriceGroups(postGetPriceGroupsRequest)
2706
+
2707
+ Add Price Group
2708
+
2709
+ ### Example
2710
+
2711
+ ```typescript
2712
+ import {
2713
+ BillingApi,
2714
+ Configuration,
2715
+ PostGetPriceGroupsRequest
2716
+ } from 'yellowgrid-api-ts';
2717
+
2718
+ const configuration = new Configuration();
2719
+ const apiInstance = new BillingApi(configuration);
2720
+
2721
+ let postGetPriceGroupsRequest: PostGetPriceGroupsRequest; //
2722
+
2723
+ const { status, data } = await apiInstance.postGetPriceGroups(
2724
+ postGetPriceGroupsRequest
2725
+ );
2726
+ ```
2727
+
2728
+ ### Parameters
2729
+
2730
+ |Name | Type | Description | Notes|
2731
+ |------------- | ------------- | ------------- | -------------|
2732
+ | **postGetPriceGroupsRequest** | **PostGetPriceGroupsRequest**| | |
2733
+
2734
+
2735
+ ### Return type
2736
+
2737
+ **PriceGroup**
2738
+
2739
+ ### Authorization
2740
+
2741
+ No authorization required
2742
+
2743
+ ### HTTP request headers
2744
+
2745
+ - **Content-Type**: application/json
2746
+ - **Accept**: application/json
2747
+
2748
+
2749
+ ### HTTP response details
2750
+ | Status code | Description | Response headers |
2751
+ |-------------|-------------|------------------|
2752
+ |**200** | Price Group | - |
2753
+ |**400** | Bad Request | - |
2754
+ |**401** | Unauthorised | - |
2755
+ |**403** | Access Denied | - |
2756
+
2757
+ [[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)
2758
+
2759
+ # **postGetServicePlans**
2760
+ > ServicePlan postGetServicePlans(postGetServicePlansRequest)
2761
+
2762
+ Add Service Plan
2763
+
2764
+ ### Example
2765
+
2766
+ ```typescript
2767
+ import {
2768
+ BillingApi,
2769
+ Configuration,
2770
+ PostGetServicePlansRequest
2771
+ } from 'yellowgrid-api-ts';
2772
+
2773
+ const configuration = new Configuration();
2774
+ const apiInstance = new BillingApi(configuration);
2775
+
2776
+ let postGetServicePlansRequest: PostGetServicePlansRequest; //
2777
+
2778
+ const { status, data } = await apiInstance.postGetServicePlans(
2779
+ postGetServicePlansRequest
2780
+ );
2781
+ ```
2782
+
2783
+ ### Parameters
2784
+
2785
+ |Name | Type | Description | Notes|
2786
+ |------------- | ------------- | ------------- | -------------|
2787
+ | **postGetServicePlansRequest** | **PostGetServicePlansRequest**| | |
2788
+
2789
+
2790
+ ### Return type
2791
+
2792
+ **ServicePlan**
2793
+
2794
+ ### Authorization
2795
+
2796
+ No authorization required
2797
+
2798
+ ### HTTP request headers
2799
+
2800
+ - **Content-Type**: application/json
2801
+ - **Accept**: application/json
2802
+
2803
+
2804
+ ### HTTP response details
2805
+ | Status code | Description | Response headers |
2806
+ |-------------|-------------|------------------|
2807
+ |**200** | Service Plan | - |
2808
+ |**400** | Bad Request | - |
2809
+ |**401** | Unauthorised | - |
2810
+ |**403** | Access Denied | - |
2811
+
2812
+ [[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)
2813
+
2814
+ # **postGetSipTrunksBilling**
2815
+ > OutboundCli postGetSipTrunksBilling(postGetSipTrunksBillingRequest)
2816
+
2817
+ Add SIP Trunk billing
2818
+
2819
+ ### Example
2820
+
2821
+ ```typescript
2822
+ import {
2823
+ BillingApi,
2824
+ Configuration,
2825
+ PostGetSipTrunksBillingRequest
2826
+ } from 'yellowgrid-api-ts';
2827
+
2828
+ const configuration = new Configuration();
2829
+ const apiInstance = new BillingApi(configuration);
2830
+
2831
+ let postGetSipTrunksBillingRequest: PostGetSipTrunksBillingRequest; //
2832
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2833
+
2834
+ const { status, data } = await apiInstance.postGetSipTrunksBilling(
2835
+ postGetSipTrunksBillingRequest,
2836
+ billCustomerId
2837
+ );
2838
+ ```
2839
+
2840
+ ### Parameters
2841
+
2842
+ |Name | Type | Description | Notes|
2843
+ |------------- | ------------- | ------------- | -------------|
2844
+ | **postGetSipTrunksBillingRequest** | **PostGetSipTrunksBillingRequest**| | |
2845
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2846
+
2847
+
2848
+ ### Return type
2849
+
2850
+ **OutboundCli**
2851
+
2852
+ ### Authorization
2853
+
2854
+ No authorization required
2855
+
2856
+ ### HTTP request headers
2857
+
2858
+ - **Content-Type**: application/json
2859
+ - **Accept**: application/json
2860
+
2861
+
2862
+ ### HTTP response details
2863
+ | Status code | Description | Response headers |
2864
+ |-------------|-------------|------------------|
2865
+ |**200** | Connection | - |
2866
+ |**400** | Bad Request | - |
2867
+ |**401** | Unauthorised | - |
2868
+ |**403** | Access Denied | - |
2869
+
2870
+ [[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)
2871
+
2872
+ # **postSendInvoices**
2873
+ > string postSendInvoices()
2874
+
2875
+ Send Invoices
2876
+
2877
+ ### Example
2878
+
2879
+ ```typescript
2880
+ import {
2881
+ BillingApi,
2882
+ Configuration
2883
+ } from 'yellowgrid-api-ts';
2884
+
2885
+ const configuration = new Configuration();
2886
+ const apiInstance = new BillingApi(configuration);
2887
+
2888
+ const { status, data } = await apiInstance.postSendInvoices();
2889
+ ```
2890
+
2891
+ ### Parameters
2892
+ This endpoint does not have any parameters.
2893
+
2894
+
2895
+ ### Return type
2896
+
2897
+ **string**
2898
+
2899
+ ### Authorization
2900
+
2901
+ No authorization required
2902
+
2903
+ ### HTTP request headers
2904
+
2905
+ - **Content-Type**: Not defined
2906
+ - **Accept**: application/json
2907
+
2908
+
2909
+ ### HTTP response details
2910
+ | Status code | Description | Response headers |
2911
+ |-------------|-------------|------------------|
2912
+ |**200** | Time Started | - |
2913
+ |**400** | Bad Request | - |
2914
+ |**401** | Unauthorised | - |
2915
+ |**403** | Access Denied | - |
2916
+
2917
+ [[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)
2918
+
2919
+ # **postUpdateConnection**
2920
+ > object postUpdateConnection(postUpdateConnectionRequest)
2921
+
2922
+ Update Connection
2923
+
2924
+ ### Example
2925
+
2926
+ ```typescript
2927
+ import {
2928
+ BillingApi,
2929
+ Configuration,
2930
+ PostUpdateConnectionRequest
2931
+ } from 'yellowgrid-api-ts';
2932
+
2933
+ const configuration = new Configuration();
2934
+ const apiInstance = new BillingApi(configuration);
2935
+
2936
+ let postUpdateConnectionRequest: PostUpdateConnectionRequest; //
2937
+ let connectionId: number; //Connection ID (optional) (default to undefined)
2938
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2939
+
2940
+ const { status, data } = await apiInstance.postUpdateConnection(
2941
+ postUpdateConnectionRequest,
2942
+ connectionId,
2943
+ billCustomerId
2944
+ );
2945
+ ```
2946
+
2947
+ ### Parameters
2948
+
2949
+ |Name | Type | Description | Notes|
2950
+ |------------- | ------------- | ------------- | -------------|
2951
+ | **postUpdateConnectionRequest** | **PostUpdateConnectionRequest**| | |
2952
+ | **connectionId** | [**number**] | Connection ID | (optional) defaults to undefined|
2953
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2954
+
2955
+
2956
+ ### Return type
2957
+
2958
+ **object**
2959
+
2960
+ ### Authorization
2961
+
2962
+ No authorization required
2963
+
2964
+ ### HTTP request headers
2965
+
2966
+ - **Content-Type**: application/json
2967
+ - **Accept**: application/json
2968
+
2969
+
2970
+ ### HTTP response details
2971
+ | Status code | Description | Response headers |
2972
+ |-------------|-------------|------------------|
2973
+ |**200** | Changes | - |
2974
+ |**400** | Bad Request | - |
2975
+ |**401** | Unauthorised | - |
2976
+ |**403** | Access Denied | - |
2977
+
2978
+ [[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)
2979
+
2980
+ # **postUpdateRecurringCharge**
2981
+ > RecurringCharge postUpdateRecurringCharge(postUpdateRecurringChargeRequest)
2982
+
2983
+ Update Recurring Charge
2984
+
2985
+ ### Example
2986
+
2987
+ ```typescript
2988
+ import {
2989
+ BillingApi,
2990
+ Configuration,
2991
+ PostUpdateRecurringChargeRequest
2992
+ } from 'yellowgrid-api-ts';
2993
+
2994
+ const configuration = new Configuration();
2995
+ const apiInstance = new BillingApi(configuration);
2996
+
2997
+ let id: number; //Recurring Charge ID (default to undefined)
2998
+ let postUpdateRecurringChargeRequest: PostUpdateRecurringChargeRequest; //
2999
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3000
+
3001
+ const { status, data } = await apiInstance.postUpdateRecurringCharge(
3002
+ id,
3003
+ postUpdateRecurringChargeRequest,
3004
+ billCustomerId
3005
+ );
3006
+ ```
3007
+
3008
+ ### Parameters
3009
+
3010
+ |Name | Type | Description | Notes|
3011
+ |------------- | ------------- | ------------- | -------------|
3012
+ | **postUpdateRecurringChargeRequest** | **PostUpdateRecurringChargeRequest**| | |
3013
+ | **id** | [**number**] | Recurring Charge ID | defaults to undefined|
3014
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3015
+
3016
+
3017
+ ### Return type
3018
+
3019
+ **RecurringCharge**
3020
+
3021
+ ### Authorization
3022
+
3023
+ No authorization required
3024
+
3025
+ ### HTTP request headers
3026
+
3027
+ - **Content-Type**: application/json
3028
+ - **Accept**: application/json
3029
+
3030
+
3031
+ ### HTTP response details
3032
+ | Status code | Description | Response headers |
3033
+ |-------------|-------------|------------------|
3034
+ |**200** | Recurring Charge | - |
3035
+ |**400** | Bad Request | - |
3036
+ |**401** | Unauthorised | - |
3037
+ |**403** | Access Denied | - |
3038
+
3039
+ [[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)
3040
+
3041
+ # **putAddCallTariffToCallTariffPlan**
3042
+ > CallTariffPlan putAddCallTariffToCallTariffPlan(putAddCallTariffToCallTariffPlanRequest)
3043
+
3044
+ Update Call Tariff
3045
+
3046
+ ### Example
3047
+
3048
+ ```typescript
3049
+ import {
3050
+ BillingApi,
3051
+ Configuration,
3052
+ PutAddCallTariffToCallTariffPlanRequest
3053
+ } from 'yellowgrid-api-ts';
3054
+
3055
+ const configuration = new Configuration();
3056
+ const apiInstance = new BillingApi(configuration);
3057
+
3058
+ let callTariffPlanId: number; //Call Tariff ID (default to undefined)
3059
+ let putAddCallTariffToCallTariffPlanRequest: PutAddCallTariffToCallTariffPlanRequest; //
3060
+
3061
+ const { status, data } = await apiInstance.putAddCallTariffToCallTariffPlan(
3062
+ callTariffPlanId,
3063
+ putAddCallTariffToCallTariffPlanRequest
3064
+ );
3065
+ ```
3066
+
3067
+ ### Parameters
3068
+
3069
+ |Name | Type | Description | Notes|
3070
+ |------------- | ------------- | ------------- | -------------|
3071
+ | **putAddCallTariffToCallTariffPlanRequest** | **PutAddCallTariffToCallTariffPlanRequest**| | |
3072
+ | **callTariffPlanId** | [**number**] | Call Tariff ID | defaults to undefined|
3073
+
3074
+
3075
+ ### Return type
3076
+
3077
+ **CallTariffPlan**
3078
+
3079
+ ### Authorization
3080
+
3081
+ No authorization required
3082
+
3083
+ ### HTTP request headers
3084
+
3085
+ - **Content-Type**: application/json
3086
+ - **Accept**: application/json
3087
+
3088
+
3089
+ ### HTTP response details
3090
+ | Status code | Description | Response headers |
3091
+ |-------------|-------------|------------------|
3092
+ |**200** | Call Tariff Plan | - |
3093
+ |**400** | Bad Request | - |
3094
+ |**401** | Unauthorised | - |
3095
+ |**403** | Access Denied | - |
3096
+
3097
+ [[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)
3098
+
3099
+ # **putAddServiceToServicePlan**
3100
+ > Service putAddServiceToServicePlan(putAddServiceToServicePlanRequest)
3101
+
3102
+ Update Service
3103
+
3104
+ ### Example
3105
+
3106
+ ```typescript
3107
+ import {
3108
+ BillingApi,
3109
+ Configuration,
3110
+ PutAddServiceToServicePlanRequest
3111
+ } from 'yellowgrid-api-ts';
3112
+
3113
+ const configuration = new Configuration();
3114
+ const apiInstance = new BillingApi(configuration);
3115
+
3116
+ let id: number; //Service ID (default to undefined)
3117
+ let putAddServiceToServicePlanRequest: PutAddServiceToServicePlanRequest; //
3118
+
3119
+ const { status, data } = await apiInstance.putAddServiceToServicePlan(
3120
+ id,
3121
+ putAddServiceToServicePlanRequest
3122
+ );
3123
+ ```
3124
+
3125
+ ### Parameters
3126
+
3127
+ |Name | Type | Description | Notes|
3128
+ |------------- | ------------- | ------------- | -------------|
3129
+ | **putAddServiceToServicePlanRequest** | **PutAddServiceToServicePlanRequest**| | |
3130
+ | **id** | [**number**] | Service ID | defaults to undefined|
3131
+
3132
+
3133
+ ### Return type
3134
+
3135
+ **Service**
3136
+
3137
+ ### Authorization
3138
+
3139
+ No authorization required
3140
+
3141
+ ### HTTP request headers
3142
+
3143
+ - **Content-Type**: application/json
3144
+ - **Accept**: application/json
3145
+
3146
+
3147
+ ### HTTP response details
3148
+ | Status code | Description | Response headers |
3149
+ |-------------|-------------|------------------|
3150
+ |**200** | Service | - |
3151
+ |**400** | Bad Request | - |
3152
+ |**401** | Unauthorised | - |
3153
+ |**403** | Access Denied | - |
3154
+
3155
+ [[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)
3156
+
3157
+ # **putConnectionSearch**
3158
+ > OutboundCli putConnectionSearch(putConnectionSearchRequest)
3159
+
3160
+ Transfer Billing Connection
3161
+
3162
+ ### Example
3163
+
3164
+ ```typescript
3165
+ import {
3166
+ BillingApi,
3167
+ Configuration,
3168
+ PutConnectionSearchRequest
3169
+ } from 'yellowgrid-api-ts';
3170
+
3171
+ const configuration = new Configuration();
3172
+ const apiInstance = new BillingApi(configuration);
3173
+
3174
+ let putConnectionSearchRequest: PutConnectionSearchRequest; //Transfer Request
3175
+ let id: number; //Connection ID (optional) (default to undefined)
3176
+ let cli: string; //CLI (optional) (default to undefined)
3177
+ let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
3178
+
3179
+ const { status, data } = await apiInstance.putConnectionSearch(
3180
+ putConnectionSearchRequest,
3181
+ id,
3182
+ cli,
3183
+ skipDDis
3184
+ );
3185
+ ```
3186
+
3187
+ ### Parameters
3188
+
3189
+ |Name | Type | Description | Notes|
3190
+ |------------- | ------------- | ------------- | -------------|
3191
+ | **putConnectionSearchRequest** | **PutConnectionSearchRequest**| Transfer Request | |
3192
+ | **id** | [**number**] | Connection ID | (optional) defaults to undefined|
3193
+ | **cli** | [**string**] | CLI | (optional) defaults to undefined|
3194
+ | **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
3195
+
3196
+
3197
+ ### Return type
3198
+
3199
+ **OutboundCli**
3200
+
3201
+ ### Authorization
3202
+
3203
+ No authorization required
3204
+
3205
+ ### HTTP request headers
3206
+
3207
+ - **Content-Type**: application/json
3208
+ - **Accept**: application/json
3209
+
3210
+
3211
+ ### HTTP response details
3212
+ | Status code | Description | Response headers |
3213
+ |-------------|-------------|------------------|
3214
+ |**200** | Connection | - |
3215
+ |**400** | Bad Request | - |
3216
+ |**401** | Unauthorised | - |
3217
+ |**403** | Access Denied | - |
3218
+
3219
+ [[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)
3220
+
3221
+ # **putConvertChildToParent**
3222
+ > Customer putConvertChildToParent()
3223
+
3224
+ Convert Child To Parent
3225
+
3226
+ ### Example
3227
+
3228
+ ```typescript
3229
+ import {
3230
+ BillingApi,
3231
+ Configuration
3232
+ } from 'yellowgrid-api-ts';
3233
+
3234
+ const configuration = new Configuration();
3235
+ const apiInstance = new BillingApi(configuration);
3236
+
3237
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3238
+
3239
+ const { status, data } = await apiInstance.putConvertChildToParent(
3240
+ billCustomerId
3241
+ );
3242
+ ```
3243
+
3244
+ ### Parameters
3245
+
3246
+ |Name | Type | Description | Notes|
3247
+ |------------- | ------------- | ------------- | -------------|
3248
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3249
+
3250
+
3251
+ ### Return type
3252
+
3253
+ **Customer**
3254
+
3255
+ ### Authorization
3256
+
3257
+ No authorization required
3258
+
3259
+ ### HTTP request headers
3260
+
3261
+ - **Content-Type**: Not defined
3262
+ - **Accept**: application/json
3263
+
3264
+
3265
+ ### HTTP response details
3266
+ | Status code | Description | Response headers |
3267
+ |-------------|-------------|------------------|
3268
+ |**200** | Customer | - |
3269
+ |**400** | Bad Request | - |
3270
+ |**401** | Unauthorised | - |
3271
+ |**403** | Access Denied | - |
3272
+
3273
+ [[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)
3274
+
3275
+ # **putDisableBundles**
3276
+ > boolean putDisableBundles()
3277
+
3278
+ Disable Bundles
3279
+
3280
+ ### Example
3281
+
3282
+ ```typescript
3283
+ import {
3284
+ BillingApi,
3285
+ Configuration
3286
+ } from 'yellowgrid-api-ts';
3287
+
3288
+ const configuration = new Configuration();
3289
+ const apiInstance = new BillingApi(configuration);
3290
+
3291
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3292
+
3293
+ const { status, data } = await apiInstance.putDisableBundles(
3294
+ billCustomerId
3295
+ );
3296
+ ```
3297
+
3298
+ ### Parameters
3299
+
3300
+ |Name | Type | Description | Notes|
3301
+ |------------- | ------------- | ------------- | -------------|
3302
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3303
+
3304
+
3305
+ ### Return type
3306
+
3307
+ **boolean**
3308
+
3309
+ ### Authorization
3310
+
3311
+ No authorization required
3312
+
3313
+ ### HTTP request headers
3314
+
3315
+ - **Content-Type**: Not defined
3316
+ - **Accept**: application/json
3317
+
3318
+
3319
+ ### HTTP response details
3320
+ | Status code | Description | Response headers |
3321
+ |-------------|-------------|------------------|
3322
+ |**200** | Successful | - |
3323
+ |**400** | Bad Request | - |
3324
+ |**401** | Unauthorised | - |
3325
+ |**403** | Access Denied | - |
3326
+
3327
+ [[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)
3328
+
3329
+ # **putDisableDdiBilling**
3330
+ > boolean putDisableDdiBilling()
3331
+
3332
+ Disable DDI Billing
14
3333
 
15
3334
  ### Example
16
3335
 
@@ -23,16 +3342,23 @@ import {
23
3342
  const configuration = new Configuration();
24
3343
  const apiInstance = new BillingApi(configuration);
25
3344
 
26
- const { status, data } = await apiInstance.getGetAllCustomer();
3345
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3346
+
3347
+ const { status, data } = await apiInstance.putDisableDdiBilling(
3348
+ billCustomerId
3349
+ );
27
3350
  ```
28
3351
 
29
3352
  ### Parameters
30
- This endpoint does not have any parameters.
3353
+
3354
+ |Name | Type | Description | Notes|
3355
+ |------------- | ------------- | ------------- | -------------|
3356
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
31
3357
 
32
3358
 
33
3359
  ### Return type
34
3360
 
35
- **{ [key: string]: { [key: string]: string; }; }**
3361
+ **boolean**
36
3362
 
37
3363
  ### Authorization
38
3364
 
@@ -47,17 +3373,125 @@ No authorization required
47
3373
  ### HTTP response details
48
3374
  | Status code | Description | Response headers |
49
3375
  |-------------|-------------|------------------|
50
- |**200** | Billing Customer List | - |
3376
+ |**200** | Successful | - |
51
3377
  |**400** | Bad Request | - |
52
3378
  |**401** | Unauthorised | - |
53
3379
  |**403** | Access Denied | - |
54
3380
 
55
3381
  [[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)
56
3382
 
57
- # **putTransferConnection**
58
- > object putTransferConnection(putTransferConnectionRequest)
3383
+ # **putEnableBundles**
3384
+ > boolean putEnableBundles()
59
3385
 
60
- Transfer Billing Connection
3386
+ Enable Bundles
3387
+
3388
+ ### Example
3389
+
3390
+ ```typescript
3391
+ import {
3392
+ BillingApi,
3393
+ Configuration
3394
+ } from 'yellowgrid-api-ts';
3395
+
3396
+ const configuration = new Configuration();
3397
+ const apiInstance = new BillingApi(configuration);
3398
+
3399
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3400
+
3401
+ const { status, data } = await apiInstance.putEnableBundles(
3402
+ billCustomerId
3403
+ );
3404
+ ```
3405
+
3406
+ ### Parameters
3407
+
3408
+ |Name | Type | Description | Notes|
3409
+ |------------- | ------------- | ------------- | -------------|
3410
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3411
+
3412
+
3413
+ ### Return type
3414
+
3415
+ **boolean**
3416
+
3417
+ ### Authorization
3418
+
3419
+ No authorization required
3420
+
3421
+ ### HTTP request headers
3422
+
3423
+ - **Content-Type**: Not defined
3424
+ - **Accept**: application/json
3425
+
3426
+
3427
+ ### HTTP response details
3428
+ | Status code | Description | Response headers |
3429
+ |-------------|-------------|------------------|
3430
+ |**200** | Successful | - |
3431
+ |**400** | Bad Request | - |
3432
+ |**401** | Unauthorised | - |
3433
+ |**403** | Access Denied | - |
3434
+
3435
+ [[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)
3436
+
3437
+ # **putEnableDdiBilling**
3438
+ > boolean putEnableDdiBilling()
3439
+
3440
+ Enable DDI Billing
3441
+
3442
+ ### Example
3443
+
3444
+ ```typescript
3445
+ import {
3446
+ BillingApi,
3447
+ Configuration
3448
+ } from 'yellowgrid-api-ts';
3449
+
3450
+ const configuration = new Configuration();
3451
+ const apiInstance = new BillingApi(configuration);
3452
+
3453
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3454
+
3455
+ const { status, data } = await apiInstance.putEnableDdiBilling(
3456
+ billCustomerId
3457
+ );
3458
+ ```
3459
+
3460
+ ### Parameters
3461
+
3462
+ |Name | Type | Description | Notes|
3463
+ |------------- | ------------- | ------------- | -------------|
3464
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3465
+
3466
+
3467
+ ### Return type
3468
+
3469
+ **boolean**
3470
+
3471
+ ### Authorization
3472
+
3473
+ No authorization required
3474
+
3475
+ ### HTTP request headers
3476
+
3477
+ - **Content-Type**: Not defined
3478
+ - **Accept**: application/json
3479
+
3480
+
3481
+ ### HTTP response details
3482
+ | Status code | Description | Response headers |
3483
+ |-------------|-------------|------------------|
3484
+ |**200** | Successful | - |
3485
+ |**400** | Bad Request | - |
3486
+ |**401** | Unauthorised | - |
3487
+ |**403** | Access Denied | - |
3488
+
3489
+ [[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)
3490
+
3491
+ # **putGetBaseServices**
3492
+ > BaseService putGetBaseServices(putGetBaseServicesRequest)
3493
+
3494
+ Update Base Service
61
3495
 
62
3496
  ### Example
63
3497
 
@@ -65,22 +3499,18 @@ Transfer Billing Connection
65
3499
  import {
66
3500
  BillingApi,
67
3501
  Configuration,
68
- PutTransferConnectionRequest
3502
+ PutGetBaseServicesRequest
69
3503
  } from 'yellowgrid-api-ts';
70
3504
 
71
3505
  const configuration = new Configuration();
72
3506
  const apiInstance = new BillingApi(configuration);
73
3507
 
74
- let putTransferConnectionRequest: PutTransferConnectionRequest; //Transfer Request
75
- let id: number; //Connection ID (optional) (default to undefined)
76
- let cli: string; //CLI (optional) (default to undefined)
77
- let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
3508
+ let baseServiceId: number; //Base Service Plan ID (default to undefined)
3509
+ let putGetBaseServicesRequest: PutGetBaseServicesRequest; //
78
3510
 
79
- const { status, data } = await apiInstance.putTransferConnection(
80
- putTransferConnectionRequest,
81
- id,
82
- cli,
83
- skipDDis
3511
+ const { status, data } = await apiInstance.putGetBaseServices(
3512
+ baseServiceId,
3513
+ putGetBaseServicesRequest
84
3514
  );
85
3515
  ```
86
3516
 
@@ -88,15 +3518,190 @@ const { status, data } = await apiInstance.putTransferConnection(
88
3518
 
89
3519
  |Name | Type | Description | Notes|
90
3520
  |------------- | ------------- | ------------- | -------------|
91
- | **putTransferConnectionRequest** | **PutTransferConnectionRequest**| Transfer Request | |
92
- | **id** | [**number**] | Connection ID | (optional) defaults to undefined|
93
- | **cli** | [**string**] | CLI | (optional) defaults to undefined|
94
- | **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
3521
+ | **putGetBaseServicesRequest** | **PutGetBaseServicesRequest**| | |
3522
+ | **baseServiceId** | [**number**] | Base Service Plan ID | defaults to undefined|
95
3523
 
96
3524
 
97
3525
  ### Return type
98
3526
 
99
- **object**
3527
+ **BaseService**
3528
+
3529
+ ### Authorization
3530
+
3531
+ No authorization required
3532
+
3533
+ ### HTTP request headers
3534
+
3535
+ - **Content-Type**: application/json
3536
+ - **Accept**: application/json
3537
+
3538
+
3539
+ ### HTTP response details
3540
+ | Status code | Description | Response headers |
3541
+ |-------------|-------------|------------------|
3542
+ |**200** | Base Service | - |
3543
+ |**400** | Bad Request | - |
3544
+ |**401** | Unauthorised | - |
3545
+ |**403** | Access Denied | - |
3546
+
3547
+ [[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)
3548
+
3549
+ # **putGetCallTariffPlan**
3550
+ > CallTariffPlan putGetCallTariffPlan(putGetCallTariffPlanRequest)
3551
+
3552
+ Update Call Tariff
3553
+
3554
+ ### Example
3555
+
3556
+ ```typescript
3557
+ import {
3558
+ BillingApi,
3559
+ Configuration,
3560
+ PutGetCallTariffPlanRequest
3561
+ } from 'yellowgrid-api-ts';
3562
+
3563
+ const configuration = new Configuration();
3564
+ const apiInstance = new BillingApi(configuration);
3565
+
3566
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
3567
+ let putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest; //
3568
+
3569
+ const { status, data } = await apiInstance.putGetCallTariffPlan(
3570
+ callTariffPlanId,
3571
+ putGetCallTariffPlanRequest
3572
+ );
3573
+ ```
3574
+
3575
+ ### Parameters
3576
+
3577
+ |Name | Type | Description | Notes|
3578
+ |------------- | ------------- | ------------- | -------------|
3579
+ | **putGetCallTariffPlanRequest** | **PutGetCallTariffPlanRequest**| | |
3580
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
3581
+
3582
+
3583
+ ### Return type
3584
+
3585
+ **CallTariffPlan**
3586
+
3587
+ ### Authorization
3588
+
3589
+ No authorization required
3590
+
3591
+ ### HTTP request headers
3592
+
3593
+ - **Content-Type**: application/json
3594
+ - **Accept**: application/json
3595
+
3596
+
3597
+ ### HTTP response details
3598
+ | Status code | Description | Response headers |
3599
+ |-------------|-------------|------------------|
3600
+ |**200** | Call Tariff Plan | - |
3601
+ |**400** | Bad Request | - |
3602
+ |**401** | Unauthorised | - |
3603
+ |**403** | Access Denied | - |
3604
+
3605
+ [[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)
3606
+
3607
+ # **putGetConnections**
3608
+ > OutboundCli putGetConnections()
3609
+
3610
+ Update Connection
3611
+
3612
+ ### Example
3613
+
3614
+ ```typescript
3615
+ import {
3616
+ BillingApi,
3617
+ Configuration,
3618
+ ConnectionRequest
3619
+ } from 'yellowgrid-api-ts';
3620
+
3621
+ const configuration = new Configuration();
3622
+ const apiInstance = new BillingApi(configuration);
3623
+
3624
+ let connectionId: number; //Connection ID (default to undefined)
3625
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3626
+ let connectionRequest: ConnectionRequest; // (optional)
3627
+
3628
+ const { status, data } = await apiInstance.putGetConnections(
3629
+ connectionId,
3630
+ billCustomerId,
3631
+ connectionRequest
3632
+ );
3633
+ ```
3634
+
3635
+ ### Parameters
3636
+
3637
+ |Name | Type | Description | Notes|
3638
+ |------------- | ------------- | ------------- | -------------|
3639
+ | **connectionRequest** | **ConnectionRequest**| | |
3640
+ | **connectionId** | [**number**] | Connection ID | defaults to undefined|
3641
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3642
+
3643
+
3644
+ ### Return type
3645
+
3646
+ **OutboundCli**
3647
+
3648
+ ### Authorization
3649
+
3650
+ No authorization required
3651
+
3652
+ ### HTTP request headers
3653
+
3654
+ - **Content-Type**: application/json
3655
+ - **Accept**: application/json
3656
+
3657
+
3658
+ ### HTTP response details
3659
+ | Status code | Description | Response headers |
3660
+ |-------------|-------------|------------------|
3661
+ |**200** | Connection | - |
3662
+ |**400** | Bad Request | - |
3663
+ |**401** | Unauthorised | - |
3664
+ |**403** | Access Denied | - |
3665
+
3666
+ [[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)
3667
+
3668
+ # **putGetPriceGroups**
3669
+ > PriceGroup putGetPriceGroups(putGetPriceGroupsRequest)
3670
+
3671
+ Update Price Group
3672
+
3673
+ ### Example
3674
+
3675
+ ```typescript
3676
+ import {
3677
+ BillingApi,
3678
+ Configuration,
3679
+ PutGetPriceGroupsRequest
3680
+ } from 'yellowgrid-api-ts';
3681
+
3682
+ const configuration = new Configuration();
3683
+ const apiInstance = new BillingApi(configuration);
3684
+
3685
+ let priceGroupId: number; //Price Group ID (default to undefined)
3686
+ let putGetPriceGroupsRequest: PutGetPriceGroupsRequest; //
3687
+
3688
+ const { status, data } = await apiInstance.putGetPriceGroups(
3689
+ priceGroupId,
3690
+ putGetPriceGroupsRequest
3691
+ );
3692
+ ```
3693
+
3694
+ ### Parameters
3695
+
3696
+ |Name | Type | Description | Notes|
3697
+ |------------- | ------------- | ------------- | -------------|
3698
+ | **putGetPriceGroupsRequest** | **PutGetPriceGroupsRequest**| | |
3699
+ | **priceGroupId** | [**number**] | Price Group ID | defaults to undefined|
3700
+
3701
+
3702
+ ### Return type
3703
+
3704
+ **PriceGroup**
100
3705
 
101
3706
  ### Authorization
102
3707
 
@@ -111,7 +3716,7 @@ No authorization required
111
3716
  ### HTTP response details
112
3717
  | Status code | Description | Response headers |
113
3718
  |-------------|-------------|------------------|
114
- |**200** | Billing Connection | - |
3719
+ |**200** | Price Group | - |
115
3720
  |**400** | Bad Request | - |
116
3721
  |**401** | Unauthorised | - |
117
3722
  |**403** | Access Denied | - |