yellowgrid-api-ts 3.2.211-dev.0 → 3.2.213-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/.openapi-generator/FILES +40 -1
  2. package/README.md +99 -2
  3. package/api.ts +15628 -9074
  4. package/dist/api.d.ts +12504 -8223
  5. package/dist/api.js +4831 -126
  6. package/docs/BaseService.md +36 -0
  7. package/docs/BillingApi.md +3242 -25
  8. package/docs/Bundle.md +34 -0
  9. package/docs/BundleCustomer.md +34 -0
  10. package/docs/CallTariff.md +34 -0
  11. package/docs/CallTariffPlan.md +36 -0
  12. package/docs/Cdr.md +112 -0
  13. package/docs/ConnectionType.md +28 -0
  14. package/docs/ContactDetail.md +58 -0
  15. package/docs/Customer.md +98 -0
  16. package/docs/CustomerRate.md +22 -0
  17. package/docs/CustomerRateType.md +12 -0
  18. package/docs/GetDisconnectDDIRequest.md +20 -0
  19. package/docs/InboundCli.md +50 -0
  20. package/docs/InboundTariffPlan.md +32 -0
  21. package/docs/OutboundCli.md +70 -0
  22. package/docs/PostAddBroadbandRequest.md +28 -0
  23. package/docs/PostAddCallTariffToCallTariffPlanRequest.md +34 -0
  24. package/docs/PostAddEthernetRequest.md +28 -0
  25. package/docs/PostAddRecurringChargeRequest.md +30 -0
  26. package/docs/PostAddServiceToServicePlanRequest.md +30 -0
  27. package/docs/PostAddSipTrunkDDIsRequest.md +30 -0
  28. package/docs/PostGetBaseServicesRequest.md +22 -0
  29. package/docs/PostGetPriceGroupsRequest.md +22 -0
  30. package/docs/PostGetServicePlansRequest.md +22 -0
  31. package/docs/PostGetSipTrunksBillingRequest.md +34 -0
  32. package/docs/PostUpdateConnectionRequest.md +22 -0
  33. package/docs/PostUpdateRecurringChargeRequest.md +30 -0
  34. package/docs/PriceGroup.md +30 -0
  35. package/docs/ProcessedCdr.md +96 -0
  36. package/docs/PutAddCallTariffToCallTariffPlanRequest.md +30 -0
  37. package/docs/PutAddServiceToServicePlanRequest.md +26 -0
  38. package/docs/PutConnectionSearchRequest.md +20 -0
  39. package/docs/PutGetBaseServicesRequest.md +28 -0
  40. package/docs/PutGetCallTariffPlanRequest.md +28 -0
  41. package/docs/PutGetPriceGroupsRequest.md +28 -0
  42. package/docs/RecurringCharge.md +48 -0
  43. package/docs/SdrReferenceType.md +24 -0
  44. package/docs/Service.md +42 -0
  45. package/docs/ServicePlan.md +36 -0
  46. package/docs/TariffRate.md +30 -0
  47. package/package.json +2 -2
