yellowgrid-api-ts 3.0.84-dev.0 → 3.0.86-dev.0

package/docs/PostGetProductForCustomerRequest.md

@@ -0,0 +1,24 @@
+# PostGetProductForCustomerRequest
+
+
+## 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 { PostGetProductForCustomerRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetProductForCustomerRequest = {
+    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/ProductsApi.md

@@ -6,12 +6,12 @@ All URIs are relative to *http://api.yellowgrid.local*
 |------------- | ------------- | -------------|
 |[**getGetAttributeSets**](#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets|
 |[**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|
 |[**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|
+|[**postGetProduct**](#postgetproduct) | **POST** /products/{sku} | Get Product|
+|[**postGetProductForCustomer**](#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer|
 
 # **getGetAttributeSets**
 > Array<AttributeSetEnum> getGetAttributeSets()
@@ -114,10 +114,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)
 
-# **getGetProduct**
-> ProductSummaryDTO getGetProduct()
+# **getGetProducts**
+> Array<BasicProductDTO> getGetProducts()
 
-Get Product
+Get Products
 
 ### Example
 
@@ -130,32 +130,16 @@ 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 hosting: boolean; //3CX Hosting (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGetProduct(
-    sku,
-    quantity,
-    licenceKey,
-    hosting
-);
+const { status, data } = await apiInstance.getGetProducts();
 ```
 
 ### Parameters
-
-|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|
-| **hosting** | [**boolean**] | 3CX Hosting | (optional) defaults to undefined|
+This endpoint does not have any parameters.
 
 
 ### Return type
 
-**ProductSummaryDTO**
+**Array<BasicProductDTO>**
 
 ### Authorization
 
@@ -170,17 +154,17 @@ No authorization required
 ### 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()
+# **getGetStockList**
+> Array<PriceListItemModel> getGetStockList()
 
-Get Product For Customer
+Get Current Stock & Pricing
 
 ### Example
 
@@ -193,35 +177,16 @@ 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 hosting: boolean; //3CX Hosting (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGetProductForCustomer(
-    customerId,
-    sku,
-    quantity,
-    licenceKey,
-    hosting
-);
+const { status, data } = await apiInstance.getGetStockList();
 ```
 
 ### Parameters
-
-|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|
-| **hosting** | [**boolean**] | 3CX Hosting | (optional) defaults to undefined|
+This endpoint does not have any parameters.
 
 
 ### Return type
 
-**ProductSummaryDTO**
+**Array<PriceListItemModel>**
 
 ### Authorization
 
@@ -236,17 +201,17 @@ No authorization required
 ### 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)
 
-# **getGetProducts**
-> Array<BasicProductDTO> getGetProducts()
+# **getGetTcxTemplates**
+> Array<TcxTemplateXmlEnum> getGetTcxTemplates()
 
-Get Products
+Get 3CX Templates
 
 ### Example
 
@@ -259,7 +224,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
-const { status, data } = await apiInstance.getGetProducts();
+const { status, data } = await apiInstance.getGetTcxTemplates();
 ```
 
 ### Parameters
@@ -268,7 +233,7 @@ This endpoint does not have any parameters.
 
 ### Return type
 
-**Array<BasicProductDTO>**
+**Array<TcxTemplateXmlEnum>**
 
 ### Authorization
 
@@ -283,17 +248,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Products |  -  |
+|**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)
 
-# **getGetStockList**
-> Array<PriceListItemModel> getGetStockList()
+# **getSearchProducts**
+> ProductSearchResultsModel getSearchProducts()
 
-Get Current Stock & Pricing
+Search Products
 
 ### Example
 
@@ -306,16 +271,29 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
-const { status, data } = await apiInstance.getGetStockList();
+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
-This endpoint does not have any 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
 
-**Array<PriceListItemModel>**
+**ProductSearchResultsModel**
 
 ### Authorization
 
@@ -337,32 +315,43 @@ 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)
 
-# **getGetTcxTemplates**
-> Array<TcxTemplateXmlEnum> getGetTcxTemplates()
+# **postGetProduct**
+> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
-Get 3CX Templates
+Get Product
 
 ### Example
 
 ```typescript
 import {
     ProductsApi,
-    Configuration
+    Configuration,
+    PostGetProductForCustomerRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
-const { status, data } = await apiInstance.getGetTcxTemplates();
+let sku: string; //Product SKU (default to undefined)
+let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+
+const { status, data } = await apiInstance.postGetProduct(
+    sku,
+    postGetProductForCustomerRequest
+);
 ```
 
 ### Parameters
-This endpoint does not have any parameters.
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
+| **sku** | [**string**] | Product SKU | defaults to undefined|
 
 
 ### Return type
 
-**Array<TcxTemplateXmlEnum>**
+**ProductSummaryDTO**
 
 ### Authorization
 
@@ -370,44 +359,45 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | 3CX Templates |  -  |
+|**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)
 
-# **getSearchProducts**
-> ProductSearchResultsModel getSearchProducts()
+# **postGetProductForCustomer**
+> ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
 
-Search Products
+Get Product For Customer
 
 ### Example
 
 ```typescript
 import {
     ProductsApi,
-    Configuration
+    Configuration,
+    PostGetProductForCustomerRequest
 } 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)
+let customerId: number; //Customer ID (default to undefined)
+let sku: string; //Product SKU (default to undefined)
+let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
 
-const { status, data } = await apiInstance.getSearchProducts(
-    pageSize,
-    page,
-    search
+const { status, data } = await apiInstance.postGetProductForCustomer(
+    customerId,
+    sku,
+    postGetProductForCustomerRequest
 );
 ```
 
@@ -415,14 +405,14 @@ const { status, data } = await apiInstance.getSearchProducts(
 
 |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|
+| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
+| **customerId** | [**number**] | Customer ID | defaults to undefined|
+| **sku** | [**string**] | Product SKU | defaults to undefined|
 
 
 ### Return type
 
-**ProductSearchResultsModel**
+**ProductSummaryDTO**
 
 ### Authorization
 
@@ -430,14 +420,14 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Products |  -  |
+|**200** | Product |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.0.84-dev.0",
+  "version": "3.0.86-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {