yellowgrid-api-ts 3.1.15 → 3.1.17-dev.0

package/docs/CustomerItemRequestDTO.md

@@ -0,0 +1,37 @@
+# CustomerItemRequestDTO
+
+Order Item Request
+
+## Properties
+
+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]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**processDate** | **string** | Date Time | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
+**readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerItemRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerItemRequestDTO = {
+    sku,
+    quantity,
+    id,
+    licenceKey,
+    hosting,
+    processDate,
+    tcxSalesCode,
+    sbcs,
+    readOnly,
+};
+```
+
+[[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/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/DetailedItemRequestDTO.md

@@ -0,0 +1,43 @@
+# DetailedItemRequestDTO
+
+Detailed Order Item Request
+
+## Properties
+
+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]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**processDate** | **string** | Date Time | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
+**readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
+**itemPrice** | **number** | Price (£) | [optional] [default to undefined]
+**additionalDiscount** | **number** | Additional Discount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DetailedItemRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: DetailedItemRequestDTO = {
+    sku,
+    quantity,
+    id,
+    licenceKey,
+    hosting,
+    processDate,
+    tcxSalesCode,
+    sbcs,
+    readOnly,
+    title,
+    itemPrice,
+    additionalDiscount,
+};
+```
+
+[[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/DetailedOrderRequestDTO.md

@@ -0,0 +1,33 @@
+# DetailedOrderRequestDTO
+
+Detailed Order Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
+**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.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 { DetailedOrderRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: DetailedOrderRequestDTO = {
+    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/ItemDiscountEntity.md

@@ -0,0 +1,33 @@
+# ItemDiscountEntity
+
+ItemDiscountsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**priceList** | **string** | priceList | [optional] [default to undefined]
+**discount** | **number** | discount | [optional] [default to undefined]
+**type** | **string** | type | [optional] [default to undefined]
+**description** | **string** | description | [optional] [default to undefined]
+**priority** | **number** | priority | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ItemDiscountEntity } from 'yellowgrid-api-ts';
+
+const instance: ItemDiscountEntity = {
+    id,
+    itemId,
+    priceList,
+    discount,
+    type,
+    description,
+    priority,
+};
+```
+
+[[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/ItemEntity.md

@@ -22,11 +22,12 @@ Name | Type | Description | Notes
 **shippingTax** | **number** | shippingTax | [optional] [default to undefined]
 **shippingTaxGbp** | **number** | shippingTaxGbp | [optional] [default to undefined]
 **customerRefunded** | **number** | customerRefunded | [optional] [default to undefined]
-**licencekey** | **string** | licencekey | [optional] [default to undefined]
+**licenceKey** | **string** | licencekey | [optional] [default to undefined]
 **addHosting** | **number** | addHosting | [optional] [default to undefined]
 **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
 
@@ -50,11 +51,12 @@ const instance: ItemEntity = {
     shippingTax,
     shippingTaxGbp,
     customerRefunded,
-    licencekey,
+    licenceKey,
     addHosting,
     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,
 };
 ```