yellowgrid-api-ts 3.2.220 → 3.2.221-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 +19899 -6358
  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 +15486 -4967
  10. package/dist/api.js +7444 -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 +3511 -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,3215 @@
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
+ const { status, data } = await apiInstance.getGetServicesPlanDetails();
1727
+ ```
1728
+
1729
+ ### Parameters
1730
+ This endpoint does not have any parameters.
1731
+
1732
+
1733
+ ### Return type
1734
+
1735
+ **Array<ServicePlan>**
1736
+
1737
+ ### Authorization
1738
+
1739
+ No authorization required
1740
+
1741
+ ### HTTP request headers
1742
+
1743
+ - **Content-Type**: Not defined
1744
+ - **Accept**: application/json
1745
+
1746
+
1747
+ ### HTTP response details
1748
+ | Status code | Description | Response headers |
1749
+ |-------------|-------------|------------------|
1750
+ |**200** | Service Plan | - |
1751
+ |**400** | Bad Request | - |
1752
+ |**401** | Unauthorised | - |
1753
+ |**403** | Access Denied | - |
1754
+
1755
+ [[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)
1756
+
1757
+ # **getGetSipTrunkList**
1758
+ > Array<Array<string>> getGetSipTrunkList()
1759
+
1760
+ Get SIP Trunk List
1761
+
1762
+ ### Example
1763
+
1764
+ ```typescript
1765
+ import {
1766
+ BillingApi,
1767
+ Configuration
1768
+ } from 'yellowgrid-api-ts';
1769
+
1770
+ const configuration = new Configuration();
1771
+ const apiInstance = new BillingApi(configuration);
1772
+
1773
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1774
+
1775
+ const { status, data } = await apiInstance.getGetSipTrunkList(
1776
+ billCustomerId
1777
+ );
1778
+ ```
1779
+
1780
+ ### Parameters
1781
+
1782
+ |Name | Type | Description | Notes|
1783
+ |------------- | ------------- | ------------- | -------------|
1784
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1785
+
1786
+
1787
+ ### Return type
1788
+
1789
+ **Array<Array<string>>**
1790
+
1791
+ ### Authorization
1792
+
1793
+ No authorization required
1794
+
1795
+ ### HTTP request headers
1796
+
1797
+ - **Content-Type**: Not defined
1798
+ - **Accept**: application/json
1799
+
1800
+
1801
+ ### HTTP response details
1802
+ | Status code | Description | Response headers |
1803
+ |-------------|-------------|------------------|
1804
+ |**200** | List Of SIP Trunks | - |
1805
+ |**400** | Bad Request | - |
1806
+ |**401** | Unauthorised | - |
1807
+ |**403** | Access Denied | - |
1808
+
1809
+ [[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)
1810
+
1811
+ # **getGetSipTrunksBilling**
1812
+ > Array<string> getGetSipTrunksBilling()
1813
+
1814
+ Get SIP Trunk Billing
1815
+
1816
+ ### Example
1817
+
1818
+ ```typescript
1819
+ import {
1820
+ BillingApi,
1821
+ Configuration
1822
+ } from 'yellowgrid-api-ts';
1823
+
1824
+ const configuration = new Configuration();
1825
+ const apiInstance = new BillingApi(configuration);
1826
+
1827
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1828
+
1829
+ const { status, data } = await apiInstance.getGetSipTrunksBilling(
1830
+ billCustomerId
1831
+ );
1832
+ ```
1833
+
1834
+ ### Parameters
1835
+
1836
+ |Name | Type | Description | Notes|
1837
+ |------------- | ------------- | ------------- | -------------|
1838
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1839
+
1840
+
1841
+ ### Return type
1842
+
1843
+ **Array<string>**
1844
+
1845
+ ### Authorization
1846
+
1847
+ No authorization required
1848
+
1849
+ ### HTTP request headers
1850
+
1851
+ - **Content-Type**: Not defined
1852
+ - **Accept**: application/json
1853
+
1854
+
1855
+ ### HTTP response details
1856
+ | Status code | Description | Response headers |
1857
+ |-------------|-------------|------------------|
1858
+ |**200** | Trunk References | - |
1859
+ |**400** | Bad Request | - |
1860
+ |**401** | Unauthorised | - |
1861
+ |**403** | Access Denied | - |
1862
+
1863
+ [[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)
1864
+
1865
+ # **getGetUnconnectedCalls**
1866
+ > Array<ProcessedCdr> getGetUnconnectedCalls()
1867
+
1868
+ Get Unconnected Calls
1869
+
1870
+ ### Example
1871
+
1872
+ ```typescript
1873
+ import {
1874
+ BillingApi,
1875
+ Configuration
1876
+ } from 'yellowgrid-api-ts';
1877
+
1878
+ const configuration = new Configuration();
1879
+ const apiInstance = new BillingApi(configuration);
1880
+
1881
+ const { status, data } = await apiInstance.getGetUnconnectedCalls();
1882
+ ```
1883
+
1884
+ ### Parameters
1885
+ This endpoint does not have any parameters.
1886
+
1887
+
1888
+ ### Return type
1889
+
1890
+ **Array<ProcessedCdr>**
1891
+
1892
+ ### Authorization
1893
+
1894
+ No authorization required
1895
+
1896
+ ### HTTP request headers
1897
+
1898
+ - **Content-Type**: Not defined
1899
+ - **Accept**: application/json
1900
+
1901
+
1902
+ ### HTTP response details
1903
+ | Status code | Description | Response headers |
1904
+ |-------------|-------------|------------------|
1905
+ |**200** | Process CDR | - |
1906
+ |**400** | Bad Request | - |
1907
+ |**401** | Unauthorised | - |
1908
+ |**403** | Access Denied | - |
1909
+
1910
+ [[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)
1911
+
1912
+ # **getGetUnconnectedServices**
1913
+ > Array<ProcessedCdr> getGetUnconnectedServices()
1914
+
1915
+ Get Unconnected Services
1916
+
1917
+ ### Example
1918
+
1919
+ ```typescript
1920
+ import {
1921
+ BillingApi,
1922
+ Configuration
1923
+ } from 'yellowgrid-api-ts';
1924
+
1925
+ const configuration = new Configuration();
1926
+ const apiInstance = new BillingApi(configuration);
1927
+
1928
+ const { status, data } = await apiInstance.getGetUnconnectedServices();
1929
+ ```
1930
+
1931
+ ### Parameters
1932
+ This endpoint does not have any parameters.
1933
+
1934
+
1935
+ ### Return type
1936
+
1937
+ **Array<ProcessedCdr>**
1938
+
1939
+ ### Authorization
1940
+
1941
+ No authorization required
1942
+
1943
+ ### HTTP request headers
1944
+
1945
+ - **Content-Type**: Not defined
1946
+ - **Accept**: application/json
1947
+
1948
+
1949
+ ### HTTP response details
1950
+ | Status code | Description | Response headers |
1951
+ |-------------|-------------|------------------|
1952
+ |**200** | Process CDR | - |
1953
+ |**400** | Bad Request | - |
1954
+ |**401** | Unauthorised | - |
1955
+ |**403** | Access Denied | - |
1956
+
1957
+ [[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)
1958
+
1959
+ # **getIsBundleCustomer**
1960
+ > boolean getIsBundleCustomer()
1961
+
1962
+ Is Bundle Customer
1963
+
1964
+ ### Example
1965
+
1966
+ ```typescript
1967
+ import {
1968
+ BillingApi,
1969
+ Configuration
1970
+ } from 'yellowgrid-api-ts';
1971
+
1972
+ const configuration = new Configuration();
1973
+ const apiInstance = new BillingApi(configuration);
1974
+
1975
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
1976
+
1977
+ const { status, data } = await apiInstance.getIsBundleCustomer(
1978
+ billCustomerId
1979
+ );
1980
+ ```
1981
+
1982
+ ### Parameters
1983
+
1984
+ |Name | Type | Description | Notes|
1985
+ |------------- | ------------- | ------------- | -------------|
1986
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
1987
+
1988
+
1989
+ ### Return type
1990
+
1991
+ **boolean**
1992
+
1993
+ ### Authorization
1994
+
1995
+ No authorization required
1996
+
1997
+ ### HTTP request headers
1998
+
1999
+ - **Content-Type**: Not defined
2000
+ - **Accept**: application/json
2001
+
2002
+
2003
+ ### HTTP response details
2004
+ | Status code | Description | Response headers |
2005
+ |-------------|-------------|------------------|
2006
+ |**200** | Successful | - |
2007
+ |**400** | Bad Request | - |
2008
+ |**401** | Unauthorised | - |
2009
+ |**403** | Access Denied | - |
2010
+
2011
+ [[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)
2012
+
2013
+ # **postAddBroadband**
2014
+ > OutboundCli postAddBroadband(postAddBroadbandRequest)
2015
+
2016
+ Add Broadband
2017
+
2018
+ ### Example
2019
+
2020
+ ```typescript
2021
+ import {
2022
+ BillingApi,
2023
+ Configuration,
2024
+ PostAddBroadbandRequest
2025
+ } from 'yellowgrid-api-ts';
2026
+
2027
+ const configuration = new Configuration();
2028
+ const apiInstance = new BillingApi(configuration);
2029
+
2030
+ let postAddBroadbandRequest: PostAddBroadbandRequest; //
2031
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2032
+
2033
+ const { status, data } = await apiInstance.postAddBroadband(
2034
+ postAddBroadbandRequest,
2035
+ billCustomerId
2036
+ );
2037
+ ```
2038
+
2039
+ ### Parameters
2040
+
2041
+ |Name | Type | Description | Notes|
2042
+ |------------- | ------------- | ------------- | -------------|
2043
+ | **postAddBroadbandRequest** | **PostAddBroadbandRequest**| | |
2044
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2045
+
2046
+
2047
+ ### Return type
2048
+
2049
+ **OutboundCli**
2050
+
2051
+ ### Authorization
2052
+
2053
+ No authorization required
2054
+
2055
+ ### HTTP request headers
2056
+
2057
+ - **Content-Type**: application/json
2058
+ - **Accept**: application/json
2059
+
2060
+
2061
+ ### HTTP response details
2062
+ | Status code | Description | Response headers |
2063
+ |-------------|-------------|------------------|
2064
+ |**200** | Connection | - |
2065
+ |**400** | Bad Request | - |
2066
+ |**401** | Unauthorised | - |
2067
+ |**403** | Access Denied | - |
2068
+
2069
+ [[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)
2070
+
2071
+ # **postAddCallTariffToCallTariffPlan**
2072
+ > CallTariffPlan postAddCallTariffToCallTariffPlan(postAddCallTariffToCallTariffPlanRequest)
2073
+
2074
+ Add Call Tariff To Call Tariff Plan
2075
+
2076
+ ### Example
2077
+
2078
+ ```typescript
2079
+ import {
2080
+ BillingApi,
2081
+ Configuration,
2082
+ PostAddCallTariffToCallTariffPlanRequest
2083
+ } from 'yellowgrid-api-ts';
2084
+
2085
+ const configuration = new Configuration();
2086
+ const apiInstance = new BillingApi(configuration);
2087
+
2088
+ let postAddCallTariffToCallTariffPlanRequest: PostAddCallTariffToCallTariffPlanRequest; //
2089
+
2090
+ const { status, data } = await apiInstance.postAddCallTariffToCallTariffPlan(
2091
+ postAddCallTariffToCallTariffPlanRequest
2092
+ );
2093
+ ```
2094
+
2095
+ ### Parameters
2096
+
2097
+ |Name | Type | Description | Notes|
2098
+ |------------- | ------------- | ------------- | -------------|
2099
+ | **postAddCallTariffToCallTariffPlanRequest** | **PostAddCallTariffToCallTariffPlanRequest**| | |
2100
+
2101
+
2102
+ ### Return type
2103
+
2104
+ **CallTariffPlan**
2105
+
2106
+ ### Authorization
2107
+
2108
+ No authorization required
2109
+
2110
+ ### HTTP request headers
2111
+
2112
+ - **Content-Type**: application/json
2113
+ - **Accept**: application/json
2114
+
2115
+
2116
+ ### HTTP response details
2117
+ | Status code | Description | Response headers |
2118
+ |-------------|-------------|------------------|
2119
+ |**200** | Call Tariff Plan | - |
2120
+ |**400** | Bad Request | - |
2121
+ |**401** | Unauthorised | - |
2122
+ |**403** | Access Denied | - |
2123
+
2124
+ [[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)
2125
+
2126
+ # **postAddChildCustomer**
2127
+ > Customer postAddChildCustomer(contactDetail)
2128
+
2129
+ Add Child Customer
2130
+
2131
+ ### Example
2132
+
2133
+ ```typescript
2134
+ import {
2135
+ BillingApi,
2136
+ Configuration,
2137
+ ContactDetail
2138
+ } from 'yellowgrid-api-ts';
2139
+
2140
+ const configuration = new Configuration();
2141
+ const apiInstance = new BillingApi(configuration);
2142
+
2143
+ let contactDetail: ContactDetail; //
2144
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2145
+ let customerId: number; //Child Customer ID (optional) (default to undefined)
2146
+
2147
+ const { status, data } = await apiInstance.postAddChildCustomer(
2148
+ contactDetail,
2149
+ billCustomerId,
2150
+ customerId
2151
+ );
2152
+ ```
2153
+
2154
+ ### Parameters
2155
+
2156
+ |Name | Type | Description | Notes|
2157
+ |------------- | ------------- | ------------- | -------------|
2158
+ | **contactDetail** | **ContactDetail**| | |
2159
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2160
+ | **customerId** | [**number**] | Child Customer ID | (optional) defaults to undefined|
2161
+
2162
+
2163
+ ### Return type
2164
+
2165
+ **Customer**
2166
+
2167
+ ### Authorization
2168
+
2169
+ No authorization required
2170
+
2171
+ ### HTTP request headers
2172
+
2173
+ - **Content-Type**: application/json
2174
+ - **Accept**: application/json
2175
+
2176
+
2177
+ ### HTTP response details
2178
+ | Status code | Description | Response headers |
2179
+ |-------------|-------------|------------------|
2180
+ |**200** | Customer | - |
2181
+ |**400** | Bad Request | - |
2182
+ |**401** | Unauthorised | - |
2183
+ |**403** | Access Denied | - |
2184
+
2185
+ [[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)
2186
+
2187
+ # **postAddEthernet**
2188
+ > OutboundCli postAddEthernet(postAddEthernetRequest)
2189
+
2190
+ Add Ethernet
2191
+
2192
+ ### Example
2193
+
2194
+ ```typescript
2195
+ import {
2196
+ BillingApi,
2197
+ Configuration,
2198
+ PostAddEthernetRequest
2199
+ } from 'yellowgrid-api-ts';
2200
+
2201
+ const configuration = new Configuration();
2202
+ const apiInstance = new BillingApi(configuration);
2203
+
2204
+ let postAddEthernetRequest: PostAddEthernetRequest; //
2205
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2206
+
2207
+ const { status, data } = await apiInstance.postAddEthernet(
2208
+ postAddEthernetRequest,
2209
+ billCustomerId
2210
+ );
2211
+ ```
2212
+
2213
+ ### Parameters
2214
+
2215
+ |Name | Type | Description | Notes|
2216
+ |------------- | ------------- | ------------- | -------------|
2217
+ | **postAddEthernetRequest** | **PostAddEthernetRequest**| | |
2218
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2219
+
2220
+
2221
+ ### Return type
2222
+
2223
+ **OutboundCli**
2224
+
2225
+ ### Authorization
2226
+
2227
+ No authorization required
2228
+
2229
+ ### HTTP request headers
2230
+
2231
+ - **Content-Type**: application/json
2232
+ - **Accept**: application/json
2233
+
2234
+
2235
+ ### HTTP response details
2236
+ | Status code | Description | Response headers |
2237
+ |-------------|-------------|------------------|
2238
+ |**200** | Connection | - |
2239
+ |**400** | Bad Request | - |
2240
+ |**401** | Unauthorised | - |
2241
+ |**403** | Access Denied | - |
2242
+
2243
+ [[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)
2244
+
2245
+ # **postAddRecurringCharge**
2246
+ > RecurringCharge postAddRecurringCharge(postAddRecurringChargeRequest)
2247
+
2248
+ Add Recurring Charge
2249
+
2250
+ ### Example
2251
+
2252
+ ```typescript
2253
+ import {
2254
+ BillingApi,
2255
+ Configuration,
2256
+ PostAddRecurringChargeRequest
2257
+ } from 'yellowgrid-api-ts';
2258
+
2259
+ const configuration = new Configuration();
2260
+ const apiInstance = new BillingApi(configuration);
2261
+
2262
+ let postAddRecurringChargeRequest: PostAddRecurringChargeRequest; //
2263
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2264
+
2265
+ const { status, data } = await apiInstance.postAddRecurringCharge(
2266
+ postAddRecurringChargeRequest,
2267
+ billCustomerId
2268
+ );
2269
+ ```
2270
+
2271
+ ### Parameters
2272
+
2273
+ |Name | Type | Description | Notes|
2274
+ |------------- | ------------- | ------------- | -------------|
2275
+ | **postAddRecurringChargeRequest** | **PostAddRecurringChargeRequest**| | |
2276
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2277
+
2278
+
2279
+ ### Return type
2280
+
2281
+ **RecurringCharge**
2282
+
2283
+ ### Authorization
2284
+
2285
+ No authorization required
2286
+
2287
+ ### HTTP request headers
2288
+
2289
+ - **Content-Type**: application/json
2290
+ - **Accept**: application/json
2291
+
2292
+
2293
+ ### HTTP response details
2294
+ | Status code | Description | Response headers |
2295
+ |-------------|-------------|------------------|
2296
+ |**200** | Recurring Charge | - |
2297
+ |**400** | Bad Request | - |
2298
+ |**401** | Unauthorised | - |
2299
+ |**403** | Access Denied | - |
2300
+
2301
+ [[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)
2302
+
2303
+ # **postAddServiceToServicePlan**
2304
+ > Service postAddServiceToServicePlan(postAddServiceToServicePlanRequest)
2305
+
2306
+ Add Service To Service Plan
2307
+
2308
+ ### Example
2309
+
2310
+ ```typescript
2311
+ import {
2312
+ BillingApi,
2313
+ Configuration,
2314
+ PostAddServiceToServicePlanRequest
2315
+ } from 'yellowgrid-api-ts';
2316
+
2317
+ const configuration = new Configuration();
2318
+ const apiInstance = new BillingApi(configuration);
2319
+
2320
+ let postAddServiceToServicePlanRequest: PostAddServiceToServicePlanRequest; //
2321
+
2322
+ const { status, data } = await apiInstance.postAddServiceToServicePlan(
2323
+ postAddServiceToServicePlanRequest
2324
+ );
2325
+ ```
2326
+
2327
+ ### Parameters
2328
+
2329
+ |Name | Type | Description | Notes|
2330
+ |------------- | ------------- | ------------- | -------------|
2331
+ | **postAddServiceToServicePlanRequest** | **PostAddServiceToServicePlanRequest**| | |
2332
+
2333
+
2334
+ ### Return type
2335
+
2336
+ **Service**
2337
+
2338
+ ### Authorization
2339
+
2340
+ No authorization required
2341
+
2342
+ ### HTTP request headers
2343
+
2344
+ - **Content-Type**: application/json
2345
+ - **Accept**: application/json
2346
+
2347
+
2348
+ ### HTTP response details
2349
+ | Status code | Description | Response headers |
2350
+ |-------------|-------------|------------------|
2351
+ |**200** | Service | - |
2352
+ |**400** | Bad Request | - |
2353
+ |**401** | Unauthorised | - |
2354
+ |**403** | Access Denied | - |
2355
+
2356
+ [[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)
2357
+
2358
+ # **postAddSipTrunkDDIs**
2359
+ > Array<OutboundCli> postAddSipTrunkDDIs(postAddSipTrunkDDIsRequest)
2360
+
2361
+ Add SIP Trunk DDIs
2362
+
2363
+ ### Example
2364
+
2365
+ ```typescript
2366
+ import {
2367
+ BillingApi,
2368
+ Configuration,
2369
+ PostAddSipTrunkDDIsRequest
2370
+ } from 'yellowgrid-api-ts';
2371
+
2372
+ const configuration = new Configuration();
2373
+ const apiInstance = new BillingApi(configuration);
2374
+
2375
+ let postAddSipTrunkDDIsRequest: PostAddSipTrunkDDIsRequest; //
2376
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2377
+
2378
+ const { status, data } = await apiInstance.postAddSipTrunkDDIs(
2379
+ postAddSipTrunkDDIsRequest,
2380
+ billCustomerId
2381
+ );
2382
+ ```
2383
+
2384
+ ### Parameters
2385
+
2386
+ |Name | Type | Description | Notes|
2387
+ |------------- | ------------- | ------------- | -------------|
2388
+ | **postAddSipTrunkDDIsRequest** | **PostAddSipTrunkDDIsRequest**| | |
2389
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2390
+
2391
+
2392
+ ### Return type
2393
+
2394
+ **Array<OutboundCli>**
2395
+
2396
+ ### Authorization
2397
+
2398
+ No authorization required
2399
+
2400
+ ### HTTP request headers
2401
+
2402
+ - **Content-Type**: application/json
2403
+ - **Accept**: application/json
2404
+
2405
+
2406
+ ### HTTP response details
2407
+ | Status code | Description | Response headers |
2408
+ |-------------|-------------|------------------|
2409
+ |**200** | Connection | - |
2410
+ |**400** | Bad Request | - |
2411
+ |**401** | Unauthorised | - |
2412
+ |**403** | Access Denied | - |
2413
+
2414
+ [[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)
2415
+
2416
+ # **postGetBaseServices**
2417
+ > Service postGetBaseServices(postGetBaseServicesRequest)
2418
+
2419
+ Add Base Service
2420
+
2421
+ ### Example
2422
+
2423
+ ```typescript
2424
+ import {
2425
+ BillingApi,
2426
+ Configuration,
2427
+ PostGetBaseServicesRequest
2428
+ } from 'yellowgrid-api-ts';
2429
+
2430
+ const configuration = new Configuration();
2431
+ const apiInstance = new BillingApi(configuration);
2432
+
2433
+ let postGetBaseServicesRequest: PostGetBaseServicesRequest; //
2434
+
2435
+ const { status, data } = await apiInstance.postGetBaseServices(
2436
+ postGetBaseServicesRequest
2437
+ );
2438
+ ```
2439
+
2440
+ ### Parameters
2441
+
2442
+ |Name | Type | Description | Notes|
2443
+ |------------- | ------------- | ------------- | -------------|
2444
+ | **postGetBaseServicesRequest** | **PostGetBaseServicesRequest**| | |
2445
+
2446
+
2447
+ ### Return type
2448
+
2449
+ **Service**
2450
+
2451
+ ### Authorization
2452
+
2453
+ No authorization required
2454
+
2455
+ ### HTTP request headers
2456
+
2457
+ - **Content-Type**: application/json
2458
+ - **Accept**: application/json
2459
+
2460
+
2461
+ ### HTTP response details
2462
+ | Status code | Description | Response headers |
2463
+ |-------------|-------------|------------------|
2464
+ |**200** | Service | - |
2465
+ |**400** | Bad Request | - |
2466
+ |**401** | Unauthorised | - |
2467
+ |**403** | Access Denied | - |
2468
+
2469
+ [[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)
2470
+
2471
+ # **postGetCallTariffPlan**
2472
+ > CallTariffPlan postGetCallTariffPlan(putGetCallTariffPlanRequest)
2473
+
2474
+ Add Call Tariff
2475
+
2476
+ ### Example
2477
+
2478
+ ```typescript
2479
+ import {
2480
+ BillingApi,
2481
+ Configuration,
2482
+ PutGetCallTariffPlanRequest
2483
+ } from 'yellowgrid-api-ts';
2484
+
2485
+ const configuration = new Configuration();
2486
+ const apiInstance = new BillingApi(configuration);
2487
+
2488
+ let putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest; //
2489
+
2490
+ const { status, data } = await apiInstance.postGetCallTariffPlan(
2491
+ putGetCallTariffPlanRequest
2492
+ );
2493
+ ```
2494
+
2495
+ ### Parameters
2496
+
2497
+ |Name | Type | Description | Notes|
2498
+ |------------- | ------------- | ------------- | -------------|
2499
+ | **putGetCallTariffPlanRequest** | **PutGetCallTariffPlanRequest**| | |
2500
+
2501
+
2502
+ ### Return type
2503
+
2504
+ **CallTariffPlan**
2505
+
2506
+ ### Authorization
2507
+
2508
+ No authorization required
2509
+
2510
+ ### HTTP request headers
2511
+
2512
+ - **Content-Type**: application/json
2513
+ - **Accept**: application/json
2514
+
2515
+
2516
+ ### HTTP response details
2517
+ | Status code | Description | Response headers |
2518
+ |-------------|-------------|------------------|
2519
+ |**200** | Call Tariff Plan | - |
2520
+ |**400** | Bad Request | - |
2521
+ |**401** | Unauthorised | - |
2522
+ |**403** | Access Denied | - |
2523
+
2524
+ [[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)
2525
+
2526
+ # **postGetConnections**
2527
+ > OutboundCli postGetConnections()
2528
+
2529
+ Add Connection
2530
+
2531
+ ### Example
2532
+
2533
+ ```typescript
2534
+ import {
2535
+ BillingApi,
2536
+ Configuration,
2537
+ ConnectionRequest
2538
+ } from 'yellowgrid-api-ts';
2539
+
2540
+ const configuration = new Configuration();
2541
+ const apiInstance = new BillingApi(configuration);
2542
+
2543
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2544
+ let connectionRequest: ConnectionRequest; // (optional)
2545
+
2546
+ const { status, data } = await apiInstance.postGetConnections(
2547
+ billCustomerId,
2548
+ connectionRequest
2549
+ );
2550
+ ```
2551
+
2552
+ ### Parameters
2553
+
2554
+ |Name | Type | Description | Notes|
2555
+ |------------- | ------------- | ------------- | -------------|
2556
+ | **connectionRequest** | **ConnectionRequest**| | |
2557
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2558
+
2559
+
2560
+ ### Return type
2561
+
2562
+ **OutboundCli**
2563
+
2564
+ ### Authorization
2565
+
2566
+ No authorization required
2567
+
2568
+ ### HTTP request headers
2569
+
2570
+ - **Content-Type**: application/json
2571
+ - **Accept**: application/json
2572
+
2573
+
2574
+ ### HTTP response details
2575
+ | Status code | Description | Response headers |
2576
+ |-------------|-------------|------------------|
2577
+ |**200** | Connection | - |
2578
+ |**400** | Bad Request | - |
2579
+ |**401** | Unauthorised | - |
2580
+ |**403** | Access Denied | - |
2581
+
2582
+ [[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)
2583
+
2584
+ # **postGetPriceGroups**
2585
+ > PriceGroup postGetPriceGroups(postGetPriceGroupsRequest)
2586
+
2587
+ Add Price Group
2588
+
2589
+ ### Example
2590
+
2591
+ ```typescript
2592
+ import {
2593
+ BillingApi,
2594
+ Configuration,
2595
+ PostGetPriceGroupsRequest
2596
+ } from 'yellowgrid-api-ts';
2597
+
2598
+ const configuration = new Configuration();
2599
+ const apiInstance = new BillingApi(configuration);
2600
+
2601
+ let postGetPriceGroupsRequest: PostGetPriceGroupsRequest; //
2602
+
2603
+ const { status, data } = await apiInstance.postGetPriceGroups(
2604
+ postGetPriceGroupsRequest
2605
+ );
2606
+ ```
2607
+
2608
+ ### Parameters
2609
+
2610
+ |Name | Type | Description | Notes|
2611
+ |------------- | ------------- | ------------- | -------------|
2612
+ | **postGetPriceGroupsRequest** | **PostGetPriceGroupsRequest**| | |
2613
+
2614
+
2615
+ ### Return type
2616
+
2617
+ **PriceGroup**
2618
+
2619
+ ### Authorization
2620
+
2621
+ No authorization required
2622
+
2623
+ ### HTTP request headers
2624
+
2625
+ - **Content-Type**: application/json
2626
+ - **Accept**: application/json
2627
+
2628
+
2629
+ ### HTTP response details
2630
+ | Status code | Description | Response headers |
2631
+ |-------------|-------------|------------------|
2632
+ |**200** | Price Group | - |
2633
+ |**400** | Bad Request | - |
2634
+ |**401** | Unauthorised | - |
2635
+ |**403** | Access Denied | - |
2636
+
2637
+ [[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)
2638
+
2639
+ # **postGetServicePlans**
2640
+ > ServicePlan postGetServicePlans(postGetServicePlansRequest)
2641
+
2642
+ Add Service Plan
2643
+
2644
+ ### Example
2645
+
2646
+ ```typescript
2647
+ import {
2648
+ BillingApi,
2649
+ Configuration,
2650
+ PostGetServicePlansRequest
2651
+ } from 'yellowgrid-api-ts';
2652
+
2653
+ const configuration = new Configuration();
2654
+ const apiInstance = new BillingApi(configuration);
2655
+
2656
+ let postGetServicePlansRequest: PostGetServicePlansRequest; //
2657
+
2658
+ const { status, data } = await apiInstance.postGetServicePlans(
2659
+ postGetServicePlansRequest
2660
+ );
2661
+ ```
2662
+
2663
+ ### Parameters
2664
+
2665
+ |Name | Type | Description | Notes|
2666
+ |------------- | ------------- | ------------- | -------------|
2667
+ | **postGetServicePlansRequest** | **PostGetServicePlansRequest**| | |
2668
+
2669
+
2670
+ ### Return type
2671
+
2672
+ **ServicePlan**
2673
+
2674
+ ### Authorization
2675
+
2676
+ No authorization required
2677
+
2678
+ ### HTTP request headers
2679
+
2680
+ - **Content-Type**: application/json
2681
+ - **Accept**: application/json
2682
+
2683
+
2684
+ ### HTTP response details
2685
+ | Status code | Description | Response headers |
2686
+ |-------------|-------------|------------------|
2687
+ |**200** | Service Plan | - |
2688
+ |**400** | Bad Request | - |
2689
+ |**401** | Unauthorised | - |
2690
+ |**403** | Access Denied | - |
2691
+
2692
+ [[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)
2693
+
2694
+ # **postGetSipTrunksBilling**
2695
+ > OutboundCli postGetSipTrunksBilling(postGetSipTrunksBillingRequest)
2696
+
2697
+ Add SIP Trunk billing
2698
+
2699
+ ### Example
2700
+
2701
+ ```typescript
2702
+ import {
2703
+ BillingApi,
2704
+ Configuration,
2705
+ PostGetSipTrunksBillingRequest
2706
+ } from 'yellowgrid-api-ts';
2707
+
2708
+ const configuration = new Configuration();
2709
+ const apiInstance = new BillingApi(configuration);
2710
+
2711
+ let postGetSipTrunksBillingRequest: PostGetSipTrunksBillingRequest; //
2712
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2713
+
2714
+ const { status, data } = await apiInstance.postGetSipTrunksBilling(
2715
+ postGetSipTrunksBillingRequest,
2716
+ billCustomerId
2717
+ );
2718
+ ```
2719
+
2720
+ ### Parameters
2721
+
2722
+ |Name | Type | Description | Notes|
2723
+ |------------- | ------------- | ------------- | -------------|
2724
+ | **postGetSipTrunksBillingRequest** | **PostGetSipTrunksBillingRequest**| | |
2725
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2726
+
2727
+
2728
+ ### Return type
2729
+
2730
+ **OutboundCli**
2731
+
2732
+ ### Authorization
2733
+
2734
+ No authorization required
2735
+
2736
+ ### HTTP request headers
2737
+
2738
+ - **Content-Type**: application/json
2739
+ - **Accept**: application/json
2740
+
2741
+
2742
+ ### HTTP response details
2743
+ | Status code | Description | Response headers |
2744
+ |-------------|-------------|------------------|
2745
+ |**200** | Connection | - |
2746
+ |**400** | Bad Request | - |
2747
+ |**401** | Unauthorised | - |
2748
+ |**403** | Access Denied | - |
2749
+
2750
+ [[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)
2751
+
2752
+ # **postSendInvoices**
2753
+ > string postSendInvoices()
2754
+
2755
+ Send Invoices
2756
+
2757
+ ### Example
2758
+
2759
+ ```typescript
2760
+ import {
2761
+ BillingApi,
2762
+ Configuration
2763
+ } from 'yellowgrid-api-ts';
2764
+
2765
+ const configuration = new Configuration();
2766
+ const apiInstance = new BillingApi(configuration);
2767
+
2768
+ const { status, data } = await apiInstance.postSendInvoices();
2769
+ ```
2770
+
2771
+ ### Parameters
2772
+ This endpoint does not have any parameters.
2773
+
2774
+
2775
+ ### Return type
2776
+
2777
+ **string**
2778
+
2779
+ ### Authorization
2780
+
2781
+ No authorization required
2782
+
2783
+ ### HTTP request headers
2784
+
2785
+ - **Content-Type**: Not defined
2786
+ - **Accept**: application/json
2787
+
2788
+
2789
+ ### HTTP response details
2790
+ | Status code | Description | Response headers |
2791
+ |-------------|-------------|------------------|
2792
+ |**200** | Time Started | - |
2793
+ |**400** | Bad Request | - |
2794
+ |**401** | Unauthorised | - |
2795
+ |**403** | Access Denied | - |
2796
+
2797
+ [[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)
2798
+
2799
+ # **postUpdateConnection**
2800
+ > object postUpdateConnection(postUpdateConnectionRequest)
2801
+
2802
+ Update Connection
2803
+
2804
+ ### Example
2805
+
2806
+ ```typescript
2807
+ import {
2808
+ BillingApi,
2809
+ Configuration,
2810
+ PostUpdateConnectionRequest
2811
+ } from 'yellowgrid-api-ts';
2812
+
2813
+ const configuration = new Configuration();
2814
+ const apiInstance = new BillingApi(configuration);
2815
+
2816
+ let postUpdateConnectionRequest: PostUpdateConnectionRequest; //
2817
+ let connectionId: number; //Connection ID (optional) (default to undefined)
2818
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2819
+
2820
+ const { status, data } = await apiInstance.postUpdateConnection(
2821
+ postUpdateConnectionRequest,
2822
+ connectionId,
2823
+ billCustomerId
2824
+ );
2825
+ ```
2826
+
2827
+ ### Parameters
2828
+
2829
+ |Name | Type | Description | Notes|
2830
+ |------------- | ------------- | ------------- | -------------|
2831
+ | **postUpdateConnectionRequest** | **PostUpdateConnectionRequest**| | |
2832
+ | **connectionId** | [**number**] | Connection ID | (optional) defaults to undefined|
2833
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2834
+
2835
+
2836
+ ### Return type
2837
+
2838
+ **object**
2839
+
2840
+ ### Authorization
2841
+
2842
+ No authorization required
2843
+
2844
+ ### HTTP request headers
2845
+
2846
+ - **Content-Type**: application/json
2847
+ - **Accept**: application/json
2848
+
2849
+
2850
+ ### HTTP response details
2851
+ | Status code | Description | Response headers |
2852
+ |-------------|-------------|------------------|
2853
+ |**200** | Changes | - |
2854
+ |**400** | Bad Request | - |
2855
+ |**401** | Unauthorised | - |
2856
+ |**403** | Access Denied | - |
2857
+
2858
+ [[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)
2859
+
2860
+ # **postUpdateRecurringCharge**
2861
+ > RecurringCharge postUpdateRecurringCharge(postUpdateRecurringChargeRequest)
2862
+
2863
+ Update Recurring Charge
2864
+
2865
+ ### Example
2866
+
2867
+ ```typescript
2868
+ import {
2869
+ BillingApi,
2870
+ Configuration,
2871
+ PostUpdateRecurringChargeRequest
2872
+ } from 'yellowgrid-api-ts';
2873
+
2874
+ const configuration = new Configuration();
2875
+ const apiInstance = new BillingApi(configuration);
2876
+
2877
+ let id: number; //Recurring Charge ID (default to undefined)
2878
+ let postUpdateRecurringChargeRequest: PostUpdateRecurringChargeRequest; //
2879
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
2880
+
2881
+ const { status, data } = await apiInstance.postUpdateRecurringCharge(
2882
+ id,
2883
+ postUpdateRecurringChargeRequest,
2884
+ billCustomerId
2885
+ );
2886
+ ```
2887
+
2888
+ ### Parameters
2889
+
2890
+ |Name | Type | Description | Notes|
2891
+ |------------- | ------------- | ------------- | -------------|
2892
+ | **postUpdateRecurringChargeRequest** | **PostUpdateRecurringChargeRequest**| | |
2893
+ | **id** | [**number**] | Recurring Charge ID | defaults to undefined|
2894
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
2895
+
2896
+
2897
+ ### Return type
2898
+
2899
+ **RecurringCharge**
2900
+
2901
+ ### Authorization
2902
+
2903
+ No authorization required
2904
+
2905
+ ### HTTP request headers
2906
+
2907
+ - **Content-Type**: application/json
2908
+ - **Accept**: application/json
2909
+
2910
+
2911
+ ### HTTP response details
2912
+ | Status code | Description | Response headers |
2913
+ |-------------|-------------|------------------|
2914
+ |**200** | Recurring Charge | - |
2915
+ |**400** | Bad Request | - |
2916
+ |**401** | Unauthorised | - |
2917
+ |**403** | Access Denied | - |
2918
+
2919
+ [[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)
2920
+
2921
+ # **putAddCallTariffToCallTariffPlan**
2922
+ > CallTariffPlan putAddCallTariffToCallTariffPlan(putAddCallTariffToCallTariffPlanRequest)
2923
+
2924
+ Update Call Tariff
2925
+
2926
+ ### Example
2927
+
2928
+ ```typescript
2929
+ import {
2930
+ BillingApi,
2931
+ Configuration,
2932
+ PutAddCallTariffToCallTariffPlanRequest
2933
+ } from 'yellowgrid-api-ts';
2934
+
2935
+ const configuration = new Configuration();
2936
+ const apiInstance = new BillingApi(configuration);
2937
+
2938
+ let callTariffPlanId: number; //Call Tariff ID (default to undefined)
2939
+ let putAddCallTariffToCallTariffPlanRequest: PutAddCallTariffToCallTariffPlanRequest; //
2940
+
2941
+ const { status, data } = await apiInstance.putAddCallTariffToCallTariffPlan(
2942
+ callTariffPlanId,
2943
+ putAddCallTariffToCallTariffPlanRequest
2944
+ );
2945
+ ```
2946
+
2947
+ ### Parameters
2948
+
2949
+ |Name | Type | Description | Notes|
2950
+ |------------- | ------------- | ------------- | -------------|
2951
+ | **putAddCallTariffToCallTariffPlanRequest** | **PutAddCallTariffToCallTariffPlanRequest**| | |
2952
+ | **callTariffPlanId** | [**number**] | Call Tariff ID | defaults to undefined|
2953
+
2954
+
2955
+ ### Return type
2956
+
2957
+ **CallTariffPlan**
2958
+
2959
+ ### Authorization
2960
+
2961
+ No authorization required
2962
+
2963
+ ### HTTP request headers
2964
+
2965
+ - **Content-Type**: application/json
2966
+ - **Accept**: application/json
2967
+
2968
+
2969
+ ### HTTP response details
2970
+ | Status code | Description | Response headers |
2971
+ |-------------|-------------|------------------|
2972
+ |**200** | Call Tariff Plan | - |
2973
+ |**400** | Bad Request | - |
2974
+ |**401** | Unauthorised | - |
2975
+ |**403** | Access Denied | - |
2976
+
2977
+ [[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)
2978
+
2979
+ # **putAddServiceToServicePlan**
2980
+ > Service putAddServiceToServicePlan(putAddServiceToServicePlanRequest)
2981
+
2982
+ Update Service
2983
+
2984
+ ### Example
2985
+
2986
+ ```typescript
2987
+ import {
2988
+ BillingApi,
2989
+ Configuration,
2990
+ PutAddServiceToServicePlanRequest
2991
+ } from 'yellowgrid-api-ts';
2992
+
2993
+ const configuration = new Configuration();
2994
+ const apiInstance = new BillingApi(configuration);
2995
+
2996
+ let id: number; //Service ID (default to undefined)
2997
+ let putAddServiceToServicePlanRequest: PutAddServiceToServicePlanRequest; //
2998
+
2999
+ const { status, data } = await apiInstance.putAddServiceToServicePlan(
3000
+ id,
3001
+ putAddServiceToServicePlanRequest
3002
+ );
3003
+ ```
3004
+
3005
+ ### Parameters
3006
+
3007
+ |Name | Type | Description | Notes|
3008
+ |------------- | ------------- | ------------- | -------------|
3009
+ | **putAddServiceToServicePlanRequest** | **PutAddServiceToServicePlanRequest**| | |
3010
+ | **id** | [**number**] | Service ID | defaults to undefined|
3011
+
3012
+
3013
+ ### Return type
3014
+
3015
+ **Service**
3016
+
3017
+ ### Authorization
3018
+
3019
+ No authorization required
3020
+
3021
+ ### HTTP request headers
3022
+
3023
+ - **Content-Type**: application/json
3024
+ - **Accept**: application/json
3025
+
3026
+
3027
+ ### HTTP response details
3028
+ | Status code | Description | Response headers |
3029
+ |-------------|-------------|------------------|
3030
+ |**200** | Service | - |
3031
+ |**400** | Bad Request | - |
3032
+ |**401** | Unauthorised | - |
3033
+ |**403** | Access Denied | - |
3034
+
3035
+ [[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)
3036
+
3037
+ # **putConnectionSearch**
3038
+ > OutboundCli putConnectionSearch(putConnectionSearchRequest)
3039
+
3040
+ Transfer Billing Connection
3041
+
3042
+ ### Example
3043
+
3044
+ ```typescript
3045
+ import {
3046
+ BillingApi,
3047
+ Configuration,
3048
+ PutConnectionSearchRequest
3049
+ } from 'yellowgrid-api-ts';
3050
+
3051
+ const configuration = new Configuration();
3052
+ const apiInstance = new BillingApi(configuration);
3053
+
3054
+ let putConnectionSearchRequest: PutConnectionSearchRequest; //Transfer Request
3055
+ let id: number; //Connection ID (optional) (default to undefined)
3056
+ let cli: string; //CLI (optional) (default to undefined)
3057
+ let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
3058
+
3059
+ const { status, data } = await apiInstance.putConnectionSearch(
3060
+ putConnectionSearchRequest,
3061
+ id,
3062
+ cli,
3063
+ skipDDis
3064
+ );
3065
+ ```
3066
+
3067
+ ### Parameters
3068
+
3069
+ |Name | Type | Description | Notes|
3070
+ |------------- | ------------- | ------------- | -------------|
3071
+ | **putConnectionSearchRequest** | **PutConnectionSearchRequest**| Transfer Request | |
3072
+ | **id** | [**number**] | Connection ID | (optional) defaults to undefined|
3073
+ | **cli** | [**string**] | CLI | (optional) defaults to undefined|
3074
+ | **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
3075
+
3076
+
3077
+ ### Return type
3078
+
3079
+ **OutboundCli**
3080
+
3081
+ ### Authorization
3082
+
3083
+ No authorization required
3084
+
3085
+ ### HTTP request headers
3086
+
3087
+ - **Content-Type**: application/json
3088
+ - **Accept**: application/json
3089
+
3090
+
3091
+ ### HTTP response details
3092
+ | Status code | Description | Response headers |
3093
+ |-------------|-------------|------------------|
3094
+ |**200** | Connection | - |
3095
+ |**400** | Bad Request | - |
3096
+ |**401** | Unauthorised | - |
3097
+ |**403** | Access Denied | - |
3098
+
3099
+ [[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)
3100
+
3101
+ # **putConvertChildToParent**
3102
+ > Customer putConvertChildToParent()
3103
+
3104
+ Convert Child To Parent
3105
+
3106
+ ### Example
3107
+
3108
+ ```typescript
3109
+ import {
3110
+ BillingApi,
3111
+ Configuration
3112
+ } from 'yellowgrid-api-ts';
3113
+
3114
+ const configuration = new Configuration();
3115
+ const apiInstance = new BillingApi(configuration);
3116
+
3117
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3118
+
3119
+ const { status, data } = await apiInstance.putConvertChildToParent(
3120
+ billCustomerId
3121
+ );
3122
+ ```
3123
+
3124
+ ### Parameters
3125
+
3126
+ |Name | Type | Description | Notes|
3127
+ |------------- | ------------- | ------------- | -------------|
3128
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3129
+
3130
+
3131
+ ### Return type
3132
+
3133
+ **Customer**
3134
+
3135
+ ### Authorization
3136
+
3137
+ No authorization required
3138
+
3139
+ ### HTTP request headers
3140
+
3141
+ - **Content-Type**: Not defined
3142
+ - **Accept**: application/json
3143
+
3144
+
3145
+ ### HTTP response details
3146
+ | Status code | Description | Response headers |
3147
+ |-------------|-------------|------------------|
3148
+ |**200** | Customer | - |
3149
+ |**400** | Bad Request | - |
3150
+ |**401** | Unauthorised | - |
3151
+ |**403** | Access Denied | - |
3152
+
3153
+ [[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)
3154
+
3155
+ # **putDisableBundles**
3156
+ > boolean putDisableBundles()
3157
+
3158
+ Disable Bundles
3159
+
3160
+ ### Example
3161
+
3162
+ ```typescript
3163
+ import {
3164
+ BillingApi,
3165
+ Configuration
3166
+ } from 'yellowgrid-api-ts';
3167
+
3168
+ const configuration = new Configuration();
3169
+ const apiInstance = new BillingApi(configuration);
3170
+
3171
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3172
+
3173
+ const { status, data } = await apiInstance.putDisableBundles(
3174
+ billCustomerId
3175
+ );
3176
+ ```
3177
+
3178
+ ### Parameters
3179
+
3180
+ |Name | Type | Description | Notes|
3181
+ |------------- | ------------- | ------------- | -------------|
3182
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3183
+
3184
+
3185
+ ### Return type
3186
+
3187
+ **boolean**
3188
+
3189
+ ### Authorization
3190
+
3191
+ No authorization required
3192
+
3193
+ ### HTTP request headers
3194
+
3195
+ - **Content-Type**: Not defined
3196
+ - **Accept**: application/json
3197
+
3198
+
3199
+ ### HTTP response details
3200
+ | Status code | Description | Response headers |
3201
+ |-------------|-------------|------------------|
3202
+ |**200** | Successful | - |
3203
+ |**400** | Bad Request | - |
3204
+ |**401** | Unauthorised | - |
3205
+ |**403** | Access Denied | - |
3206
+
3207
+ [[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)
3208
+
3209
+ # **putDisableDdiBilling**
3210
+ > boolean putDisableDdiBilling()
3211
+
3212
+ Disable DDI Billing
14
3213
 
15
3214
  ### Example
16
3215
 
@@ -23,16 +3222,23 @@ import {
23
3222
  const configuration = new Configuration();
24
3223
  const apiInstance = new BillingApi(configuration);
25
3224
 
26
- const { status, data } = await apiInstance.getGetAllCustomer();
3225
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3226
+
3227
+ const { status, data } = await apiInstance.putDisableDdiBilling(
3228
+ billCustomerId
3229
+ );
27
3230
  ```
