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

package/docs/PostAddAdminNoteRequest.md

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

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

@@ -0,0 +1,20 @@
+# PostSplitOrderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemIds** | **Array<number>** | Item Ids | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostSplitOrderRequest } from 'yellowgrid-api-ts';
+
+const instance: PostSplitOrderRequest = {
+    itemIds,
+};
+```
+
+[[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

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/PrinterEntity.md

@@ -0,0 +1,29 @@
+# PrinterEntity
+
+PrintersEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**brand** | **string** | brand | [optional] [default to undefined]
+**model** | **string** | model | [optional] [default to undefined]
+**sn** | **string** | sn | [optional] [default to undefined]
+**location** | **string** | location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PrinterEntity } from 'yellowgrid-api-ts';
+
+const instance: PrinterEntity = {
+    id,
+    brand,
+    model,
+    sn,
+    location,
+};
+```
+
+[[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/ProductSummaryDTO.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [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]
@@ -26,6 +27,7 @@ const instance: ProductSummaryDTO = {
     title,
     quantity,
     stockProduct,
+    dueDate,
     price,
     cartonSize,
     rrp,

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -11,6 +11,7 @@ All URIs are relative to *https://localhost*
 |[**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|
+|[**patchAddQuantityToStock**](#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock|
 |[**postGetProduct**](#postgetproduct) | **POST** /products/{sku} | Get Product|
 |[**postGetProductForCustomer**](#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer|
 
@@ -363,6 +364,63 @@ 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)
 
+# **patchAddQuantityToStock**
+> patchAddQuantityToStock()
+
+Add Item Quantity To Stock
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let sku: string; //Product SKU (default to undefined)
+let quantity: number; //Quantity (default to undefined)
+
+const { status, data } = await apiInstance.patchAddQuantityToStock(
+    sku,
+    quantity
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sku** | [**string**] | Product SKU | defaults to undefined|
+| **quantity** | [**number**] | Quantity | 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)
+
 # **postGetProduct**
 > ProductSummaryDTO postGetProduct(postGetProductRequest)
 

package/docs/ProspectDTO.md

@@ -0,0 +1,33 @@
+# ProspectDTO
+
+Prospect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyName** | **string** | Company Name | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
+**callbackDate** | **string** | Date Time | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProspectDTO } from 'yellowgrid-api-ts';
+
+const instance: ProspectDTO = {
+    companyName,
+    telephone,
+    lastOrderDate,
+    callbackDate,
+    xeroId,
+    removed,
+    status,
+};
+```
+
+[[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/ProspectEntity.md

@@ -0,0 +1,41 @@
+# ProspectEntity
+
+ProspectEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**status** | **number** | status | [optional] [default to undefined]
+**customerId** | **number** | customerId | [optional] [default to undefined]
+**companyName** | **string** | companyName | [optional] [default to undefined]
+**contactName** | **string** | contactName | [optional] [default to undefined]
+**telephone** | **string** | telephone | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**reason** | **string** | reason | [optional] [default to undefined]
+**lastOrderDate** | **string** | lastOrderDate | [optional] [default to undefined]
+**followUpDate** | **string** | followUpDate | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProspectEntity } from 'yellowgrid-api-ts';
+
+const instance: ProspectEntity = {
+    id,
+    status,
+    customerId,
+    companyName,
+    contactName,
+    telephone,
+    email,
+    reason,
+    lastOrderDate,
+    followUpDate,
+    notes,
+};
+```
+
+[[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/ProspectsApi.md

@@ -0,0 +1,226 @@
+# ProspectsApi
+
+All URIs are relative to *https://bitbucket.org*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetProspect**](#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect|
+|[**getGetProspects**](#getgetprospects) | **GET** /accounts/prospects | Get Prospects|
+|[**getRemoveFromProspects**](#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects|
+|[**getSetCallback**](#getsetcallback) | **GET** /accounts/prospects/{xero_id}/date | Set Call Back Date|
+
+# **getGetProspect**
+> ProspectDTO getGetProspect()
+
+Get Prospect
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+let xeroId: string; //Xero ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetProspect(
+    xeroId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **xeroId** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**ProspectDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospect |  -  |
+|**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)
+
+# **getGetProspects**
+> Array<ProspectDTO> getGetProspects()
+
+Get Prospects
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+const { status, data } = await apiInstance.getGetProspects();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ProspectDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospects |  -  |
+|**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)
+
+# **getRemoveFromProspects**
+> ProspectDTO getRemoveFromProspects()
+
+Remove From Prospect
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+let xeroId: string; //Xero ID (default to undefined)
+let status: boolean; //Status (default to undefined)
+
+const { status, data } = await apiInstance.getRemoveFromProspects(
+    xeroId,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **xeroId** | [**string**] | Xero ID | defaults to undefined|
+| **status** | [**boolean**] | Status | defaults to undefined|
+
+
+### Return type
+
+**ProspectDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospect |  -  |
+|**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)
+
+# **getSetCallback**
+> ProspectDTO getSetCallback()
+
+Set Call Back Date
+
+### Example
+
+```typescript
+import {
+    ProspectsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProspectsApi(configuration);
+
+let xeroId: string; //Xero ID (default to undefined)
+let date: string; //Callback Date (default to undefined)
+
+const { status, data } = await apiInstance.getSetCallback(
+    xeroId,
+    date
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **xeroId** | [**string**] | Xero ID | defaults to undefined|
+| **date** | [**string**] | Callback Date | defaults to undefined|
+
+
+### Return type
+
+**ProspectDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prospect |  -  |
+|**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/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/PutAllocateItemsRequest.md

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

@@ -0,0 +1,22 @@
+# PutAllocateItemsRequestItemsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**itemId** | **number** | Item ID | [optional] [default to undefined]
+**quantity** | **number** | Quantity To Allocate | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAllocateItemsRequestItemsInner } from 'yellowgrid-api-ts';
+
+const instance: PutAllocateItemsRequestItemsInner = {
+    itemId,
+    quantity,
+};
+```
+
+[[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/RemoteStorageDTO.md

@@ -0,0 +1,27 @@
+# RemoteStorageDTO
+
+Remote Storage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | AWS ID | [optional] [default to undefined]
+**secret** | **string** | AWS Secret | [optional] [default to undefined]
+**name** | **string** | AWS Bucket Name | [optional] [default to undefined]
+**region** | **string** | AWS Region | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RemoteStorageDTO } from 'yellowgrid-api-ts';
+
+const instance: RemoteStorageDTO = {
+    id,
+    secret,
+    name,
+    region,
+};
+```
+
+[[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/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|