yellowgrid-api-ts 3.2.261 → 3.2.262-dev.0

package/docs/PortalAccountModel.md

@@ -6,29 +6,29 @@ Customer Account
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
-**name** | **string** | Contact Name | [optional] [default to undefined]
-**email** | **string** | Email | [optional] [default to undefined]
-**phone** | **string** | Phone Number | [optional] [default to undefined]
-**company** | **string** | Company Name | [optional] [default to undefined]
-**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
-**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**county** | **string** | County | [optional] [default to undefined]
-**iso** | **string** | Country ISO Code | [optional] [default to undefined]
-**postalCode** | **string** | Post Code | [optional] [default to undefined]
-**accountNumber** | **string** | Account Number | [optional] [default to undefined]
-**xeroId** | **string** | Xero Contact ID | [optional] [default to undefined]
-**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
-**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
-**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
-**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
-**creationDate** | **string** | Creation Date | [optional] [default to undefined]
-**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
-**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
-**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
+**id** | **number** | ID | [default to undefined]
+**name** | **string** | Contact Name | [default to undefined]
+**email** | **string** | Email | [default to undefined]
+**phone** | **string** | Phone Number | [default to undefined]
+**company** | **string** | Company Name | [default to undefined]
+**companyNumber** | **string** | Company Registration Number | [default to undefined]
+**vatNumber** | **string** | VAT Number | [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [default to undefined]
+**city** | **string** | City | [default to undefined]
+**county** | **string** | County | [default to undefined]
+**iso** | **string** | Country ISO Code | [default to undefined]
+**postalCode** | **string** | Post Code | [default to undefined]
+**accountNumber** | **string** | Account Number | [default to undefined]
+**xeroId** | **string** | Xero Contact ID | [default to undefined]
+**creditLimit** | **number** | Credit Limit | [default to undefined]
+**paymentMethod** | **string** | Payment Method | [default to undefined]
+**servicePaymentMethod** | **string** | Service Payment Method | [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [default to undefined]
+**creationDate** | **string** | Creation Date | [default to undefined]
+**prizePromo** | **boolean** | Prize Promo Enabled | [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [default to undefined]
+**cname** | **string** | Wizard CNAME | [default to undefined]
 **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
 **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
 

package/docs/PortalLoginModel.md

@@ -6,13 +6,13 @@ Portal Login
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **string** | Email Address | [optional] [default to undefined]
-**password** | **string** | Password | [optional] [default to undefined]
-**code** | **string** | MFA Code | [optional] [default to undefined]
-**secret** | **string** | MFA Secret | [optional] [default to undefined]
-**codeChallenge** | **string** | Oauth 2.0 code challenge | [optional] [default to undefined]
-**codeVerifier** | **string** | Oauth 2.0 code verifier | [optional] [default to undefined]
-**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [optional] [default to undefined]
+**email** | **string** | Email Address | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+**code** | **string** | MFA Code | [default to undefined]
+**secret** | **string** | MFA Secret | [default to undefined]
+**codeChallenge** | **string** | Oauth 2.0 code challenge | [default to undefined]
+**codeVerifier** | **string** | Oauth 2.0 code verifier | [default to undefined]
+**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [default to undefined]
 
 ## Example
 

package/docs/PostAddAdminNoteRequest.md

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

@@ -5,15 +5,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
-**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
-**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
-**legend** | **Array<string>** | Legend | [optional] [default to undefined]
-**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
+**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [default to undefined]
+**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
+**legend** | **Array<string>** | Legend | [default to undefined]
+**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
 **currency** | **string** | Currency | [optional] [default to undefined]
-**locale** | **string** | Locale | [optional] [default to undefined]
-**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [optional] [default to undefined]
-**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
+**locale** | **string** | Locale | [default to undefined]
+**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [default to undefined]
+**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
 
 ## Example
 

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/PriceListItemModel.md

@@ -6,9 +6,9 @@ Price & Stock List
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
-**price** | **number** | Price | [optional] [default to undefined]
+**price** | **number** | Price | [default to undefined]
 **rrp** | **number** | RRP | [optional] [default to undefined]
 **stock** | **number** | Stock | [optional] [default to undefined]
 

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/PrinterEntity.md

@@ -6,11 +6,11 @@ PrintersEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**brand** | **string** | brand | [optional] [default to undefined]
-**model** | **string** | model | [optional] [default to undefined]
-**sn** | **string** | sn | [optional] [default to undefined]
-**location** | **string** | location | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**brand** | **string** | brand | [default to undefined]
+**model** | **string** | model | [default to undefined]
+**sn** | **string** | sn | [default to undefined]
+**location** | **string** | location | [default to undefined]
 
 ## Example
 

package/docs/PrizesEntity.md

@@ -6,12 +6,12 @@ PrizesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**year** | **number** | year | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**title** | **string** | title | [optional] [default to undefined]
-**target** | **number** | target | [optional] [default to undefined]
-**image** | **string** | image | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**year** | **number** | year | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**title** | **string** | title | [default to undefined]
+**target** | **number** | target | [default to undefined]
+**image** | **string** | image | [default to undefined]
 
 ## Example
 

package/docs/ProductDetailedSummaryDTO.md

@@ -6,16 +6,16 @@ Product Detailed Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
 **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/ProductPriceListItemModel.md

@@ -6,9 +6,9 @@ Product Price List Item
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
-**price** | **number** | Price | [optional] [default to undefined]
+**price** | **number** | Price | [default to undefined]
 **rrp** | **number** | RRP | [optional] [default to undefined]
 **stock** | **number** | Stock | [optional] [default to undefined]
 **brand** | **string** | Brand | [optional] [default to undefined]

package/docs/ProductPriceModel.md

@@ -0,0 +1,23 @@
+# ProductPriceModel
+
+Product Price
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [default to undefined]
+**price** | **number** | Price (£) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductPriceModel } from 'yellowgrid-api-ts';
+
+const instance: ProductPriceModel = {
+    priceList,
+    price,
+};
+```
+
+[[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/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/ProductSearchResultsModel.md

@@ -6,7 +6,7 @@ Product Search Results
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [optional] [default to undefined]
+**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [default to undefined]
 
 ## Example
 

package/docs/ProductSerialInfoDTO.md

@@ -0,0 +1,27 @@
+# ProductSerialInfoDTO
+
+Product Serial Info Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Product Title | [default to undefined]
+**mac** | **boolean** | Has MAC Address | [default to undefined]
+**serialPrefixes** | **Array<string>** | Serial Prefix | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSerialInfoDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductSerialInfoDTO = {
+    sku,
+    title,
+    mac,
+    serialPrefixes,
+};
+```
+
+[[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/ProductSerialInfoModel.md

@@ -6,9 +6,9 @@ Product Serial Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Product Title | [optional] [default to undefined]
-**mac** | **boolean** | Has MAC Address | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Product Title | [default to undefined]
+**mac** | **boolean** | Has MAC Address | [default to undefined]
 **serial_prefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
 
 ## Example

package/docs/ProductSummaryDTO.md

@@ -6,14 +6,14 @@ Product Summary
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
 **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/PromoCodesEntity.md

@@ -7,16 +7,16 @@ PromoCodesEntity
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | id | [optional] [default to undefined]
-**code** | **string** | code | [optional] [default to undefined]
-**description** | **string** | description | [optional] [default to undefined]
-**banner** | **string** | banner | [optional] [default to undefined]
-**start** | **string** | start | [optional] [default to undefined]
-**expiry** | **string** | expiry | [optional] [default to undefined]
-**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
-**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
-**orderRestrictions** | **string** | orderRestrictions | [optional] [default to undefined]
-**includeDistribution** | **number** | includeDistribution | [optional] [default to undefined]
-**distributionOnly** | **number** | distributionOnly | [optional] [default to undefined]
+**code** | **string** | code | [default to undefined]
+**description** | **string** | description | [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
+**customerLimit** | **number** | customerLimit | [default to undefined]
+**globalLimit** | **number** | globalLimit | [default to undefined]
+**orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]
+**includeDistribution** | **boolean** | includeDistribution | [default to undefined]
+**distributionOnly** | **boolean** | distributionOnly | [default to undefined]
+**nfr** | **boolean** | nfr | [default to undefined]
 **note** | **string** | note | [optional] [default to undefined]
 
 ## Example
@@ -28,14 +28,14 @@ const instance: PromoCodesEntity = {
     id,
     code,
     description,
-    banner,
-    start,
-    expiry,
+    startDate,
+    endDate,
     customerLimit,
     globalLimit,
     orderRestrictions,
     includeDistribution,
     distributionOnly,
+    nfr,
     note,
 };
 ```

package/docs/PromoItemModel.md

@@ -0,0 +1,35 @@
+# PromoItemModel
+
+Promo Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [default to undefined]
+**promoId** | **number** | promoId | [default to undefined]
+**price** | **number** | price | [default to undefined]
+**discount** | **number** | discount | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**quantity** | **number** | quantity | [default to undefined]
+**bulkQuantity** | **number** | bulkQuantity | [default to undefined]
+**bulkAdd** | **number** | bulkAdd | [default to undefined]
+
+## Example
+
+```typescript
+import { PromoItemModel } from 'yellowgrid-api-ts';
+
+const instance: PromoItemModel = {
+    id,
+    promoId,
+    price,
+    discount,
+    sku,
+    quantity,
+    bulkQuantity,
+    bulkAdd,
+};
+```
+
+[[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/PromoItemsEntity.md

@@ -6,14 +6,14 @@ PromoItemsEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**promoId** | **number** | promoId | [optional] [default to undefined]
-**price** | **number** | price | [optional] [default to undefined]
-**discount** | **number** | discount | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**quantity** | **number** | quantity | [optional] [default to undefined]
-**bulkQuantity** | **number** | bulkQuantity | [optional] [default to undefined]
-**bulkAdd** | **number** | bulkAdd | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**promoId** | **number** | promoId | [default to undefined]
+**price** | **number** | price | [default to undefined]
+**discount** | **number** | discount | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**quantity** | **number** | quantity | [default to undefined]
+**bulkQuantity** | **number** | bulkQuantity | [default to undefined]
+**bulkAdd** | **number** | bulkAdd | [default to undefined]
 
 ## Example
 

package/docs/PromoModel.md

@@ -0,0 +1,45 @@
+# PromoModel
+
+Promotion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**code** | **string** | code | [default to undefined]
+**description** | **string** | description | [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
+**customerLimit** | **number** | customerLimit | [default to undefined]
+**globalLimit** | **number** | globalLimit | [default to undefined]
+**orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]
+**includeDistribution** | **boolean** | includeDistribution | [default to undefined]
+**distributionOnly** | **boolean** | distributionOnly | [default to undefined]
+**nfr** | **boolean** | nfr | [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**items** | [**Array<PromoItemModel>**](PromoItemModel.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromoModel } from 'yellowgrid-api-ts';
+
+const instance: PromoModel = {
+    id,
+    code,
+    description,
+    startDate,
+    endDate,
+    customerLimit,
+    globalLimit,
+    orderRestrictions,
+    includeDistribution,
+    distributionOnly,
+    nfr,
+    note,
+    items,
+};
+```
+
+[[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/PromoSummariesModel.md

@@ -0,0 +1,27 @@
+# PromoSummariesModel
+
+Promotions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PromoSummaryDTO>**](PromoSummaryDTO.md) | Results | [default to undefined]
+**page** | **number** | Page | [default to undefined]
+**perPage** | **number** | Per Page | [default to undefined]
+**totalResults** | **number** | Total Results | [default to undefined]
+
+## Example
+
+```typescript
+import { PromoSummariesModel } from 'yellowgrid-api-ts';
+
+const instance: PromoSummariesModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[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/PromoSummaryDTO.md

@@ -0,0 +1,31 @@
+# PromoSummaryDTO
+
+Promo Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**description** | **string** | Description | [default to undefined]
+**code** | **string** | Promo Code | [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
+**orders** | **number** | Orders | [default to undefined]
+
+## Example
+
+```typescript
+import { PromoSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: PromoSummaryDTO = {
+    id,
+    description,
+    code,
+    startDate,
+    endDate,
+    orders,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)