yellowgrid-api-ts 3.2.114-dev.0 → 3.2.116-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 +6 -1
- package/README.md +15 -1
- package/api.ts +769 -74
- package/dist/api.d.ts +430 -73
- package/dist/api.js +790 -25
- package/docs/AccountPageDetailsDTO.md +9 -3
- package/docs/AccountsApi.md +178 -1
- package/docs/AddressDTO.md +0 -2
- package/docs/Class3CXInstallationsApi.md +288 -4
- package/docs/InstallationDetailsDTO.md +39 -0
- package/docs/OrdersApi.md +58 -0
- package/docs/PatchUpdateAccountCompanyNumberRequest.md +20 -0
- package/docs/PatchUpdateAccountPhoneRequest.md +20 -0
- package/docs/PatchUpdateAccountVatNumberRequest.md +20 -0
- package/docs/ProductSummaryDTO.md +2 -0
- package/docs/RemoteStorageDTO.md +27 -0
- package/docs/TcxSbcDTO.md +2 -0
- package/docs/TcxSbcResponseDTO.md +23 -0
- package/package.json +1 -1
package/docs/OrdersApi.md
CHANGED
|
@@ -23,6 +23,7 @@ All URIs are relative to *https://localhost*
|
|
|
23
23
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
24
24
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
25
25
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
26
|
+
|[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
|
|
26
27
|
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
27
28
|
|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
|
|
28
29
|
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
@@ -1133,6 +1134,63 @@ No authorization required
|
|
|
1133
1134
|
|
|
1134
1135
|
[[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)
|
|
1135
1136
|
|
|
1137
|
+
# **postProcessTcxLicences**
|
|
1138
|
+
> OrderDetailsDTO postProcessTcxLicences()
|
|
1139
|
+
|
|
1140
|
+
Process 3CX Licences (Admin)
|
|
1141
|
+
|
|
1142
|
+
### Example
|
|
1143
|
+
|
|
1144
|
+
```typescript
|
|
1145
|
+
import {
|
|
1146
|
+
OrdersApi,
|
|
1147
|
+
Configuration
|
|
1148
|
+
} from 'yellowgrid-api-ts';
|
|
1149
|
+
|
|
1150
|
+
const configuration = new Configuration();
|
|
1151
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1152
|
+
|
|
1153
|
+
let id: number; //Order ID (default to undefined)
|
|
1154
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1155
|
+
|
|
1156
|
+
const { status, data } = await apiInstance.postProcessTcxLicences(
|
|
1157
|
+
id,
|
|
1158
|
+
batchId
|
|
1159
|
+
);
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1162
|
+
### Parameters
|
|
1163
|
+
|
|
1164
|
+
|Name | Type | Description | Notes|
|
|
1165
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1166
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1167
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
### Return type
|
|
1171
|
+
|
|
1172
|
+
**OrderDetailsDTO**
|
|
1173
|
+
|
|
1174
|
+
### Authorization
|
|
1175
|
+
|
|
1176
|
+
No authorization required
|
|
1177
|
+
|
|
1178
|
+
### HTTP request headers
|
|
1179
|
+
|
|
1180
|
+
- **Content-Type**: Not defined
|
|
1181
|
+
- **Accept**: application/json
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
### HTTP response details
|
|
1185
|
+
| Status code | Description | Response headers |
|
|
1186
|
+
|-------------|-------------|------------------|
|
|
1187
|
+
|**200** | Order Details | - |
|
|
1188
|
+
|**400** | Bad Request | - |
|
|
1189
|
+
|**401** | Unauthorised | - |
|
|
1190
|
+
|**403** | Access Denied | - |
|
|
1191
|
+
|
|
1192
|
+
[[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)
|
|
1193
|
+
|
|
1136
1194
|
# **postSendOrderEmail**
|
|
1137
1195
|
> postSendOrderEmail()
|
|
1138
1196
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchUpdateAccountCompanyNumberRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**companyNumber** | **string** | Company Number | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchUpdateAccountCompanyNumberRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchUpdateAccountCompanyNumberRequest = {
|
|
16
|
+
companyNumber,
|
|
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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchUpdateAccountPhoneRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**phone** | **string** | Phone | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchUpdateAccountPhoneRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchUpdateAccountPhoneRequest = {
|
|
16
|
+
phone,
|
|
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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchUpdateAccountVatNumberRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchUpdateAccountVatNumberRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchUpdateAccountVatNumberRequest = {
|
|
16
|
+
vatNumber,
|
|
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)
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
11
11
|
**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
|
|
12
12
|
**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
|
|
13
|
+
**dueDate** | **string** | Date Time | [optional] [default to undefined]
|
|
13
14
|
**price** | **number** | Price | [optional] [default to undefined]
|
|
14
15
|
**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
|
|
15
16
|
**rrp** | **number** | RRP Price | [optional] [default to undefined]
|
|
@@ -26,6 +27,7 @@ const instance: ProductSummaryDTO = {
|
|
|
26
27
|
title,
|
|
27
28
|
quantity,
|
|
28
29
|
stockProduct,
|
|
30
|
+
dueDate,
|
|
29
31
|
price,
|
|
30
32
|
cartonSize,
|
|
31
33
|
rrp,
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# RemoteStorageDTO
|
|
2
|
+
|
|
3
|
+
Remote Storage
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | AWS ID | [optional] [default to undefined]
|
|
10
|
+
**secret** | **string** | AWS Secret | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | AWS Bucket Name | [optional] [default to undefined]
|
|
12
|
+
**region** | **string** | AWS Region | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { RemoteStorageDTO } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: RemoteStorageDTO = {
|
|
20
|
+
id,
|
|
21
|
+
secret,
|
|
22
|
+
name,
|
|
23
|
+
region,
|
|
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/TcxSbcDTO.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**dns** | **string** | DNS | [optional] [default to undefined]
|
|
14
14
|
**tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
|
|
15
15
|
**tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
|
|
16
|
+
**configured** | **boolean** | 3CX SBC Configured | [optional] [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -27,6 +28,7 @@ const instance: TcxSbcDTO = {
|
|
|
27
28
|
dns,
|
|
28
29
|
tcxUrl,
|
|
29
30
|
tcxKey,
|
|
31
|
+
configured,
|
|
30
32
|
};
|
|
31
33
|
```
|
|
32
34
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TcxSbcResponseDTO
|
|
2
|
+
|
|
3
|
+
3CX SBC Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**status** | **string** | Status | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | Message | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { TcxSbcResponseDTO } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: TcxSbcResponseDTO = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
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)
|