yellowgrid-api-ts 3.0.110-dev.0 → 3.0.111
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 +195 -212
- package/README.md +7 -33
- package/api.ts +259 -1791
- 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 +150 -1304
- package/dist/api.js +208 -1060
- 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 -12
- package/docs/ItemEntity.md +0 -2
- 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 +43 -164
- 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/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 -39
- package/docs/AdminItemRequestDTO.md +0 -39
- package/docs/AdminOrderRequestDTO.md +0 -45
- package/docs/AdminUserModel.md +0 -29
- package/docs/BasicItemDTO.md +0 -23
- package/docs/BasicProductDTO.md +0 -23
- package/docs/CourierPriceEntity.md +0 -39
- package/docs/CustomerItemRequestDTO.md +0 -35
- package/docs/CustomerOrderRequestDTO.md +0 -33
- package/docs/LinkedOrderEntity.md +0 -23
- package/docs/PostGetProductForCustomerRequest.md +0 -24
- 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/TcxSbcDTO.md +0 -31
package/docs/ProductsApi.md
CHANGED
|
@@ -5,13 +5,11 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetAttributeSets**](#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets|
|
|
8
|
+
|[**getGetCustomerPriceLists**](#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists|
|
|
8
9
|
|[**getGetLegacyStockList**](#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing|
|
|
9
|
-
|[**getGetProducts**](#getgetproducts) | **GET** /products | Get Products|
|
|
10
|
+
|[**getGetProducts**](#getgetproducts) | **GET** /products/search | Get Products|
|
|
10
11
|
|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
|
|
11
12
|
|[**getGetTcxTemplates**](#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates|
|
|
12
|
-
|[**getSearchProducts**](#getsearchproducts) | **GET** /products/search | Search Products|
|
|
13
|
-
|[**postGetProduct**](#postgetproduct) | **POST** /products/{sku} | Get Product|
|
|
14
|
-
|[**postGetProductForCustomer**](#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer|
|
|
15
13
|
|
|
16
14
|
# **getGetAttributeSets**
|
|
17
15
|
> Array<AttributeSetEnum> getGetAttributeSets()
|
|
@@ -60,10 +58,10 @@ No authorization required
|
|
|
60
58
|
|
|
61
59
|
[[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)
|
|
62
60
|
|
|
63
|
-
# **
|
|
64
|
-
>
|
|
61
|
+
# **getGetCustomerPriceLists**
|
|
62
|
+
> Array<CustomerPriceListEnum> getGetCustomerPriceLists()
|
|
65
63
|
|
|
66
|
-
Get
|
|
64
|
+
Get Customer Price Lists
|
|
67
65
|
|
|
68
66
|
### Example
|
|
69
67
|
|
|
@@ -76,61 +74,7 @@ import {
|
|
|
76
74
|
const configuration = new Configuration();
|
|
77
75
|
const apiInstance = new ProductsApi(configuration);
|
|
78
76
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
const { status, data } = await apiInstance.getGetLegacyStockList(
|
|
82
|
-
format
|
|
83
|
-
);
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
### Parameters
|
|
87
|
-
|
|
88
|
-
|Name | Type | Description | Notes|
|
|
89
|
-
|------------- | ------------- | ------------- | -------------|
|
|
90
|
-
| **format** | [**'XML' | 'CSV'**]**Array<'XML' | 'CSV'>** | File Format | defaults to undefined|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
### Return type
|
|
94
|
-
|
|
95
|
-
**string**
|
|
96
|
-
|
|
97
|
-
### Authorization
|
|
98
|
-
|
|
99
|
-
No authorization required
|
|
100
|
-
|
|
101
|
-
### HTTP request headers
|
|
102
|
-
|
|
103
|
-
- **Content-Type**: Not defined
|
|
104
|
-
- **Accept**: text/csv, application/xml
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
### HTTP response details
|
|
108
|
-
| Status code | Description | Response headers |
|
|
109
|
-
|-------------|-------------|------------------|
|
|
110
|
-
|**200** | Products | - |
|
|
111
|
-
|**400** | Bad Request | - |
|
|
112
|
-
|**401** | Unauthorised | - |
|
|
113
|
-
|**403** | Access Denied | - |
|
|
114
|
-
|
|
115
|
-
[[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)
|
|
116
|
-
|
|
117
|
-
# **getGetProducts**
|
|
118
|
-
> Array<BasicProductDTO> getGetProducts()
|
|
119
|
-
|
|
120
|
-
Get Products
|
|
121
|
-
|
|
122
|
-
### Example
|
|
123
|
-
|
|
124
|
-
```typescript
|
|
125
|
-
import {
|
|
126
|
-
ProductsApi,
|
|
127
|
-
Configuration
|
|
128
|
-
} from 'yellowgrid-api-ts';
|
|
129
|
-
|
|
130
|
-
const configuration = new Configuration();
|
|
131
|
-
const apiInstance = new ProductsApi(configuration);
|
|
132
|
-
|
|
133
|
-
const { status, data } = await apiInstance.getGetProducts();
|
|
77
|
+
const { status, data } = await apiInstance.getGetCustomerPriceLists();
|
|
134
78
|
```
|
|
135
79
|
|
|
136
80
|
### Parameters
|
|
@@ -139,7 +83,7 @@ This endpoint does not have any parameters.
|
|
|
139
83
|
|
|
140
84
|
### Return type
|
|
141
85
|
|
|
142
|
-
**Array<
|
|
86
|
+
**Array<CustomerPriceListEnum>**
|
|
143
87
|
|
|
144
88
|
### Authorization
|
|
145
89
|
|
|
@@ -154,15 +98,15 @@ No authorization required
|
|
|
154
98
|
### HTTP response details
|
|
155
99
|
| Status code | Description | Response headers |
|
|
156
100
|
|-------------|-------------|------------------|
|
|
157
|
-
|**200** |
|
|
101
|
+
|**200** | Price Lists | - |
|
|
158
102
|
|**400** | Bad Request | - |
|
|
159
103
|
|**401** | Unauthorised | - |
|
|
160
104
|
|**403** | Access Denied | - |
|
|
161
105
|
|
|
162
106
|
[[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)
|
|
163
107
|
|
|
164
|
-
# **
|
|
165
|
-
>
|
|
108
|
+
# **getGetLegacyStockList**
|
|
109
|
+
> string getGetLegacyStockList()
|
|
166
110
|
|
|
167
111
|
Get Current Stock & Pricing
|
|
168
112
|
|
|
@@ -177,63 +121,23 @@ import {
|
|
|
177
121
|
const configuration = new Configuration();
|
|
178
122
|
const apiInstance = new ProductsApi(configuration);
|
|
179
123
|
|
|
180
|
-
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
### Parameters
|
|
184
|
-
This endpoint does not have any parameters.
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
### Return type
|
|
188
|
-
|
|
189
|
-
**Array<PriceListItemModel>**
|
|
190
|
-
|
|
191
|
-
### Authorization
|
|
192
|
-
|
|
193
|
-
No authorization required
|
|
194
|
-
|
|
195
|
-
### HTTP request headers
|
|
196
|
-
|
|
197
|
-
- **Content-Type**: Not defined
|
|
198
|
-
- **Accept**: application/json
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
### HTTP response details
|
|
202
|
-
| Status code | Description | Response headers |
|
|
203
|
-
|-------------|-------------|------------------|
|
|
204
|
-
|**200** | Products | - |
|
|
205
|
-
|**400** | Bad Request | - |
|
|
206
|
-
|**401** | Unauthorised | - |
|
|
207
|
-
|**403** | Access Denied | - |
|
|
208
|
-
|
|
209
|
-
[[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)
|
|
210
|
-
|
|
211
|
-
# **getGetTcxTemplates**
|
|
212
|
-
> Array<TcxTemplateXmlEnum> getGetTcxTemplates()
|
|
213
|
-
|
|
214
|
-
Get 3CX Templates
|
|
215
|
-
|
|
216
|
-
### Example
|
|
217
|
-
|
|
218
|
-
```typescript
|
|
219
|
-
import {
|
|
220
|
-
ProductsApi,
|
|
221
|
-
Configuration
|
|
222
|
-
} from 'yellowgrid-api-ts';
|
|
223
|
-
|
|
224
|
-
const configuration = new Configuration();
|
|
225
|
-
const apiInstance = new ProductsApi(configuration);
|
|
124
|
+
let format: 'XML' | 'CSV'; //File Format (default to undefined)
|
|
226
125
|
|
|
227
|
-
const { status, data } = await apiInstance.
|
|
126
|
+
const { status, data } = await apiInstance.getGetLegacyStockList(
|
|
127
|
+
format
|
|
128
|
+
);
|
|
228
129
|
```
|
|
229
130
|
|
|
230
131
|
### Parameters
|
|
231
|
-
|
|
132
|
+
|
|
133
|
+
|Name | Type | Description | Notes|
|
|
134
|
+
|------------- | ------------- | ------------- | -------------|
|
|
135
|
+
| **format** | [**'XML' | 'CSV'**]**Array<'XML' | 'CSV'>** | File Format | defaults to undefined|
|
|
232
136
|
|
|
233
137
|
|
|
234
138
|
### Return type
|
|
235
139
|
|
|
236
|
-
**
|
|
140
|
+
**string**
|
|
237
141
|
|
|
238
142
|
### Authorization
|
|
239
143
|
|
|
@@ -242,23 +146,23 @@ No authorization required
|
|
|
242
146
|
### HTTP request headers
|
|
243
147
|
|
|
244
148
|
- **Content-Type**: Not defined
|
|
245
|
-
- **Accept**: application/
|
|
149
|
+
- **Accept**: text/csv, application/xml
|
|
246
150
|
|
|
247
151
|
|
|
248
152
|
### HTTP response details
|
|
249
153
|
| Status code | Description | Response headers |
|
|
250
154
|
|-------------|-------------|------------------|
|
|
251
|
-
|**200** |
|
|
155
|
+
|**200** | Products | - |
|
|
252
156
|
|**400** | Bad Request | - |
|
|
253
157
|
|**401** | Unauthorised | - |
|
|
254
158
|
|**403** | Access Denied | - |
|
|
255
159
|
|
|
256
160
|
[[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)
|
|
257
161
|
|
|
258
|
-
# **
|
|
259
|
-
> ProductSearchResultsModel
|
|
162
|
+
# **getGetProducts**
|
|
163
|
+
> ProductSearchResultsModel getGetProducts()
|
|
260
164
|
|
|
261
|
-
|
|
165
|
+
Get Products
|
|
262
166
|
|
|
263
167
|
### Example
|
|
264
168
|
|
|
@@ -275,7 +179,7 @@ let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
|
275
179
|
let page: number; //Page Number (optional) (default to 1)
|
|
276
180
|
let search: string; //Search (optional) (default to undefined)
|
|
277
181
|
|
|
278
|
-
const { status, data } = await apiInstance.
|
|
182
|
+
const { status, data } = await apiInstance.getGetProducts(
|
|
279
183
|
pageSize,
|
|
280
184
|
page,
|
|
281
185
|
search
|
|
@@ -315,43 +219,32 @@ No authorization required
|
|
|
315
219
|
|
|
316
220
|
[[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)
|
|
317
221
|
|
|
318
|
-
# **
|
|
319
|
-
>
|
|
222
|
+
# **getGetStockList**
|
|
223
|
+
> Array<PriceListItemModel> getGetStockList()
|
|
320
224
|
|
|
321
|
-
Get
|
|
225
|
+
Get Current Stock & Pricing
|
|
322
226
|
|
|
323
227
|
### Example
|
|
324
228
|
|
|
325
229
|
```typescript
|
|
326
230
|
import {
|
|
327
231
|
ProductsApi,
|
|
328
|
-
Configuration
|
|
329
|
-
PostGetProductForCustomerRequest
|
|
232
|
+
Configuration
|
|
330
233
|
} from 'yellowgrid-api-ts';
|
|
331
234
|
|
|
332
235
|
const configuration = new Configuration();
|
|
333
236
|
const apiInstance = new ProductsApi(configuration);
|
|
334
237
|
|
|
335
|
-
|
|
336
|
-
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
337
|
-
|
|
338
|
-
const { status, data } = await apiInstance.postGetProduct(
|
|
339
|
-
sku,
|
|
340
|
-
postGetProductForCustomerRequest
|
|
341
|
-
);
|
|
238
|
+
const { status, data } = await apiInstance.getGetStockList();
|
|
342
239
|
```
|
|
343
240
|
|
|
344
241
|
### Parameters
|
|
345
|
-
|
|
346
|
-
|Name | Type | Description | Notes|
|
|
347
|
-
|------------- | ------------- | ------------- | -------------|
|
|
348
|
-
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
349
|
-
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
242
|
+
This endpoint does not have any parameters.
|
|
350
243
|
|
|
351
244
|
|
|
352
245
|
### Return type
|
|
353
246
|
|
|
354
|
-
**
|
|
247
|
+
**Array<PriceListItemModel>**
|
|
355
248
|
|
|
356
249
|
### Authorization
|
|
357
250
|
|
|
@@ -359,60 +252,46 @@ No authorization required
|
|
|
359
252
|
|
|
360
253
|
### HTTP request headers
|
|
361
254
|
|
|
362
|
-
- **Content-Type**:
|
|
255
|
+
- **Content-Type**: Not defined
|
|
363
256
|
- **Accept**: application/json
|
|
364
257
|
|
|
365
258
|
|
|
366
259
|
### HTTP response details
|
|
367
260
|
| Status code | Description | Response headers |
|
|
368
261
|
|-------------|-------------|------------------|
|
|
369
|
-
|**200** |
|
|
262
|
+
|**200** | Products | - |
|
|
370
263
|
|**400** | Bad Request | - |
|
|
371
264
|
|**401** | Unauthorised | - |
|
|
372
265
|
|**403** | Access Denied | - |
|
|
373
266
|
|
|
374
267
|
[[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)
|
|
375
268
|
|
|
376
|
-
# **
|
|
377
|
-
>
|
|
269
|
+
# **getGetTcxTemplates**
|
|
270
|
+
> Array<TcxTemplateXmlEnum> getGetTcxTemplates()
|
|
378
271
|
|
|
379
|
-
Get
|
|
272
|
+
Get 3CX Templates
|
|
380
273
|
|
|
381
274
|
### Example
|
|
382
275
|
|
|
383
276
|
```typescript
|
|
384
277
|
import {
|
|
385
278
|
ProductsApi,
|
|
386
|
-
Configuration
|
|
387
|
-
PostGetProductForCustomerRequest
|
|
279
|
+
Configuration
|
|
388
280
|
} from 'yellowgrid-api-ts';
|
|
389
281
|
|
|
390
282
|
const configuration = new Configuration();
|
|
391
283
|
const apiInstance = new ProductsApi(configuration);
|
|
392
284
|
|
|
393
|
-
|
|
394
|
-
let sku: string; //Product SKU (default to undefined)
|
|
395
|
-
let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
|
|
396
|
-
|
|
397
|
-
const { status, data } = await apiInstance.postGetProductForCustomer(
|
|
398
|
-
customerId,
|
|
399
|
-
sku,
|
|
400
|
-
postGetProductForCustomerRequest
|
|
401
|
-
);
|
|
285
|
+
const { status, data } = await apiInstance.getGetTcxTemplates();
|
|
402
286
|
```
|
|
403
287
|
|
|
404
288
|
### Parameters
|
|
405
|
-
|
|
406
|
-
|Name | Type | Description | Notes|
|
|
407
|
-
|------------- | ------------- | ------------- | -------------|
|
|
408
|
-
| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
|
|
409
|
-
| **customerId** | [**number**] | Customer ID | defaults to undefined|
|
|
410
|
-
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
289
|
+
This endpoint does not have any parameters.
|
|
411
290
|
|
|
412
291
|
|
|
413
292
|
### Return type
|
|
414
293
|
|
|
415
|
-
**
|
|
294
|
+
**Array<TcxTemplateXmlEnum>**
|
|
416
295
|
|
|
417
296
|
### Authorization
|
|
418
297
|
|
|
@@ -420,14 +299,14 @@ No authorization required
|
|
|
420
299
|
|
|
421
300
|
### HTTP request headers
|
|
422
301
|
|
|
423
|
-
- **Content-Type**:
|
|
302
|
+
- **Content-Type**: Not defined
|
|
424
303
|
- **Accept**: application/json
|
|
425
304
|
|
|
426
305
|
|
|
427
306
|
### HTTP response details
|
|
428
307
|
| Status code | Description | Response headers |
|
|
429
308
|
|-------------|-------------|------------------|
|
|
430
|
-
|**200** |
|
|
309
|
+
|**200** | 3CX Templates | - |
|
|
431
310
|
|**400** | Bad Request | - |
|
|
432
311
|
|**401** | Unauthorised | - |
|
|
433
312
|
|**403** | Access Denied | - |
|
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/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,39 +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
|
-
**onHold** | **boolean** | On Hold | [optional] [default to undefined]
|
|
18
|
-
**balance** | **number** | Balance (£) | [optional] [default to undefined]
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { AccountDetailedSummaryDTO } from 'yellowgrid-api-ts';
|
|
24
|
-
|
|
25
|
-
const instance: AccountDetailedSummaryDTO = {
|
|
26
|
-
id,
|
|
27
|
-
xeroId,
|
|
28
|
-
company,
|
|
29
|
-
creditLimit,
|
|
30
|
-
contacts,
|
|
31
|
-
billingAddress,
|
|
32
|
-
addresses,
|
|
33
|
-
provisioningUrls,
|
|
34
|
-
onHold,
|
|
35
|
-
balance,
|
|
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,39 +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
|
-
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
16
|
-
**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
|
|
17
|
-
**title** | **string** | Title | [optional] [default to undefined]
|
|
18
|
-
**itemPrice** | **number** | Price (£) | [optional] [default to undefined]
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { AdminItemRequestDTO } from 'yellowgrid-api-ts';
|
|
24
|
-
|
|
25
|
-
const instance: AdminItemRequestDTO = {
|
|
26
|
-
sku,
|
|
27
|
-
quantity,
|
|
28
|
-
id,
|
|
29
|
-
licenceKey,
|
|
30
|
-
hosting,
|
|
31
|
-
processDate,
|
|
32
|
-
tcxSalesCode,
|
|
33
|
-
sbcs,
|
|
34
|
-
title,
|
|
35
|
-
itemPrice,
|
|
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,45 +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
|
-
**contact** | **string** | Contact | [optional] [default to undefined]
|
|
18
|
-
**ignoreOnHold** | **boolean** | Ignore Customer On Hold | [optional] [default to false]
|
|
19
|
-
**ignoreCreditLimit** | **boolean** | Ignore Customer Credit Limit | [optional] [default to false]
|
|
20
|
-
**includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
|
|
21
|
-
**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
|
|
22
|
-
|
|
23
|
-
## Example
|
|
24
|
-
|
|
25
|
-
```typescript
|
|
26
|
-
import { AdminOrderRequestDTO } from 'yellowgrid-api-ts';
|
|
27
|
-
|
|
28
|
-
const instance: AdminOrderRequestDTO = {
|
|
29
|
-
orderReference,
|
|
30
|
-
items,
|
|
31
|
-
shippingService,
|
|
32
|
-
provisioningUrl,
|
|
33
|
-
shippingAddress,
|
|
34
|
-
partShip,
|
|
35
|
-
quote,
|
|
36
|
-
customerId,
|
|
37
|
-
contact,
|
|
38
|
-
ignoreOnHold,
|
|
39
|
-
ignoreCreditLimit,
|
|
40
|
-
includeNfrPromos,
|
|
41
|
-
carriageCharge,
|
|
42
|
-
};
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
[[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,29 +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
|
-
**email** | **string** | Email | [optional] [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { AdminUserModel } from 'yellowgrid-api-ts';
|
|
19
|
-
|
|
20
|
-
const instance: AdminUserModel = {
|
|
21
|
-
firstName,
|
|
22
|
-
lastName,
|
|
23
|
-
avatar,
|
|
24
|
-
role,
|
|
25
|
-
email,
|
|
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)
|