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

package/docs/PostGetPriceGroupsRequest.md

@@ -0,0 +1,22 @@
+# PostGetPriceGroupsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetPriceGroupsRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetPriceGroupsRequest = {
+    name,
+    description,
+};
+```
+
+[[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/PostGetProductRequest.md

@@ -0,0 +1,24 @@
+# PostGetProductRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetProductRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetProductRequest = {
+    quantity,
+    licenceKey,
+    hosting,
+};
+```
+
+[[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/PostGetServicePlansRequest.md

@@ -0,0 +1,22 @@
+# PostGetServicePlansRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetServicePlansRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetServicePlansRequest = {
+    name,
+    planGroup,
+};
+```
+
+[[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/PostGetSipTrunksBillingRequest.md

@@ -0,0 +1,34 @@
+# PostGetSipTrunksBillingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parentEndpointId** | **string** |  | [optional] [default to undefined]
+**endpointId** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**callTariffPlanName** | **string** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+**isMtPrimarySipTrunk** | **boolean** |  | [optional] [default to undefined]
+**mtPrimarySipTrunkId** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetSipTrunksBillingRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetSipTrunksBillingRequest = {
+    parentEndpointId,
+    endpointId,
+    connectionDate,
+    servicePlanName,
+    callTariffPlanName,
+    invoiceDescription,
+    isMtPrimarySipTrunk,
+    mtPrimarySipTrunkId,
+};
+```
+
+[[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/PostUpdateConnectionRequest.md

@@ -0,0 +1,22 @@
+# PostUpdateConnectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostUpdateConnectionRequest } from 'yellowgrid-api-ts';
+
+const instance: PostUpdateConnectionRequest = {
+    property,
+    value,
+};
+```
+
+[[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/PostUpdateRecurringChargeRequest.md

@@ -0,0 +1,30 @@
+# PostUpdateRecurringChargeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**endPeriod** | **string** | Date Time | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostUpdateRecurringChargeRequest } from 'yellowgrid-api-ts';
+
+const instance: PostUpdateRecurringChargeRequest = {
+    reference,
+    description,
+    customerCharge,
+    quantity,
+    endPeriod,
+    accountCode,
+};
+```
+
+[[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/PriceGroup.md

@@ -0,0 +1,30 @@
+# PriceGroup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**category** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PriceGroup } from 'yellowgrid-api-ts';
+
+const instance: PriceGroup = {
+    createdDate,
+    id,
+    name,
+    category,
+    description,
+    filePeriod,
+};
+```
+
+[[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

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProcessedCdr.md

@@ -0,0 +1,96 @@
+# ProcessedCdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**cdrId** | **number** |  | [optional] [default to undefined]
+**cdr** | [**Cdr**](Cdr.md) |  | [optional] [default to undefined]
+**contentReference** | **string** |  | [optional] [default to undefined]
+**callClass** | **string** |  | [optional] [default to undefined]
+**inbound** | **boolean** |  | [optional] [default to undefined]
+**cli** | **string** |  | [optional] [default to undefined]
+**presentationNumber** | **string** |  | [optional] [default to undefined]
+**outboundCliId** | **number** |  | [optional] [default to undefined]
+**outboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**mtPrimaryOutboundCliId** | **number** |  | [optional] [default to undefined]
+**mtPrimaryOutboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**callTariffPlan** | [**CallTariffPlan**](CallTariffPlan.md) |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) |  | [optional] [default to undefined]
+**callTariffId** | **number** |  | [optional] [default to undefined]
+**callTariff** | [**CallTariff**](CallTariff.md) |  | [optional] [default to undefined]
+**customerChargePreRounded** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**customerChargePostBundle** | **number** |  | [optional] [default to undefined]
+**bundleName** | **string** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**tariffPlanName** | **string** |  | [optional] [default to undefined]
+**chargecode** | **string** |  | [optional] [default to undefined]
+**priceGroupName** | **string** |  | [optional] [default to undefined]
+**unknownDestRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**ngcsAcsChgPerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAcsChgPerCall** | **number** |  | [optional] [default to undefined]
+**customerNGCSAcssChg** | **number** |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**salesprice** | **number** |  | [optional] [default to undefined]
+**callDateTime** | **string** |  | [optional] [default to undefined]
+**duration** | **number** |  | [optional] [default to undefined]
+**ngcsServiceCharge** | **number** |  | [optional] [default to undefined]
+**cdrDescription** | **string** |  | [optional] [default to undefined]
+**calledNumber** | **string** |  | [optional] [default to undefined]
+**remarks** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProcessedCdr } from 'yellowgrid-api-ts';
+
+const instance: ProcessedCdr = {
+    id,
+    cdrId,
+    cdr,
+    contentReference,
+    callClass,
+    inbound,
+    cli,
+    presentationNumber,
+    outboundCliId,
+    outboundCli,
+    mtPrimaryOutboundCliId,
+    mtPrimaryOutboundCli,
+    callTariffPlanId,
+    callTariffPlan,
+    inboundTariffPlanId,
+    inboundTariffPlan,
+    callTariffId,
+    callTariff,
+    customerChargePreRounded,
+    customerCharge,
+    customerChargePostBundle,
+    bundleName,
+    customerId,
+    tariffPlanName,
+    chargecode,
+    priceGroupName,
+    unknownDestRate,
+    ngcsAcsChgPerMin,
+    ngcsAcsChgPerCall,
+    customerNGCSAcssChg,
+    customerRate,
+    salesprice,
+    callDateTime,
+    duration,
+    ngcsServiceCharge,
+    cdrDescription,
+    calledNumber,
+    remarks,
+    filePeriod,
+};
+```
+
+[[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/ProductDetailedSummaryDTO.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-**dueDate** | **string** | Due Date | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
 **onOrder** | **number** | On Order | [optional] [default to undefined]
 
 ## Example

package/docs/ProductSearchDTO.md

@@ -0,0 +1,37 @@
+# ProductSearchDTO
+
+Product Search
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | Hosting | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
+**discount** | **number** | Discount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSearchDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductSearchDTO = {
+    sku,
+    quantity,
+    licenceKey,
+    hosting,
+    tcxSalesCode,
+    renewalYears,
+    orderId,
+    items,
+    discount,
+};
+```
+
+[[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/ProductSummaryDTO.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProspectDTO.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **companyName** | **string** | Company Name | [optional] [default to undefined]
 **telephone** | **string** | Telephone | [optional] [default to undefined]
-**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
-**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
+**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
+**callbackDate** | **string** | Date Time | [optional] [default to undefined]
 **xeroId** | **string** | Xero ID | [optional] [default to undefined]
 **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
 **status** | **string** | Status | [optional] [default to undefined]

package/docs/ProspectsApi.md

@@ -1,6 +1,6 @@
 # ProspectsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/PutAddCallTariffToCallTariffPlanRequest.md

@@ -0,0 +1,30 @@
+# PutAddCallTariffToCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tariffRateMarkup** | **string** |  | [optional] [default to undefined]
+**tariffRateDay** | **number** |  | [optional] [default to undefined]
+**tariffRateEvening** | **number** |  | [optional] [default to undefined]
+**tariffRateWeekend** | **number** |  | [optional] [default to undefined]
+**tariffRateMinimum** | **number** |  | [optional] [default to undefined]
+**tariffRateSetup** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAddCallTariffToCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutAddCallTariffToCallTariffPlanRequest = {
+    tariffRateMarkup,
+    tariffRateDay,
+    tariffRateEvening,
+    tariffRateWeekend,
+    tariffRateMinimum,
+    tariffRateSetup,
+};
+```
+
+[[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/PutAddServiceToServicePlanRequest.md

@@ -0,0 +1,26 @@
+# PutAddServiceToServicePlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerRate_Markup** | **string** |  | [optional] [default to undefined]
+**customerRate_Amount** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAddServiceToServicePlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutAddServiceToServicePlanRequest = {
+    customerRate_Markup,
+    customerRate_Amount,
+    description,
+    hideOnInvoice,
+};
+```
+
+[[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/PutConnectionSearchRequest.md

@@ -0,0 +1,20 @@
+# PutConnectionSearchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutConnectionSearchRequest } from 'yellowgrid-api-ts';
+
+const instance: PutConnectionSearchRequest = {
+    customerId,
+};
+```
+
+[[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/PutGetBaseServicesRequest.md

@@ -0,0 +1,28 @@
+# PutGetBaseServicesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**serviceCodeAdmin** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**dataType** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetBaseServicesRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetBaseServicesRequest = {
+    property,
+    value,
+    serviceCodeAdmin,
+    description,
+    dataType,
+};
+```
+
+[[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/PutGetCallTariffPlanRequest.md

@@ -0,0 +1,28 @@
+# PutGetCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateType** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetCallTariffPlanRequest = {
+    name,
+    unknownDestinationsRateType,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[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/PutGetPriceGroupsRequest.md

@@ -0,0 +1,28 @@
+# PutGetPriceGroupsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetPriceGroupsRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetPriceGroupsRequest = {
+    property,
+    value,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[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/RecordingsBackupInfoDTO.md

@@ -6,8 +6,8 @@ Recordings Backup Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |  | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/RecurringCharge.md

@@ -0,0 +1,48 @@
+# RecurringCharge
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**customer** | [**Customer**](Customer.md) |  | [default to undefined]
+**phoneNumber** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**channelPartnerBuy** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**frequency** | **number** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**isActive** | **boolean** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RecurringCharge } from 'yellowgrid-api-ts';
+
+const instance: RecurringCharge = {
+    createdDate,
+    id,
+    customerId,
+    customer,
+    phoneNumber,
+    description,
+    channelPartnerBuy,
+    customerCharge,
+    frequency,
+    startDate,
+    endDate,
+    quantity,
+    accountCode,
+    filePeriod,
+    isActive,
+};
+```
+
+[[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/ReportRequestDTO.md

@@ -0,0 +1,37 @@
+# ReportRequestDTO
+
+Report Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report** | **string** | Report | [optional] [default to undefined]
+**start** | **string** | Date Time | [optional] [default to undefined]
+**end** | **string** | Date Time | [optional] [default to undefined]
+**month** | **number** | Month | [optional] [default to undefined]
+**year** | **number** | Year | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**recipients** | **Array<string>** | Recipients | [optional] [default to undefined]
+**graphType** | **string** | Graph Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: ReportRequestDTO = {
+    report,
+    start,
+    end,
+    month,
+    year,
+    sku,
+    price,
+    recipients,
+    graphType,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)