yellowgrid-api-ts 3.2.255 → 3.2.257
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 +1 -1
- package/README.md +3 -3
- package/api.ts +149 -149
- package/dist/api.d.ts +67 -67
- package/dist/api.js +172 -172
- package/dist/models/ConnectionTypeEnum.d.ts +63 -0
- package/dist/models/ConnectionTypeEnum.js +65 -0
- package/docs/BillingApi.md +118 -118
- package/docs/{GetDisconnectDDIRequest.md → PostDisconnectDDIRequest.md} +3 -3
- package/models/ConnectionTypeEnum.ts +64 -0
- package/package.json +1 -1
package/docs/BillingApi.md
CHANGED
|
@@ -16,8 +16,6 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
16
16
|
|[**getAddServiceToServicePlan**](#getaddservicetoserviceplan) | **GET** /billing/admin/servicePlan/service | |
|
|
17
17
|
|[**getAddSipTrunkDDIs**](#getaddsiptrunkddis) | **GET** /billing/customer/sipTrunkDDIs | |
|
|
18
18
|
|[**getConnectionSearch**](#getconnectionsearch) | **GET** /billing/admin/connections | |
|
|
19
|
-
|[**getDisconnectConnection**](#getdisconnectconnection) | **GET** /billing/customer/disconnectConnection | |
|
|
20
|
-
|[**getDisconnectDDI**](#getdisconnectddi) | **GET** /billing/customer/disconnectDDI | |
|
|
21
19
|
|[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
|
|
22
20
|
|[**getGetAllMtSipTrunks**](#getgetallmtsiptrunks) | **GET** /billing/customer/list/allMtSipTrunks | |
|
|
23
21
|
|[**getGetAllSipTrunks**](#getgetallsiptrunks) | **GET** /billing/customer/list/allSipTrunks | |
|
|
@@ -48,6 +46,8 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
48
46
|
|[**postAddRecurringCharge**](#postaddrecurringcharge) | **POST** /billing/customer/recurringCharges | |
|
|
49
47
|
|[**postAddServiceToServicePlan**](#postaddservicetoserviceplan) | **POST** /billing/admin/servicePlan/service | |
|
|
50
48
|
|[**postAddSipTrunkDDIs**](#postaddsiptrunkddis) | **POST** /billing/customer/sipTrunkDDIs | |
|
|
49
|
+
|[**postDisconnectConnection**](#postdisconnectconnection) | **POST** /billing/customer/disconnectConnection | |
|
|
50
|
+
|[**postDisconnectDDI**](#postdisconnectddi) | **POST** /billing/customer/disconnectDDI | |
|
|
51
51
|
|[**postGetBaseServices**](#postgetbaseservices) | **POST** /billing/admin/baseServices | |
|
|
52
52
|
|[**postGetCallTariffPlan**](#postgetcalltariffplan) | **POST** /billing/admin/callTariffPlan | |
|
|
53
53
|
|[**postGetConnections**](#postgetconnections) | **POST** /billing/customer/connections | |
|
|
@@ -727,122 +727,6 @@ No authorization required
|
|
|
727
727
|
|
|
728
728
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
729
729
|
|
|
730
|
-
# **getDisconnectConnection**
|
|
731
|
-
> number getDisconnectConnection(getDisconnectDDIRequest)
|
|
732
|
-
|
|
733
|
-
Disconnect Connection
|
|
734
|
-
|
|
735
|
-
### Example
|
|
736
|
-
|
|
737
|
-
```typescript
|
|
738
|
-
import {
|
|
739
|
-
BillingApi,
|
|
740
|
-
Configuration,
|
|
741
|
-
GetDisconnectDDIRequest
|
|
742
|
-
} from 'yellowgrid-api-ts';
|
|
743
|
-
|
|
744
|
-
const configuration = new Configuration();
|
|
745
|
-
const apiInstance = new BillingApi(configuration);
|
|
746
|
-
|
|
747
|
-
let getDisconnectDDIRequest: GetDisconnectDDIRequest; //
|
|
748
|
-
let billCustomerId: number; //Customer ID (optional) (default to undefined)
|
|
749
|
-
|
|
750
|
-
const { status, data } = await apiInstance.getDisconnectConnection(
|
|
751
|
-
getDisconnectDDIRequest,
|
|
752
|
-
billCustomerId
|
|
753
|
-
);
|
|
754
|
-
```
|
|
755
|
-
|
|
756
|
-
### Parameters
|
|
757
|
-
|
|
758
|
-
|Name | Type | Description | Notes|
|
|
759
|
-
|------------- | ------------- | ------------- | -------------|
|
|
760
|
-
| **getDisconnectDDIRequest** | **GetDisconnectDDIRequest**| | |
|
|
761
|
-
| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
### Return type
|
|
765
|
-
|
|
766
|
-
**number**
|
|
767
|
-
|
|
768
|
-
### Authorization
|
|
769
|
-
|
|
770
|
-
No authorization required
|
|
771
|
-
|
|
772
|
-
### HTTP request headers
|
|
773
|
-
|
|
774
|
-
- **Content-Type**: application/json
|
|
775
|
-
- **Accept**: application/json
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
### HTTP response details
|
|
779
|
-
| Status code | Description | Response headers |
|
|
780
|
-
|-------------|-------------|------------------|
|
|
781
|
-
|**200** | Connection ID | - |
|
|
782
|
-
|**400** | Bad Request | - |
|
|
783
|
-
|**401** | Unauthorised | - |
|
|
784
|
-
|**403** | Access Denied | - |
|
|
785
|
-
|
|
786
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
787
|
-
|
|
788
|
-
# **getDisconnectDDI**
|
|
789
|
-
> number getDisconnectDDI(getDisconnectDDIRequest)
|
|
790
|
-
|
|
791
|
-
Disconnect DDI
|
|
792
|
-
|
|
793
|
-
### Example
|
|
794
|
-
|
|
795
|
-
```typescript
|
|
796
|
-
import {
|
|
797
|
-
BillingApi,
|
|
798
|
-
Configuration,
|
|
799
|
-
GetDisconnectDDIRequest
|
|
800
|
-
} from 'yellowgrid-api-ts';
|
|
801
|
-
|
|
802
|
-
const configuration = new Configuration();
|
|
803
|
-
const apiInstance = new BillingApi(configuration);
|
|
804
|
-
|
|
805
|
-
let getDisconnectDDIRequest: GetDisconnectDDIRequest; //
|
|
806
|
-
let billCustomerId: number; //Customer ID (optional) (default to undefined)
|
|
807
|
-
|
|
808
|
-
const { status, data } = await apiInstance.getDisconnectDDI(
|
|
809
|
-
getDisconnectDDIRequest,
|
|
810
|
-
billCustomerId
|
|
811
|
-
);
|
|
812
|
-
```
|
|
813
|
-
|
|
814
|
-
### Parameters
|
|
815
|
-
|
|
816
|
-
|Name | Type | Description | Notes|
|
|
817
|
-
|------------- | ------------- | ------------- | -------------|
|
|
818
|
-
| **getDisconnectDDIRequest** | **GetDisconnectDDIRequest**| | |
|
|
819
|
-
| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
### Return type
|
|
823
|
-
|
|
824
|
-
**number**
|
|
825
|
-
|
|
826
|
-
### Authorization
|
|
827
|
-
|
|
828
|
-
No authorization required
|
|
829
|
-
|
|
830
|
-
### HTTP request headers
|
|
831
|
-
|
|
832
|
-
- **Content-Type**: application/json
|
|
833
|
-
- **Accept**: application/json
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
### HTTP response details
|
|
837
|
-
| Status code | Description | Response headers |
|
|
838
|
-
|-------------|-------------|------------------|
|
|
839
|
-
|**200** | DDI ID | - |
|
|
840
|
-
|**400** | Bad Request | - |
|
|
841
|
-
|**401** | Unauthorised | - |
|
|
842
|
-
|**403** | Access Denied | - |
|
|
843
|
-
|
|
844
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
845
|
-
|
|
846
730
|
# **getGetAllCustomer**
|
|
847
731
|
> { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
|
|
848
732
|
|
|
@@ -2420,6 +2304,122 @@ No authorization required
|
|
|
2420
2304
|
|
|
2421
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)
|
|
2422
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
2423
|
# **postGetBaseServices**
|
|
2424
2424
|
> Service postGetBaseServices(postGetBaseServicesRequest)
|
|
2425
2425
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PostDisconnectDDIRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { PostDisconnectDDIRequest } from 'yellowgrid-api-ts';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: PostDisconnectDDIRequest = {
|
|
16
16
|
id,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
export const ConnectionTypeEnum = {
|
|
2
|
+
"SIP_TRUNK": {
|
|
3
|
+
"name": "SIP_TRUNK",
|
|
4
|
+
"value": "SIP Trunks",
|
|
5
|
+
"publicValue": "SIP Trunks"
|
|
6
|
+
},
|
|
7
|
+
"BROADBAND": {
|
|
8
|
+
"name": "BROADBAND",
|
|
9
|
+
"value": "Broadband",
|
|
10
|
+
"publicValue": "Broadband"
|
|
11
|
+
},
|
|
12
|
+
"ETHERNET": {
|
|
13
|
+
"name": "ETHERNET",
|
|
14
|
+
"value": "Ethernet",
|
|
15
|
+
"publicValue": "Ethernet"
|
|
16
|
+
},
|
|
17
|
+
"MOBILE": {
|
|
18
|
+
"name": "MOBILE",
|
|
19
|
+
"value": "Mobile",
|
|
20
|
+
"publicValue": "Mobile"
|
|
21
|
+
},
|
|
22
|
+
"WLR": {
|
|
23
|
+
"name": "WLR",
|
|
24
|
+
"value": "WLR",
|
|
25
|
+
"publicValue": "WLR"
|
|
26
|
+
},
|
|
27
|
+
"HZN": {
|
|
28
|
+
"name": "HZN",
|
|
29
|
+
"value": "Horizon",
|
|
30
|
+
"publicValue": "Horizon"
|
|
31
|
+
},
|
|
32
|
+
"NTS": {
|
|
33
|
+
"name": "NTS",
|
|
34
|
+
"value": "NTS",
|
|
35
|
+
"publicValue": "NTS"
|
|
36
|
+
},
|
|
37
|
+
"HOSTING": {
|
|
38
|
+
"name": "HOSTING",
|
|
39
|
+
"value": "Hosting",
|
|
40
|
+
"publicValue": "Hosting"
|
|
41
|
+
},
|
|
42
|
+
"CRM": {
|
|
43
|
+
"name": "CRM",
|
|
44
|
+
"value": "CRM",
|
|
45
|
+
"publicValue": "CRM"
|
|
46
|
+
},
|
|
47
|
+
"TCX_MULTITENANT": {
|
|
48
|
+
"name": "TCX_MULTITENANT",
|
|
49
|
+
"value": "Starter Bundle",
|
|
50
|
+
"publicValue": "Starter Bundle"
|
|
51
|
+
},
|
|
52
|
+
"OTHER": {
|
|
53
|
+
"name": "OTHER",
|
|
54
|
+
"value": "Other",
|
|
55
|
+
"publicValue": "Other"
|
|
56
|
+
},
|
|
57
|
+
"RECURRING_CHARGES": {
|
|
58
|
+
"name": "RECURRING_CHARGES",
|
|
59
|
+
"value": "Recurring Charges",
|
|
60
|
+
"publicValue": "Recurring Charges"
|
|
61
|
+
}
|
|
62
|
+
} as const;
|
|
63
|
+
|
|
64
|
+
export type ConnectionTypeEnum = typeof ConnectionTypeEnum;
|