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