28
3231
 
29
3232
  ### Parameters
30
- This endpoint does not have any parameters.
3233
+
3234
+ |Name | Type | Description | Notes|
3235
+ |------------- | ------------- | ------------- | -------------|
3236
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
31
3237
 
32
3238
 
33
3239
  ### Return type
34
3240
 
35
- **{ [key: string]: { [key: string]: string; }; }**
3241
+ **boolean**
36
3242
 
37
3243
  ### Authorization
38
3244
 
@@ -47,17 +3253,125 @@ No authorization required
47
3253
  ### HTTP response details
48
3254
  | Status code | Description | Response headers |
49
3255
  |-------------|-------------|------------------|
50
- |**200** | Billing Customer List | - |
3256
+ |**200** | Successful | - |
51
3257
  |**400** | Bad Request | - |
52
3258
  |**401** | Unauthorised | - |
53
3259
  |**403** | Access Denied | - |
54
3260
 
55
3261
  [[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
3262
 
57
- # **putTransferConnection**
58
- > object putTransferConnection(putTransferConnectionRequest)
3263
+ # **putEnableBundles**
3264
+ > boolean putEnableBundles()
59
3265
 
60
- Transfer Billing Connection
3266
+ Enable Bundles
3267
+
3268
+ ### Example
3269
+
3270
+ ```typescript
3271
+ import {
3272
+ BillingApi,
3273
+ Configuration
3274
+ } from 'yellowgrid-api-ts';
3275
+
3276
+ const configuration = new Configuration();
3277
+ const apiInstance = new BillingApi(configuration);
3278
+
3279
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3280
+
3281
+ const { status, data } = await apiInstance.putEnableBundles(
3282
+ billCustomerId
3283
+ );
3284
+ ```
3285
+
3286
+ ### Parameters
3287
+
3288
+ |Name | Type | Description | Notes|
3289
+ |------------- | ------------- | ------------- | -------------|
3290
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3291
+
3292
+
3293
+ ### Return type
3294
+
3295
+ **boolean**
3296
+
3297
+ ### Authorization
3298
+
3299
+ No authorization required
3300
+
3301
+ ### HTTP request headers
3302
+
3303
+ - **Content-Type**: Not defined
3304
+ - **Accept**: application/json
3305
+
3306
+
3307
+ ### HTTP response details
3308
+ | Status code | Description | Response headers |
3309
+ |-------------|-------------|------------------|
3310
+ |**200** | Successful | - |
3311
+ |**400** | Bad Request | - |
3312
+ |**401** | Unauthorised | - |
3313
+ |**403** | Access Denied | - |
3314
+
3315
+ [[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)
3316
+
3317
+ # **putEnableDdiBilling**
3318
+ > boolean putEnableDdiBilling()
3319
+
3320
+ Enable DDI Billing
3321
+
3322
+ ### Example
3323
+
3324
+ ```typescript
3325
+ import {
3326
+ BillingApi,
3327
+ Configuration
3328
+ } from 'yellowgrid-api-ts';
3329
+
3330
+ const configuration = new Configuration();
3331
+ const apiInstance = new BillingApi(configuration);
3332
+
3333
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3334
+
3335
+ const { status, data } = await apiInstance.putEnableDdiBilling(
3336
+ billCustomerId
3337
+ );
3338
+ ```
3339
+
3340
+ ### Parameters
3341
+
3342
+ |Name | Type | Description | Notes|
3343
+ |------------- | ------------- | ------------- | -------------|
3344
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3345
+
3346
+
3347
+ ### Return type
3348
+
3349
+ **boolean**
3350
+
3351
+ ### Authorization
3352
+
3353
+ No authorization required
3354
+
3355
+ ### HTTP request headers
3356
+
3357
+ - **Content-Type**: Not defined
3358
+ - **Accept**: application/json
3359
+
3360
+
3361
+ ### HTTP response details
3362
+ | Status code | Description | Response headers |
3363
+ |-------------|-------------|------------------|
3364
+ |**200** | Successful | - |
3365
+ |**400** | Bad Request | - |
3366
+ |**401** | Unauthorised | - |
3367
+ |**403** | Access Denied | - |
3368
+
3369
+ [[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)
3370
+
3371
+ # **putGetBaseServices**
3372
+ > BaseService putGetBaseServices(putGetBaseServicesRequest)
3373
+
3374
+ Update Base Service
61
3375
 
62
3376
  ### Example
63
3377
 
@@ -65,22 +3379,18 @@ Transfer Billing Connection
65
3379
  import {
66
3380
  BillingApi,
67
3381
  Configuration,
68
- PutTransferConnectionRequest
3382
+ PutGetBaseServicesRequest
69
3383
  } from 'yellowgrid-api-ts';
70
3384
 
71
3385
  const configuration = new Configuration();
72
3386
  const apiInstance = new BillingApi(configuration);
73
3387
 
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)
3388
+ let baseServiceId: number; //Base Service Plan ID (default to undefined)
3389
+ let putGetBaseServicesRequest: PutGetBaseServicesRequest; //
78
3390
 
79
- const { status, data } = await apiInstance.putTransferConnection(
80
- putTransferConnectionRequest,
81
- id,
82
- cli,
83
- skipDDis
3391
+ const { status, data } = await apiInstance.putGetBaseServices(
3392
+ baseServiceId,
3393
+ putGetBaseServicesRequest
84
3394
  );
85
3395
  ```
86
3396
 
@@ -88,15 +3398,190 @@ const { status, data } = await apiInstance.putTransferConnection(
88
3398
 
89
3399
  |Name | Type | Description | Notes|
90
3400
  |------------- | ------------- | ------------- | -------------|
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|
3401
+ | **putGetBaseServicesRequest** | **PutGetBaseServicesRequest**| | |
3402
+ | **baseServiceId** | [**number**] | Base Service Plan ID | defaults to undefined|
95
3403
 
96
3404
 
97
3405
  ### Return type
98
3406
 
99
- **object**
3407
+ **BaseService**
3408
+
3409
+ ### Authorization
3410
+
3411
+ No authorization required
3412
+
3413
+ ### HTTP request headers
3414
+
3415
+ - **Content-Type**: application/json
3416
+ - **Accept**: application/json
3417
+
3418
+
3419
+ ### HTTP response details
3420
+ | Status code | Description | Response headers |
3421
+ |-------------|-------------|------------------|
3422
+ |**200** | Base Service | - |
3423
+ |**400** | Bad Request | - |
3424
+ |**401** | Unauthorised | - |
3425
+ |**403** | Access Denied | - |
3426
+
3427
+ [[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)
3428
+
3429
+ # **putGetCallTariffPlan**
3430
+ > CallTariffPlan putGetCallTariffPlan(putGetCallTariffPlanRequest)
3431
+
3432
+ Update Call Tariff
3433
+
3434
+ ### Example
3435
+
3436
+ ```typescript
3437
+ import {
3438
+ BillingApi,
3439
+ Configuration,
3440
+ PutGetCallTariffPlanRequest
3441
+ } from 'yellowgrid-api-ts';
3442
+
3443
+ const configuration = new Configuration();
3444
+ const apiInstance = new BillingApi(configuration);
3445
+
3446
+ let callTariffPlanId: number; //Call Tariff Plan ID (default to undefined)
3447
+ let putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest; //
3448
+
3449
+ const { status, data } = await apiInstance.putGetCallTariffPlan(
3450
+ callTariffPlanId,
3451
+ putGetCallTariffPlanRequest
3452
+ );
3453
+ ```
3454
+
3455
+ ### Parameters
3456
+
3457
+ |Name | Type | Description | Notes|
3458
+ |------------- | ------------- | ------------- | -------------|
3459
+ | **putGetCallTariffPlanRequest** | **PutGetCallTariffPlanRequest**| | |
3460
+ | **callTariffPlanId** | [**number**] | Call Tariff Plan ID | defaults to undefined|
3461
+
3462
+
3463
+ ### Return type
3464
+
3465
+ **CallTariffPlan**
3466
+
3467
+ ### Authorization
3468
+
3469
+ No authorization required
3470
+
3471
+ ### HTTP request headers
3472
+
3473
+ - **Content-Type**: application/json
3474
+ - **Accept**: application/json
3475
+
3476
+
3477
+ ### HTTP response details
3478
+ | Status code | Description | Response headers |
3479
+ |-------------|-------------|------------------|
3480
+ |**200** | Call Tariff Plan | - |
3481
+ |**400** | Bad Request | - |
3482
+ |**401** | Unauthorised | - |
3483
+ |**403** | Access Denied | - |
3484
+
3485
+ [[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)
3486
+
3487
+ # **putGetConnections**
3488
+ > OutboundCli putGetConnections()
3489
+
3490
+ Update Connection
3491
+
3492
+ ### Example
3493
+
3494
+ ```typescript
3495
+ import {
3496
+ BillingApi,
3497
+ Configuration,
3498
+ ConnectionRequest
3499
+ } from 'yellowgrid-api-ts';
3500
+
3501
+ const configuration = new Configuration();
3502
+ const apiInstance = new BillingApi(configuration);
3503
+
3504
+ let connectionId: number; //Connection ID (default to undefined)
3505
+ let billCustomerId: number; //Customer ID (optional) (default to undefined)
3506
+ let connectionRequest: ConnectionRequest; // (optional)
3507
+
3508
+ const { status, data } = await apiInstance.putGetConnections(
3509
+ connectionId,
3510
+ billCustomerId,
3511
+ connectionRequest
3512
+ );
3513
+ ```
3514
+
3515
+ ### Parameters
3516
+
3517
+ |Name | Type | Description | Notes|
3518
+ |------------- | ------------- | ------------- | -------------|
3519
+ | **connectionRequest** | **ConnectionRequest**| | |
3520
+ | **connectionId** | [**number**] | Connection ID | defaults to undefined|
3521
+ | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
3522
+
3523
+
3524
+ ### Return type
3525
+
3526
+ **OutboundCli**
3527
+
3528
+ ### Authorization
3529
+
3530
+ No authorization required
3531
+
3532
+ ### HTTP request headers
3533
+
3534
+ - **Content-Type**: application/json
3535
+ - **Accept**: application/json
3536
+
3537
+
3538
+ ### HTTP response details
3539
+ | Status code | Description | Response headers |
3540
+ |-------------|-------------|------------------|
3541
+ |**200** | Connection | - |
3542
+ |**400** | Bad Request | - |
3543
+ |**401** | Unauthorised | - |
3544
+ |**403** | Access Denied | - |
3545
+
3546
+ [[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)
3547
+
3548
+ # **putGetPriceGroups**
3549
+ > PriceGroup putGetPriceGroups(putGetPriceGroupsRequest)
3550
+
3551
+ Update Price Group
3552
+
3553
+ ### Example
3554
+
3555
+ ```typescript
3556
+ import {
3557
+ BillingApi,
3558
+ Configuration,
3559
+ PutGetPriceGroupsRequest
3560
+ } from 'yellowgrid-api-ts';
3561
+
3562
+ const configuration = new Configuration();
3563
+ const apiInstance = new BillingApi(configuration);
3564
+
3565
+ let priceGroupId: number; //Price Group ID (default to undefined)
3566
+ let putGetPriceGroupsRequest: PutGetPriceGroupsRequest; //
3567
+
3568
+ const { status, data } = await apiInstance.putGetPriceGroups(
3569
+ priceGroupId,
3570
+ putGetPriceGroupsRequest
3571
+ );
3572
+ ```
3573
+
3574
+ ### Parameters
3575
+
3576
+ |Name | Type | Description | Notes|
3577
+ |------------- | ------------- | ------------- | -------------|
3578
+ | **putGetPriceGroupsRequest** | **PutGetPriceGroupsRequest**| | |
3579
+ | **priceGroupId** | [**number**] | Price Group ID | defaults to undefined|
3580
+
3581
+
3582
+ ### Return type
3583
+
3584
+ **PriceGroup**
100
3585
 
101
3586
  ### Authorization
102
3587
 
@@ -111,7 +3596,7 @@ No authorization required
111
3596
  ### HTTP response details
112
3597
  | Status code | Description | Response headers |
113
3598
  |-------------|-------------|------------------|
114
- |**200** | Billing Connection | - |
3599
+ |**200** | Price Group | - |
115
3600
  |**400** | Bad Request | - |
116
3601
  |**401** | Unauthorised | - |
117
3602
  |**403** | Access Denied | - |