yellowgrid-api-ts 3.1.6 → 3.1.8-dev.0

package/docs/ProductsApi.md

@@ -5,11 +5,13 @@ 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|
+|[**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()
@@ -58,10 +60,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)
 
-# **getGetCustomerPriceLists**
-> Array<CustomerPriceListEnum> getGetCustomerPriceLists()
+# **getGetLegacyStockList**
+> string getGetLegacyStockList()
 
-Get Customer Price Lists
+Get Current Stock & Pricing
 
 ### Example
 
@@ -74,7 +76,61 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
-const { status, data } = await apiInstance.getGetCustomerPriceLists();
+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**
+> 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
@@ -83,7 +139,7 @@ This endpoint does not have any parameters.
 
 ### Return type
 
-**Array<CustomerPriceListEnum>**
+**Array<BasicProductDTO>**
 
 ### Authorization
 
@@ -98,15 +154,15 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Price Lists |  -  |
+|**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)
 
-# **getGetLegacyStockList**
-> string getGetLegacyStockList()
+# **getGetStockList**
+> Array<PriceListItemModel> getGetStockList()
 
 Get Current Stock & Pricing
 
@@ -121,23 +177,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.getGetStockList();
 ```
 
 ### 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<PriceListItemModel>**
 
 ### Authorization
 
@@ -146,7 +195,7 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: text/csv, application/xml
+ - **Accept**: application/json
 
 
 ### HTTP response details
@@ -159,10 +208,57 @@ 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)
 
-# **getGetProducts**
-> ProductSearchResultsModel getGetProducts()
+# **getGetTcxTemplates**
+> Array<TcxTemplateXmlEnum> getGetTcxTemplates()
 
-Get Products
+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)
+
+# **getSearchProducts**
+> ProductSearchResultsModel getSearchProducts()
+
+Search Products
 
 ### Example
 
@@ -179,7 +275,7 @@ 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(
+const { status, data } = await apiInstance.getSearchProducts(
     pageSize,
     page,
     search
@@ -219,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)
 
-# **getGetStockList**
-> Array<PriceListItemModel> getGetStockList()
+# **postGetProduct**
+> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
-Get Current Stock & Pricing
+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.getGetStockList();
+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<PriceListItemModel>**
+**ProductSummaryDTO**
 
 ### Authorization
 
@@ -252,46 +359,60 @@ 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 |  -  |
 
 [[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()
+# **postGetProductForCustomer**
+> ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
 
-Get 3CX Templates
+Get Product For Customer
 
 ### 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 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.postGetProductForCustomer(
+    customerId,
+    sku,
+    postGetProductForCustomerRequest
+);
 ```
 
 ### Parameters
-This endpoint does not have any parameters.
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
+| **customerId** | [**number**] | Customer ID | defaults to undefined|
+| **sku** | [**string**] | Product SKU | defaults to undefined|
 
 
 ### Return type
 
-**Array<TcxTemplateXmlEnum>**
+**ProductSummaryDTO**
 
 ### Authorization
 
@@ -299,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** | 3CX Templates |  -  |
+|**200** | Product |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |

package/docs/ProvisioningApi.md

@@ -235,7 +235,7 @@ 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)
 
 # **getGetGroups**
-> Array<ProvisioningEntity> getGetGroups()
+> Array<ProvisioningModel> getGetGroups()
 
 Get provisioning groups
 
@@ -266,7 +266,7 @@ const { status, data } = await apiInstance.getGetGroups(
 
 ### Return type
 
-**Array<ProvisioningEntity>**
+**Array<ProvisioningModel>**
 
 ### Authorization
 
@@ -289,7 +289,7 @@ 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)
 
 # **postAddFanvilGroup**
-> ProvisioningEntity postAddFanvilGroup()
+> ProvisioningModel postAddFanvilGroup()
 
 Create a Fanvil provisioning group
 
@@ -321,7 +321,7 @@ const { status, data } = await apiInstance.postAddFanvilGroup(
 
 ### Return type
 
-**ProvisioningEntity**
+**ProvisioningModel**
 
 ### Authorization
 

package/docs/{ProvisioningEntity.md → ProvisioningModel.md}

@@ -1,4 +1,4 @@
-# ProvisioningEntity
+# ProvisioningModel
 
 Provisioning Group
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { ProvisioningEntity } from 'yellowgrid-api-ts';
+import { ProvisioningModel } from 'yellowgrid-api-ts';
 
-const instance: ProvisioningEntity = {
+const instance: ProvisioningModel = {
     groupName,
     provisioningUrl,
     auth,

package/docs/ShipmentEntity.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **courierTracking** | **string** | courierTracking | [optional] [default to undefined]
 **courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
 **scannedData** | **string** | mac | [optional] [default to undefined]
-**date** | **string** | date | [optional] [default to undefined]
+**dateShipped** | **string** | date | [optional] [default to undefined]
 **requestDate** | **string** | requestDate | [optional] [default to undefined]
 **provId** | **number** | provId | [optional] [default to undefined]
 
@@ -34,7 +34,7 @@ const instance: ShipmentEntity = {
     courierTracking,
     courierBoxes,
     scannedData,
-    date,
+    dateShipped,
     requestDate,
     provId,
 };

package/docs/ShippingApi.md

@@ -0,0 +1,63 @@
+# ShippingApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
+
+# **postGetShippingServices**
+> ShippingServicesModel postGetShippingServices()
+
+Get Shipping Services
+
+### Example
+
+```typescript
+import {
+    ShippingApi,
+    Configuration,
+    ShippingInformationDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ShippingApi(configuration);
+
+let shippingInformationDTO: ShippingInformationDTO; //Shipping Information (optional)
+
+const { status, data } = await apiInstance.postGetShippingServices(
+    shippingInformationDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **shippingInformationDTO** | **ShippingInformationDTO**| Shipping Information | |
+
+
+### Return type
+
+**ShippingServicesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Shipping Services |  -  |
+|**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/ShippingConsignmentModel.md

@@ -0,0 +1,26 @@
+# ShippingConsignmentModel
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service** | [**ShippingServiceModel**](ShippingServiceModel.md) |  | [optional] [default to undefined]
+**id** | **string** | ID/Number | [optional] [default to undefined]
+**trackingNumber** | **string** | Tracking Number | [optional] [default to undefined]
+**parcelIds** | **Array<string>** | Parcels | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingConsignmentModel } from 'yellowgrid-api-ts';
+
+const instance: ShippingConsignmentModel = {
+    service,
+    id,
+    trackingNumber,
+    parcelIds,
+};
+```
+
+[[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/ShippingInformationDTO.md

@@ -0,0 +1,25 @@
+# ShippingInformationDTO
+
+Shipping Information
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [optional] [default to undefined]
+**postalCode** | **string** | Destination Post Code | [optional] [default to undefined]
+**iso** | **string** | Destination ISO | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingInformationDTO } from 'yellowgrid-api-ts';
+
+const instance: ShippingInformationDTO = {
+    items,
+    postalCode,
+    iso,
+};
+```
+
+[[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/ShippingServiceDTO.md

@@ -0,0 +1,23 @@
+# ShippingServiceDTO
+
+Shipping Service
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**courier** | **string** | Courier | [optional] [default to undefined]
+**serviceName** | **string** | Service Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingServiceDTO } from 'yellowgrid-api-ts';
+
+const instance: ShippingServiceDTO = {
+    courier,
+    serviceName,
+};
+```
+
+[[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/ShippingServiceModel.md

@@ -0,0 +1,31 @@
+# ShippingServiceModel
+
+Shipping Service
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**courier** | **string** | Courier | [optional] [default to undefined]
+**code** | **string** | Code | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
+**description** | **string** | Description | [optional] [default to undefined]
+**label** | **string** | Label | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingServiceModel } from 'yellowgrid-api-ts';
+
+const instance: ShippingServiceModel = {
+    courier,
+    code,
+    name,
+    description,
+    label,
+    price,
+};
+```
+
+[[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/{GetGetPasswordHash200Response.md → ShippingServicesModel.md}

@@ -1,19 +1,19 @@
-# GetGetPasswordHash200Response
+# ShippingServicesModel
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**hash** | **string** |  | [optional] [default to undefined]
+**services** | [**Array<ShippingServiceModel>**](ShippingServiceModel.md) | Services | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { GetGetPasswordHash200Response } from 'yellowgrid-api-ts';
+import { ShippingServicesModel } from 'yellowgrid-api-ts';
 
-const instance: GetGetPasswordHash200Response = {
-    hash,
+const instance: ShippingServicesModel = {
+    services,
 };
 ```
 

package/docs/StockManagementApi.md

@@ -692,7 +692,7 @@ 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)
 
 # **getGetStockSupplierProducts**
-> Array<ProductSummaryModel> getGetStockSupplierProducts()
+> Array<ProductSummaryDTO> getGetStockSupplierProducts()
 
 Get Stock Supplier\'s Products
 
@@ -723,7 +723,7 @@ const { status, data } = await apiInstance.getGetStockSupplierProducts(
 
 ### Return type
 
-**Array<ProductSummaryModel>**
+**Array<ProductSummaryDTO>**
 
 ### Authorization
 

package/docs/TcxSbcDTO.md

@@ -0,0 +1,31 @@
+# TcxSbcDTO
+
+SBC Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ipAddress** | **string** | LAN IP Address | [optional] [default to undefined]
+**defaultGateway** | **string** | LAN Default Gateway | [optional] [default to undefined]
+**netmask** | **string** | LAN Subnet Mask | [optional] [default to undefined]
+**dns** | **string** | DNS | [optional] [default to undefined]
+**tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
+**tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxSbcDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxSbcDTO = {
+    ipAddress,
+    defaultGateway,
+    netmask,
+    dns,
+    tcxUrl,
+    tcxKey,
+};
+```
+
+[[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/TcxSbcModel.md

@@ -1,6 +1,6 @@
 # TcxSbcModel
 
-3CX SBC Model
+3CX Wizard SBC
 
 ## Properties