yellowgrid-api-ts 3.2.55-dev.0 → 3.2.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +229 -249
- package/README.md +0 -34
- package/api.ts +207 -2373
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/config.json +3 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +105 -1727
- package/dist/api.js +84 -1379
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/OrdersApi.md +12 -788
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/package.json +1 -1
- package/dist/models/CourierEnum.d.ts +0 -18
- package/dist/models/CourierEnum.js +0 -20
- package/dist/models/PrinterEnum.d.ts +0 -18
- package/dist/models/PrinterEnum.js +0 -20
- package/docs/BatchDTO.md +0 -57
- package/docs/CreditNoteDTO.md +0 -21
- package/docs/CreditNoteEntity.md +0 -29
- package/docs/CreditNoteItemDTO.md +0 -25
- package/docs/CreditNoteItemEntity.md +0 -29
- package/docs/CreditNoteModel.md +0 -29
- package/docs/OrderDetailsDTO.md +0 -63
- package/docs/OrderItemDTO.md +0 -53
- package/docs/OrderedItemModel.md +0 -47
- package/docs/PostAddOrderNoteRequest.md +0 -20
- package/docs/PostSplitOrderRequest.md +0 -20
- package/docs/PrinterEntity.md +0 -29
- package/docs/PutAllocateItemsRequest.md +0 -20
- package/docs/PutAllocateItemsRequestItemsInner.md +0 -22
- package/docs/ShipmentDTO.md +0 -31
- package/docs/ShipmentItemDTO.md +0 -23
- package/docs/ShipmentItemModel.md +0 -29
- package/docs/ShipmentModel.md +0 -43
- package/docs/ShipmentRequestDTO.md +0 -31
- package/docs/ShippingRequestDTO.md +0 -24
- package/docs/SupplierModel.md +0 -37
- package/hs_err_pid58424.log +0 -247
- package/models/CourierEnum.ts +0 -19
- package/models/PrinterEnum.ts +0 -19
package/getEnums.php
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
<?php
|
|
2
|
-
|
|
3
|
-
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
-
|
|
5
|
-
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
-
|
|
7
|
-
$dir = __DIR__."/models";
|
|
8
|
-
if (!is_dir($dir)) {
|
|
9
|
-
mkdir($dir);
|
|
10
|
-
}
|
|
11
|
-
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
12
|
-
$ref = new ReflectionEnum($publicEnum->value);
|
|
13
|
-
$cases = [];
|
|
14
|
-
foreach ($ref->getCases() as $c) {
|
|
15
|
-
/** @var BackedEnum $enum */
|
|
16
|
-
$enum = $c->getEnum()->getName();
|
|
17
|
-
$value = $c->getBackingValue();
|
|
18
|
-
/** @var PublicEnumInterface $case */
|
|
19
|
-
$case = $enum::from($value);
|
|
20
|
-
$cases[$c->getName()] = [
|
|
21
|
-
"name" => $case->name,
|
|
22
|
-
"value" => $case->value,
|
|
23
|
-
"publicValue" => $case->getPublicValue()
|
|
24
|
-
];
|
|
25
|
-
}
|
|
26
|
-
$enumName = $ref->getShortName();
|
|
27
|
-
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
28
|
-
$content = "export const $enumName = $enumString as const;".
|
|
29
|
-
"\n\n export type $enumName = typeof $enumName;";
|
|
30
|
-
file_put_contents("$dir/$enumName.ts", $content);
|
|
31
|
-
}
|
|
1
|
+
<?php
|
|
2
|
+
|
|
3
|
+
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
+
|
|
5
|
+
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
+
|
|
7
|
+
$dir = __DIR__."/models";
|
|
8
|
+
if (!is_dir($dir)) {
|
|
9
|
+
mkdir($dir);
|
|
10
|
+
}
|
|
11
|
+
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
12
|
+
$ref = new ReflectionEnum($publicEnum->value);
|
|
13
|
+
$cases = [];
|
|
14
|
+
foreach ($ref->getCases() as $c) {
|
|
15
|
+
/** @var BackedEnum $enum */
|
|
16
|
+
$enum = $c->getEnum()->getName();
|
|
17
|
+
$value = $c->getBackingValue();
|
|
18
|
+
/** @var PublicEnumInterface $case */
|
|
19
|
+
$case = $enum::from($value);
|
|
20
|
+
$cases[$c->getName()] = [
|
|
21
|
+
"name" => $case->name,
|
|
22
|
+
"value" => $case->value,
|
|
23
|
+
"publicValue" => $case->getPublicValue()
|
|
24
|
+
];
|
|
25
|
+
}
|
|
26
|
+
$enumName = $ref->getShortName();
|
|
27
|
+
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
28
|
+
$content = "export const $enumName = $enumString as const;".
|
|
29
|
+
"\n\n export type $enumName = typeof $enumName;";
|
|
30
|
+
file_put_contents("$dir/$enumName.ts", $content);
|
|
31
|
+
}
|
package/index.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
5
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
package/package.json
CHANGED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
export declare const CourierEnum: {
|
|
2
|
-
readonly DPD: {
|
|
3
|
-
readonly name: "DPD";
|
|
4
|
-
readonly value: "DPD";
|
|
5
|
-
readonly publicValue: "DPD";
|
|
6
|
-
};
|
|
7
|
-
readonly CHORLTON: {
|
|
8
|
-
readonly name: "CHORLTON";
|
|
9
|
-
readonly value: "Chorlton Pallet";
|
|
10
|
-
readonly publicValue: "Chorlton Pallet";
|
|
11
|
-
};
|
|
12
|
-
readonly BUILT_IN: {
|
|
13
|
-
readonly name: "BUILT_IN";
|
|
14
|
-
readonly value: "POPS";
|
|
15
|
-
readonly publicValue: "POPS";
|
|
16
|
-
};
|
|
17
|
-
};
|
|
18
|
-
export type CourierEnum = typeof CourierEnum;
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.CourierEnum = void 0;
|
|
4
|
-
exports.CourierEnum = {
|
|
5
|
-
"DPD": {
|
|
6
|
-
"name": "DPD",
|
|
7
|
-
"value": "DPD",
|
|
8
|
-
"publicValue": "DPD"
|
|
9
|
-
},
|
|
10
|
-
"CHORLTON": {
|
|
11
|
-
"name": "CHORLTON",
|
|
12
|
-
"value": "Chorlton Pallet",
|
|
13
|
-
"publicValue": "Chorlton Pallet"
|
|
14
|
-
},
|
|
15
|
-
"BUILT_IN": {
|
|
16
|
-
"name": "BUILT_IN",
|
|
17
|
-
"value": "POPS",
|
|
18
|
-
"publicValue": "POPS"
|
|
19
|
-
}
|
|
20
|
-
};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
export declare const PrinterEnum: {
|
|
2
|
-
readonly STORE_ROOM: {
|
|
3
|
-
readonly name: "STORE_ROOM";
|
|
4
|
-
readonly value: 1;
|
|
5
|
-
readonly publicValue: "Store Room";
|
|
6
|
-
};
|
|
7
|
-
readonly PI_DESK: {
|
|
8
|
-
readonly name: "PI_DESK";
|
|
9
|
-
readonly value: 2;
|
|
10
|
-
readonly publicValue: "Raspberry Pi Desk";
|
|
11
|
-
};
|
|
12
|
-
readonly SPARE: {
|
|
13
|
-
readonly name: "SPARE";
|
|
14
|
-
readonly value: 3;
|
|
15
|
-
readonly publicValue: "Spare";
|
|
16
|
-
};
|
|
17
|
-
};
|
|
18
|
-
export type PrinterEnum = typeof PrinterEnum;
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.PrinterEnum = void 0;
|
|
4
|
-
exports.PrinterEnum = {
|
|
5
|
-
"STORE_ROOM": {
|
|
6
|
-
"name": "STORE_ROOM",
|
|
7
|
-
"value": 1,
|
|
8
|
-
"publicValue": "Store Room"
|
|
9
|
-
},
|
|
10
|
-
"PI_DESK": {
|
|
11
|
-
"name": "PI_DESK",
|
|
12
|
-
"value": 2,
|
|
13
|
-
"publicValue": "Raspberry Pi Desk"
|
|
14
|
-
},
|
|
15
|
-
"SPARE": {
|
|
16
|
-
"name": "SPARE",
|
|
17
|
-
"value": 3,
|
|
18
|
-
"publicValue": "Spare"
|
|
19
|
-
}
|
|
20
|
-
};
|
package/docs/BatchDTO.md
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
# BatchDTO
|
|
2
|
-
|
|
3
|
-
Batch DTO
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**orderId** | **number** | orderId | [optional] [default to undefined]
|
|
11
|
-
**supplierId** | **number** | supplierId | [optional] [default to undefined]
|
|
12
|
-
**poNumber** | **string** | poNumber | [optional] [default to undefined]
|
|
13
|
-
**carriage** | **number** | carriage | [optional] [default to undefined]
|
|
14
|
-
**courier** | **string** | courier | [optional] [default to undefined]
|
|
15
|
-
**courierService** | **string** | courierService | [optional] [default to undefined]
|
|
16
|
-
**courierReference** | **string** | courierReference | [optional] [default to undefined]
|
|
17
|
-
**courierUnique** | **string** | courierUnique | [optional] [default to undefined]
|
|
18
|
-
**notes** | **string** | notes | [optional] [default to undefined]
|
|
19
|
-
**ordered** | **number** | ordered | [optional] [default to undefined]
|
|
20
|
-
**carriagePaid** | **number** | carriagePaid | [optional] [default to undefined]
|
|
21
|
-
**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
|
|
22
|
-
**carriageRefundedDue** | **number** | carriageRefundedDue | [optional] [default to undefined]
|
|
23
|
-
**netdespatchLabel** | **string** | netdespatchLabel | [optional] [default to undefined]
|
|
24
|
-
**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
|
|
25
|
-
**mac** | **string** | mac | [optional] [default to undefined]
|
|
26
|
-
**shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
|
|
27
|
-
**items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
|
|
28
|
-
|
|
29
|
-
## Example
|
|
30
|
-
|
|
31
|
-
```typescript
|
|
32
|
-
import { BatchDTO } from 'yellowgrid-api-ts';
|
|
33
|
-
|
|
34
|
-
const instance: BatchDTO = {
|
|
35
|
-
id,
|
|
36
|
-
orderId,
|
|
37
|
-
supplierId,
|
|
38
|
-
poNumber,
|
|
39
|
-
carriage,
|
|
40
|
-
courier,
|
|
41
|
-
courierService,
|
|
42
|
-
courierReference,
|
|
43
|
-
courierUnique,
|
|
44
|
-
notes,
|
|
45
|
-
ordered,
|
|
46
|
-
carriagePaid,
|
|
47
|
-
carriageRefunded,
|
|
48
|
-
carriageRefundedDue,
|
|
49
|
-
netdespatchLabel,
|
|
50
|
-
courierBoxes,
|
|
51
|
-
mac,
|
|
52
|
-
shipments,
|
|
53
|
-
items,
|
|
54
|
-
};
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
[[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/CreditNoteDTO.md
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# CreditNoteDTO
|
|
2
|
-
|
|
3
|
-
Credit Note
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**items** | [**Array<CreditNoteItemDTO>**](CreditNoteItemDTO.md) | Items | [optional] [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { CreditNoteDTO } from 'yellowgrid-api-ts';
|
|
15
|
-
|
|
16
|
-
const instance: CreditNoteDTO = {
|
|
17
|
-
items,
|
|
18
|
-
};
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
[[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
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# CreditNoteEntity
|
|
2
|
-
|
|
3
|
-
CreditNotesEntity
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**orderId** | **number** | orderId | [optional] [default to undefined]
|
|
11
|
-
**transactionId** | **string** | transactionId | [optional] [default to undefined]
|
|
12
|
-
**amount** | **number** | amount | [optional] [default to undefined]
|
|
13
|
-
**timestamp** | **string** | timestamp | [optional] [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { CreditNoteEntity } from 'yellowgrid-api-ts';
|
|
19
|
-
|
|
20
|
-
const instance: CreditNoteEntity = {
|
|
21
|
-
id,
|
|
22
|
-
orderId,
|
|
23
|
-
transactionId,
|
|
24
|
-
amount,
|
|
25
|
-
timestamp,
|
|
26
|
-
};
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# CreditNoteItemDTO
|
|
2
|
-
|
|
3
|
-
Credit Note Item
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**itemId** | **number** | Item ID | [optional] [default to undefined]
|
|
10
|
-
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
11
|
-
**amount** | **number** | Amount | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { CreditNoteItemDTO } from 'yellowgrid-api-ts';
|
|
17
|
-
|
|
18
|
-
const instance: CreditNoteItemDTO = {
|
|
19
|
-
itemId,
|
|
20
|
-
quantity,
|
|
21
|
-
amount,
|
|
22
|
-
};
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# CreditNoteItemEntity
|
|
2
|
-
|
|
3
|
-
CreditNotesItemsEntity
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
|
|
11
|
-
**orderId** | **number** | orderId | [optional] [default to undefined]
|
|
12
|
-
**itemId** | **number** | itemId | [optional] [default to undefined]
|
|
13
|
-
**amount** | **number** | amount | [optional] [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { CreditNoteItemEntity } from 'yellowgrid-api-ts';
|
|
19
|
-
|
|
20
|
-
const instance: CreditNoteItemEntity = {
|
|
21
|
-
id,
|
|
22
|
-
creditNoteId,
|
|
23
|
-
orderId,
|
|
24
|
-
itemId,
|
|
25
|
-
amount,
|
|
26
|
-
};
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
[[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
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# CreditNoteModel
|
|
2
|
-
|
|
3
|
-
Credit Note Model
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**orderId** | **number** | orderId | [optional] [default to undefined]
|
|
11
|
-
**transactionId** | **string** | transactionId | [optional] [default to undefined]
|
|
12
|
-
**amount** | **number** | amount | [optional] [default to undefined]
|
|
13
|
-
**timestamp** | **string** | timestamp | [optional] [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { CreditNoteModel } from 'yellowgrid-api-ts';
|
|
19
|
-
|
|
20
|
-
const instance: CreditNoteModel = {
|
|
21
|
-
id,
|
|
22
|
-
orderId,
|
|
23
|
-
transactionId,
|
|
24
|
-
amount,
|
|
25
|
-
timestamp,
|
|
26
|
-
};
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
[[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
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# OrderDetailsDTO
|
|
2
|
-
|
|
3
|
-
Order Details
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
-
**reference** | **string** | Reference | [optional] [default to undefined]
|
|
11
|
-
**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
|
|
12
|
-
**invoiceId** | **string** | Invoice ID | [optional] [default to undefined]
|
|
13
|
-
**orderDate** | **string** | Date Time | [optional] [default to undefined]
|
|
14
|
-
**paid** | **boolean** | Paid | [optional] [default to undefined]
|
|
15
|
-
**complete** | **boolean** | Complete | [optional] [default to undefined]
|
|
16
|
-
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
17
|
-
**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) | | [optional] [default to undefined]
|
|
18
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
19
|
-
**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [optional] [default to undefined]
|
|
20
|
-
**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
|
|
21
|
-
**fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
|
|
22
|
-
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
23
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
24
|
-
**readonly** | **boolean** | Readonly | [optional] [default to undefined]
|
|
25
|
-
**detailedItems** | [**Array<OrderItemDTO>**](OrderItemDTO.md) | Detailed Items | [optional] [default to undefined]
|
|
26
|
-
**batches** | [**Array<BatchDTO>**](BatchDTO.md) | Batches | [optional] [default to undefined]
|
|
27
|
-
**logEntries** | [**Array<AuditLogEntity>**](AuditLogEntity.md) | Audit Log | [optional] [default to undefined]
|
|
28
|
-
**paymentLink** | **string** | Card Payment Link | [optional] [default to undefined]
|
|
29
|
-
**credits** | [**Array<CreditNoteModel>**](CreditNoteModel.md) | Credits | [optional] [default to undefined]
|
|
30
|
-
**customerEmail** | **string** | Customer Email | [optional] [default to undefined]
|
|
31
|
-
|
|
32
|
-
## Example
|
|
33
|
-
|
|
34
|
-
```typescript
|
|
35
|
-
import { OrderDetailsDTO } from 'yellowgrid-api-ts';
|
|
36
|
-
|
|
37
|
-
const instance: OrderDetailsDTO = {
|
|
38
|
-
id,
|
|
39
|
-
reference,
|
|
40
|
-
invoiceNumber,
|
|
41
|
-
invoiceId,
|
|
42
|
-
orderDate,
|
|
43
|
-
paid,
|
|
44
|
-
complete,
|
|
45
|
-
quote,
|
|
46
|
-
customer,
|
|
47
|
-
shippingAddress,
|
|
48
|
-
items,
|
|
49
|
-
carriageCharge,
|
|
50
|
-
fulfillable,
|
|
51
|
-
provisioningUrl,
|
|
52
|
-
shippingService,
|
|
53
|
-
readonly,
|
|
54
|
-
detailedItems,
|
|
55
|
-
batches,
|
|
56
|
-
logEntries,
|
|
57
|
-
paymentLink,
|
|
58
|
-
credits,
|
|
59
|
-
customerEmail,
|
|
60
|
-
};
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
[[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
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# OrderItemDTO
|
|
2
|
-
|
|
3
|
-
Order Item Details
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
10
|
-
**quantity** | **number** | Quantity | [optional] [default to undefined]
|
|
11
|
-
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
|
-
**orderId** | **number** | Order ID | [optional] [default to undefined]
|
|
13
|
-
**title** | **string** | Title | [optional] [default to undefined]
|
|
14
|
-
**price** | **number** | Price | [optional] [default to undefined]
|
|
15
|
-
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
16
|
-
**licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
|
|
17
|
-
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
18
|
-
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
19
|
-
**promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
|
|
20
|
-
**refunded** | **number** | Refunded | [optional] [default to undefined]
|
|
21
|
-
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
|
|
22
|
-
**readonly** | **boolean** | Readonly | [optional] [default to undefined]
|
|
23
|
-
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
24
|
-
**suppliers** | [**Array<SupplierModel>**](SupplierModel.md) | Suppliers | [optional] [default to undefined]
|
|
25
|
-
**allocated** | **number** | Allocated | [optional] [default to undefined]
|
|
26
|
-
|
|
27
|
-
## Example
|
|
28
|
-
|
|
29
|
-
```typescript
|
|
30
|
-
import { OrderItemDTO } from 'yellowgrid-api-ts';
|
|
31
|
-
|
|
32
|
-
const instance: OrderItemDTO = {
|
|
33
|
-
sku,
|
|
34
|
-
quantity,
|
|
35
|
-
id,
|
|
36
|
-
orderId,
|
|
37
|
-
title,
|
|
38
|
-
price,
|
|
39
|
-
licenceKey,
|
|
40
|
-
licenceExpiry,
|
|
41
|
-
processDate,
|
|
42
|
-
hosting,
|
|
43
|
-
promoItem,
|
|
44
|
-
refunded,
|
|
45
|
-
sbcs,
|
|
46
|
-
readonly,
|
|
47
|
-
tcxSalesCode,
|
|
48
|
-
suppliers,
|
|
49
|
-
allocated,
|
|
50
|
-
};
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
[[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
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# OrderedItemModel
|
|
2
|
-
|
|
3
|
-
Ordered Item Model
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**itemId** | **number** | itemId | [optional] [default to undefined]
|
|
11
|
-
**orderedQuantity** | **number** | orderedQuantity | [optional] [default to undefined]
|
|
12
|
-
**itemStatus** | **number** | itemStatus | [optional] [default to undefined]
|
|
13
|
-
**supplierId** | **number** | supplierId | [optional] [default to undefined]
|
|
14
|
-
**supplierItemId** | **number** | supplierItemId | [optional] [default to undefined]
|
|
15
|
-
**supplierPrice** | **number** | supplierPrice | [optional] [default to undefined]
|
|
16
|
-
**statusDate** | **string** | statusDate | [optional] [default to undefined]
|
|
17
|
-
**statusAuthor** | **number** | statusAuthor | [optional] [default to undefined]
|
|
18
|
-
**supplierPaid** | **number** | supplierPaid | [optional] [default to undefined]
|
|
19
|
-
**supplierCreditDue** | **number** | supplierCreditDue | [optional] [default to undefined]
|
|
20
|
-
**supplierCreditReceived** | **number** | supplierCreditReceived | [optional] [default to undefined]
|
|
21
|
-
**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
|
|
22
|
-
**returnedStock** | **number** | returnedStock | [optional] [default to undefined]
|
|
23
|
-
|
|
24
|
-
## Example
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
import { OrderedItemModel } from 'yellowgrid-api-ts';
|
|
28
|
-
|
|
29
|
-
const instance: OrderedItemModel = {
|
|
30
|
-
id,
|
|
31
|
-
itemId,
|
|
32
|
-
orderedQuantity,
|
|
33
|
-
itemStatus,
|
|
34
|
-
supplierId,
|
|
35
|
-
supplierItemId,
|
|
36
|
-
supplierPrice,
|
|
37
|
-
statusDate,
|
|
38
|
-
statusAuthor,
|
|
39
|
-
supplierPaid,
|
|
40
|
-
supplierCreditDue,
|
|
41
|
-
supplierCreditReceived,
|
|
42
|
-
supplierSku,
|
|
43
|
-
returnedStock,
|
|
44
|
-
};
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PostAddOrderNoteRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**note** | **string** | Order Note | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PostAddOrderNoteRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PostAddOrderNoteRequest = {
|
|
16
|
-
note,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PostSplitOrderRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**itemIds** | **Array<number>** | Item Ids | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PostSplitOrderRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PostSplitOrderRequest = {
|
|
16
|
-
itemIds,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[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
DELETED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# PrinterEntity
|
|
2
|
-
|
|
3
|
-
PrintersEntity
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**brand** | **string** | brand | [optional] [default to undefined]
|
|
11
|
-
**model** | **string** | model | [optional] [default to undefined]
|
|
12
|
-
**sn** | **string** | sn | [optional] [default to undefined]
|
|
13
|
-
**location** | **string** | location | [optional] [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { PrinterEntity } from 'yellowgrid-api-ts';
|
|
19
|
-
|
|
20
|
-
const instance: PrinterEntity = {
|
|
21
|
-
id,
|
|
22
|
-
brand,
|
|
23
|
-
model,
|
|
24
|
-
sn,
|
|
25
|
-
location,
|
|
26
|
-
};
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# PutAllocateItemsRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**items** | [**Array<PutAllocateItemsRequestItemsInner>**](PutAllocateItemsRequestItemsInner.md) | Items | [optional] [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { PutAllocateItemsRequest } from 'yellowgrid-api-ts';
|
|
14
|
-
|
|
15
|
-
const instance: PutAllocateItemsRequest = {
|
|
16
|
-
items,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# PutAllocateItemsRequestItemsInner
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**itemId** | **number** | Item ID | [optional] [default to undefined]
|
|
9
|
-
**quantity** | **number** | Quantity To Allocate | [optional] [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { PutAllocateItemsRequestItemsInner } from 'yellowgrid-api-ts';
|
|
15
|
-
|
|
16
|
-
const instance: PutAllocateItemsRequestItemsInner = {
|
|
17
|
-
itemId,
|
|
18
|
-
quantity,
|
|
19
|
-
};
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|