yellowgrid-api-ts 3.0.79

package/docs/OrderedItemEntity.md

@@ -0,0 +1,47 @@
+# OrderedItemEntity
+
+OrderedItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**orderedQuantity** | **number** | orderedQuantity | [optional] [default to undefined]
+**itemStatus** | **number** | itemStatus | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [optional] [default to undefined]
+**supplierItemId** | **number** | supplierItemId | [optional] [default to undefined]
+**supplierPrice** | **number** | supplierPrice | [optional] [default to undefined]
+**statusDate** | **string** | statusDate | [optional] [default to undefined]
+**statusAuthor** | **number** | statusAuthor | [optional] [default to undefined]
+**supplierPaid** | **number** | supplierPaid | [optional] [default to undefined]
+**supplierCreditDue** | **number** | supplierCreditDue | [optional] [default to undefined]
+**supplierCreditReceived** | **number** | supplierCreditReceived | [optional] [default to undefined]
+**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
+**returnedStock** | **number** | returnedStock | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderedItemEntity } from 'yellowgrid-api-ts';
+
+const instance: OrderedItemEntity = {
+    id,
+    itemId,
+    orderedQuantity,
+    itemStatus,
+    supplierId,
+    supplierItemId,
+    supplierPrice,
+    statusDate,
+    statusAuthor,
+    supplierPaid,
+    supplierCreditDue,
+    supplierCreditReceived,
+    supplierSku,
+    returnedStock,
+};
+```
+
+[[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/OrdersApi.md

@@ -0,0 +1,135 @@
+# OrdersApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteDeleteOrder**](#deletedeleteorder) | **DELETE** /orders/{id} | |
+|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders|
+
+# **deleteDeleteOrder**
+> deleteDeleteOrder()
+
+Delete Orders
+
+### 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.deleteDeleteOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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()
+
+Get Orders
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(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 fulfillable: boolean; //Fulfillable (optional) (default to undefined)
+let status: 'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'; //Status (optional) (default to undefined)
+let filter: 'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'; //Filter (optional) (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetOrders(
+    pageSize,
+    page,
+    search,
+    fulfillable,
+    status,
+    filter,
+    customerId
+);
+```
+
+### 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|
+| **fulfillable** | [**boolean**] | Fulfillable | (optional) defaults to undefined|
+| **status** | [**&#39;PAID&#39; | &#39;INVOICE_PAID&#39; | &#39;UNPAID&#39; | &#39;QUOTE&#39;**]**Array<&#39;PAID&#39; &#124; &#39;INVOICE_PAID&#39; &#124; &#39;UNPAID&#39; &#124; &#39;QUOTE&#39;>** | Status | (optional) defaults to undefined|
+| **filter** | [**&#39;OUTSTANDING&#39; | &#39;QUOTES&#39; | &#39;ALL&#39; | &#39;BACK_ORDERS&#39;**]**Array<&#39;OUTSTANDING&#39; &#124; &#39;QUOTES&#39; &#124; &#39;ALL&#39; &#124; &#39;BACK_ORDERS&#39;>** | Filter | (optional) defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**OrderSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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/PatchSetTcxWizardCnameRequest.md

@@ -0,0 +1,20 @@
+# PatchSetTcxWizardCnameRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cname** | **string** | CNAME | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchSetTcxWizardCnameRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchSetTcxWizardCnameRequest = {
+    cname,
+};
+```
+
+[[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/PatchUpdateAccountContactPasswordRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateAccountContactPasswordRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **string** | Password | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateAccountContactPasswordRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateAccountContactPasswordRequest = {
+    password,
+};
+```
+
+[[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/PortalAccountModel.md

@@ -0,0 +1,67 @@
+# PortalAccountModel
+
+Customer Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**name** | **string** | Contact Name | [optional] [default to undefined]
+**email** | **string** | Email | [optional] [default to undefined]
+**phone** | **string** | Phone Number | [optional] [default to undefined]
+**company** | **string** | Company Name | [optional] [default to undefined]
+**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
+**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**county** | **string** | County | [optional] [default to undefined]
+**iso** | **string** | Country ISO Code | [optional] [default to undefined]
+**postalCode** | **string** | Post Code | [optional] [default to undefined]
+**accountNumber** | **string** | Account Number | [optional] [default to undefined]
+**xeroId** | **string** | Xero Contact ID | [optional] [default to undefined]
+**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
+**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
+**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**creationDate** | **string** | Creation Date | [optional] [default to undefined]
+**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
+**directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
+**navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
+**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PortalAccountModel } from 'yellowgrid-api-ts';
+
+const instance: PortalAccountModel = {
+    id,
+    name,
+    email,
+    phone,
+    company,
+    companyNumber,
+    vatNumber,
+    addressLine1,
+    addressLine2,
+    city,
+    county,
+    iso,
+    postalCode,
+    accountNumber,
+    xeroId,
+    creditLimit,
+    paymentMethod,
+    servicePaymentMethod,
+    resellerId,
+    creationDate,
+    prizePromo,
+    directDebitMandate,
+    navigation,
+    cname,
+};
+```
+
+[[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/PortalLoginModel.md

@@ -0,0 +1,33 @@
+# PortalLoginModel
+
+Portal Login
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email Address | [optional] [default to undefined]
+**password** | **string** | Password | [optional] [default to undefined]
+**code** | **string** | MFA Code | [optional] [default to undefined]
+**secret** | **string** | MFA Secret | [optional] [default to undefined]
+**codeChallenge** | **string** | Oauth 2.0 code challenge | [optional] [default to undefined]
+**codeVerifier** | **string** | Oauth 2.0 code verifier | [optional] [default to undefined]
+**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PortalLoginModel } from 'yellowgrid-api-ts';
+
+const instance: PortalLoginModel = {
+    email,
+    password,
+    code,
+    secret,
+    codeChallenge,
+    codeVerifier,
+    redirect_uri,
+};
+```
+
+[[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/PostAddWebhook200Response.md

@@ -0,0 +1,20 @@
+# PostAddWebhook200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddWebhook200Response } from 'yellowgrid-api-ts';
+
+const instance: PostAddWebhook200Response = {
+    url,
+};
+```
+
+[[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/PostGetClientCredentialsRequest.md

@@ -0,0 +1,20 @@
+# PostGetClientCredentialsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scopes** | **Array<string>** | OAuth 2.0 scopes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetClientCredentialsRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetClientCredentialsRequest = {
+    scopes,
+};
+```
+
+[[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/PriceListItemModel.md

@@ -0,0 +1,29 @@
+# PriceListItemModel
+
+Price & Stock List
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**rrp** | **number** | RRP | [optional] [default to undefined]
+**stock** | **number** | Stock | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PriceListItemModel } from 'yellowgrid-api-ts';
+
+const instance: PriceListItemModel = {
+    title,
+    sku,
+    price,
+    rrp,
+    stock,
+};
+```
+
+[[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/PricingApi.md

@@ -0,0 +1,138 @@
+# PricingApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetPriceList**](#getgetpricelist) | **GET** /finance/pricing/lists | Get Price List|
+|[**postSendPriceList**](#postsendpricelist) | **POST** /finance/pricing/lists/send | Send Price List|
+
+# **getGetPriceList**
+> File getGetPriceList()
+
+Get Price List
+
+### Example
+
+```typescript
+import {
+    PricingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PricingApi(configuration);
+
+let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks'; //Price List Type (default to undefined)
+let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
+let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
+let customerId: string; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetPriceList(
+    type,
+    format,
+    category,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39;>** | Price List Type | defaults to undefined|
+| **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
+| **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
+| **customerId** | [**string**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf, text/csv, text/html, application/json, application/xml
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Price List |  -  |
+|**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)
+
+# **postSendPriceList**
+> postSendPriceList()
+
+Send Price List
+
+### Example
+
+```typescript
+import {
+    PricingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PricingApi(configuration);
+
+let email: string; //Email Address (default to undefined)
+let customerId: string; //Customer ID (default to undefined)
+let type: 'Products' | 'Stock Products' | '3CX Licences' | 'Hosted By Yellowgrid' | '3CX Starter Bundle' | 'EdTechPro' | 'SMS' | 'SIP Trunks'; //Price List Type (default to undefined)
+let format: 'pdf' | 'json' | 'csv' | 'xml' | 'html'; //Document Format (default to undefined)
+let category: 'Yealink' | 'Mairdi' | 'Jabra' | '3CX' | 'Fanvil' | 'VT' | 'Netgear' | 'Algo' | 'Yealink Headsets' | 'Yealink DECT Handsets' | 'Yealink DECT Headsets' | 'Yealink BT Headsets' | 'Yealink USB Wired Headsets' | 'Yealink Meeting Rooms' | 'Fanvil Phones' | 'Fanvil Headsets' | 'Fanvil Wireless Phones' | 'Fanvil Security Products' | 'Fanvil Accessories' | 'Fanvil Hotel Phones'; //Product Category (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postSendPriceList(
+    email,
+    customerId,
+    type,
+    format,
+    category
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **email** | [**string**] | Email Address | defaults to undefined|
+| **customerId** | [**string**] | Customer ID | defaults to undefined|
+| **type** | [**&#39;Products&#39; | &#39;Stock Products&#39; | &#39;3CX Licences&#39; | &#39;Hosted By Yellowgrid&#39; | &#39;3CX Starter Bundle&#39; | &#39;EdTechPro&#39; | &#39;SMS&#39; | &#39;SIP Trunks&#39;**]**Array<&#39;Products&#39; &#124; &#39;Stock Products&#39; &#124; &#39;3CX Licences&#39; &#124; &#39;Hosted By Yellowgrid&#39; &#124; &#39;3CX Starter Bundle&#39; &#124; &#39;EdTechPro&#39; &#124; &#39;SMS&#39; &#124; &#39;SIP Trunks&#39;>** | Price List Type | defaults to undefined|
+| **format** | [**&#39;pdf&#39; | &#39;json&#39; | &#39;csv&#39; | &#39;xml&#39; | &#39;html&#39;**]**Array<&#39;pdf&#39; &#124; &#39;json&#39; &#124; &#39;csv&#39; &#124; &#39;xml&#39; &#124; &#39;html&#39;>** | Document Format | defaults to undefined|
+| **category** | [**&#39;Yealink&#39; | &#39;Mairdi&#39; | &#39;Jabra&#39; | &#39;3CX&#39; | &#39;Fanvil&#39; | &#39;VT&#39; | &#39;Netgear&#39; | &#39;Algo&#39; | &#39;Yealink Headsets&#39; | &#39;Yealink DECT Handsets&#39; | &#39;Yealink DECT Headsets&#39; | &#39;Yealink BT Headsets&#39; | &#39;Yealink USB Wired Headsets&#39; | &#39;Yealink Meeting Rooms&#39; | &#39;Fanvil Phones&#39; | &#39;Fanvil Headsets&#39; | &#39;Fanvil Wireless Phones&#39; | &#39;Fanvil Security Products&#39; | &#39;Fanvil Accessories&#39; | &#39;Fanvil Hotel Phones&#39;**]**Array<&#39;Yealink&#39; &#124; &#39;Mairdi&#39; &#124; &#39;Jabra&#39; &#124; &#39;3CX&#39; &#124; &#39;Fanvil&#39; &#124; &#39;VT&#39; &#124; &#39;Netgear&#39; &#124; &#39;Algo&#39; &#124; &#39;Yealink Headsets&#39; &#124; &#39;Yealink DECT Handsets&#39; &#124; &#39;Yealink DECT Headsets&#39; &#124; &#39;Yealink BT Headsets&#39; &#124; &#39;Yealink USB Wired Headsets&#39; &#124; &#39;Yealink Meeting Rooms&#39; &#124; &#39;Fanvil Phones&#39; &#124; &#39;Fanvil Headsets&#39; &#124; &#39;Fanvil Wireless Phones&#39; &#124; &#39;Fanvil Security Products&#39; &#124; &#39;Fanvil Accessories&#39; &#124; &#39;Fanvil Hotel Phones&#39;>** | Product Category | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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/PrizesEntity.md

@@ -0,0 +1,31 @@
+# PrizesEntity
+
+PrizesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**year** | **number** | year | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**target** | **number** | target | [optional] [default to undefined]
+**image** | **string** | image | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PrizesEntity } from 'yellowgrid-api-ts';
+
+const instance: PrizesEntity = {
+    id,
+    year,
+    sku,
+    title,
+    target,
+    image,
+};
+```
+
+[[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/ProductSearchResultsModel.md

@@ -0,0 +1,21 @@
+# ProductSearchResultsModel
+
+Product Search Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<ProductSummaryModel>**](ProductSummaryModel.md) | Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSearchResultsModel } from 'yellowgrid-api-ts';
+
+const instance: ProductSearchResultsModel = {
+    results,
+};
+```
+
+[[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/ProductSerialInfoModel.md

@@ -0,0 +1,27 @@
+# ProductSerialInfoModel
+
+Product Serial Info
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**title** | **string** | Product Title | [optional] [default to undefined]
+**mac** | **boolean** | Has MAC Address | [optional] [default to undefined]
+**serial_prefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSerialInfoModel } from 'yellowgrid-api-ts';
+
+const instance: ProductSerialInfoModel = {
+    sku,
+    title,
+    mac,
+    serial_prefixes,
+};
+```
+
+[[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/ProductSummaryModel.md

@@ -0,0 +1,31 @@
+# ProductSummaryModel
+
+Product Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
+**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
+**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSummaryModel } from 'yellowgrid-api-ts';
+
+const instance: ProductSummaryModel = {
+    sku,
+    title,
+    quantity,
+    stockProduct,
+    price,
+    cartonSize,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)