package/docs/Bundle.md ADDED
@@ -0,0 +1,34 @@
1
+ # Bundle
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
+ **name** | **string** | | [default to undefined]
11
+ **category** | **string** | | [default to undefined]
12
+ **description** | **string** | | [default to undefined]
13
+ **customers** | [**Array<Customer>**](Customer.md) | | [optional] [readonly] [default to undefined]
14
+ **bundleCustomers** | [**Array<BundleCustomer>**](BundleCustomer.md) | | [optional] [readonly] [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { Bundle } from 'yellowgrid-api-ts';
21
+
22
+ const instance: Bundle = {
23
+ createdDate,
24
+ id,
25
+ name,
26
+ category,
27
+ description,
28
+ customers,
29
+ bundleCustomers,
30
+ filePeriod,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # BundleCustomer
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
+ **bundleId** | **number** | | [optional] [default to undefined]
11
+ **bundle** | [**Bundle**](Bundle.md) | | [default to undefined]
12
+ **customerId** | **number** | | [optional] [default to undefined]
13
+ **customer** | [**Customer**](Customer.md) | | [default to undefined]
14
+ **endDate** | **string** | | [optional] [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { BundleCustomer } from 'yellowgrid-api-ts';
21
+
22
+ const instance: BundleCustomer = {
23
+ createdDate,
24
+ id,
25
+ bundleId,
26
+ bundle,
27
+ customerId,
28
+ customer,
29
+ endDate,
30
+ filePeriod,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # CallTariff
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
+ **callTariffPlanId** | **number** | | [optional] [default to undefined]
11
+ **inboundTariffPlanId** | **number** | | [optional] [default to undefined]
12
+ **priceGroupId** | **number** | | [optional] [default to undefined]
13
+ **priceGroup** | [**PriceGroup**](PriceGroup.md) | | [default to undefined]
14
+ **tariffRate** | [**TariffRate**](TariffRate.md) | | [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CallTariff } from 'yellowgrid-api-ts';
21
+
22
+ const instance: CallTariff = {
23
+ createdDate,
24
+ id,
25
+ callTariffPlanId,
26
+ inboundTariffPlanId,
27
+ priceGroupId,
28
+ priceGroup,
29
+ tariffRate,
30
+ filePeriod,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,36 @@
1
+ # CallTariffPlan
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
+ **name** | **string** | | [default to undefined]
11
+ **unknownDestinationsRate** | [**CustomerRate**](CustomerRate.md) | | [default to undefined]
12
+ **ngcsAccessChargePerMin** | **number** | | [optional] [default to undefined]
13
+ **ngcsAccessChargePerCall** | **number** | | [optional] [default to undefined]
14
+ **callTariffs** | [**Array<CallTariff>**](CallTariff.md) | | [optional] [readonly] [default to undefined]
15
+ **filePeriod** | **string** | | [optional] [default to undefined]
16
+ **closed** | **boolean** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { CallTariffPlan } from 'yellowgrid-api-ts';
22
+
23
+ const instance: CallTariffPlan = {
24
+ createdDate,
25
+ id,
26
+ name,
27
+ unknownDestinationsRate,
28
+ ngcsAccessChargePerMin,
29
+ ngcsAccessChargePerCall,
30
+ callTariffs,
31
+ filePeriod,
32
+ closed,
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)
package/docs/Cdr.md ADDED
@@ -0,0 +1,112 @@
1
+ # Cdr
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [default to undefined]
9
+ **callType** | **string** | | [default to undefined]
10
+ **callCause** | **string** | | [optional] [default to undefined]
11
+ **customerIdentifier** | **string** | | [default to undefined]
12
+ **nonChargedParty** | **string** | | [default to undefined]
13
+ **callDate** | **string** | | [default to undefined]
14
+ **callTime** | **string** | | [default to undefined]
15
+ **duration** | **number** | | [optional] [default to undefined]
16
+ **bytesTransmitted** | **number** | | [optional] [default to undefined]
17
+ **bytesReceived** | **number** | | [optional] [default to undefined]
18
+ **description** | **string** | | [optional] [default to undefined]
19
+ **chargecode** | **string** | | [optional] [default to undefined]
20
+ **timeBand** | **string** | | [optional] [default to undefined]
21
+ **salesprice** | **number** | | [optional] [default to undefined]
22
+ **salespricePreBundle** | **number** | | [optional] [default to undefined]
23
+ **extension** | **string** | | [optional] [default to undefined]
24
+ **ddi** | **string** | | [optional] [default to undefined]
25
+ **groupingID** | **string** | | [optional] [default to undefined]
26
+ **callClass** | **string** | | [optional] [default to undefined]
27
+ **carrier** | **string** | | [optional] [default to undefined]
28
+ **recording** | **boolean** | | [optional] [default to undefined]
29
+ **vat** | **string** | | [optional] [default to undefined]
30
+ **countryOfOrigin** | **string** | | [optional] [default to undefined]
31
+ **network** | **string** | | [optional] [default to undefined]
32
+ **retailTariffCode** | **string** | | [optional] [default to undefined]
33
+ **remoteNetwork** | **string** | | [optional] [default to undefined]
34
+ **apn** | **string** | | [optional] [default to undefined]
35
+ **divertedNumber** | **string** | | [optional] [default to undefined]
36
+ **ringTime** | **number** | | [optional] [default to undefined]
37
+ **recordID** | **string** | | [optional] [default to undefined]
38
+ **currency** | **string** | | [optional] [default to undefined]
39
+ **presentationNumber** | **string** | | [optional] [default to undefined]
40
+ **networkAccessReference** | **string** | | [optional] [default to undefined]
41
+ **ngcsAccessCharge** | **number** | | [optional] [default to undefined]
42
+ **ngcsServiceCharge** | **number** | | [optional] [default to undefined]
43
+ **totalBytesTransferred** | **number** | | [optional] [default to undefined]
44
+ **userID** | **string** | | [optional] [default to undefined]
45
+ **onwardBillingReference** | **string** | | [optional] [default to undefined]
46
+ **contractName** | **string** | | [optional] [default to undefined]
47
+ **bundleName** | **string** | | [optional] [default to undefined]
48
+ **bundleAllowance** | **number** | | [optional] [default to undefined]
49
+ **discountReference** | **string** | | [optional] [default to undefined]
50
+ **routingCode** | **string** | | [optional] [default to undefined]
51
+ **filename** | **string** | | [default to undefined]
52
+ **contentReference** | **string** | | [default to undefined]
53
+ **processedCdr** | [**ProcessedCdr**](ProcessedCdr.md) | | [optional] [default to undefined]
54
+ **filePeriod** | **string** | | [default to undefined]
55
+
56
+ ## Example
57
+
58
+ ```typescript
59
+ import { Cdr } from 'yellowgrid-api-ts';
60
+
61
+ const instance: Cdr = {
62
+ id,
63
+ callType,
64
+ callCause,
65
+ customerIdentifier,
66
+ nonChargedParty,
67
+ callDate,
68
+ callTime,
69
+ duration,
70
+ bytesTransmitted,
71
+ bytesReceived,
72
+ description,
73
+ chargecode,
74
+ timeBand,
75
+ salesprice,
76
+ salespricePreBundle,
77
+ extension,
78
+ ddi,
79
+ groupingID,
80
+ callClass,
81
+ carrier,
82
+ recording,
83
+ vat,
84
+ countryOfOrigin,
85
+ network,
86
+ retailTariffCode,
87
+ remoteNetwork,
88
+ apn,
89
+ divertedNumber,
90
+ ringTime,
91
+ recordID,
92
+ currency,
93
+ presentationNumber,
94
+ networkAccessReference,
95
+ ngcsAccessCharge,
96
+ ngcsServiceCharge,
97
+ totalBytesTransferred,
98
+ userID,
99
+ onwardBillingReference,
100
+ contractName,
101
+ bundleName,
102
+ bundleAllowance,
103
+ discountReference,
104
+ routingCode,
105
+ filename,
106
+ contentReference,
107
+ processedCdr,
108
+ filePeriod,
109
+ };
110
+ ```
111
+
112
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # ConnectionType
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
+ **name** | **string** | | [default to undefined]
11
+ **description** | **string** | | [optional] [default to undefined]
12
+ **accountCode** | **string** | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { ConnectionType } from 'yellowgrid-api-ts';
18
+
19
+ const instance: ConnectionType = {
20
+ createdDate,
21
+ id,
22
+ name,
23
+ description,
24
+ accountCode,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,58 @@
1
+ # ContactDetail
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **customerName** | **string** | | [default to undefined]
9
+ **contactName** | **string** | | [optional] [default to undefined]
10
+ **address1** | **string** | | [optional] [default to undefined]
11
+ **address2** | **string** | | [optional] [default to undefined]
12
+ **address3** | **string** | | [optional] [default to undefined]
13
+ **address4** | **string** | | [optional] [default to undefined]
14
+ **postCode** | **string** | | [optional] [default to undefined]
15
+ **country** | **string** | | [optional] [default to undefined]
16
+ **phone1** | **string** | | [optional] [default to undefined]
17
+ **email** | **string** | | [optional] [default to undefined]
18
+ **siteInfo** | **string** | | [optional] [default to undefined]
19
+ **siteContactName** | **string** | | [optional] [default to undefined]
20
+ **siteAddress1** | **string** | | [optional] [default to undefined]
21
+ **siteAddress2** | **string** | | [optional] [default to undefined]
22
+ **siteAddress3** | **string** | | [optional] [default to undefined]
23
+ **siteAddress4** | **string** | | [optional] [default to undefined]
24
+ **sitePostcode** | **string** | | [optional] [default to undefined]
25
+ **siteCountry** | **string** | | [optional] [default to undefined]
26
+ **sitePhone1** | **string** | | [optional] [default to undefined]
27
+ **siteEmail** | **string** | | [optional] [default to undefined]
28
+
29
+ ## Example
30
+
31
+ ```typescript
32
+ import { ContactDetail } from 'yellowgrid-api-ts';
33
+
34
+ const instance: ContactDetail = {
35
+ customerName,
36
+ contactName,
37
+ address1,
38
+ address2,
39
+ address3,
40
+ address4,
41
+ postCode,
42
+ country,
43
+ phone1,
44
+ email,
45
+ siteInfo,
46
+ siteContactName,
47
+ siteAddress1,
48
+ siteAddress2,
49
+ siteAddress3,
50
+ siteAddress4,
51
+ sitePostcode,
52
+ siteCountry,
53
+ sitePhone1,
54
+ siteEmail,
55
+ };
56
+ ```
57
+
58
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,98 @@
1
+ # Customer
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
+ **customerCode** | **string** | | [default to undefined]
11
+ **parentCustomerCode** | **string** | | [optional] [default to undefined]
12
+ **customerName** | **string** | | [default to undefined]
13
+ **accountId** | **string** | | [optional] [default to undefined]
14
+ **contactName** | **string** | | [optional] [default to undefined]
15
+ **address1** | **string** | | [optional] [default to undefined]
16
+ **address2** | **string** | | [optional] [default to undefined]
17
+ **address3** | **string** | | [optional] [default to undefined]
18
+ **address4** | **string** | | [optional] [default to undefined]
19
+ **postCode** | **string** | | [optional] [default to undefined]
20
+ **country** | **string** | | [optional] [default to undefined]
21
+ **phone1** | **string** | | [optional] [default to undefined]
22
+ **email** | **string** | | [optional] [default to undefined]
23
+ **ddEnabled** | **boolean** | | [optional] [default to undefined]
24
+ **acClosedDate** | **string** | | [optional] [default to undefined]
25
+ **siteInfo** | **string** | | [optional] [default to undefined]
26
+ **siteContactName** | **string** | | [optional] [default to undefined]
27
+ **siteAddress1** | **string** | | [optional] [default to undefined]
28
+ **siteAddress2** | **string** | | [optional] [default to undefined]
29
+ **siteAddress3** | **string** | | [optional] [default to undefined]
30
+ **siteAddress4** | **string** | | [optional] [default to undefined]
31
+ **sitePostcode** | **string** | | [optional] [default to undefined]
32
+ **siteCountry** | **string** | | [optional] [default to undefined]
33
+ **sitePhone1** | **string** | | [optional] [default to undefined]
34
+ **siteEmail** | **string** | | [optional] [default to undefined]
35
+ **vatCode** | **string** | | [optional] [default to undefined]
36
+ **outboundClis** | [**Array<OutboundCli>**](OutboundCli.md) | | [optional] [readonly] [default to undefined]
37
+ **inboundClis** | [**Array<InboundCli>**](InboundCli.md) | | [optional] [readonly] [default to undefined]
38
+ **bundles** | [**Array<Bundle>**](Bundle.md) | | [optional] [readonly] [default to undefined]
39
+ **bundleCustomers** | [**Array<BundleCustomer>**](BundleCustomer.md) | | [optional] [readonly] [default to undefined]
40
+ **ddiBilling** | **boolean** | | [optional] [default to undefined]
41
+ **lastInvoiceNumber** | **string** | | [optional] [default to undefined]
42
+ **username** | **string** | | [optional] [default to undefined]
43
+ **sshKey** | **string** | | [optional] [default to undefined]
44
+ **directCustomer** | **boolean** | | [optional] [readonly] [default to undefined]
45
+ **parentCustomer** | **boolean** | | [optional] [readonly] [default to undefined]
46
+ **childCustomer** | **boolean** | | [optional] [readonly] [default to undefined]
47
+ **acClosed** | **boolean** | | [optional] [readonly] [default to undefined]
48
+
49
+ ## Example
50
+
51
+ ```typescript
52
+ import { Customer } from 'yellowgrid-api-ts';
53
+
54
+ const instance: Customer = {
55
+ createdDate,
56
+ id,
57
+ customerCode,
58
+ parentCustomerCode,
59
+ customerName,
60
+ accountId,
61
+ contactName,
62
+ address1,
63
+ address2,
64
+ address3,
65
+ address4,
66
+ postCode,
67
+ country,
68
+ phone1,
69
+ email,
70
+ ddEnabled,
71
+ acClosedDate,
72
+ siteInfo,
73
+ siteContactName,
74
+ siteAddress1,
75
+ siteAddress2,
76
+ siteAddress3,
77
+ siteAddress4,
78
+ sitePostcode,
79
+ siteCountry,
80
+ sitePhone1,
81
+ siteEmail,
82
+ vatCode,
83
+ outboundClis,
84
+ inboundClis,
85
+ bundles,
86
+ bundleCustomers,
87
+ ddiBilling,
88
+ lastInvoiceNumber,
89
+ username,
90
+ sshKey,
91
+ directCustomer,
92
+ parentCustomer,
93
+ childCustomer,
94
+ acClosed,
95
+ };
96
+ ```
97
+
98
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # CustomerRate
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **markup** | [**CustomerRateType**](CustomerRateType.md) | | [optional] [default to undefined]
9
+ **amount** | **number** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { CustomerRate } from 'yellowgrid-api-ts';
15
+
16
+ const instance: CustomerRate = {
17
+ markup,
18
+ amount,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # CustomerRateType
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Fixed` (value: `'FIXED'`)
7
+
8
+ * `MarkupPercent` (value: `'MARKUP_PERCENT'`)
9
+
10
+ * `MarkupFixed` (value: `'MARKUP_FIXED'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # GetDisconnectDDIRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GetDisconnectDDIRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: GetDisconnectDDIRequest = {
16
+ id,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,50 @@
1
+ # InboundCli
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
+ **cli** | **string** | | [default to undefined]
11
+ **customerId** | **number** | | [optional] [default to undefined]
12
+ **customer** | [**Customer**](Customer.md) | | [default to undefined]
13
+ **prefix** | **string** | | [default to undefined]
14
+ **phoneNumber** | **string** | | [default to undefined]
15
+ **operator** | **string** | | [default to undefined]
16
+ **inboundTariffPlanId** | **number** | | [optional] [default to undefined]
17
+ **inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) | | [optional] [default to undefined]
18
+ **invoiceDescription** | **string** | | [optional] [default to undefined]
19
+ **connected** | **boolean** | | [optional] [default to undefined]
20
+ **disconnectedDate** | **string** | | [optional] [default to undefined]
21
+ **lastInvoicedPeriod** | **string** | | [optional] [default to undefined]
22
+ **planName** | **string** | | [optional] [default to undefined]
23
+ **filePeriod** | **string** | | [optional] [default to undefined]
24
+
25
+ ## Example
26
+
27
+ ```typescript
28
+ import { InboundCli } from 'yellowgrid-api-ts';
29
+
30
+ const instance: InboundCli = {
31
+ createdDate,
32
+ id,
33
+ cli,
34
+ customerId,
35
+ customer,
36
+ prefix,
37
+ phoneNumber,
38
+ operator,
39
+ inboundTariffPlanId,
40
+ inboundTariffPlan,
41
+ invoiceDescription,
42
+ connected,
43
+ disconnectedDate,
44
+ lastInvoicedPeriod,
45
+ planName,
46
+ filePeriod,
47
+ };
48
+ ```
49
+
50
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,32 @@
1
+ # InboundTariffPlan
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
+ **name** | **string** | | [default to undefined]
11
+ **rate** | [**TariffRate**](TariffRate.md) | | [default to undefined]
12
+ **terminationOverrideTariffs** | [**Array<CallTariff>**](CallTariff.md) | | [optional] [readonly] [default to undefined]
13
+ **filePeriod** | **string** | | [optional] [default to undefined]
14
+ **closed** | **boolean** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { InboundTariffPlan } from 'yellowgrid-api-ts';
20
+
21
+ const instance: InboundTariffPlan = {
22
+ createdDate,
23
+ id,
24
+ name,
25
+ rate,
26
+ terminationOverrideTariffs,
27
+ filePeriod,
28
+ closed,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,70 @@
1
+ # OutboundCli
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
+ **cli** | **string** | | [default to undefined]
11
+ **customerId** | **number** | | [optional] [default to undefined]
12
+ **customer** | [**Customer**](Customer.md) | | [optional] [default to undefined]
13
+ **operator** | **string** | | [optional] [default to undefined]
14
+ **callTariffPlanId** | **number** | | [optional] [default to undefined]
15
+ **callTariffPlan** | [**CallTariffPlan**](CallTariffPlan.md) | | [optional] [default to undefined]
16
+ **servicePlanId** | **number** | | [optional] [default to undefined]
17
+ **servicePlan** | [**ServicePlan**](ServicePlan.md) | | [optional] [default to undefined]
18
+ **invoiceDescription** | **string** | | [optional] [default to undefined]
19
+ **inboundTariffPlanId** | **number** | | [optional] [default to undefined]
20
+ **inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) | | [optional] [default to undefined]
21
+ **inboundInvoiceDescription** | **string** | | [optional] [default to undefined]
22
+ **serviceID** | **string** | | [optional] [default to undefined]
23
+ **connectedDate** | **string** | | [optional] [default to undefined]
24
+ **disconnectedDate** | **string** | | [optional] [default to undefined]
25
+ **lastTrafficPeriod** | **string** | | [optional] [default to undefined]
26
+ **filePeriod** | **string** | | [optional] [default to undefined]
27
+ **sipTrunkSdrRefId** | **number** | | [optional] [default to undefined]
28
+ **isMtPrimarySipTrunk** | **boolean** | | [optional] [default to undefined]
29
+ **mtPrimarySipTrunkId** | **number** | | [optional] [default to undefined]
30
+ **zeroRated** | **boolean** | | [optional] [default to undefined]
31
+ **connected** | **boolean** | | [optional] [readonly] [default to undefined]
32
+ **futureConnection** | **boolean** | | [optional] [readonly] [default to undefined]
33
+ **sdrRefType** | [**SdrReferenceType**](SdrReferenceType.md) | | [optional] [default to undefined]
34
+
35
+ ## Example
36
+
37
+ ```typescript
38
+ import { OutboundCli } from 'yellowgrid-api-ts';
39
+
40
+ const instance: OutboundCli = {
41
+ createdDate,
42
+ id,
43
+ cli,
44
+ customerId,
45
+ customer,
46
+ operator,
47
+ callTariffPlanId,
48
+ callTariffPlan,
49
+ servicePlanId,
50
+ servicePlan,
51
+ invoiceDescription,
52
+ inboundTariffPlanId,
53
+ inboundTariffPlan,
54
+ inboundInvoiceDescription,
55
+ serviceID,
56
+ connectedDate,
57
+ disconnectedDate,
58
+ lastTrafficPeriod,
59
+ filePeriod,
60
+ sipTrunkSdrRefId,
61
+ isMtPrimarySipTrunk,
62
+ mtPrimarySipTrunkId,
63
+ zeroRated,
64
+ connected,
65
+ futureConnection,
66
+ sdrRefType,
67
+ };
68
+ ```
69
+
70
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # PostAddBroadbandRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **customerId** | **number** | | [optional] [default to undefined]
9
+ **orderId** | **number** | | [optional] [default to undefined]
10
+ **connectionDate** | **string** | Date Time | [optional] [default to undefined]
11
+ **servicePlanName** | **string** | | [optional] [default to undefined]
12
+ **invoiceDescription** | **string** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { PostAddBroadbandRequest } from 'yellowgrid-api-ts';
18
+
19
+ const instance: PostAddBroadbandRequest = {
20
+ customerId,
21
+ orderId,
22
+ connectionDate,
23
+ servicePlanName,
24
+ invoiceDescription,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)