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