yellowgrid-api-ts 3.2.247-dev.0 → 3.2.249-dev.0

package/dist/models/ConnectionTypeEnum.d.ts

@@ -39,8 +39,8 @@ export declare const ConnectionTypeEnum: {
         readonly value: "Hosting";
         readonly publicValue: "Hosting";
     };
-    readonly CRM: {
-        readonly name: "CRM";
+    readonly CRM_INTEGRATION: {
+        readonly name: "CRM_INTEGRATION";
         readonly value: "CRM";
         readonly publicValue: "CRM";
     };
@@ -49,15 +49,25 @@ export declare const ConnectionTypeEnum: {
         readonly value: "Starter Bundle";
         readonly publicValue: "Starter Bundle";
     };
-    readonly OTHER: {
-        readonly name: "OTHER";
-        readonly value: "Other";
-        readonly publicValue: "Other";
-    };
     readonly RECURRING_CHARGES: {
         readonly name: "RECURRING_CHARGES";
         readonly value: "Recurring Charges";
         readonly publicValue: "Recurring Charges";
     };
+    readonly TLN_SMS: {
+        readonly name: "TLN_SMS";
+        readonly value: "SMS";
+        readonly publicValue: "SMS";
+    };
+    readonly CFD: {
+        readonly name: "CFD";
+        readonly value: "CFD";
+        readonly publicValue: "CFD";
+    };
+    readonly ETP_CRM: {
+        readonly name: "ETP_CRM";
+        readonly value: "EdTechPro";
+        readonly publicValue: "EdTechPro";
+    };
 };
 export type ConnectionTypeEnum = typeof ConnectionTypeEnum;

package/dist/models/ConnectionTypeEnum.js

@@ -42,8 +42,8 @@ exports.ConnectionTypeEnum = {
         "value": "Hosting",
         "publicValue": "Hosting"
     },
-    "CRM": {
-        "name": "CRM",
+    "CRM_INTEGRATION": {
+        "name": "CRM_INTEGRATION",
         "value": "CRM",
         "publicValue": "CRM"
     },
@@ -52,14 +52,24 @@ exports.ConnectionTypeEnum = {
         "value": "Starter Bundle",
         "publicValue": "Starter Bundle"
     },
-    "OTHER": {
-        "name": "OTHER",
-        "value": "Other",
-        "publicValue": "Other"
-    },
     "RECURRING_CHARGES": {
         "name": "RECURRING_CHARGES",
         "value": "Recurring Charges",
         "publicValue": "Recurring Charges"
+    },
+    "TLN_SMS": {
+        "name": "TLN_SMS",
+        "value": "SMS",
+        "publicValue": "SMS"
+    },
+    "CFD": {
+        "name": "CFD",
+        "value": "CFD",
+        "publicValue": "CFD"
+    },
+    "ETP_CRM": {
+        "name": "ETP_CRM",
+        "value": "EdTechPro",
+        "publicValue": "EdTechPro"
     }
 };

package/dist/models/ReasonEnum.d.ts

@@ -9,15 +9,10 @@ export declare const ReasonEnum: {
         readonly value: 2;
         readonly publicValue: "Faulty";
     };
-    readonly WORKING_GOOD_CONDITION: {
-        readonly name: "WORKING_GOOD_CONDITION";
+    readonly WORKING: {
+        readonly name: "WORKING";
         readonly value: 3;
         readonly publicValue: "Working (Good Condition)";
     };
-    readonly WORKING_BAD_CONDITION: {
-        readonly name: "WORKING_BAD_CONDITION";
-        readonly value: 4;
-        readonly publicValue: "Working (Bad Condition)";
-    };
 };
 export type ReasonEnum = typeof ReasonEnum;

package/dist/models/ReasonEnum.js

@@ -12,14 +12,9 @@ exports.ReasonEnum = {
         "value": 2,
         "publicValue": "Faulty"
     },
-    "WORKING_GOOD_CONDITION": {
-        "name": "WORKING_GOOD_CONDITION",
+    "WORKING": {
+        "name": "WORKING",
         "value": 3,
         "publicValue": "Working (Good Condition)"
-    },
-    "WORKING_BAD_CONDITION": {
-        "name": "WORKING_BAD_CONDITION",
-        "value": 4,
-        "publicValue": "Working (Bad Condition)"
     }
 };

package/docs/AccountDetailedSummaryDTO.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [default to undefined]
 **onHold** | **boolean** | On Hold | [default to undefined]
 **balance** | **number** | Balance (£) | [optional] [default to undefined]
+**firstOrder** | **boolean** | First Order | [default to undefined]
 
 ## Example
 
