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

package/docs/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -9,12 +9,13 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
+|[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
 |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
 |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
 |[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
 |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
-|[**getUpdatePaymentStatus**](#getupdatepaymentstatus) | **GET** /admin/orders/{id}/paid | Change Payment Status (Admin)|
+|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
 |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
 |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
@@ -22,13 +23,16 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
 |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
 |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
+|[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
 |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
 |[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
 |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
 |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
 |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
+|[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
 |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
+|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
 |[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
 
 # **deleteDeleteBatch**
@@ -310,6 +314,66 @@ 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)
 
+# **getGetCommercialInvoice**
+> File getGetCommercialInvoice()
+
+Get Commercial Invoice PDF
+
+### 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)
+let batchId: number; //Batch ID (default to undefined)
+let shipmentId: number; //Shipment ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetCommercialInvoice(
+    id,
+    batchId,
+    shipmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order PDF |  -  |
+|**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)
+
 # **getGetEditableOrder**
 > DetailedOrderRequestDTO getGetEditableOrder()
 
@@ -601,10 +665,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)
 
-# **getUpdatePaymentStatus**
-> OrderDetailsDTO getUpdatePaymentStatus()
+# **patchCompleteOrder**
+> OrderDetailsDTO patchCompleteOrder()
 
-Change Payment Status (Admin)
+Mark Order As Complete (Admin)
 
 ### Example
 
@@ -618,11 +682,9 @@ const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
-let id2: boolean; //Paid (default to undefined)
 
-const { status, data } = await apiInstance.getUpdatePaymentStatus(
-    id,
-    id2
+const { status, data } = await apiInstance.patchCompleteOrder(
+    id
 );
 ```
 
@@ -631,7 +693,6 @@ const { status, data } = await apiInstance.getUpdatePaymentStatus(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
-| **id2** | [**boolean**] | Paid | defaults to undefined|
 
 
 ### Return type
@@ -1059,13 +1120,71 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: text/html, application/json
+ - **Accept**: text/html
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Shipping Label |  -  |
+|**204** | 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)
+
+# **postProcessTcxLicences**
+> OrderDetailsDTO postProcessTcxLicences()
+
+Process 3CX Licences (Admin)
+
+### 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)
+let batchId: number; //Batch ID (default to undefined)
+
+const { status, data } = await apiInstance.postProcessTcxLicences(
+    id,
+    batchId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+
+
+### Return type
+
+**OrderDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Details |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
@@ -1429,6 +1548,70 @@ 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)
 
+# **putUpdateBatchItem**
+> OrderedItemModel putUpdateBatchItem()
+
+Update Batch Item (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrderedItemModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let batchId: number; //Batch ID (default to undefined)
+let itemId: number; //Ordered Item ID (default to undefined)
+let orderedItemModel: OrderedItemModel; //Batch Item (optional)
+
+const { status, data } = await apiInstance.putUpdateBatchItem(
+    id,
+    batchId,
+    itemId,
+    orderedItemModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
+
+
+### Return type
+
+**OrderedItemModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ordered Item |  -  |
+|**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()
 
@@ -1490,6 +1673,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)
 
+# **putUpdatePaymentStatus**
+> OrderDetailsDTO putUpdatePaymentStatus()
+
+Change Payment Status (Admin)
+
+### 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)
+let paid: boolean; //Paid (default to undefined)
+
+const { status, data } = await apiInstance.putUpdatePaymentStatus(
+    id,
+    paid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **paid** | [**boolean**] | Paid | defaults to undefined|
+
+
+### Return type
+
+**OrderDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Details |  -  |
+|**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)
+
 # **putUpdateShipment**
 > ShipmentDTO putUpdateShipment()
 

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/PricingApi.md

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

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://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**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/ProvisioningApi.md

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

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://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SMSApi.md

@@ -1,6 +1,6 @@
 # SMSApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/StockManagementApi.md

@@ -1,6 +1,6 @@
 # StockManagementApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SystemApi.md

@@ -1,6 +1,6 @@
 # SystemApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/TcxSbcDTO.md

@@ -6,12 +6,14 @@ SBC Data
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
 **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]
+**configured** | **boolean** | 3CX SBC Configured | [optional] [default to undefined]
 
 ## Example
 
@@ -19,12 +21,14 @@ Name | Type | Description | Notes
 import { TcxSbcDTO } from 'yellowgrid-api-ts';
 
 const instance: TcxSbcDTO = {
+    id,
     ipAddress,
     defaultGateway,
     netmask,
     dns,
     tcxUrl,
     tcxKey,
+    configured,
 };
 ```
 

package/docs/TcxSbcResponseDTO.md

@@ -0,0 +1,23 @@
+# TcxSbcResponseDTO
+
+3CX SBC Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Status | [optional] [default to undefined]
+**message** | **string** | Message | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxSbcResponseDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxSbcResponseDTO = {
+    status,
+    message,
+};
+```
+
+[[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/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/WebhooksApi.md

@@ -1,6 +1,6 @@
 # WebhooksApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|