yellowgrid-api-ts 3.2.218-dev.0 → 3.2.219-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +52 -1
- package/README.md +119 -2
- package/api.ts +5345 -123
- package/dist/api.d.ts +2715 -52
- package/dist/api.js +5500 -118
- package/dist/models/ConnectionTypeEnum.d.ts +63 -0
- package/dist/models/ConnectionTypeEnum.js +65 -0
- package/docs/AdminRmaDTO.md +3 -1
- package/docs/AdminRmaItemDTO.md +2 -0
- package/docs/AdminRmaSummaryDTO.md +2 -0
- package/docs/BaseService.md +36 -0
- package/docs/BillingApi.md +3575 -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/ProductSerialInfoDTO.md +27 -0
- package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
- package/docs/PutAddServiceToServicePlanRequest.md +26 -0
- package/docs/PutConnectionSearchRequest.md +20 -0
- package/docs/PutGetBaseServicesRequest.md +28 -0
- package/docs/PutGetCallTariffPlanRequest.md +28 -0
- package/docs/PutGetPriceGroupsRequest.md +28 -0
- package/docs/RMAApi.md +111 -1
- package/docs/RecurringCharge.md +48 -0
- package/docs/RmaDTO.md +2 -0
- package/docs/RmaItemDTO.md +2 -0
- package/docs/RmaOrderDTO.md +29 -0
- package/docs/RmaOrderItemDTO.md +33 -0
- package/docs/RmaOrderSummaryDTO.md +25 -0
- package/docs/RmaSummaryDTO.md +2 -0
- package/docs/Sdr.md +66 -0
- package/docs/SdrReferenceType.md +24 -0
- package/docs/Service.md +42 -0
- package/docs/ServicePlan.md +36 -0
- package/docs/SpecialService.md +40 -0
- package/docs/TariffRate.md +30 -0
- package/docs/UnconnectedSdr.md +68 -0
- package/models/ConnectionTypeEnum.ts +64 -0
- package/package.json +1 -1
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
export declare const ConnectionTypeEnum: {
|
|
2
|
+
readonly SIP_TRUNK: {
|
|
3
|
+
readonly name: "SIP_TRUNK";
|
|
4
|
+
readonly value: "SIP Trunks";
|
|
5
|
+
readonly publicValue: "SIP Trunks";
|
|
6
|
+
};
|
|
7
|
+
readonly BROADBAND: {
|
|
8
|
+
readonly name: "BROADBAND";
|
|
9
|
+
readonly value: "Broadband";
|
|
10
|
+
readonly publicValue: "Broadband";
|
|
11
|
+
};
|
|
12
|
+
readonly ETHERNET: {
|
|
13
|
+
readonly name: "ETHERNET";
|
|
14
|
+
readonly value: "Ethernet";
|
|
15
|
+
readonly publicValue: "Ethernet";
|
|
16
|
+
};
|
|
17
|
+
readonly MOBILE: {
|
|
18
|
+
readonly name: "MOBILE";
|
|
19
|
+
readonly value: "Mobile";
|
|
20
|
+
readonly publicValue: "Mobile";
|
|
21
|
+
};
|
|
22
|
+
readonly WLR: {
|
|
23
|
+
readonly name: "WLR";
|
|
24
|
+
readonly value: "WLR";
|
|
25
|
+
readonly publicValue: "WLR";
|
|
26
|
+
};
|
|
27
|
+
readonly HZN: {
|
|
28
|
+
readonly name: "HZN";
|
|
29
|
+
readonly value: "Horizon";
|
|
30
|
+
readonly publicValue: "Horizon";
|
|
31
|
+
};
|
|
32
|
+
readonly NTS: {
|
|
33
|
+
readonly name: "NTS";
|
|
34
|
+
readonly value: "NTS";
|
|
35
|
+
readonly publicValue: "NTS";
|
|
36
|
+
};
|
|
37
|
+
readonly HOSTING: {
|
|
38
|
+
readonly name: "HOSTING";
|
|
39
|
+
readonly value: "Hosting";
|
|
40
|
+
readonly publicValue: "Hosting";
|
|
41
|
+
};
|
|
42
|
+
readonly CRM: {
|
|
43
|
+
readonly name: "CRM";
|
|
44
|
+
readonly value: "CRM";
|
|
45
|
+
readonly publicValue: "CRM";
|
|
46
|
+
};
|
|
47
|
+
readonly TCX_MULTITENANT: {
|
|
48
|
+
readonly name: "TCX_MULTITENANT";
|
|
49
|
+
readonly value: "Starter Bundle";
|
|
50
|
+
readonly publicValue: "Starter Bundle";
|
|
51
|
+
};
|
|
52
|
+
readonly OTHER: {
|
|
53
|
+
readonly name: "OTHER";
|
|
54
|
+
readonly value: "Other";
|
|
55
|
+
readonly publicValue: "Other";
|
|
56
|
+
};
|
|
57
|
+
readonly RECURRING_CHARGES: {
|
|
58
|
+
readonly name: "RECURRING_CHARGES";
|
|
59
|
+
readonly value: "Recurring Charges";
|
|
60
|
+
readonly publicValue: "Recurring Charges";
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
export type ConnectionTypeEnum = typeof ConnectionTypeEnum;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ConnectionTypeEnum = void 0;
|
|
4
|
+
exports.ConnectionTypeEnum = {
|
|
5
|
+
"SIP_TRUNK": {
|
|
6
|
+
"name": "SIP_TRUNK",
|
|
7
|
+
"value": "SIP Trunks",
|
|
8
|
+
"publicValue": "SIP Trunks"
|
|
9
|
+
},
|
|
10
|
+
"BROADBAND": {
|
|
11
|
+
"name": "BROADBAND",
|
|
12
|
+
"value": "Broadband",
|
|
13
|
+
"publicValue": "Broadband"
|
|
14
|
+
},
|
|
15
|
+
"ETHERNET": {
|
|
16
|
+
"name": "ETHERNET",
|
|
17
|
+
"value": "Ethernet",
|
|
18
|
+
"publicValue": "Ethernet"
|
|
19
|
+
},
|
|
20
|
+
"MOBILE": {
|
|
21
|
+
"name": "MOBILE",
|
|
22
|
+
"value": "Mobile",
|
|
23
|
+
"publicValue": "Mobile"
|
|
24
|
+
},
|
|
25
|
+
"WLR": {
|
|
26
|
+
"name": "WLR",
|
|
27
|
+
"value": "WLR",
|
|
28
|
+
"publicValue": "WLR"
|
|
29
|
+
},
|
|
30
|
+
"HZN": {
|
|
31
|
+
"name": "HZN",
|
|
32
|
+
"value": "Horizon",
|
|
33
|
+
"publicValue": "Horizon"
|
|
34
|
+
},
|
|
35
|
+
"NTS": {
|
|
36
|
+
"name": "NTS",
|
|
37
|
+
"value": "NTS",
|
|
38
|
+
"publicValue": "NTS"
|
|
39
|
+
},
|
|
40
|
+
"HOSTING": {
|
|
41
|
+
"name": "HOSTING",
|
|
42
|
+
"value": "Hosting",
|
|
43
|
+
"publicValue": "Hosting"
|
|
44
|
+
},
|
|
45
|
+
"CRM": {
|
|
46
|
+
"name": "CRM",
|
|
47
|
+
"value": "CRM",
|
|
48
|
+
"publicValue": "CRM"
|
|
49
|
+
},
|
|
50
|
+
"TCX_MULTITENANT": {
|
|
51
|
+
"name": "TCX_MULTITENANT",
|
|
52
|
+
"value": "Starter Bundle",
|
|
53
|
+
"publicValue": "Starter Bundle"
|
|
54
|
+
},
|
|
55
|
+
"OTHER": {
|
|
56
|
+
"name": "OTHER",
|
|
57
|
+
"value": "Other",
|
|
58
|
+
"publicValue": "Other"
|
|
59
|
+
},
|
|
60
|
+
"RECURRING_CHARGES": {
|
|
61
|
+
"name": "RECURRING_CHARGES",
|
|
62
|
+
"value": "Recurring Charges",
|
|
63
|
+
"publicValue": "Recurring Charges"
|
|
64
|
+
}
|
|
65
|
+
};
|
package/docs/AdminRmaDTO.md
CHANGED
|
@@ -15,9 +15,10 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
16
16
|
**resolution** | **number** | RMA Resolution | [optional] [default to undefined]
|
|
17
17
|
**status** | **number** | RMA Status | [optional] [default to undefined]
|
|
18
|
+
**statusText** | **string** | RMA Status Text | [optional] [default to undefined]
|
|
18
19
|
**approved** | **boolean** | RMA Approval Status | [optional] [default to undefined]
|
|
19
20
|
**address** | [**AddressDTO**](AddressDTO.md) | RMA Return Address | [optional] [default to undefined]
|
|
20
|
-
**customerId** | **
|
|
21
|
+
**customerId** | **string** | Customer ID | [optional] [default to undefined]
|
|
21
22
|
**customerName** | **string** | Customer Name | [optional] [default to undefined]
|
|
22
23
|
**createdAt** | **string** | Date Time | [optional] [default to undefined]
|
|
23
24
|
**items** | [**Array<AdminRmaItemDTO>**](AdminRmaItemDTO.md) | RMA Items | [optional] [default to undefined]
|
|
@@ -42,6 +43,7 @@ const instance: AdminRmaDTO = {
|
|
|
42
43
|
ticketId,
|
|
43
44
|
resolution,
|
|
44
45
|
status,
|
|
46
|
+
statusText,
|
|
45
47
|
approved,
|
|
46
48
|
address,
|
|
47
49
|
customerId,
|
package/docs/AdminRmaItemDTO.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**serialNumber** | **string** | RMA Item Serial Number | [optional] [default to undefined]
|
|
14
14
|
**received** | **boolean** | RMA Item Received Status | [optional] [default to undefined]
|
|
15
15
|
**status** | **number** | RMA Item Status | [optional] [default to undefined]
|
|
16
|
+
**statusText** | **string** | RMA Item Status Text | [optional] [default to undefined]
|
|
16
17
|
**note** | **string** | RMA Item Note | [optional] [default to undefined]
|
|
17
18
|
**resolution** | **number** | RMA Item Resolution | [optional] [default to undefined]
|
|
18
19
|
**replacementSku** | **string** | RMA Item Replacement SKU | [optional] [default to undefined]
|
|
@@ -30,6 +31,7 @@ const instance: AdminRmaItemDTO = {
|
|
|
30
31
|
serialNumber,
|
|
31
32
|
received,
|
|
32
33
|
status,
|
|
34
|
+
statusText,
|
|
33
35
|
note,
|
|
34
36
|
resolution,
|
|
35
37
|
replacementSku,
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**orderId** | **number** | Order ID | [optional] [default to undefined]
|
|
11
11
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
12
12
|
**status** | **number** | RMA Status | [optional] [default to undefined]
|
|
13
|
+
**statusText** | **string** | Status Text | [optional] [default to undefined]
|
|
13
14
|
**items** | [**Array<RmaSummaryItemDTO>**](RmaSummaryItemDTO.md) | RMA Summary Items | [optional] [default to undefined]
|
|
14
15
|
**customerId** | **number** | RMA Customer ID | [optional] [default to undefined]
|
|
15
16
|
**customerName** | **string** | RMA Customer Name | [optional] [default to undefined]
|
|
@@ -26,6 +27,7 @@ const instance: AdminRmaSummaryDTO = {
|
|
|
26
27
|
orderId,
|
|
27
28
|
orderReference,
|
|
28
29
|
status,
|
|
30
|
+
statusText,
|
|
29
31
|
items,
|
|
30
32
|
customerId,
|
|
31
33
|
customerName,
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# BaseService
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**createdDate** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**id** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**serviceCode** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**dataType** | **string** | | [default to undefined]
|
|
12
|
+
**originalDescription** | **string** | | [default to undefined]
|
|
13
|
+
**cost** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**startDate** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**endDate** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**filePeriod** | **string** | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { BaseService } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: BaseService = {
|
|
24
|
+
createdDate,
|
|
25
|
+
id,
|
|
26
|
+
serviceCode,
|
|
27
|
+
dataType,
|
|
28
|
+
originalDescription,
|
|
29
|
+
cost,
|
|
30
|
+
startDate,
|
|
31
|
+
endDate,
|
|
32
|
+
filePeriod,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|