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

package/docs/SMSApi.md

@@ -1,11 +1,67 @@
 # SMSApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**postCreateSmsAccount**](#postcreatesmsaccount) | **POST** /messaging/sms/account | Create SMS Account|
 |[**postSendSms**](#postsendsms) | **POST** /messaging/sms/send | |
 
+# **postCreateSmsAccount**
+> SmsAccountDTO postCreateSmsAccount()
+
+Create SMS Account
+
+### Example
+
+```typescript
+import {
+    SMSApi,
+    Configuration,
+    SmsAccountRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SMSApi(configuration);
+
+let smsAccountRequestDTO: SmsAccountRequestDTO; //SMS Account Request (optional)
+
+const { status, data } = await apiInstance.postCreateSmsAccount(
+    smsAccountRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **smsAccountRequestDTO** | **SmsAccountRequestDTO**| SMS Account Request | |
+
+
+### Return type
+
+**SmsAccountDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SMS Account |  -  |
+|**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)
+
 # **postSendSms**
 > SmsDataModel postSendSms()
 

package/docs/ServicesApi.md

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

package/docs/ShipmentDTO.md

@@ -0,0 +1,41 @@
+# 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]
+**tracking** | **string** | Courier Tracking | [optional] [default to undefined]
+**trackingUrl** | **string** | Courier Tracking URL | [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]
+**boxes** | **number** | Boxes Shipped | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShipmentDTO } from 'yellowgrid-api-ts';
+
+const instance: ShipmentDTO = {
+    id,
+    batchId,
+    courier,
+    reference,
+    tracking,
+    trackingUrl,
+    requestedDate,
+    scannedItems,
+    items,
+    address,
+    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/ShipmentItemDTO.md

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

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **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]
+**itemId** | **number** | item | [optional] [default to undefined]
 
 ## Example
 

package/docs/ShipmentItemModel.md

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

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

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

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

package/docs/ShippingRequestDTO.md

@@ -0,0 +1,28 @@
+# 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]
+**printer** | **number** | Printer | [optional] [default to undefined]
+**shipment** | [**ShipmentRequestDTO**](ShipmentRequestDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: ShippingRequestDTO = {
+    courier,
+    service,
+    boxes,
+    printer,
+    shipment,
+};
+```
+
+[[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/SmsAccountDTO.md

@@ -0,0 +1,31 @@
+# SmsAccountDTO
+
+SMS Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sendUrl** | **string** | Send URL | [optional] [default to undefined]
+**webhookUrl** | **string** | Webhook URL | [optional] [default to undefined]
+**apiKey** | **string** | API Key | [optional] [default to undefined]
+**numbers** | [**Array<SmsNumbersEntity>**](SmsNumbersEntity.md) | Numbers | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
+**whitelist** | [**Array<SmsWhitelistEntity>**](SmsWhitelistEntity.md) | Sender Whitelist | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsAccountDTO } from 'yellowgrid-api-ts';
+
+const instance: SmsAccountDTO = {
+    sendUrl,
+    webhookUrl,
+    apiKey,
+    numbers,
+    name,
+    whitelist,
+};
+```
+
+[[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/SmsAccountRequestDTO.md

@@ -0,0 +1,29 @@
+# SmsAccountRequestDTO
+
+SMS Account Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **number** | SMS Provider | [optional] [default to undefined]
+**name** | **string** | Customer Name | [optional] [default to undefined]
+**webhookUrl** | **string** | SMS Webhook | [optional] [default to undefined]
+**iso** | **string** | Number Country | [optional] [default to undefined]
+**type** | **string** | Number Type | [optional] [default to TypeEnum_Mobile]
+
+## Example
+
+```typescript
+import { SmsAccountRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: SmsAccountRequestDTO = {
+    provider,
+    name,
+    webhookUrl,
+    iso,
+    type,
+};
+```
+
+[[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/StockManagementApi.md

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

package/docs/SupplierItemModel.md

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

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

@@ -1,6 +1,6 @@
 # SystemApi
 
-All URIs are relative to *https://localhost*
+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,
 };
 ```