yellowgrid-api-ts 3.2.62 → 3.2.64-dev.0
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 +249 -235
- package/.openapi-generator/VERSION +1 -1
- package/README.md +37 -21
- package/api.ts +6603 -1902
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +3 -3
- package/configuration.ts +19 -25
- package/dist/api.d.ts +5481 -849
- package/dist/api.js +2041 -1698
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/CourierEnum.d.ts +18 -0
- package/dist/models/CourierEnum.js +20 -0
- package/dist/models/PrinterEnum.d.ts +18 -0
- package/dist/models/PrinterEnum.js +20 -0
- package/docs/AccountsApi.md +1 -1
- package/docs/BatchDTO.md +59 -0
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -56
- package/docs/CreditNoteDTO.md +21 -0
- package/docs/CreditNoteEntity.md +29 -0
- package/docs/CreditNoteItemDTO.md +25 -0
- package/docs/CreditNoteItemEntity.md +29 -0
- package/docs/CreditNoteModel.md +29 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/OAuth20Api.md +4 -4
- package/docs/OrderDetailsDTO.md +63 -0
- package/docs/OrderItemDTO.md +53 -0
- package/docs/OrderedItemModel.md +47 -0
- package/docs/OrdersApi.md +856 -22
- package/docs/PostAddOrderNoteRequest.md +20 -0
- package/docs/PostSplitOrderRequest.md +20 -0
- package/docs/PricingApi.md +1 -1
- package/docs/PrinterEntity.md +29 -0
- package/docs/ProductsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/PutAllocateItemsRequest.md +20 -0
- package/docs/PutAllocateItemsRequestItemsInner.md +22 -0
- package/docs/SIPTrunksApi.md +1 -56
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentDTO.md +31 -0
- package/docs/ShipmentItemDTO.md +23 -0
- package/docs/ShipmentItemModel.md +29 -0
- package/docs/ShipmentModel.md +43 -0
- package/docs/ShipmentRequestDTO.md +31 -0
- package/docs/ShippingApi.md +1 -1
- package/docs/ShippingRequestDTO.md +24 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/SupplierModel.md +37 -0
- package/docs/SystemApi.md +1 -1
- package/docs/{SupportTicketModel.md → TelephonySupportTicketModel.md} +3 -3
- package/docs/TicketsApi.md +9 -9
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/hs_err_pid58424.log +247 -0
- package/index.ts +1 -1
- package/models/CourierEnum.ts +19 -0
- package/models/PrinterEnum.ts +19 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/dist/models/EventStatusEnum.d.ts +0 -18
- package/dist/models/EventStatusEnum.js +0 -20
- package/dist/models/PortStatusEnum.d.ts +0 -18
- package/dist/models/PortStatusEnum.js +0 -20
- package/docs/NumberPortDTO.md +0 -55
- package/docs/NumberPortModel.md +0 -51
- package/docs/NumberPortRangeDTO.md +0 -33
- package/docs/NumberPortRangeRequestDTO.md +0 -27
- package/docs/NumberPortingApi.md +0 -668
- package/docs/NumberPortsModel.md +0 -27
- package/models/EventStatusEnum.ts +0 -19
- package/models/PortStatusEnum.ts +0 -19
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
# Class3CXMultiTenantApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.yellowgrid.local*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**deleteGetTenant**](#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant|
|
|
8
|
-
|[**getGetAdminTenants**](#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants|
|
|
9
8
|
|[**getGetTenant**](#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant|
|
|
10
9
|
|[**getGetTenants**](#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants|
|
|
11
10
|
|[**postAddMtDdi**](#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI|
|
|
@@ -67,60 +66,6 @@ No authorization required
|
|
|
67
66
|
|
|
68
67
|
[[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)
|
|
69
68
|
|
|
70
|
-
# **getGetAdminTenants**
|
|
71
|
-
> Array<TcxMultiTenantModel> getGetAdminTenants()
|
|
72
|
-
|
|
73
|
-
Get 3CX Starter Bundle Tenants
|
|
74
|
-
|
|
75
|
-
### Example
|
|
76
|
-
|
|
77
|
-
```typescript
|
|
78
|
-
import {
|
|
79
|
-
Class3CXMultiTenantApi,
|
|
80
|
-
Configuration
|
|
81
|
-
} from 'yellowgrid-api-ts';
|
|
82
|
-
|
|
83
|
-
const configuration = new Configuration();
|
|
84
|
-
const apiInstance = new Class3CXMultiTenantApi(configuration);
|
|
85
|
-
|
|
86
|
-
let customerId: number; // (default to undefined)
|
|
87
|
-
|
|
88
|
-
const { status, data } = await apiInstance.getGetAdminTenants(
|
|
89
|
-
customerId
|
|
90
|
-
);
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
### Parameters
|
|
94
|
-
|
|
95
|
-
|Name | Type | Description | Notes|
|
|
96
|
-
|------------- | ------------- | ------------- | -------------|
|
|
97
|
-
| **customerId** | [**number**] | | defaults to undefined|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
### Return type
|
|
101
|
-
|
|
102
|
-
**Array<TcxMultiTenantModel>**
|
|
103
|
-
|
|
104
|
-
### Authorization
|
|
105
|
-
|
|
106
|
-
No authorization required
|
|
107
|
-
|
|
108
|
-
### HTTP request headers
|
|
109
|
-
|
|
110
|
-
- **Content-Type**: Not defined
|
|
111
|
-
- **Accept**: application/json
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
### HTTP response details
|
|
115
|
-
| Status code | Description | Response headers |
|
|
116
|
-
|-------------|-------------|------------------|
|
|
117
|
-
|**200** | 3CX Starter Bundle Tenant | - |
|
|
118
|
-
|**400** | Bad Request | - |
|
|
119
|
-
|**401** | Unauthorised | - |
|
|
120
|
-
|**403** | Access Denied | - |
|
|
121
|
-
|
|
122
|
-
[[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)
|
|
123
|
-
|
|
124
69
|
# **getGetTenant**
|
|
125
70
|
> TcxMultiTenantModel getGetTenant()
|
|
126
71
|
|
|
@@ -0,0 +1,21 @@
|
|
|
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)
|
|
@@ -0,0 +1,29 @@
|
|
|
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)
|
|
@@ -0,0 +1,25 @@
|
|
|
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)
|
|
@@ -0,0 +1,29 @@
|
|
|
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)
|
|
@@ -0,0 +1,29 @@
|
|
|
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/MyPBXToolsApi.md
CHANGED
package/docs/OAuth20Api.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OAuth20Api
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.yellowgrid.local*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
157
157
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
|
|
158
158
|
| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
|
|
159
159
|
| **grantType** | [**string**]**Array<'client_credentials' | 'code' | 'refresh_token' | 'authorization_code' | 'ms_auth' | 'token_exchange' | 'password'>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
|
|
160
|
-
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | '
|
|
160
|
+
| **scope** | [**string**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | (optional) defaults to undefined|
|
|
161
161
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
162
162
|
| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
|
|
163
163
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
|
|
|
210
210
|
|
|
211
211
|
let clientId: string; //OAuth 2.0 Client ID (default to undefined)
|
|
212
212
|
let responseType: string; //OAuth 2.0 Response Type (default to 'code')
|
|
213
|
-
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | '
|
|
213
|
+
let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
|
|
214
214
|
let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
|
|
215
215
|
let state: string; //OAuth 2.0 State (optional) (default to undefined)
|
|
216
216
|
let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
|
|
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
|
|
|
233
233
|
|------------- | ------------- | ------------- | -------------|
|
|
234
234
|
| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
|
|
235
235
|
| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
|
|
236
|
-
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | '
|
|
236
|
+
| **scope** | [**'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'**]**Array<'*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'>** | OAuth 2.0 Scope | defaults to undefined|
|
|
237
237
|
| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
|
|
238
238
|
| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
|
|
239
239
|
| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
|
|
@@ -0,0 +1,63 @@
|
|
|
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)
|
|
@@ -0,0 +1,53 @@
|
|
|
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)
|
|
@@ -0,0 +1,47 @@
|
|
|
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)
|