yellowgrid-api-ts 3.2.237 → 3.2.238-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 +367 -306
- package/.openapi-generator/VERSION +1 -1
- package/README.md +132 -3
- package/api.ts +20035 -6358
- 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 +15872 -5106
- package/dist/api.js +6725 -603
- 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/GraphTypeEnum.d.ts +13 -0
- package/dist/models/GraphTypeEnum.js +15 -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 +68 -0
- package/dist/models/ReportEnum.js +70 -0
- package/docs/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountDetailedSummaryDTO.md +2 -0
- package/docs/AccountsApi.md +49 -1
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/AxisDataDTO.md +25 -0
- 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/CustomerCoordinatesDTO.md +31 -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/GraphDTO.md +33 -0
- package/docs/InboundCli.md +50 -0
- package/docs/InboundTariffPlan.md +32 -0
- package/docs/InboundTariffPlanResponse.md +28 -0
- package/docs/MiscApi.md +63 -0
- 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 +37 -0
- package/docs/PasswordSenderEntity.md +33 -0
- 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/PostGenerateReport200Response.md +36 -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/PromoSummariesModel.md +27 -0
- package/docs/PromoSummaryDTO.md +29 -0
- package/docs/PromotionsApi.md +71 -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 +37 -0
- package/docs/ReportsApi.md +56 -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/SeriesDTO.md +27 -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/TableDTO.md +25 -0
- package/docs/TableDataDTO.md +21 -0
- package/docs/TableRowDTO.md +21 -0
- package/docs/TariffRate.md +30 -0
- package/docs/TcxHostingPricingEntity.md +35 -0
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxInstallationModel.md +2 -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/GraphTypeEnum.ts +14 -0
- package/models/GroupEnum.ts +44 -0
- package/models/HostingPriceListEnum.ts +5 -0
- package/models/ReportEnum.ts +69 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
|
@@ -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,36 @@
|
|
|
1
|
+
# PostGenerateReport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | Title | [optional] [default to undefined]
|
|
9
|
+
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
|
|
10
|
+
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
|
|
11
|
+
**legend** | **Array<string>** | Legend | [optional] [default to undefined]
|
|
12
|
+
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
|
|
13
|
+
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
14
|
+
**locale** | **string** | Locale | [optional] [default to undefined]
|
|
15
|
+
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [optional] [default to undefined]
|
|
16
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { PostGenerateReport200Response } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: PostGenerateReport200Response = {
|
|
24
|
+
title,
|
|
25
|
+
xAxis,
|
|
26
|
+
yAxis,
|
|
27
|
+
legend,
|
|
28
|
+
series,
|
|
29
|
+
currency,
|
|
30
|
+
locale,
|
|
31
|
+
headers,
|
|
32
|
+
rows,
|
|
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)
|
|
@@ -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)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# PostGetSipTrunksBillingRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**parentEndpointId** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**endpointId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**connectionDate** | **string** | Date Time | [optional] [default to undefined]
|
|
11
|
+
**servicePlanName** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**callTariffPlanName** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**invoiceDescription** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**isMtPrimarySipTrunk** | **boolean** | | [optional] [default to undefined]
|
|
15
|
+
**mtPrimarySipTrunkId** | **number** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { PostGetSipTrunksBillingRequest } from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const instance: PostGetSipTrunksBillingRequest = {
|
|
23
|
+
parentEndpointId,
|
|
24
|
+
endpointId,
|
|
25
|
+
connectionDate,
|
|
26
|
+
servicePlanName,
|
|
27
|
+
callTariffPlanName,
|
|
28
|
+
invoiceDescription,
|
|
29
|
+
isMtPrimarySipTrunk,
|
|
30
|
+
mtPrimarySipTrunkId,
|
|
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,22 @@
|
|
|
1
|
+
# PostUpdateConnectionRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**property** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**value** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PostUpdateConnectionRequest } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: PostUpdateConnectionRequest = {
|
|
17
|
+
property,
|
|
18
|
+
value,
|
|
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,30 @@
|
|
|
1
|
+
# PostUpdateRecurringChargeRequest
|
|
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 { PostUpdateRecurringChargeRequest } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: PostUpdateRecurringChargeRequest = {
|
|
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
|
+
# PriceGroup
|
|
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
|
+
**filePeriod** | **string** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PriceGroup } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: PriceGroup = {
|
|
21
|
+
createdDate,
|
|
22
|
+
id,
|
|
23
|
+
name,
|
|
24
|
+
category,
|
|
25
|
+
description,
|
|
26
|
+
filePeriod,
|
|
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,24 @@
|
|
|
1
|
+
# PriceGroupResponse
|
|
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
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PriceGroupResponse } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: PriceGroupResponse = {
|
|
18
|
+
id,
|
|
19
|
+
name,
|
|
20
|
+
description,
|
|
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)
|
package/docs/PricingApi.md
CHANGED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# ProcessedCdr
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**cdrId** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**cdr** | [**Cdr**](Cdr.md) | | [optional] [default to undefined]
|
|
11
|
+
**contentReference** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**callClass** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**inbound** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**cli** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**presentationNumber** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**outboundCliId** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**outboundCli** | [**OutboundCli**](OutboundCli.md) | | [optional] [default to undefined]
|
|
18
|
+
**mtPrimaryOutboundCliId** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**mtPrimaryOutboundCli** | [**OutboundCli**](OutboundCli.md) | | [optional] [default to undefined]
|
|
20
|
+
**callTariffPlanId** | **number** | | [optional] [default to undefined]
|
|
21
|
+
**callTariffPlan** | [**CallTariffPlan**](CallTariffPlan.md) | | [optional] [default to undefined]
|
|
22
|
+
**inboundTariffPlanId** | **number** | | [optional] [default to undefined]
|
|
23
|
+
**inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) | | [optional] [default to undefined]
|
|
24
|
+
**callTariffId** | **number** | | [optional] [default to undefined]
|
|
25
|
+
**callTariff** | [**CallTariff**](CallTariff.md) | | [optional] [default to undefined]
|
|
26
|
+
**customerChargePreRounded** | **number** | | [optional] [default to undefined]
|
|
27
|
+
**customerCharge** | **number** | | [optional] [default to undefined]
|
|
28
|
+
**customerChargePostBundle** | **number** | | [optional] [default to undefined]
|
|
29
|
+
**bundleName** | **string** | | [optional] [default to undefined]
|
|
30
|
+
**customerId** | **number** | | [optional] [default to undefined]
|
|
31
|
+
**tariffPlanName** | **string** | | [optional] [default to undefined]
|
|
32
|
+
**chargecode** | **string** | | [optional] [default to undefined]
|
|
33
|
+
**priceGroupName** | **string** | | [optional] [default to undefined]
|
|
34
|
+
**unknownDestRate** | [**CustomerRate**](CustomerRate.md) | | [optional] [default to undefined]
|
|
35
|
+
**ngcsAcsChgPerMin** | **number** | | [optional] [default to undefined]
|
|
36
|
+
**ngcsAcsChgPerCall** | **number** | | [optional] [default to undefined]
|
|
37
|
+
**customerNGCSAcssChg** | **number** | | [optional] [default to undefined]
|
|
38
|
+
**customerRate** | [**CustomerRate**](CustomerRate.md) | | [optional] [default to undefined]
|
|
39
|
+
**salesprice** | **number** | | [optional] [default to undefined]
|
|
40
|
+
**callDateTime** | **string** | | [optional] [default to undefined]
|
|
41
|
+
**duration** | **number** | | [optional] [default to undefined]
|
|
42
|
+
**ngcsServiceCharge** | **number** | | [optional] [default to undefined]
|
|
43
|
+
**cdrDescription** | **string** | | [optional] [default to undefined]
|
|
44
|
+
**calledNumber** | **string** | | [optional] [default to undefined]
|
|
45
|
+
**remarks** | **string** | | [optional] [default to undefined]
|
|
46
|
+
**filePeriod** | **string** | | [optional] [default to undefined]
|
|
47
|
+
|
|
48
|
+
## Example
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
import { ProcessedCdr } from 'yellowgrid-api-ts';
|
|
52
|
+
|
|
53
|
+
const instance: ProcessedCdr = {
|
|
54
|
+
id,
|
|
55
|
+
cdrId,
|
|
56
|
+
cdr,
|
|
57
|
+
contentReference,
|
|
58
|
+
callClass,
|
|
59
|
+
inbound,
|
|
60
|
+
cli,
|
|
61
|
+
presentationNumber,
|
|
62
|
+
outboundCliId,
|
|
63
|
+
outboundCli,
|
|
64
|
+
mtPrimaryOutboundCliId,
|
|
65
|
+
mtPrimaryOutboundCli,
|
|
66
|
+
callTariffPlanId,
|
|
67
|
+
callTariffPlan,
|
|
68
|
+
inboundTariffPlanId,
|
|
69
|
+
inboundTariffPlan,
|
|
70
|
+
callTariffId,
|
|
71
|
+
callTariff,
|
|
72
|
+
customerChargePreRounded,
|
|
73
|
+
customerCharge,
|
|
74
|
+
customerChargePostBundle,
|
|
75
|
+
bundleName,
|
|
76
|
+
customerId,
|
|
77
|
+
tariffPlanName,
|
|
78
|
+
chargecode,
|
|
79
|
+
priceGroupName,
|
|
80
|
+
unknownDestRate,
|
|
81
|
+
ngcsAcsChgPerMin,
|
|
82
|
+
ngcsAcsChgPerCall,
|
|
83
|
+
customerNGCSAcssChg,
|
|
84
|
+
customerRate,
|
|
85
|
+
salesprice,
|
|
86
|
+
callDateTime,
|
|
87
|
+
duration,
|
|
88
|
+
ngcsServiceCharge,
|
|
89
|
+
cdrDescription,
|
|
90
|
+
calledNumber,
|
|
91
|
+
remarks,
|
|
92
|
+
filePeriod,
|
|
93
|
+
};
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
14
14
|
**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
|
|
15
15
|
**rrp** | **number** | RRP Price | [optional] [default to undefined]
|
|
16
|
-
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |
|
|
16
|
+
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | | [optional] [default to undefined]
|
|
17
17
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
18
|
-
**dueDate** | **string** |
|
|
18
|
+
**dueDate** | **string** | Date Time | [optional] [default to undefined]
|
|
19
19
|
**onOrder** | **number** | On Order | [optional] [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# ProductSearchDTO
|
|
2
|
+
|
|
3
|
+
Product Search
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
11
|
+
**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
|
|
12
|
+
**hosting** | **boolean** | Hosting | [optional] [default to undefined]
|
|
13
|
+
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
14
|
+
**renewalYears** | **number** | 3CX Renewal Years | [optional] [default to undefined]
|
|
15
|
+
**orderId** | **number** | Order ID | [optional] [default to undefined]
|
|
16
|
+
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
17
|
+
**discount** | **number** | Discount | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { ProductSearchDTO } from 'yellowgrid-api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: ProductSearchDTO = {
|
|
25
|
+
sku,
|
|
26
|
+
quantity,
|
|
27
|
+
licenceKey,
|
|
28
|
+
hosting,
|
|
29
|
+
tcxSalesCode,
|
|
30
|
+
renewalYears,
|
|
31
|
+
orderId,
|
|
32
|
+
items,
|
|
33
|
+
discount,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
14
14
|
**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
|
|
15
15
|
**rrp** | **number** | RRP Price | [optional] [default to undefined]
|
|
16
|
-
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |
|
|
16
|
+
**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | | [optional] [default to undefined]
|
|
17
17
|
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
package/docs/ProductsApi.md
CHANGED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# PromoSummariesModel
|
|
2
|
+
|
|
3
|
+
Promotions
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<PromoSummaryDTO>**](PromoSummaryDTO.md) | Results | [optional] [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [optional] [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [optional] [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PromoSummariesModel } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: PromoSummariesModel = {
|
|
20
|
+
results,
|
|
21
|
+
page,
|
|
22
|
+
perPage,
|
|
23
|
+
totalResults,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[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,29 @@
|
|
|
1
|
+
# PromoSummaryDTO
|
|
2
|
+
|
|
3
|
+
Promo Summary
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**description** | **string** | Description | [optional] [default to undefined]
|
|
10
|
+
**code** | **string** | Promo Code | [optional] [default to undefined]
|
|
11
|
+
**startDate** | **string** | Date Time | [optional] [default to undefined]
|
|
12
|
+
**endDate** | **string** | Date Time | [optional] [default to undefined]
|
|
13
|
+
**orders** | **number** | Orders | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PromoSummaryDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: PromoSummaryDTO = {
|
|
21
|
+
description,
|
|
22
|
+
code,
|
|
23
|
+
startDate,
|
|
24
|
+
endDate,
|
|
25
|
+
orders,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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,71 @@
|
|
|
1
|
+
# PromotionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getGetPromos**](#getgetpromos) | **GET** /marketing/promos | |
|
|
8
|
+
|
|
9
|
+
# **getGetPromos**
|
|
10
|
+
> PromoSummariesModel getGetPromos()
|
|
11
|
+
|
|
12
|
+
Get Promos
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
PromotionsApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new PromotionsApi(configuration);
|
|
24
|
+
|
|
25
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
26
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
27
|
+
let search: string; //Search (optional) (default to undefined)
|
|
28
|
+
let expired: boolean; //Expired (optional) (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.getGetPromos(
|
|
31
|
+
pageSize,
|
|
32
|
+
page,
|
|
33
|
+
search,
|
|
34
|
+
expired
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
43
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
44
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
45
|
+
| **expired** | [**boolean**] | Expired | (optional) defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**PromoSummariesModel**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Promo Summaries | - |
|
|
66
|
+
|**400** | Bad Request | - |
|
|
67
|
+
|**401** | Unauthorised | - |
|
|
68
|
+
|**403** | Access Denied | - |
|
|
69
|
+
|
|
70
|
+
[[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)
|
|
71
|
+
|