@@ -33,6 +34,7 @@ const instance: AccountDetailedSummaryDTO = {
     provisioningUrls,
     onHold,
     balance,
+    firstOrder,
 };
 ```
 

package/docs/AccountsApi.md

@@ -18,6 +18,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
 |[**getGetCustomerMap**](#getgetcustomermap) | **GET** /admin/accounts/customer/map | |
+|[**getGetDeliveryAddresses**](#getgetdeliveryaddresses) | **GET** /accounts/addresses/delivery | |
 |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
 |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
 |[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
@@ -786,6 +787,53 @@ No authorization required
 
 [[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)
 
+# **getGetDeliveryAddresses**
+> Array<AddressModel> getGetDeliveryAddresses()
+
+Get account delivery addresses
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+const { status, data } = await apiInstance.getGetDeliveryAddresses();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<AddressModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Account Delivery Addresses |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **getGetFinanceSettings**
 > AccountFinanceDTO getGetFinanceSettings()
 

package/docs/AdminRmaDTO.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **statusText** | **string** | RMA Status Text | [default to undefined]
 **approved** | **boolean** | RMA Approval Status | [default to undefined]
 **address** | [**AddressDTO**](AddressDTO.md) |  | [default to undefined]
+**advanceReplacementOrderId** | **number** | Advance Replacement Order ID | [default to undefined]
 **customerId** | **number** | Customer ID | [default to undefined]
 **xeroId** | **string** | Customer Xero ID | [default to undefined]
 **customerName** | **string** | Customer Name | [default to undefined]
@@ -48,6 +49,7 @@ const instance: AdminRmaDTO = {
     statusText,
     approved,
     address,
+    advanceReplacementOrderId,
     customerId,
     xeroId,
     customerName,

package/docs/BillingApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**deleteAddRecurringCharge**](#deleteaddrecurringcharge) | **DELETE** /billing/customer/recurringCharges | |
 |[**deleteAddServiceToServicePlan**](#deleteaddservicetoserviceplan) | **DELETE** /billing/admin/servicePlan/service | |
 |[**deleteCloseAccount**](#deletecloseaccount) | **DELETE** /billing/customer/customer | |
+|[**deleteDeleteCallTariffId**](#deletedeletecalltariffid) | **DELETE** /billing/admin/callTariffPlan/callTariff/{id} | |
 |[**deleteGetBaseServices**](#deletegetbaseservices) | **DELETE** /billing/admin/baseServices | |
 |[**deleteGetCallTariffPlan**](#deletegetcalltariffplan) | **DELETE** /billing/admin/callTariffPlan | |
 |[**deleteGetPriceGroups**](#deletegetpricegroups) | **DELETE** /billing/admin/priceGroups | |
@@ -293,6 +294,60 @@ No authorization required
 
 [[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)
 
+# **deleteDeleteCallTariffId**
+> boolean deleteDeleteCallTariffId()
+
+Delete Call Tariff By ID
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let id: number; //Call Tariff ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteCallTariffId(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Call Tariff ID | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **deleteGetBaseServices**
 > boolean deleteGetBaseServices()
 
@@ -946,7 +1001,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let billCustomerId: number; //Customer ID (optional) (default to undefined)
+let billCustomerId: string; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetBillingCustomerDetails(
     billCustomerId
@@ -957,7 +1012,7 @@ const { status, data } = await apiInstance.getGetBillingCustomerDetails(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+| **billCustomerId** | [**string**] | Customer ID | (optional) defaults to undefined|
 
 
 ### Return type
@@ -1306,7 +1361,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
+let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
 let billCustomerId: number; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetConnections(
@@ -1319,7 +1374,7 @@ const { status, data } = await apiInstance.getGetConnections(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
+| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
 | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
 
 
@@ -1665,7 +1720,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
+let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetServicesPlanDetails(
     type
@@ -1676,7 +1731,7 @@ const { status, data } = await apiInstance.getGetServicesPlanDetails(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
+| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/OrdersApi.md

@@ -10,6 +10,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
 |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
+|[**getGetCustomerOrderSummary**](#getgetcustomerordersummary) | **GET** /orders/{id}/summary | |
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
 |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
 |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
@@ -375,6 +376,60 @@ No authorization required
 
 [[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)
 
+# **getGetCustomerOrderSummary**
+> OrderSummaryDTO getGetCustomerOrderSummary()
+
+Get Order
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetCustomerOrderSummary(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**OrderSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Summary |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **getGetEditableOrder**
 > DetailedOrderRequestDTO getGetEditableOrder()
 

package/docs/PromoCodesEntity.md

@@ -6,18 +6,18 @@ PromoCodesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [default to undefined]
+**id** | **number** | id | [optional] [default to undefined]
 **code** | **string** | code | [default to undefined]
 **description** | **string** | description | [default to undefined]
-**banner** | **string** | banner | [default to undefined]
-**start** | **string** | start | [default to undefined]
-**expiry** | **string** | expiry | [default to undefined]
+**startDate** | **string** | start | [optional] [default to undefined]
+**endDate** | **string** | expiry | [optional] [default to undefined]
 **customerLimit** | **number** | customerLimit | [default to undefined]
 **globalLimit** | **number** | globalLimit | [default to undefined]
-**orderRestrictions** | **string** | orderRestrictions | [default to undefined]
-**includeDistribution** | **number** | includeDistribution | [default to undefined]
-**distributionOnly** | **number** | distributionOnly | [default to undefined]
-**note** | **string** | note | [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/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** | start | [optional] [default to undefined]
+**endDate** | **string** | expiry | [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** | Start Date | [optional] [default to undefined]
+**endDate** | **string** | End Date | [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)