yellowgrid-api-ts 3.1.3 → 3.1.4-dev.0

package/docs/CustomerOrderRequestDTO.md

@@ -0,0 +1,33 @@
+# CustomerOrderRequestDTO
+
+Order Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
+**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
+**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
+**quote** | **boolean** | Quote | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerOrderRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerOrderRequestDTO = {
+    orderReference,
+    items,
+    shippingService,
+    provisioningUrl,
+    shippingAddress,
+    partShip,
+    quote,
+};
+```
+
+[[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/ItemDTO.md

@@ -6,17 +6,21 @@ Order Item
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
 **id** | **number** | ID | [optional] [default to undefined]
 **orderId** | **number** | Order ID | [optional] [default to undefined]
 **title** | **string** | Title | [optional] [default to undefined]
-**sku** | **string** | SKU | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
 **price** | **number** | Price | [optional] [default to undefined]
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
 **processDate** | **string** | Date Time | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 **promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
 **refunded** | **number** | Refunded | [optional] [default to undefined]
+**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
+**readonly** | **boolean** | Readonly | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
 
 ## Example
 
@@ -24,17 +28,21 @@ Name | Type | Description | Notes
 import { ItemDTO } from 'yellowgrid-api-ts';
 
 const instance: ItemDTO = {
+    sku,
+    quantity,
     id,
     orderId,
     title,
-    sku,
-    quantity,
     price,
     licenceKey,
     licenceExpiry,
     processDate,
+    hosting,
     promoItem,
     refunded,
+    sbcs,
+    readonly,
+    tcxSalesCode,
 };
 ```
 

package/docs/ItemEntity.md

@@ -27,6 +27,7 @@ Name | Type | Description | Notes
 **licenceExpiryDate** | **string** | licenceExpiryDate | [optional] [default to undefined]
 **processDate** | **string** | processDate | [optional] [default to undefined]
 **promoItem** | **number** | promo | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
 
 ## Example
 
@@ -55,6 +56,7 @@ const instance: ItemEntity = {
     licenceExpiryDate,
     processDate,
     promoItem,
+    tcxSalesCode,
 };
 ```
 

package/docs/LinkedOrderEntity.md

@@ -0,0 +1,23 @@
+# LinkedOrderEntity
+
+LinkedOrdersEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**linkedOrderId** | **number** | linkedOrderId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LinkedOrderEntity } from 'yellowgrid-api-ts';
+
+const instance: LinkedOrderEntity = {
+    orderId,
+    linkedOrderId,
+};
+```
+
+[[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/OrderSummaryDTO.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **id** | **number** | ID | [optional] [default to undefined]
 **reference** | **string** | Reference | [optional] [default to undefined]
 **invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**invoiceId** | **string** | Invoice ID | [optional] [default to undefined]
 **orderDate** | **string** | Date Time | [optional] [default to undefined]
 **paid** | **boolean** | Paid | [optional] [default to undefined]
 **complete** | **boolean** | Complete | [optional] [default to undefined]
@@ -18,6 +19,9 @@ Name | Type | Description | Notes
 **items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [optional] [default to undefined]
 **carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
 **fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
+**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
+**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
+**readonly** | **boolean** | Readonly | [optional] [default to undefined]
 
 ## Example
 
@@ -28,6 +32,7 @@ const instance: OrderSummaryDTO = {
     id,
     reference,
     invoiceNumber,
+    invoiceId,
     orderDate,
     paid,
     complete,
@@ -37,6 +42,9 @@ const instance: OrderSummaryDTO = {
     items,
     carriageCharge,
     fulfillable,
+    provisioningUrl,
+    shippingService,
+    readonly,
 };
 ```
 

package/docs/OrderTotalModel.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **vatRate** | **number** | VAT Rate | [optional] [default to undefined]
 **credit** | **number** | Credit | [optional] [default to undefined]
 **currency** | **string** | Currency | [optional] [default to undefined]
+**delivery** | **number** | Delivery | [optional] [default to undefined]
 
 ## Example
 
@@ -27,6 +28,7 @@ const instance: OrderTotalModel = {
     vatRate,
     credit,
     currency,
+    delivery,
 };
 ```
 

package/docs/OrdersApi.md

@@ -4,11 +4,16 @@ All URIs are relative to *http://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteDeleteOrder**](#deletedeleteorder) | **DELETE** /orders/{id} | |
+|[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders|
+|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | |
 |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders|
+|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
+|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order|
+|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
+|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order|
 
-# **deleteDeleteOrder**
-> deleteDeleteOrder()
+# **deleteUpdateOrder**
+> deleteUpdateOrder()
 
 Delete Orders
 
@@ -25,7 +30,7 @@ const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
 
-const { status, data } = await apiInstance.deleteDeleteOrder(
+const { status, data } = await apiInstance.deleteUpdateOrder(
     id
 );
 ```
@@ -61,6 +66,60 @@ 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)
 
+# **getGetEditableOrder**
+> OrderSummaryDTO getGetEditableOrder()
+
+Get Editable Order
+
+### 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.getGetEditableOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**OrderSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Summary |  -  |
+|**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()
 
@@ -133,3 +192,241 @@ 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)
 
+# **postCreateAdminOrder**
+> Array<OrderSummaryDTO> postCreateAdminOrder()
+
+Create An Order (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    AdminOrderRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let readonly: boolean; //Readonly Order (optional) (default to undefined)
+let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
+
+const { status, data } = await apiInstance.postCreateAdminOrder(
+    readonly,
+    adminOrderRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
+| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **postGetOrders**
+> Array<OrderSummaryDTO> postGetOrders()
+
+Create An Order
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    CustomerOrderRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let readonly: boolean; //Readonly Order (optional) (default to undefined)
+let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
+
+const { status, data } = await apiInstance.postGetOrders(
+    readonly,
+    customerOrderRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
+| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **putUpdateAdminOrder**
+> Array<OrderSummaryDTO> putUpdateAdminOrder()
+
+Update An Order (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    AdminOrderRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let readonly: boolean; //Readonly Order (optional) (default to undefined)
+let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
+
+const { status, data } = await apiInstance.putUpdateAdminOrder(
+    id,
+    readonly,
+    adminOrderRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **putUpdateOrder**
+> Array<OrderSummaryDTO> putUpdateOrder()
+
+Update An Order
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    CustomerOrderRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let readonly: boolean; //Readonly Order (optional) (default to undefined)
+let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
+
+const { status, data } = await apiInstance.putUpdateOrder(
+    id,
+    readonly,
+    customerOrderRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OrderSummaryDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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/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/ProductSearchResultsModel.md

@@ -6,7 +6,7 @@ Product Search Results
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<ProductSummaryModel>**](ProductSummaryModel.md) | Results | [optional] [default to undefined]
+**results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [optional] [default to undefined]
 
 ## Example
 

package/docs/{ProductSummaryModel.md → ProductSummaryDTO.md}

@@ -1,4 +1,4 @@
-# ProductSummaryModel
+# ProductSummaryDTO
 
 Product Summary
 
@@ -12,19 +12,21 @@ Name | Type | Description | Notes
 **stockProduct** | **boolean** | Stock Product | [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]
 
 ## Example
 
 ```typescript
-import { ProductSummaryModel } from 'yellowgrid-api-ts';
+import { ProductSummaryDTO } from 'yellowgrid-api-ts';
 
-const instance: ProductSummaryModel = {
+const instance: ProductSummaryDTO = {
     sku,
     title,
     quantity,
     stockProduct,
     price,
     cartonSize,
+    rrp,
 };
 ```