yellowgrid-api-ts 3.0.84-dev.0 → 3.0.84
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 +190 -208
- package/README.md +7 -34
- package/api.ts +253 -1798
- 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 +163 -1316
- package/dist/api.js +201 -1079
- 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/AccountsApi.md +0 -103
- package/docs/Class3CXApi.md +55 -0
- package/docs/ClientDetailsModel.md +2 -0
- package/docs/{ShippingServicesModel.md → GetGetPasswordHash200Response.md} +5 -5
- package/docs/ItemDTO.md +4 -10
- package/docs/OrderSummaryDTO.md +0 -8
- package/docs/OrderTotalModel.md +0 -2
- package/docs/OrdersApi.md +4 -301
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/{ProductSummaryDTO.md → ProductSummaryModel.md} +3 -5
- package/docs/ProductsApi.md +35 -166
- package/docs/ProvisioningApi.md +4 -4
- package/docs/{ProvisioningModel.md → ProvisioningEntity.md} +3 -3
- package/docs/ShipmentEntity.md +2 -2
- package/docs/StockManagementApi.md +2 -2
- package/docs/TcxBackupModel.md +2 -0
- package/docs/TcxSbcModel.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/AbstractOrderRequestDTO.md +0 -33
- package/docs/AccountDetailedSummaryDTO.md +0 -35
- package/docs/AdminItemRequestDTO.md +0 -37
- package/docs/AdminOrderRequestDTO.md +0 -41
- package/docs/AdminUserModel.md +0 -31
- package/docs/BasicItemDTO.md +0 -23
- package/docs/BasicProductDTO.md +0 -23
- package/docs/CourierPriceEntity.md +0 -39
- package/docs/CustomerItemRequestDTO.md +0 -33
- package/docs/CustomerOrderRequestDTO.md +0 -33
- package/docs/LinkedOrderEntity.md +0 -23
- package/docs/NavigationItemModel.md +0 -27
- package/docs/ShippingApi.md +0 -63
- package/docs/ShippingConsignmentModel.md +0 -26
- package/docs/ShippingInformationDTO.md +0 -25
- package/docs/ShippingServiceDTO.md +0 -23
- package/docs/ShippingServiceModel.md +0 -31
- package/docs/SubNavigationItemModel.md +0 -25
- package/docs/TcxSbcDTO.md +0 -31
package/docs/ProvisioningApi.md
CHANGED
|
@@ -235,7 +235,7 @@ No authorization required
|
|
|
235
235
|
[[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)
|
|
236
236
|
|
|
237
237
|
# **getGetGroups**
|
|
238
|
-
> Array<
|
|
238
|
+
> Array<ProvisioningEntity> getGetGroups()
|
|
239
239
|
|
|
240
240
|
Get provisioning groups
|
|
241
241
|
|
|
@@ -266,7 +266,7 @@ const { status, data } = await apiInstance.getGetGroups(
|
|
|
266
266
|
|
|
267
267
|
### Return type
|
|
268
268
|
|
|
269
|
-
**Array<
|
|
269
|
+
**Array<ProvisioningEntity>**
|
|
270
270
|
|
|
271
271
|
### Authorization
|
|
272
272
|
|
|
@@ -289,7 +289,7 @@ No authorization required
|
|
|
289
289
|
[[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)
|
|
290
290
|
|
|
291
291
|
# **postAddFanvilGroup**
|
|
292
|
-
>
|
|
292
|
+
> ProvisioningEntity postAddFanvilGroup()
|
|
293
293
|
|
|
294
294
|
Create a Fanvil provisioning group
|
|
295
295
|
|
|
@@ -321,7 +321,7 @@ const { status, data } = await apiInstance.postAddFanvilGroup(
|
|
|
321
321
|
|
|
322
322
|
### Return type
|
|
323
323
|
|
|
324
|
-
**
|
|
324
|
+
**ProvisioningEntity**
|
|
325
325
|
|
|
326
326
|
### Authorization
|
|
327
327
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ProvisioningEntity
|
|
2
2
|
|
|
3
3
|
Provisioning Group
|
|
4
4
|
|
|
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import {
|
|
18
|
+
import { ProvisioningEntity } from 'yellowgrid-api-ts';
|
|
19
19
|
|
|
20
|
-
const instance:
|
|
20
|
+
const instance: ProvisioningEntity = {
|
|
21
21
|
groupName,
|
|
22
22
|
provisioningUrl,
|
|
23
23
|
auth,
|
package/docs/ShipmentEntity.md
CHANGED
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**courierTracking** | **string** | courierTracking | [optional] [default to undefined]
|
|
16
16
|
**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
|
|
17
17
|
**scannedData** | **string** | mac | [optional] [default to undefined]
|
|
18
|
-
**
|
|
18
|
+
**date** | **string** | date | [optional] [default to undefined]
|
|
19
19
|
**requestDate** | **string** | requestDate | [optional] [default to undefined]
|
|
20
20
|
**provId** | **number** | provId | [optional] [default to undefined]
|
|
21
21
|
|
|
@@ -34,7 +34,7 @@ const instance: ShipmentEntity = {
|
|
|
34
34
|
courierTracking,
|
|
35
35
|
courierBoxes,
|
|
36
36
|
scannedData,
|
|
37
|
-
|
|
37
|
+
date,
|
|
38
38
|
requestDate,
|
|
39
39
|
provId,
|
|
40
40
|
};
|
|
@@ -692,7 +692,7 @@ No authorization required
|
|
|
692
692
|
[[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)
|
|
693
693
|
|
|
694
694
|
# **getGetStockSupplierProducts**
|
|
695
|
-
> Array<
|
|
695
|
+
> Array<ProductSummaryModel> getGetStockSupplierProducts()
|
|
696
696
|
|
|
697
697
|
Get Stock Supplier\'s Products
|
|
698
698
|
|
|
@@ -723,7 +723,7 @@ const { status, data } = await apiInstance.getGetStockSupplierProducts(
|
|
|
723
723
|
|
|
724
724
|
### Return type
|
|
725
725
|
|
|
726
|
-
**Array<
|
|
726
|
+
**Array<ProductSummaryModel>**
|
|
727
727
|
|
|
728
728
|
### Authorization
|
|
729
729
|
|
package/docs/TcxBackupModel.md
CHANGED
|
@@ -24,6 +24,7 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**licence** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
25
25
|
**extLength** | **number** | Extension Length | [optional] [default to undefined]
|
|
26
26
|
**phone** | **string** | 3CX Licence Phone | [optional] [default to undefined]
|
|
27
|
+
**companyName** | **string** | Company Name | [optional] [default to undefined]
|
|
27
28
|
|
|
28
29
|
## Example
|
|
29
30
|
|
|
@@ -49,6 +50,7 @@ const instance: TcxBackupModel = {
|
|
|
49
50
|
licence,
|
|
50
51
|
extLength,
|
|
51
52
|
phone,
|
|
53
|
+
companyName,
|
|
52
54
|
};
|
|
53
55
|
```
|
|
54
56
|
|
package/docs/TcxSbcModel.md
CHANGED
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,33 +0,0 @@
|
|
|
1
|
-
# AbstractOrderRequestDTO
|
|
2
|
-
|
|
3
|
-
Order Request
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
|
-
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
|
-
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { AbstractOrderRequestDTO } from 'yellowgrid-api-ts';
|
|
21
|
-
|
|
22
|
-
const instance: AbstractOrderRequestDTO = {
|
|
23
|
-
orderReference,
|
|
24
|
-
items,
|
|
25
|
-
shippingService,
|
|
26
|
-
provisioningUrl,
|
|
27
|
-
shippingAddress,
|
|
28
|
-
partShip,
|
|
29
|
-
quote,
|
|
30
|
-
};
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
[[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,35 +0,0 @@
|
|
|
1
|
-
# AccountDetailedSummaryDTO
|
|
2
|
-
|
|
3
|
-
Account Details
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
-
**xeroId** | **string** | Xero ID | [optional] [default to undefined]
|
|
11
|
-
**company** | **string** | Company | [optional] [default to undefined]
|
|
12
|
-
**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
|
|
13
|
-
**contacts** | [**Array<AccountContactModel>**](AccountContactModel.md) | Contacts | [optional] [default to undefined]
|
|
14
|
-
**billingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
15
|
-
**addresses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [optional] [default to undefined]
|
|
16
|
-
**provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [optional] [default to undefined]
|
|
17
|
-
|
|
18
|
-
## Example
|
|
19
|
-
|
|
20
|
-
```typescript
|
|
21
|
-
import { AccountDetailedSummaryDTO } from 'yellowgrid-api-ts';
|
|
22
|
-
|
|
23
|
-
const instance: AccountDetailedSummaryDTO = {
|
|
24
|
-
id,
|
|
25
|
-
xeroId,
|
|
26
|
-
company,
|
|
27
|
-
creditLimit,
|
|
28
|
-
contacts,
|
|
29
|
-
billingAddress,
|
|
30
|
-
addresses,
|
|
31
|
-
provisioningUrls,
|
|
32
|
-
};
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
[[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,37 +0,0 @@
|
|
|
1
|
-
# AdminItemRequestDTO
|
|
2
|
-
|
|
3
|
-
Admin Order Item Request
|
|
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
|
-
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
|
-
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
14
|
-
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
15
|
-
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
|
|
16
|
-
**title** | **string** | Title | [optional] [default to undefined]
|
|
17
|
-
**itemPrice** | **number** | Price (£) | [optional] [default to undefined]
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import { AdminItemRequestDTO } from 'yellowgrid-api-ts';
|
|
23
|
-
|
|
24
|
-
const instance: AdminItemRequestDTO = {
|
|
25
|
-
sku,
|
|
26
|
-
quantity,
|
|
27
|
-
id,
|
|
28
|
-
licenceKey,
|
|
29
|
-
hosting,
|
|
30
|
-
processDate,
|
|
31
|
-
sbcs,
|
|
32
|
-
title,
|
|
33
|
-
itemPrice,
|
|
34
|
-
};
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
[[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,41 +0,0 @@
|
|
|
1
|
-
# AdminOrderRequestDTO
|
|
2
|
-
|
|
3
|
-
Admin Order Request
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<AdminItemRequestDTO>**](AdminItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
|
-
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
|
-
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
|
-
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
17
|
-
**ignoreOnHold** | **boolean** | Ignore Customer On Hold | [optional] [default to false]
|
|
18
|
-
**ignoreCreditLimit** | **boolean** | Ignore Customer Credit Limit | [optional] [default to false]
|
|
19
|
-
**includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
|
|
20
|
-
|
|
21
|
-
## Example
|
|
22
|
-
|
|
23
|
-
```typescript
|
|
24
|
-
import { AdminOrderRequestDTO } from 'yellowgrid-api-ts';
|
|
25
|
-
|
|
26
|
-
const instance: AdminOrderRequestDTO = {
|
|
27
|
-
orderReference,
|
|
28
|
-
items,
|
|
29
|
-
shippingService,
|
|
30
|
-
provisioningUrl,
|
|
31
|
-
shippingAddress,
|
|
32
|
-
partShip,
|
|
33
|
-
quote,
|
|
34
|
-
customerId,
|
|
35
|
-
ignoreOnHold,
|
|
36
|
-
ignoreCreditLimit,
|
|
37
|
-
includeNfrPromos,
|
|
38
|
-
};
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
[[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/AdminUserModel.md
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# AdminUserModel
|
|
2
|
-
|
|
3
|
-
Admin User
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**firstName** | **string** | First Name | [optional] [default to undefined]
|
|
10
|
-
**lastName** | **string** | Last Name | [optional] [default to undefined]
|
|
11
|
-
**avatar** | **string** | Avatar | [optional] [default to undefined]
|
|
12
|
-
**role** | **number** | Role | [optional] [default to undefined]
|
|
13
|
-
**navigation** | [**Array<NavigationItemModel>**](NavigationItemModel.md) | Navigation | [optional] [default to undefined]
|
|
14
|
-
**email** | **string** | Email | [optional] [default to undefined]
|
|
15
|
-
|
|
16
|
-
## Example
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import { AdminUserModel } from 'yellowgrid-api-ts';
|
|
20
|
-
|
|
21
|
-
const instance: AdminUserModel = {
|
|
22
|
-
firstName,
|
|
23
|
-
lastName,
|
|
24
|
-
avatar,
|
|
25
|
-
role,
|
|
26
|
-
navigation,
|
|
27
|
-
email,
|
|
28
|
-
};
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
[[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/BasicItemDTO.md
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# BasicItemDTO
|
|
2
|
-
|
|
3
|
-
Basic Order Item
|
|
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
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { BasicItemDTO } from 'yellowgrid-api-ts';
|
|
16
|
-
|
|
17
|
-
const instance: BasicItemDTO = {
|
|
18
|
-
sku,
|
|
19
|
-
quantity,
|
|
20
|
-
};
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
[[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/BasicProductDTO.md
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# BasicProductDTO
|
|
2
|
-
|
|
3
|
-
Basic Product
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
10
|
-
**title** | **string** | Title | [optional] [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { BasicProductDTO } from 'yellowgrid-api-ts';
|
|
16
|
-
|
|
17
|
-
const instance: BasicProductDTO = {
|
|
18
|
-
sku,
|
|
19
|
-
title,
|
|
20
|
-
};
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
[[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,39 +0,0 @@
|
|
|
1
|
-
# CourierPriceEntity
|
|
2
|
-
|
|
3
|
-
CourierPricesEntity
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [optional] [default to undefined]
|
|
10
|
-
**courier** | **string** | courier | [optional] [default to undefined]
|
|
11
|
-
**destinationIso** | **string** | destinationIso | [optional] [default to undefined]
|
|
12
|
-
**serviceDescription** | **string** | serviceDescription | [optional] [default to undefined]
|
|
13
|
-
**flatRate** | **number** | flatRate | [optional] [default to undefined]
|
|
14
|
-
**initialBox** | **number** | initialBox | [optional] [default to undefined]
|
|
15
|
-
**initialKg** | **number** | initialKg | [optional] [default to undefined]
|
|
16
|
-
**perBox** | **number** | perBox | [optional] [default to undefined]
|
|
17
|
-
**perKg** | **number** | perKg | [optional] [default to undefined]
|
|
18
|
-
**maxKg** | **number** | maxKg | [optional] [default to undefined]
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { CourierPriceEntity } from 'yellowgrid-api-ts';
|
|
24
|
-
|
|
25
|
-
const instance: CourierPriceEntity = {
|
|
26
|
-
id,
|
|
27
|
-
courier,
|
|
28
|
-
destinationIso,
|
|
29
|
-
serviceDescription,
|
|
30
|
-
flatRate,
|
|
31
|
-
initialBox,
|
|
32
|
-
initialKg,
|
|
33
|
-
perBox,
|
|
34
|
-
perKg,
|
|
35
|
-
maxKg,
|
|
36
|
-
};
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
[[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,33 +0,0 @@
|
|
|
1
|
-
# CustomerItemRequestDTO
|
|
2
|
-
|
|
3
|
-
Order Item Request
|
|
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
|
-
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
|
-
**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
|
|
14
|
-
**processDate** | **string** | Date Time | [optional] [default to undefined]
|
|
15
|
-
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { CustomerItemRequestDTO } from 'yellowgrid-api-ts';
|
|
21
|
-
|
|
22
|
-
const instance: CustomerItemRequestDTO = {
|
|
23
|
-
sku,
|
|
24
|
-
quantity,
|
|
25
|
-
id,
|
|
26
|
-
licenceKey,
|
|
27
|
-
hosting,
|
|
28
|
-
processDate,
|
|
29
|
-
sbcs,
|
|
30
|
-
};
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
[[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,33 +0,0 @@
|
|
|
1
|
-
# CustomerOrderRequestDTO
|
|
2
|
-
|
|
3
|
-
Order Request
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
|
|
12
|
-
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
|
|
15
|
-
**quote** | **boolean** | Quote | [optional] [default to undefined]
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { CustomerOrderRequestDTO } from 'yellowgrid-api-ts';
|
|
21
|
-
|
|
22
|
-
const instance: CustomerOrderRequestDTO = {
|
|
23
|
-
orderReference,
|
|
24
|
-
items,
|
|
25
|
-
shippingService,
|
|
26
|
-
provisioningUrl,
|
|
27
|
-
shippingAddress,
|
|
28
|
-
partShip,
|
|
29
|
-
quote,
|
|
30
|
-
};
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
[[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,23 +0,0 @@
|
|
|
1
|
-
# LinkedOrderEntity
|
|
2
|
-
|
|
3
|
-
LinkedOrdersEntity
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**orderId** | **number** | orderId | [optional] [default to undefined]
|
|
10
|
-
**linkedOrderId** | **number** | linkedOrderId | [optional] [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { LinkedOrderEntity } from 'yellowgrid-api-ts';
|
|
16
|
-
|
|
17
|
-
const instance: LinkedOrderEntity = {
|
|
18
|
-
orderId,
|
|
19
|
-
linkedOrderId,
|
|
20
|
-
};
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
[[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,27 +0,0 @@
|
|
|
1
|
-
# NavigationItemModel
|
|
2
|
-
|
|
3
|
-
POPS Navigation Item
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [optional] [default to undefined]
|
|
10
|
-
**url** | **string** | URL | [optional] [default to undefined]
|
|
11
|
-
**icon** | **string** | Icon (Font Awesome) | [optional] [default to undefined]
|
|
12
|
-
**items** | [**Array<SubNavigationItemModel>**](SubNavigationItemModel.md) | Sub Navigation | [optional] [default to undefined]
|
|
13
|
-
|
|
14
|
-
## Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import { NavigationItemModel } from 'yellowgrid-api-ts';
|
|
18
|
-
|
|
19
|
-
const instance: NavigationItemModel = {
|
|
20
|
-
title,
|
|
21
|
-
url,
|
|
22
|
-
icon,
|
|
23
|
-
items,
|
|
24
|
-
};
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
[[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
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# ShippingApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://api.yellowgrid.local*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
|
|
8
|
-
|
|
9
|
-
# **postGetShippingServices**
|
|
10
|
-
> ShippingServicesModel postGetShippingServices()
|
|
11
|
-
|
|
12
|
-
Get Shipping Services
|
|
13
|
-
|
|
14
|
-
### Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import {
|
|
18
|
-
ShippingApi,
|
|
19
|
-
Configuration,
|
|
20
|
-
ShippingInformationDTO
|
|
21
|
-
} from 'yellowgrid-api-ts';
|
|
22
|
-
|
|
23
|
-
const configuration = new Configuration();
|
|
24
|
-
const apiInstance = new ShippingApi(configuration);
|
|
25
|
-
|
|
26
|
-
let shippingInformationDTO: ShippingInformationDTO; //Shipping Information (optional)
|
|
27
|
-
|
|
28
|
-
const { status, data } = await apiInstance.postGetShippingServices(
|
|
29
|
-
shippingInformationDTO
|
|
30
|
-
);
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### Parameters
|
|
34
|
-
|
|
35
|
-
|Name | Type | Description | Notes|
|
|
36
|
-
|------------- | ------------- | ------------- | -------------|
|
|
37
|
-
| **shippingInformationDTO** | **ShippingInformationDTO**| Shipping Information | |
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
### Return type
|
|
41
|
-
|
|
42
|
-
**ShippingServicesModel**
|
|
43
|
-
|
|
44
|
-
### Authorization
|
|
45
|
-
|
|
46
|
-
No authorization required
|
|
47
|
-
|
|
48
|
-
### HTTP request headers
|
|
49
|
-
|
|
50
|
-
- **Content-Type**: application/json
|
|
51
|
-
- **Accept**: application/json
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
### HTTP response details
|
|
55
|
-
| Status code | Description | Response headers |
|
|
56
|
-
|-------------|-------------|------------------|
|
|
57
|
-
|**200** | Shipping Services | - |
|
|
58
|
-
|**400** | Bad Request | - |
|
|
59
|
-
|**401** | Unauthorised | - |
|
|
60
|
-
|**403** | Access Denied | - |
|
|
61
|
-
|
|
62
|
-
[[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)
|
|
63
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# ShippingConsignmentModel
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**service** | [**ShippingServiceModel**](ShippingServiceModel.md) | | [optional] [default to undefined]
|
|
9
|
-
**id** | **string** | ID/Number | [optional] [default to undefined]
|
|
10
|
-
**trackingNumber** | **string** | Tracking Number | [optional] [default to undefined]
|
|
11
|
-
**parcelIds** | **Array<string>** | Parcels | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { ShippingConsignmentModel } from 'yellowgrid-api-ts';
|
|
17
|
-
|
|
18
|
-
const instance: ShippingConsignmentModel = {
|
|
19
|
-
service,
|
|
20
|
-
id,
|
|
21
|
-
trackingNumber,
|
|
22
|
-
parcelIds,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[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
|
-
# ShippingInformationDTO
|
|
2
|
-
|
|
3
|
-
Shipping Information
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [optional] [default to undefined]
|
|
10
|
-
**postalCode** | **string** | Destination Post Code | [optional] [default to undefined]
|
|
11
|
-
**iso** | **string** | Destination ISO | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { ShippingInformationDTO } from 'yellowgrid-api-ts';
|
|
17
|
-
|
|
18
|
-
const instance: ShippingInformationDTO = {
|
|
19
|
-
items,
|
|
20
|
-
postalCode,
|
|
21
|
-
iso,
|
|
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,23 +0,0 @@
|
|
|
1
|
-
# ShippingServiceDTO
|
|
2
|
-
|
|
3
|
-
Shipping Service
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**courier** | **string** | Courier | [optional] [default to undefined]
|
|
10
|
-
**serviceName** | **string** | Service Name | [optional] [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { ShippingServiceDTO } from 'yellowgrid-api-ts';
|
|
16
|
-
|
|
17
|
-
const instance: ShippingServiceDTO = {
|
|
18
|
-
courier,
|
|
19
|
-
serviceName,
|
|
20
|
-
};
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|