yellowgrid-api-ts 3.1.4-dev.0 → 3.1.4

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.
Files changed (57) hide show
  1. package/.openapi-generator/FILES +195 -213
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +7 -33
  4. package/api.ts +254 -1792
  5. package/base.ts +1 -1
  6. package/common.ts +5 -5
  7. package/config.json +3 -3
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +150 -1310
  10. package/dist/api.js +208 -1060
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +1 -1
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +1 -1
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/docs/AccountsApi.md +0 -103
  20. package/docs/AddressModel.md +0 -2
  21. package/docs/Class3CXApi.md +55 -0
  22. package/docs/ClientDetailsModel.md +2 -0
  23. package/docs/{ShippingServicesModel.md → GetGetPasswordHash200Response.md} +5 -5
  24. package/docs/ItemDTO.md +4 -12
  25. package/docs/ItemEntity.md +0 -2
  26. package/docs/OrderSummaryDTO.md +0 -8
  27. package/docs/OrderTotalModel.md +0 -2
  28. package/docs/OrdersApi.md +4 -301
  29. package/docs/ProductSearchResultsModel.md +1 -1
  30. package/docs/{ProductSummaryDTO.md → ProductSummaryModel.md} +3 -5
  31. package/docs/ProductsApi.md +43 -164
  32. package/docs/ProvisioningApi.md +4 -4
  33. package/docs/{ProvisioningModel.md → ProvisioningEntity.md} +3 -3
  34. package/docs/ShipmentEntity.md +2 -2
  35. package/docs/StockManagementApi.md +2 -2
  36. package/docs/TcxSbcModel.md +1 -1
  37. package/index.ts +1 -1
  38. package/openapitools.json +1 -1
  39. package/package.json +1 -1
  40. package/docs/AbstractOrderRequestDTO.md +0 -33
  41. package/docs/AccountDetailedSummaryDTO.md +0 -39
  42. package/docs/AdminItemRequestDTO.md +0 -39
  43. package/docs/AdminOrderRequestDTO.md +0 -45
  44. package/docs/AdminUserModel.md +0 -29
  45. package/docs/BasicItemDTO.md +0 -23
  46. package/docs/BasicProductDTO.md +0 -23
  47. package/docs/CourierPriceEntity.md +0 -39
  48. package/docs/CustomerItemRequestDTO.md +0 -35
  49. package/docs/CustomerOrderRequestDTO.md +0 -33
  50. package/docs/LinkedOrderEntity.md +0 -23
  51. package/docs/PostGetProductForCustomerRequest.md +0 -24
  52. package/docs/ShippingApi.md +0 -63
  53. package/docs/ShippingConsignmentModel.md +0 -26
  54. package/docs/ShippingInformationDTO.md +0 -25
  55. package/docs/ShippingServiceDTO.md +0 -23
  56. package/docs/ShippingServiceModel.md +0 -31
  57. package/docs/TcxSbcDTO.md +0 -31
