yellowgrid-api-ts 3.2.62 → 3.2.64-dev.0

package/docs/PostAddOrderNoteRequest.md

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

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

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

package/docs/PrinterEntity.md

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

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

package/docs/ProvisioningApi.md

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

package/docs/PutAllocateItemsRequest.md

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

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

@@ -1,13 +1,12 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteGetSipTrunk**](#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk|
 |[**getCanDivert**](#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed|
 |[**getGetAddress**](#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address|
-|[**getGetAdminSipTrunks**](#getgetadminsiptrunks) | **GET** /sip/trunks/admin | |
 |[**getGetAreaCodes**](#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes|
 |[**getGetCliFlexibility**](#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status|
 |[**getGetDdis**](#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs|
@@ -190,60 +189,6 @@ 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)
 
-# **getGetAdminSipTrunks**
-> Array<SipTrunkEntity> getGetAdminSipTrunks()
-
-Get SIP Trunks
-
-### Example
-
-```typescript
-import {
-    SIPTrunksApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new SIPTrunksApi(configuration);
-
-let customerId: number; //Customer ID (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGetAdminSipTrunks(
-    customerId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<SipTrunkEntity>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | SIP Trunks |  -  |
-|**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)
-
 # **getGetAreaCodes**
 > Array<AreaCodeModel> getGetAreaCodes()
 

package/docs/SMSApi.md

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

package/docs/ServicesApi.md

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

package/docs/ShipmentDTO.md

@@ -0,0 +1,31 @@
+# ShipmentDTO
+
+Shipment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 = {
+    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

@@ -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/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** | **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

@@ -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://bitbucket.org*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingRequestDTO.md

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

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

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://bitbucket.org*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/{SupportTicketModel.md → TelephonySupportTicketModel.md}

@@ -1,4 +1,4 @@
-# SupportTicketModel
+# TelephonySupportTicketModel
 
 Telephony Support Ticket
 
@@ -21,9 +21,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { SupportTicketModel } from 'yellowgrid-api-ts';
+import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
 
-const instance: SupportTicketModel = {
+const instance: TelephonySupportTicketModel = {
     id,
     status,
     statusId,

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -71,7 +71,7 @@ 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)
 
 # **getGetTicket**
-> SupportTicketModel getGetTicket()
+> TelephonySupportTicketModel getGetTicket()
 
 Retrieve a telephony support ticket
 
@@ -102,7 +102,7 @@ const { status, data } = await apiInstance.getGetTicket(
 
 ### Return type
 
-**SupportTicketModel**
+**TelephonySupportTicketModel**
 
 ### Authorization
 
@@ -125,7 +125,7 @@ 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)
 
 # **patchCloseTicket**
-> SupportTicketModel patchCloseTicket()
+> TelephonySupportTicketModel patchCloseTicket()
 
 Close a telephony support ticket
 
@@ -156,7 +156,7 @@ const { status, data } = await apiInstance.patchCloseTicket(
 
 ### Return type
 
-**SupportTicketModel**
+**TelephonySupportTicketModel**
 
 ### Authorization
 
@@ -179,7 +179,7 @@ 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)
 
 # **postCreateTicket**
-> SupportTicketModel postCreateTicket()
+> TelephonySupportTicketModel postCreateTicket()
 
 Create a new telephony support ticket
 
@@ -216,7 +216,7 @@ const { status, data } = await apiInstance.postCreateTicket(
 
 ### Return type
 
-**SupportTicketModel**
+**TelephonySupportTicketModel**
 
 ### Authorization
 
@@ -239,7 +239,7 @@ 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)
 
 # **postTicketReply**
-> SupportTicketModel postTicketReply()
+> TelephonySupportTicketModel postTicketReply()
 
 Reply to a telephony support ticket
 
@@ -276,7 +276,7 @@ const { status, data } = await apiInstance.postTicketReply(
 
 ### Return type
 
-**SupportTicketModel**
+**TelephonySupportTicketModel**
 
 ### Authorization
 

package/docs/WebhooksApi.md

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

package/getEnums.php

@@ -1,31 +1,31 @@
-<?php
-
-use App\Contracts\Enums\PublicEnumInterface;
-
-require_once __DIR__."/../../../../vendor/autoload.php";
-
-$dir = __DIR__."/models";
-if (!is_dir($dir)) {
-    mkdir($dir);
-}
-foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
-    $ref = new ReflectionEnum($publicEnum->value);
-    $cases = [];
-    foreach ($ref->getCases() as $c) {
-        /** @var BackedEnum $enum */
-        $enum = $c->getEnum()->getName();
-        $value = $c->getBackingValue();
-        /** @var PublicEnumInterface $case */
-        $case = $enum::from($value);
-        $cases[$c->getName()] = [
-            "name" => $case->name,
-            "value" => $case->value,
-            "publicValue" => $case->getPublicValue()
-        ];
-    }
-    $enumName = $ref->getShortName();
-    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
-    $content = "export const $enumName = $enumString as const;".
-        "\n\n export type $enumName = typeof $enumName;";
-    file_put_contents("$dir/$enumName.ts", $content);
-}
+<?php
+
+use App\Contracts\Enums\PublicEnumInterface;
+
+require_once __DIR__."/../../../../vendor/autoload.php";
+
+$dir = __DIR__."/models";
+if (!is_dir($dir)) {
+    mkdir($dir);
+}
+foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
+    $ref = new ReflectionEnum($publicEnum->value);
+    $cases = [];
+    foreach ($ref->getCases() as $c) {
+        /** @var BackedEnum $enum */
+        $enum = $c->getEnum()->getName();
+        $value = $c->getBackingValue();
+        /** @var PublicEnumInterface $case */
+        $case = $enum::from($value);
+        $cases[$c->getName()] = [
+            "name" => $case->name,
+            "value" => $case->value,
+            "publicValue" => $case->getPublicValue()
+        ];
+    }
+    $enumName = $ref->getShortName();
+    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
+    $content = "export const $enumName = $enumString as const;".
+        "\n\n export type $enumName = typeof $enumName;";
+    file_put_contents("$dir/$enumName.ts", $content);
+}