yellowgrid-api-ts 3.2.70-dev.0 → 3.2.72-dev.0

package/docs/CreditNoteEntity.md

@@ -1,29 +0,0 @@
-# CreditNoteEntity
-
-CreditNotesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**transactionId** | **string** | transactionId | [optional] [default to undefined]
-**amount** | **number** | amount | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreditNoteEntity } from 'yellowgrid-api-ts';
-
-const instance: CreditNoteEntity = {
-    id,
-    orderId,
-    transactionId,
-    amount,
-    timestamp,
-};
-```
-
-[[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/CreditNoteItemDTO.md

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

@@ -1,29 +0,0 @@
-# CreditNoteItemEntity
-
-CreditNotesItemsEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**itemId** | **number** | itemId | [optional] [default to undefined]
-**amount** | **number** | amount | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreditNoteItemEntity } from 'yellowgrid-api-ts';
-
-const instance: CreditNoteItemEntity = {
-    id,
-    creditNoteId,
-    orderId,
-    itemId,
-    amount,
-};
-```
-
-[[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/OrderDetailsDTO.md

@@ -1,63 +0,0 @@
-# OrderDetailsDTO
-
-Order Details
-
-## Properties
-
-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]
-**quote** | **boolean** | Quote | [optional] [default to undefined]
-**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |  | [optional] [default to undefined]
-**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
-**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]
-**detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
-**batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]
-**logEntries** | [**Array<AuditLogEntity>**](AuditLogEntity.md) | Audit Log | [optional] [default to undefined]
-**paymentLink** | **string** | Card Payment Link | [optional] [default to undefined]
-**credits** | [**Array<CreditNoteModel>**](CreditNoteModel.md) | Credits | [optional] [default to undefined]
-**customerEmail** | **string** | Customer Email | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { OrderDetailsDTO } from 'yellowgrid-api-ts';
-
-const instance: OrderDetailsDTO = {
-    id,
-    reference,
-    invoiceNumber,
-    invoiceId,
-    orderDate,
-    paid,
-    complete,
-    quote,
-    customer,
-    shippingAddress,
-    items,
-    carriageCharge,
-    fulfillable,
-    provisioningUrl,
-    shippingService,
-    readonly,
-    detailedItems,
-    batches,
-    logEntries,
-    paymentLink,
-    credits,
-    customerEmail,
-};
-```
-
-[[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/OrderItemDTO.md

@@ -1,55 +0,0 @@
-# OrderItemDTO
-
-Order Item Details
-
-## 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]
-**orderId** | **number** | Order ID | [optional] [default to undefined]
-**title** | **string** | Title | [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]
-**suppliers** | [**Array<SupplierModel>**](SupplierModel.md) | Suppliers | [optional] [default to undefined]
-**supplierItems** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Supplier Items | [optional] [default to undefined]
-**allocated** | **number** | Allocated | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { OrderItemDTO } from 'yellowgrid-api-ts';
-
-const instance: OrderItemDTO = {
-    sku,
-    quantity,
-    id,
-    orderId,
-    title,
-    price,
-    licenceKey,
-    licenceExpiry,
-    processDate,
-    hosting,
-    promoItem,
-    refunded,
-    sbcs,
-    readonly,
-    tcxSalesCode,
-    suppliers,
-    supplierItems,
-    allocated,
-};
-```
-
-[[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/OrderedItemModel.md

@@ -1,47 +0,0 @@
-# OrderedItemModel
-
-Ordered Item Model
-
-## 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 { OrderedItemModel } from 'yellowgrid-api-ts';
-
-const instance: OrderedItemModel = {
-    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/PostAddOrderNoteRequest.md

@@ -1,20 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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/PrinterEntity.md

@@ -1,29 +0,0 @@
-# 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/PutAllocateItemsRequest.md

@@ -1,20 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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/ShipmentDTO.md

@@ -1,35 +0,0 @@
-# ShipmentDTO
-
-Shipment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
-**batchId** | **number** | Batch ID | [optional] [default to undefined]
-**courier** | **string** | Courier | [optional] [default to undefined]
-**reference** | **string** | Courier Reference | [optional] [default to undefined]
-**requestedDate** | **string** | Date Time | [optional] [default to undefined]
-**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [optional] [default to undefined]
-**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [optional] [default to undefined]
-**address** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShipmentDTO } from 'yellowgrid-api-ts';
-
-const instance: ShipmentDTO = {
-    id,
-    batchId,
-    courier,
-    reference,
-    requestedDate,
-    scannedItems,
-    items,
-    address,
-};
-```
-
-[[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/ShipmentItemDTO.md

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

@@ -1,29 +0,0 @@
-# ShipmentItemModel
-
-Shipment Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**shipmentId** | **number** | shipmentId | [optional] [default to undefined]
-**batchId** | **number** | batchId | [optional] [default to undefined]
-**quantity** | **number** | quantity | [optional] [default to undefined]
-**itemId** | **string** | item | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShipmentItemModel } from 'yellowgrid-api-ts';
-
-const instance: ShipmentItemModel = {
-    id,
-    shipmentId,
-    batchId,
-    quantity,
-    itemId,
-};
-```
-
-[[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/ShipmentModel.md

@@ -1,43 +0,0 @@
-# ShipmentModel
-
-Shipment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**batchId** | **number** | batchId | [optional] [default to undefined]
-**courier** | **string** | courier | [optional] [default to undefined]
-**courierService** | **string** | courierService | [optional] [default to undefined]
-**courierServiceDesc** | **string** | courierServiceDesc | [optional] [default to undefined]
-**courierReference** | **string** | courierReference | [optional] [default to undefined]
-**courierTracking** | **string** | courierTracking | [optional] [default to undefined]
-**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
-**scannedData** | **string** | mac | [optional] [default to undefined]
-**dateShipped** | **string** | date | [optional] [default to undefined]
-**requestDate** | **string** | requestDate | [optional] [default to undefined]
-**provId** | **number** | provId | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShipmentModel } from 'yellowgrid-api-ts';
-
-const instance: ShipmentModel = {
-    id,
-    batchId,
-    courier,
-    courierService,
-    courierServiceDesc,
-    courierReference,
-    courierTracking,
-    courierBoxes,
-    scannedData,
-    dateShipped,
-    requestDate,
-    provId,
-};
-```
-
-[[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/ShipmentRequestDTO.md

@@ -1,31 +0,0 @@
-# ShipmentRequestDTO
-
-Shipment Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**courier** | **string** | Courier | [optional] [default to undefined]
-**address** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
-**scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
-**service** | **string** | Service | [optional] [default to undefined]
-**shipDate** | **string** | Date Time | [optional] [default to undefined]
-**items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShipmentRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: ShipmentRequestDTO = {
-    courier,
-    address,
-    scannedLines,
-    service,
-    shipDate,
-    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/ShippingRequestDTO.md

@@ -1,24 +0,0 @@
-# ShippingRequestDTO
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**courier** | **string** | Courier | [optional] [default to undefined]
-**service** | **string** | Courier Service | [optional] [default to undefined]
-**boxes** | **number** | Boxes | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShippingRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: ShippingRequestDTO = {
-    courier,
-    service,
-    boxes,
-};
-```
-
-[[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/SupplierItemModel.md

@@ -1,35 +0,0 @@
-# SupplierItemModel
-
-Supplier Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**supplierId** | **number** | supplierId | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**title** | **string** | title | [optional] [default to undefined]
-**itemOptions** | **string** | itemOptions | [optional] [default to undefined]
-**itemPrice** | **number** | itemPrice | [optional] [default to undefined]
-**itemType** | **number** | itemType | [optional] [default to undefined]
-**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SupplierItemModel } from 'yellowgrid-api-ts';
-
-const instance: SupplierItemModel = {
-    id,
-    supplierId,
-    sku,
-    title,
-    itemOptions,
-    itemPrice,
-    itemType,
-    supplierSku,
-};
-```
-
-[[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/SupplierModel.md

@@ -1,37 +0,0 @@
-# SupplierModel
-
-Supplier
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**name** | **string** | name | [optional] [default to undefined]
-**shortName** | **string** | nameShort | [optional] [default to undefined]
-**email** | **string** | email | [optional] [default to undefined]
-**phone** | **string** | phone | [optional] [default to undefined]
-**defaultCourier** | **string** | defaultCourier | [optional] [default to undefined]
-**defaultCarriage** | **number** | defaultCarriage | [optional] [default to undefined]
-**accountNumber** | **string** | account | [optional] [default to undefined]
-**xeroAccountNumber** | **string** | internalAccount | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SupplierModel } from 'yellowgrid-api-ts';
-
-const instance: SupplierModel = {
-    id,
-    name,
-    shortName,
-    email,
-    phone,
-    defaultCourier,
-    defaultCarriage,
-    accountNumber,
-    xeroAccountNumber,
-};
-```
-
-[[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/TelephonySupportTicketModel.md

@@ -1,41 +0,0 @@
-# TelephonySupportTicketModel
-
-Telephony Support Ticket
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Ticket ID | [optional] [default to undefined]
-**status** | **string** | Ticket status | [optional] [default to undefined]
-**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
-**subject** | **string** | Ticket subject | [optional] [default to undefined]
-**supportEmail** | **string** | Support email address | [optional] [default to undefined]
-**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
-**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
-**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
-**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
-**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
-**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
-
-const instance: TelephonySupportTicketModel = {
-    id,
-    status,
-    statusId,
-    subject,
-    supportEmail,
-    toEmails,
-    description,
-    descriptionText,
-    createdAt,
-    attachments,
-    conversations,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)