package/docs/OrdersApi.md CHANGED
@@ -4,16 +4,11 @@ All URIs are relative to *http://api.yellowgrid.local*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders|
8
- |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | |
7
+ |[**deleteDeleteOrder**](#deletedeleteorder) | **DELETE** /orders/{id} | |
9
8
  |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders|
10
- |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
11
- |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order|
12
- |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
13
- |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order|
14
9
 
15
- # **deleteUpdateOrder**
16
- > deleteUpdateOrder()
10
+ # **deleteDeleteOrder**
11
+ > deleteDeleteOrder()
17
12
 
18
13
  Delete Orders
19
14
 
@@ -30,7 +25,7 @@ const apiInstance = new OrdersApi(configuration);
30
25
 
31
26
  let id: number; //Order ID (default to undefined)
32
27
 
33
- const { status, data } = await apiInstance.deleteUpdateOrder(
28
+ const { status, data } = await apiInstance.deleteDeleteOrder(
34
29
  id
35
30
  );
36
31
  ```
@@ -66,60 +61,6 @@ No authorization required
66
61
 
67
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)
68
63
 
69
- # **getGetEditableOrder**
70
- > OrderSummaryDTO getGetEditableOrder()
71
-
72
- Get Editable Order
73
-
74
- ### Example
75
-
76
- ```typescript
77
- import {
78
- OrdersApi,
79
- Configuration
80
- } from 'yellowgrid-api-ts';
81
-
82
- const configuration = new Configuration();
83
- const apiInstance = new OrdersApi(configuration);
84
-
85
- let id: number; //Order ID (default to undefined)
86
-
87
- const { status, data } = await apiInstance.getGetEditableOrder(
88
- id
89
- );
90
- ```
91
-
92
- ### Parameters
93
-
94
- |Name | Type | Description | Notes|
95
- |------------- | ------------- | ------------- | -------------|
96
- | **id** | [**number**] | Order ID | defaults to undefined|
97
-
98
-
99
- ### Return type
100
-
101
- **OrderSummaryDTO**
102
-
103
- ### Authorization
104
-
105
- No authorization required
106
-
107
- ### HTTP request headers
108
-
109
- - **Content-Type**: Not defined
110
- - **Accept**: application/json
111
-
112
-
113
- ### HTTP response details
114
- | Status code | Description | Response headers |
115
- |-------------|-------------|------------------|
116
- |**200** | Order Summary | - |
117
- |**400** | Bad Request | - |
118
- |**401** | Unauthorised | - |
119
- |**403** | Access Denied | - |
120
-
121
- [[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)
122
-
123
64
  # **getGetOrders**
124
65
  > OrderSummariesModel getGetOrders()
125
66
 
@@ -192,241 +133,3 @@ No authorization required
192
133
 
193
134
  [[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)
194
135
 
195
- # **postCreateAdminOrder**
196
- > Array<OrderSummaryDTO> postCreateAdminOrder()
197
-
198
- Create An Order (Admin)
199
-
200
- ### Example
201
-
202
- ```typescript
203
- import {
204
- OrdersApi,
205
- Configuration,
206
- AdminOrderRequestDTO
207
- } from 'yellowgrid-api-ts';
208
-
209
- const configuration = new Configuration();
210
- const apiInstance = new OrdersApi(configuration);
211
-
212
- let readonly: boolean; //Readonly Order (optional) (default to undefined)
213
- let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
214
-
215
- const { status, data } = await apiInstance.postCreateAdminOrder(
216
- readonly,
217
- adminOrderRequestDTO
218
- );
219
- ```
220
-
221
- ### Parameters
222
-
223
- |Name | Type | Description | Notes|
224
- |------------- | ------------- | ------------- | -------------|
225
- | **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
226
- | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
227
-
228
-
229
- ### Return type
230
-
231
- **Array<OrderSummaryDTO>**
232
-
233
- ### Authorization
234
-
235
- No authorization required
236
-
237
- ### HTTP request headers
238
-
239
- - **Content-Type**: application/json
240
- - **Accept**: application/json
241
-
242
-
243
- ### HTTP response details
244
- | Status code | Description | Response headers |
245
- |-------------|-------------|------------------|
246
- |**200** | Order Summaries | - |
247
- |**400** | Bad Request | - |
248
- |**401** | Unauthorised | - |
249
- |**403** | Access Denied | - |
250
-
251
- [[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)
252
-
253
- # **postGetOrders**
254
- > Array<OrderSummaryDTO> postGetOrders()
255
-
256
- Create An Order
257
-
258
- ### Example
259
-
260
- ```typescript
261
- import {
262
- OrdersApi,
263
- Configuration,
264
- CustomerOrderRequestDTO
265
- } from 'yellowgrid-api-ts';
266
-
267
- const configuration = new Configuration();
268
- const apiInstance = new OrdersApi(configuration);
269
-
270
- let readonly: boolean; //Readonly Order (optional) (default to undefined)
271
- let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
272
-
273
- const { status, data } = await apiInstance.postGetOrders(
274
- readonly,
275
- customerOrderRequestDTO
276
- );
277
- ```
278
-
279
- ### Parameters
280
-
281
- |Name | Type | Description | Notes|
282
- |------------- | ------------- | ------------- | -------------|
283
- | **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
284
- | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
285
-
286
-
287
- ### Return type
288
-
289
- **Array<OrderSummaryDTO>**
290
-
291
- ### Authorization
292
-
293
- No authorization required
294
-
295
- ### HTTP request headers
296
-
297
- - **Content-Type**: application/json
298
- - **Accept**: application/json
299
-
300
-
301
- ### HTTP response details
302
- | Status code | Description | Response headers |
303
- |-------------|-------------|------------------|
304
- |**200** | Order Summaries | - |
305
- |**400** | Bad Request | - |
306
- |**401** | Unauthorised | - |
307
- |**403** | Access Denied | - |
308
-
309
- [[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)
310
-
311
- # **putUpdateAdminOrder**
312
- > Array<OrderSummaryDTO> putUpdateAdminOrder()
313
-
314
- Update An Order (Admin)
315
-
316
- ### Example
317
-
318
- ```typescript
319
- import {
320
- OrdersApi,
321
- Configuration,
322
- AdminOrderRequestDTO
323
- } from 'yellowgrid-api-ts';
324
-
325
- const configuration = new Configuration();
326
- const apiInstance = new OrdersApi(configuration);
327
-
328
- let id: number; //Order ID (default to undefined)
329
- let readonly: boolean; //Readonly Order (optional) (default to undefined)
330
- let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
331
-
332
- const { status, data } = await apiInstance.putUpdateAdminOrder(
333
- id,
334
- readonly,
335
- adminOrderRequestDTO
336
- );
337
- ```
338
-
339
- ### Parameters
340
-
341
- |Name | Type | Description | Notes|
342
- |------------- | ------------- | ------------- | -------------|
343
- | **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
344
- | **id** | [**number**] | Order ID | defaults to undefined|
345
- | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
346
-
347
-
348
- ### Return type
349
-
350
- **Array<OrderSummaryDTO>**
351
-
352
- ### Authorization
353
-
354
- No authorization required
355
-
356
- ### HTTP request headers
357
-
358
- - **Content-Type**: application/json
359
- - **Accept**: application/json
360
-
361
-
362
- ### HTTP response details
363
- | Status code | Description | Response headers |
364
- |-------------|-------------|------------------|
365
- |**200** | Order Summaries | - |
366
- |**400** | Bad Request | - |
367
- |**401** | Unauthorised | - |
368
- |**403** | Access Denied | - |
369
-
370
- [[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)
371
-
372
- # **putUpdateOrder**
373
- > Array<OrderSummaryDTO> putUpdateOrder()
374
-
375
- Update An Order
376
-
377
- ### Example
378
-
379
- ```typescript
380
- import {
381
- OrdersApi,
382
- Configuration,
383
- CustomerOrderRequestDTO
384
- } from 'yellowgrid-api-ts';
385
-
386
- const configuration = new Configuration();
387
- const apiInstance = new OrdersApi(configuration);
388
-
389
- let id: number; //Order ID (default to undefined)
390
- let readonly: boolean; //Readonly Order (optional) (default to undefined)
391
- let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
392
-
393
- const { status, data } = await apiInstance.putUpdateOrder(
394
- id,
395
- readonly,
396
- customerOrderRequestDTO
397
- );
398
- ```
399
-
400
- ### Parameters
401
-
402
- |Name | Type | Description | Notes|
403
- |------------- | ------------- | ------------- | -------------|
404
- | **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
405
- | **id** | [**number**] | Order ID | defaults to undefined|
406
- | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
407
-
408
-
409
- ### Return type
410
-
411
- **Array<OrderSummaryDTO>**
412
-
413
- ### Authorization
414
-
415
- No authorization required
416
-
417
- ### HTTP request headers
418
-
419
- - **Content-Type**: application/json
420
- - **Accept**: application/json
421
-
422
-
423
- ### HTTP response details
424
- | Status code | Description | Response headers |
425
- |-------------|-------------|------------------|
426
- |**200** | Order Summaries | - |
427
- |**400** | Bad Request | - |
428
- |**401** | Unauthorised | - |
429
- |**403** | Access Denied | - |
430
-
431
- [[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)
432
-
package/docs/ProductSearchResultsModel.md CHANGED
@@ -6,7 +6,7 @@ Product Search Results
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **results** | [**Array&lt;ProductSummaryDTO&gt;**](ProductSummaryDTO.md) | Results | [optional] [default to undefined]
9
+ **results** | [**Array&lt;ProductSummaryModel&gt;**](ProductSummaryModel.md) | Results | [optional] [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
package/docs/{ProductSummaryDTO.md → ProductSummaryModel.md} RENAMED
@@ -1,4 +1,4 @@
1
- # ProductSummaryDTO
1
+ # ProductSummaryModel
2
2
 
3
3
  Product Summary
4
4
 
@@ -12,21 +12,19 @@ Name | Type | Description | Notes
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
13
  **price** | **number** | Price | [optional] [default to undefined]
14
14
  **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
15
- **rrp** | **number** | RRP Price | [optional] [default to undefined]
16
15
 
17
16
  ## Example
18
17
 
19
18
  ```typescript
20
- import { ProductSummaryDTO } from 'yellowgrid-api-ts';
19
+ import { ProductSummaryModel } from 'yellowgrid-api-ts';
21
20
 
22
- const instance: ProductSummaryDTO = {
21
+ const instance: ProductSummaryModel = {
23
22
  sku,
24
23
  title,
25
24
  quantity,
26
25
  stockProduct,
27
26
  price,
28
27
  cartonSize,
29
- rrp,
30
28
  };
31
29
  ```
32
30