yellowgrid-api-ts 3.0.79

package/docs/ProductsApi.md

@@ -0,0 +1,315 @@
+# ProductsApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetAttributeSets**](#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets|
+|[**getGetCustomerPriceLists**](#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists|
+|[**getGetLegacyStockList**](#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing|
+|[**getGetProducts**](#getgetproducts) | **GET** /products/search | Get Products|
+|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
+|[**getGetTcxTemplates**](#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates|
+
+# **getGetAttributeSets**
+> Array<AttributeSetEnum> getGetAttributeSets()
+
+Get Attribute Sets
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+const { status, data } = await apiInstance.getGetAttributeSets();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<AttributeSetEnum>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Attribute Sets |  -  |
+|**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)
+
+# **getGetCustomerPriceLists**
+> Array<CustomerPriceListEnum> getGetCustomerPriceLists()
+
+Get Customer Price Lists
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+const { status, data } = await apiInstance.getGetCustomerPriceLists();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<CustomerPriceListEnum>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Price Lists |  -  |
+|**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)
+
+# **getGetLegacyStockList**
+> string getGetLegacyStockList()
+
+Get Current Stock & Pricing
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let format: 'XML' | 'CSV'; //File Format (default to undefined)
+
+const { status, data } = await apiInstance.getGetLegacyStockList(
+    format
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **format** | [**&#39;XML&#39; | &#39;CSV&#39;**]**Array<&#39;XML&#39; &#124; &#39;CSV&#39;>** | File Format | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv, application/xml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Products |  -  |
+|**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)
+
+# **getGetProducts**
+> ProductSearchResultsModel getGetProducts()
+
+Get Products
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(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)
+
+const { status, data } = await apiInstance.getGetProducts(
+    pageSize,
+    page,
+    search
+);
+```
+
+### 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|
+
+
+### Return type
+
+**ProductSearchResultsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Products |  -  |
+|**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)
+
+# **getGetStockList**
+> Array<PriceListItemModel> getGetStockList()
+
+Get Current Stock & Pricing
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+const { status, data } = await apiInstance.getGetStockList();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<PriceListItemModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Products |  -  |
+|**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)
+
+# **getGetTcxTemplates**
+> Array<TcxTemplateXmlEnum> getGetTcxTemplates()
+
+Get 3CX Templates
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+const { status, data } = await apiInstance.getGetTcxTemplates();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<TcxTemplateXmlEnum>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Templates |  -  |
+|**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/PromoCodesEntity.md

@@ -0,0 +1,43 @@
+# PromoCodesEntity
+
+PromoCodesEntity
+
+## Properties
+
+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]
+**note** | **string** | note | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromoCodesEntity } from 'yellowgrid-api-ts';
+
+const instance: PromoCodesEntity = {
+    id,
+    code,
+    description,
+    banner,
+    start,
+    expiry,
+    customerLimit,
+    globalLimit,
+    orderRestrictions,
+    includeDistribution,
+    distributionOnly,
+    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/PromoItemsEntity.md

@@ -0,0 +1,35 @@
+# PromoItemsEntity
+
+PromoItemsEntity
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { PromoItemsEntity } from 'yellowgrid-api-ts';
+
+const instance: PromoItemsEntity = {
+    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)