yellowgrid-api-ts 3.2.244 → 3.2.246-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 +369 -318
- package/.openapi-generator/VERSION +1 -1
- package/README.md +123 -3
- package/api.ts +14410 -953
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +4 -3
- package/configuration.ts +21 -27
- package/dist/api.d.ts +15808 -5240
- package/dist/api.js +8872 -2842
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +4 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/ConnectionTypeEnum.d.ts +73 -0
- package/dist/models/ConnectionTypeEnum.js +75 -0
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/dist/models/HostingPriceListEnum.d.ts +5 -0
- package/dist/models/HostingPriceListEnum.js +5 -0
- package/dist/models/ReportEnum.d.ts +15 -0
- package/dist/models/ReportEnum.js +15 -0
- package/docs/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountDetailedSummaryDTO.md +2 -0
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/BaseService.md +36 -0
- package/docs/BillingApi.md +3631 -26
- package/docs/Bundle.md +34 -0
- package/docs/BundleCustomer.md +34 -0
- package/docs/CRMApi.md +1 -1
- 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/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/ConnectionRequest.md +36 -0
- package/docs/ConnectionType.md +28 -0
- package/docs/ContactDetail.md +58 -0
- package/docs/CrmActivityDTO.md +1 -1
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/Customer.md +98 -0
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/CustomerRate.md +22 -0
- package/docs/CustomerRateType.md +12 -0
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/GetDisconnectDDIRequest.md +20 -0
- package/docs/InboundCli.md +50 -0
- package/docs/InboundTariffPlan.md +32 -0
- package/docs/InboundTariffPlanResponse.md +28 -0
- package/docs/MiscApi.md +1 -1
- package/docs/MultiTenantSipTrunkRequest.md +22 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +1 -1
- package/docs/OutboundCli.md +70 -0
- package/docs/PartnerDTO.md +1 -1
- package/docs/PasswordSenderDTO.md +1 -1
- package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
- package/docs/PostAddAdminNoteRequest.md +20 -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/PostGetProductRequest.md +24 -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/PricingApi.md +1 -1
- package/docs/ProcessedCdr.md +96 -0
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductSearchDTO.md +37 -0
- package/docs/ProductSummaryDTO.md +1 -1
- package/docs/ProductsApi.md +1 -1
- package/docs/PromoCodesEntity.md +6 -6
- package/docs/PromoItemModel.md +35 -0
- package/docs/PromoModel.md +45 -0
- package/docs/PromoSummariesModel.md +27 -0
- package/docs/PromoSummaryDTO.md +29 -0
- package/docs/PromotionsApi.md +241 -0
- package/docs/ProspectDTO.md +2 -2
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- 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/RecordingsBackupInfoDTO.md +2 -2
- package/docs/RecurringCharge.md +48 -0
- package/docs/ReportRequestDTO.md +2 -2
- package/docs/ReportsApi.md +1 -1
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- 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/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingApi.md +1 -1
- package/docs/SpecialService.md +40 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/SuppliersApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TariffRate.md +30 -0
- package/docs/TcxHostingPricingEntity.md +35 -0
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/UnconnectedSdr.md +68 -0
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/ConnectionTypeEnum.ts +74 -0
- package/models/GroupEnum.ts +44 -0
- package/models/HostingPriceListEnum.ts +5 -0
- package/models/ReportEnum.ts +15 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
|
@@ -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,28 @@
|
|
|
1
|
+
# InboundTariffPlanResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**rate** | [**TariffRate**](TariffRate.md) | | [optional] [default to undefined]
|
|
11
|
+
**callTariffs** | [**Array<CallTariffResponse>**](CallTariffResponse.md) | | [optional] [default to undefined]
|
|
12
|
+
**closed** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { InboundTariffPlanResponse } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: InboundTariffPlanResponse = {
|
|
20
|
+
id,
|
|
21
|
+
name,
|
|
22
|
+
rate,
|
|
23
|
+
callTariffs,
|
|
24
|
+
closed,
|
|
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)
|
package/docs/MiscApi.md
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MultiTenantSipTrunkRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**isPrimary** | **boolean** | | [default to undefined]
|
|
9
|
+
**mtPrimarySipTrunkId** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MultiTenantSipTrunkRequest } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: MultiTenantSipTrunkRequest = {
|
|
17
|
+
isPrimary,
|
|
18
|
+
mtPrimarySipTrunkId,
|
|
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)
|
package/docs/MyPBXToolsApi.md
CHANGED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# NumberPortModel
|
|
2
|
+
|
|
3
|
+
Number Port Model
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Number Port ID | [optional] [default to undefined]
|
|
10
|
+
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
11
|
+
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
12
|
+
**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
|
|
13
|
+
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
14
|
+
**city** | **string** | City | [optional] [default to undefined]
|
|
15
|
+
**postCode** | **string** | Post Code | [optional] [default to undefined]
|
|
16
|
+
**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
|
|
17
|
+
**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
|
|
18
|
+
**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
|
|
19
|
+
**portDate** | **string** | Port Date | [optional] [default to undefined]
|
|
20
|
+
**comment** | **string** | Comment | [optional] [default to undefined]
|
|
21
|
+
**status** | **number** | Status | [optional] [default to undefined]
|
|
22
|
+
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
23
|
+
**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
|
|
24
|
+
**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { NumberPortModel } from 'yellowgrid-api-ts';
|
|
30
|
+
|
|
31
|
+
const instance: NumberPortModel = {
|
|
32
|
+
id,
|
|
33
|
+
customerId,
|
|
34
|
+
endUser,
|
|
35
|
+
addressLine1,
|
|
36
|
+
addressLine2,
|
|
37
|
+
city,
|
|
38
|
+
postCode,
|
|
39
|
+
trunkId,
|
|
40
|
+
tenantId,
|
|
41
|
+
requestedPortDate,
|
|
42
|
+
portDate,
|
|
43
|
+
comment,
|
|
44
|
+
status,
|
|
45
|
+
ticketId,
|
|
46
|
+
ranges,
|
|
47
|
+
customerName,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[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/NumberPortingApi.md
CHANGED
package/docs/OAuth20Api.md
CHANGED
package/docs/OrdersApi.md
CHANGED
|
@@ -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)
|
package/docs/PartnerDTO.md
CHANGED
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
|
|
18
18
|
**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
|
|
19
19
|
**aligned** | **boolean** | Aligned | [optional] [default to undefined]
|
|
20
|
-
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |
|
|
20
|
+
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [optional] [default to undefined]
|
|
21
21
|
|
|
22
22
|
## Example
|
|
23
23
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**password** | **string** | Password | [optional] [default to undefined]
|
|
11
11
|
**expiryInterval** | **number** | Expiry Interval | [optional] [default to undefined]
|
|
12
12
|
**intervalType** | **string** | Interval Type | [optional] [default to undefined]
|
|
13
|
-
**expiry** | **string** |
|
|
13
|
+
**expiry** | **string** | Date Time | [optional] [default to undefined]
|
|
14
14
|
**recipient** | **Array<string>** | Recipient | [optional] [default to undefined]
|
|
15
15
|
**url** | **string** | URL | [optional] [default to undefined]
|
|
16
16
|
**description** | **string** | Description | [optional] [default to undefined]
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchSetTcxWizardCnameRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**cname** | **string** | CNAME | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchSetTcxWizardCnameRequest = {
|
|
16
|
+
cname,
|
|
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,20 @@
|
|
|
1
|
+
# PostAddAdminNoteRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**note** | **string** | Note | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PostAddAdminNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PostAddAdminNoteRequest = {
|
|
16
|
+
note,
|
|
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,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)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# PostAddCallTariffToCallTariffPlanRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**planName** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**priceGroupName** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**tariffRateMarkup** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**tariffRateDay** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**tariffRateEvening** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**tariffRateWeekend** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**tariffRateMinimum** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**tariffRateSetup** | **number** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { PostAddCallTariffToCallTariffPlanRequest } from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: PostAddCallTariffToCallTariffPlanRequest = {
|
|
23
|
+
planName,
|
|
24
|
+
priceGroupName,
|
|
25
|
+
tariffRateMarkup,
|
|
26
|
+
tariffRateDay,
|
|
27
|
+
tariffRateEvening,
|
|
28
|
+
tariffRateWeekend,
|
|
29
|
+
tariffRateMinimum,
|
|
30
|
+
tariffRateSetup,
|
|
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,28 @@
|
|
|
1
|
+
# PostAddEthernetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**customerId** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**cesRef** | **string** | | [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 { PostAddEthernetRequest } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: PostAddEthernetRequest = {
|
|
20
|
+
customerId,
|
|
21
|
+
cesRef,
|
|
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)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# PostAddRecurringChargeRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**reference** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**customerCharge** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**quantity** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**endPeriod** | **string** | Date Time | [optional] [default to undefined]
|
|
13
|
+
**accountCode** | **string** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PostAddRecurringChargeRequest } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: PostAddRecurringChargeRequest = {
|
|
21
|
+
reference,
|
|
22
|
+
description,
|
|
23
|
+
customerCharge,
|
|
24
|
+
quantity,
|
|
25
|
+
endPeriod,
|
|
26
|
+
accountCode,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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,30 @@
|
|
|
1
|
+
# PostAddServiceToServicePlanRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**serviceCode** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**planGroup** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**customerRate_Markup** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**customerRate_Amount** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**hideOnInvoice** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PostAddServiceToServicePlanRequest } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: PostAddServiceToServicePlanRequest = {
|
|
21
|
+
serviceCode,
|
|
22
|
+
planGroup,
|
|
23
|
+
customerRate_Markup,
|
|
24
|
+
customerRate_Amount,
|
|
25
|
+
description,
|
|
26
|
+
hideOnInvoice,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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,30 @@
|
|
|
1
|
+
# PostAddSipTrunkDDIsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startDDI** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
**sipTrunkSdrRefId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**connectionDate** | **string** | Date Time | [optional] [default to undefined]
|
|
11
|
+
**endDDI** | **Array<string>** | | [optional] [default to undefined]
|
|
12
|
+
**inboundTariffPlanName** | **Array<string>** | | [optional] [default to undefined]
|
|
13
|
+
**invoiceDescription** | **Array<string>** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PostAddSipTrunkDDIsRequest } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: PostAddSipTrunkDDIsRequest = {
|
|
21
|
+
startDDI,
|
|
22
|
+
sipTrunkSdrRefId,
|
|
23
|
+
connectionDate,
|
|
24
|
+
endDDI,
|
|
25
|
+
inboundTariffPlanName,
|
|
26
|
+
invoiceDescription,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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
|
+
# PostDisconnectDDIRequest
|
|
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 { PostDisconnectDDIRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PostDisconnectDDIRequest = {
|
|
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,22 @@
|
|
|
1
|
+
# PostGetBaseServicesRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**serviceCode** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**originalDescription** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PostGetBaseServicesRequest } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: PostGetBaseServicesRequest = {
|
|
17
|
+
serviceCode,
|
|
18
|
+
originalDescription,
|
|
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,22 @@
|
|
|
1
|
+
# PostGetPriceGroupsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PostGetPriceGroupsRequest } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: PostGetPriceGroupsRequest = {
|
|
17
|
+
name,
|
|
18
|
+
description,
|
|
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,24 @@
|
|
|
1
|
+
# PostGetProductRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
9
|
+
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
10
|
+
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PostGetProductRequest } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: PostGetProductRequest = {
|
|
18
|
+
quantity,
|
|
19
|
+
licenceKey,
|
|
20
|
+
hosting,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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
|
+
# PostGetServicePlansRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**planGroup** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PostGetServicePlansRequest } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: PostGetServicePlansRequest = {
|
|
17
|
+
name,
|
|
18
|
+
planGroup,
|
|
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)
|