yellowgrid-api-ts 3.2.76-dev.0 → 3.2.77-dev.0

package/docs/BatchDTO.md

@@ -0,0 +1,59 @@
+# BatchDTO
+
+Batch DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [optional] [default to undefined]
+**poNumber** | **string** | poNumber | [optional] [default to undefined]
+**carriage** | **number** | carriage | [optional] [default to undefined]
+**courier** | **string** | courier | [optional] [default to undefined]
+**courierService** | **string** | courierService | [optional] [default to undefined]
+**courierReference** | **string** | courierReference | [optional] [default to undefined]
+**courierUnique** | **string** | courierUnique | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
+**ordered** | **number** | ordered | [optional] [default to undefined]
+**carriagePaid** | **number** | carriagePaid | [optional] [default to undefined]
+**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
+**carriageRefundedDue** | **number** | carriageRefundedDue | [optional] [default to undefined]
+**netdespatchLabel** | **string** | netdespatchLabel | [optional] [default to undefined]
+**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
+**mac** | **string** | mac | [optional] [default to undefined]
+**shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
+**items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
+**supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BatchDTO } from 'yellowgrid-api-ts';
+
+const instance: BatchDTO = {
+    id,
+    orderId,
+    supplierId,
+    poNumber,
+    carriage,
+    courier,
+    courierService,
+    courierReference,
+    courierUnique,
+    notes,
+    ordered,
+    carriagePaid,
+    carriageRefunded,
+    carriageRefundedDue,
+    netdespatchLabel,
+    courierBoxes,
+    mac,
+    shipments,
+    items,
+    supplier,
+};
+```
+
+[[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/CRMApi.md

@@ -1,6 +1,6 @@
 # CRMApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXApi.md

@@ -1,6 +1,6 @@
 # Class3CXApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationWizardApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationWizardApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXIntegrationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXMultiTenantApi.md

@@ -1,6 +1,6 @@
 # Class3CXMultiTenantApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/CreditNoteDTO.md

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

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

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

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

@@ -0,0 +1,29 @@
+# CreditNoteModel
+
+Credit Note Model
+
+## 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 { CreditNoteModel } from 'yellowgrid-api-ts';
+
+const instance: CreditNoteModel = {
+    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/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/NumberPortModel.md

@@ -0,0 +1,51 @@
+# NumberPortModel
+
+Number Port Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Number Port ID | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+**endUser** | **string** | End User | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
+**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
+**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
+**portDate** | **string** | Port Date | [optional] [default to undefined]
+**comment** | **string** | Comment | [optional] [default to undefined]
+**status** | **number** | Status | [optional] [default to undefined]
+**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
+**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
+**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NumberPortModel } from 'yellowgrid-api-ts';
+
+const instance: NumberPortModel = {
+    id,
+    customerId,
+    endUser,
+    addressLine1,
+    addressLine2,
+    city,
+    postCode,
+    trunkId,
+    tenantId,
+    requestedPortDate,
+    portDate,
+    comment,
+    status,
+    ticketId,
+    ranges,
+    customerName,
+};
+```
+
+[[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/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OrderDetailsDTO.md

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

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