yellowgrid-api-ts 3.0.83-dev.0 → 3.0.83

package/docs/OrdersApi.md

@@ -4,16 +4,11 @@ All URIs are relative to *http://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders|
-|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | |
+|[**deleteDeleteOrder**](#deletedeleteorder) | **DELETE** /orders/{id} | |
 |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders|
-|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
-|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order|
-|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
-|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order|
 
-# **deleteUpdateOrder**
-> deleteUpdateOrder()
+# **deleteDeleteOrder**
+> deleteDeleteOrder()
 
 Delete Orders
 
@@ -30,7 +25,7 @@ const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
 
-const { status, data } = await apiInstance.deleteUpdateOrder(
+const { status, data } = await apiInstance.deleteDeleteOrder(
     id
 );
 ```
@@ -66,60 +61,6 @@ 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)
 
-# **getGetEditableOrder**
-> OrderSummaryDTO getGetEditableOrder()
-
-Get Editable 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.getGetEditableOrder(
-    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)
-
 # **getGetOrders**
 > OrderSummariesModel getGetOrders()
 
@@ -192,241 +133,3 @@ 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)
 
-# **postCreateAdminOrder**
-> Array<OrderSummaryDTO> postCreateAdminOrder()
-
-Create An Order (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    AdminOrderRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
-
-const { status, data } = await apiInstance.postCreateAdminOrder(
-    readonly,
-    adminOrderRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OrderSummaryDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order 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)
-
-# **postGetOrders**
-> Array<OrderSummaryDTO> postGetOrders()
-
-Create An Order
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    CustomerOrderRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
-
-const { status, data } = await apiInstance.postGetOrders(
-    readonly,
-    customerOrderRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OrderSummaryDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order 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)
-
-# **putUpdateAdminOrder**
-> Array<OrderSummaryDTO> putUpdateAdminOrder()
-
-Update An Order (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    AdminOrderRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
-
-const { status, data } = await apiInstance.putUpdateAdminOrder(
-    id,
-    readonly,
-    adminOrderRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OrderSummaryDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order 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)
-
-# **putUpdateOrder**
-> Array<OrderSummaryDTO> putUpdateOrder()
-
-Update An Order
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    CustomerOrderRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
-
-const { status, data } = await apiInstance.putUpdateOrder(
-    id,
-    readonly,
-    customerOrderRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OrderSummaryDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order 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)
-

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<ProductSummaryModel>**](ProductSummaryModel.md) | Results | [optional] [default to undefined]
 
 ## Example
 

package/docs/{ProductSummaryDTO.md → ProductSummaryModel.md}

@@ -1,4 +1,4 @@
-# ProductSummaryDTO
+# ProductSummaryModel
 
 Product Summary
 
@@ -12,21 +12,19 @@ Name | Type | Description | Notes
 **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]
 
 ## Example
 
 ```typescript
-import { ProductSummaryDTO } from 'yellowgrid-api-ts';
+import { ProductSummaryModel } from 'yellowgrid-api-ts';
 
-const instance: ProductSummaryDTO = {
+const instance: ProductSummaryModel = {
     sku,
     title,
     quantity,
     stockProduct,
     price,
     cartonSize,
-    rrp,
 };
 ```
 

package/docs/ProductsApi.md

@@ -5,13 +5,11 @@ 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|
-|[**getGetProduct**](#getgetproduct) | **GET** /products/{sku} | Get Product|
-|[**getGetProductForCustomer**](#getgetproductforcustomer) | **GET** /admin/products/{sku} | Get Product For Customer|
-|[**getGetProducts**](#getgetproducts) | **GET** /products | Get Products|
+|[**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|
-|[**getSearchProducts**](#getsearchproducts) | **GET** /products/search | Search Products|
 
 # **getGetAttributeSets**
 > Array<AttributeSetEnum> getGetAttributeSets()
@@ -60,10 +58,10 @@ 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)
 
-# **getGetLegacyStockList**
-> string getGetLegacyStockList()
+# **getGetCustomerPriceLists**
+> Array<CustomerPriceListEnum> getGetCustomerPriceLists()
 
-Get Current Stock & Pricing
+Get Customer Price Lists
 
 ### Example
 
@@ -76,23 +74,16 @@ import {
 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
-);
+const { status, data } = await apiInstance.getGetCustomerPriceLists();
 ```
 
 ### 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|
+This endpoint does not have any parameters.
 
 
 ### Return type
 
-**string**
+**Array<CustomerPriceListEnum>**
 
 ### Authorization
 
@@ -101,23 +92,23 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: text/csv, application/xml
+ - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Products |  -  |
+|**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)
 
-# **getGetProduct**
-> ProductSummaryDTO getGetProduct()
+# **getGetLegacyStockList**
+> string getGetLegacyStockList()
 
-Get Product
+Get Current Stock & Pricing
 
 ### Example
 
@@ -130,14 +121,10 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
-let sku: string; //Product SKU (default to undefined)
-let quantity: number; //Quantity (optional) (default to undefined)
-let licenceKey: string; //3CX Licence Key (optional) (default to undefined)
+let format: 'XML' | 'CSV'; //File Format (default to undefined)
 
-const { status, data } = await apiInstance.getGetProduct(
-    sku,
-    quantity,
-    licenceKey
+const { status, data } = await apiInstance.getGetLegacyStockList(
+    format
 );
 ```
 
@@ -145,14 +132,12 @@ const { status, data } = await apiInstance.getGetProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **sku** | [**string**] | Product SKU | defaults to undefined|
-| **quantity** | [**number**] | Quantity | (optional) defaults to undefined|
-| **licenceKey** | [**string**] | 3CX Licence Key | (optional) defaults to undefined|
+| **format** | [**&#39;XML&#39; | &#39;CSV&#39;**]**Array<&#39;XML&#39; &#124; &#39;CSV&#39;>** | File Format | defaults to undefined|
 
 
 ### Return type
 
-**ProductSummaryDTO**
+**string**
 
 ### Authorization
 
@@ -161,23 +146,23 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: text/csv, application/xml
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Product |  -  |
+|**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)
 
-# **getGetProductForCustomer**
-> ProductSummaryDTO getGetProductForCustomer()
+# **getGetProducts**
+> ProductSearchResultsModel getGetProducts()
 
-Get Product For Customer
+Get Products
 
 ### Example
 
@@ -190,16 +175,14 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
-let customerId: number; //Customer ID (default to undefined)
-let sku: string; //Product SKU (default to undefined)
-let quantity: number; //Quantity (optional) (default to undefined)
-let licenceKey: string; //3CX Licence Key (optional) (default to undefined)
+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.getGetProductForCustomer(
-    customerId,
-    sku,
-    quantity,
-    licenceKey
+const { status, data } = await apiInstance.getGetProducts(
+    pageSize,
+    page,
+    search
 );
 ```
 
@@ -207,62 +190,14 @@ const { status, data } = await apiInstance.getGetProductForCustomer(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **customerId** | [**number**] | Customer ID | defaults to undefined|
-| **sku** | [**string**] | Product SKU | defaults to undefined|
-| **quantity** | [**number**] | Quantity | (optional) defaults to undefined|
-| **licenceKey** | [**string**] | 3CX Licence Key | (optional) defaults to undefined|
-
-
-### Return type
-
-**ProductSummaryDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Product |  -  |
-|**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**
-> Array<BasicProductDTO> getGetProducts()
-
-Get Products
-
-### Example
-
-```typescript
-import {
-    ProductsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ProductsApi(configuration);
-
-const { status, data } = await apiInstance.getGetProducts();
-```
-
-### Parameters
-This endpoint does not have any parameters.
+| **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
 
-**Array<BasicProductDTO>**
+**ProductSearchResultsModel**
 
 ### Authorization
 
@@ -378,63 +313,3 @@ 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)
 
-# **getSearchProducts**
-> ProductSearchResultsModel getSearchProducts()
-
-Search 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.getSearchProducts(
-    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)
-