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

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** | 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]
 
 ## 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** | 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)

package/docs/PromotionsApi.md

@@ -0,0 +1,241 @@
+# PromotionsApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetPromo**](#getgetpromo) | **GET** /marketing/promos/{id} | |
+|[**getGetPromos**](#getgetpromos) | **GET** /marketing/promos | |
+|[**postGetPromos**](#postgetpromos) | **POST** /marketing/promos | |
+|[**putGetPromo**](#putgetpromo) | **PUT** /marketing/promos/{id} | |
+
+# **getGetPromo**
+> PromoModel getGetPromo()
+
+Get a promotion
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let id: number; //Promo ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetPromo(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Promo ID | defaults to undefined|
+
+
+### Return type
+
+**PromoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promotion |  -  |
+|**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)
+
+# **getGetPromos**
+> PromoSummariesModel getGetPromos()
+
+Get Promos
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+let expired: boolean; //Expired (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetPromos(
+    pageSize,
+    page,
+    search,
+    expired
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+| **expired** | [**boolean**] | Expired | (optional) defaults to undefined|
+
+
+### Return type
+
+**PromoSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promo Summaries |  -  |
+|**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)
+
+# **postGetPromos**
+> PromoModel postGetPromos()
+
+Create a promotion
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration,
+    PromoModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let promoModel: PromoModel; //Promotion (optional)
+
+const { status, data } = await apiInstance.postGetPromos(
+    promoModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promoModel** | **PromoModel**| Promotion | |
+
+
+### Return type
+
+**PromoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promotion |  -  |
+|**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)
+
+# **putGetPromo**
+> PromoModel putGetPromo()
+
+Update a promotion
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration,
+    PromoModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let id: number; //Promo ID (default to undefined)
+let promoModel: PromoModel; //Promotion (optional)
+
+const { status, data } = await apiInstance.putGetPromo(
+    id,
+    promoModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promoModel** | **PromoModel**| Promotion | |
+| **id** | [**number**] | Promo ID | defaults to undefined|
+
+
+### Return type
+
+**PromoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promotion |  -  |
+|**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)
+

package/docs/ProspectDTO.md

@@ -6,16 +6,16 @@ Prospect
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**companyName** | **string** | Company Name | [optional] [default to undefined]
+**companyName** | **string** | Company Name | [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]
-**xeroId** | **string** | Xero ID | [optional] [default to undefined]
-**removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
-**status** | **string** | Status | [optional] [default to undefined]
-**orderCount** | **number** | Order Count | [optional] [default to undefined]
-**tcxOrderCount** | **number** | 3CX Order Count | [optional] [default to undefined]
-**videoCount** | **number** | Branded Video Count | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [default to undefined]
+**removed** | **boolean** | Removed From Prospects | [default to undefined]
+**status** | **string** | Status | [default to undefined]
+**orderCount** | **number** | Order Count | [default to undefined]
+**tcxOrderCount** | **number** | 3CX Order Count | [default to undefined]
+**videoCount** | **number** | Branded Video Count | [default to undefined]
 
 ## Example
 

package/docs/ProspectEntity.md

@@ -6,17 +6,17 @@ ProspectEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**status** | **number** | status | [optional] [default to undefined]
-**customerId** | **number** | customerId | [optional] [default to undefined]
-**companyName** | **string** | companyName | [optional] [default to undefined]
-**contactName** | **string** | contactName | [optional] [default to undefined]
-**telephone** | **string** | telephone | [optional] [default to undefined]
-**email** | **string** | email | [optional] [default to undefined]
-**reason** | **string** | reason | [optional] [default to undefined]
-**lastOrderDate** | **string** | lastOrderDate | [optional] [default to undefined]
-**followUpDate** | **string** | followUpDate | [optional] [default to undefined]
-**notes** | **string** | notes | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**status** | **number** | status | [default to undefined]
+**customerId** | **number** | customerId | [default to undefined]
+**companyName** | **string** | companyName | [default to undefined]
+**contactName** | **string** | contactName | [default to undefined]
+**telephone** | **string** | telephone | [default to undefined]
+**email** | **string** | email | [default to undefined]
+**reason** | **string** | reason | [default to undefined]
+**lastOrderDate** | **string** | lastOrderDate | [default to undefined]
+**followUpDate** | **string** | followUpDate | [default to undefined]
+**notes** | **string** | notes | [default to undefined]
 
 ## Example
 

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

@@ -6,9 +6,9 @@ Provisioning Group
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
-**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
-**auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
+**groupName** | **string** | Provisioning Group Name | [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
+**auth** | **string** | Additional Authentication Secret | [default to undefined]
 **id** | **number** | Provisioning Group ID | [optional] [default to undefined]
 **customerId** | **number** | Owner ID | [optional] [default to undefined]
 

package/docs/ProvisioningRequestEntity.md

@@ -6,9 +6,9 @@ Provisioning Group Request
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
-**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
-**auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
+**groupName** | **string** | Provisioning Group Name | [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
+**auth** | **string** | Additional Authentication Secret | [default to undefined]
 
 ## Example