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