@digital8/lighting-illusions-ts-sdk 0.0.1776 → 0.0.1777

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 (46) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +11 -2
  3. package/dist/apis/CartsApi.d.ts +97 -1
  4. package/dist/apis/CartsApi.js +372 -0
  5. package/dist/models/AddressFrontendResource.d.ts +1 -1
  6. package/dist/models/AddressFrontendResource.js +3 -1
  7. package/dist/models/AttachCouponCartRequest.d.ts +32 -0
  8. package/dist/models/AttachCouponCartRequest.js +51 -0
  9. package/dist/models/AttachItemCartRequest.d.ts +44 -0
  10. package/dist/models/AttachItemCartRequest.js +57 -0
  11. package/dist/models/CartResource.d.ts +2 -2
  12. package/dist/models/CartResource.js +3 -1
  13. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  14. package/dist/models/ExternalApiLogResource.js +3 -1
  15. package/dist/models/IndexCartRequest.d.ts +6 -6
  16. package/dist/models/IndexCartRequest.js +2 -2
  17. package/dist/models/ProductChildSiteDetailLiteResource.d.ts +7 -0
  18. package/dist/models/ProductChildSiteDetailLiteResource.js +5 -0
  19. package/dist/models/StoreListResource.d.ts +1 -1
  20. package/dist/models/StoreListResource.js +3 -1
  21. package/dist/models/StoreResource.d.ts +1 -1
  22. package/dist/models/StoreResource.js +1 -3
  23. package/dist/models/UpdateItemCartRequest.d.ts +38 -0
  24. package/dist/models/UpdateItemCartRequest.js +53 -0
  25. package/dist/models/index.d.ts +3 -0
  26. package/dist/models/index.js +3 -0
  27. package/docs/AttachCouponCartRequest.md +34 -0
  28. package/docs/AttachItemCartRequest.md +38 -0
  29. package/docs/CartResource.md +1 -1
  30. package/docs/CartsApi.md +414 -0
  31. package/docs/IndexCartRequest.md +2 -2
  32. package/docs/ProductChildSiteDetailLiteResource.md +2 -0
  33. package/docs/UpdateItemCartRequest.md +36 -0
  34. package/package.json +1 -1
  35. package/src/apis/CartsApi.ts +342 -0
  36. package/src/models/AddressFrontendResource.ts +3 -2
  37. package/src/models/AttachCouponCartRequest.ts +66 -0
  38. package/src/models/AttachItemCartRequest.ts +83 -0
  39. package/src/models/CartResource.ts +4 -3
  40. package/src/models/ExternalApiLogResource.ts +3 -2
  41. package/src/models/IndexCartRequest.ts +8 -8
  42. package/src/models/ProductChildSiteDetailLiteResource.ts +16 -0
  43. package/src/models/StoreListResource.ts +3 -2
  44. package/src/models/StoreResource.ts +2 -3
  45. package/src/models/UpdateItemCartRequest.ts +74 -0
  46. package/src/models/index.ts +3 -0
package/docs/CartsApi.md CHANGED
@@ -4,14 +4,156 @@ All URIs are relative to *http://localhost/api*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
+ | [**attachCouponCart**](CartsApi.md#attachcouponcartoperation) | **POST** /admin-api/carts/{cart}/coupons/attach | Auto-generated: attachCouponCart |
8
+ | [**attachItemCart**](CartsApi.md#attachitemcartoperation) | **POST** /admin-api/carts/{cart}/items/attach | Auto-generated: attachItemCart |
7
9
  | [**destroyCart**](CartsApi.md#destroycart) | **DELETE** /admin-api/carts/{cart}/delete | Auto-generated: destroyCart |
10
+ | [**detachCouponCart**](CartsApi.md#detachcouponcart) | **DELETE** /admin-api/carts/{cart}/coupons/{coupon}/detach | Auto-generated: detachCouponCart |
11
+ | [**detachItemCart**](CartsApi.md#detachitemcart) | **DELETE** /admin-api/carts/{cart}/items/{cartItem}/detach | Auto-generated: detachItemCart |
8
12
  | [**indexCart**](CartsApi.md#indexcartoperation) | **POST** /admin-api/carts/list | Auto-generated: indexCart |
13
+ | [**sendPaymentLinkCart**](CartsApi.md#sendpaymentlinkcart) | **POST** /admin-api/carts/{cart}/send-payment-link | Auto-generated: sendPaymentLinkCart |
9
14
  | [**showCart**](CartsApi.md#showcart) | **GET** /admin-api/carts/{cart} | Auto-generated: showCart |
10
15
  | [**storeCart**](CartsApi.md#storecartoperation) | **POST** /admin-api/carts/create | Auto-generated: storeCart |
11
16
  | [**updateCart**](CartsApi.md#updatecartoperation) | **PUT** /admin-api/carts/{cart}/update | Auto-generated: updateCart |
17
+ | [**updateItemCart**](CartsApi.md#updateitemcartoperation) | **PUT** /admin-api/carts/{cart}/items/{cartItem}/update | Auto-generated: updateItemCart |
12
18
 
13
19
 
14
20
 
21
+ ## attachCouponCart
22
+
23
+ > CartResource attachCouponCart(cart, attachCouponCartRequest)
24
+
25
+ Auto-generated: attachCouponCart
26
+
27
+ ### Example
28
+
29
+ ```ts
30
+ import {
31
+ Configuration,
32
+ CartsApi,
33
+ } from '@digital8/lighting-illusions-ts-sdk';
34
+ import type { AttachCouponCartOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
35
+
36
+ async function example() {
37
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
38
+ const api = new CartsApi();
39
+
40
+ const body = {
41
+ // number | The id of the cart
42
+ cart: 56,
43
+ // AttachCouponCartRequest (optional)
44
+ attachCouponCartRequest: ...,
45
+ } satisfies AttachCouponCartOperationRequest;
46
+
47
+ try {
48
+ const data = await api.attachCouponCart(body);
49
+ console.log(data);
50
+ } catch (error) {
51
+ console.error(error);
52
+ }
53
+ }
54
+
55
+ // Run the test
56
+ example().catch(console.error);
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+
62
+ | Name | Type | Description | Notes |
63
+ |------------- | ------------- | ------------- | -------------|
64
+ | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
65
+ | **attachCouponCartRequest** | [AttachCouponCartRequest](AttachCouponCartRequest.md) | | [Optional] |
66
+
67
+ ### Return type
68
+
69
+ [**CartResource**](CartResource.md)
70
+
71
+ ### Authorization
72
+
73
+ No authorization required
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: `application/json`
78
+ - **Accept**: `application/json`
79
+
80
+
81
+ ### HTTP response details
82
+ | Status code | Description | Response headers |
83
+ |-------------|-------------|------------------|
84
+ | **200** | Successful resource response | - |
85
+
86
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
87
+
88
+
89
+ ## attachItemCart
90
+
91
+ > CartResource attachItemCart(cart, attachItemCartRequest)
92
+
93
+ Auto-generated: attachItemCart
94
+
95
+ ### Example
96
+
97
+ ```ts
98
+ import {
99
+ Configuration,
100
+ CartsApi,
101
+ } from '@digital8/lighting-illusions-ts-sdk';
102
+ import type { AttachItemCartOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
103
+
104
+ async function example() {
105
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
106
+ const api = new CartsApi();
107
+
108
+ const body = {
109
+ // number | The id of the cart
110
+ cart: 56,
111
+ // AttachItemCartRequest (optional)
112
+ attachItemCartRequest: ...,
113
+ } satisfies AttachItemCartOperationRequest;
114
+
115
+ try {
116
+ const data = await api.attachItemCart(body);
117
+ console.log(data);
118
+ } catch (error) {
119
+ console.error(error);
120
+ }
121
+ }
122
+
123
+ // Run the test
124
+ example().catch(console.error);
125
+ ```
126
+
127
+ ### Parameters
128
+
129
+
130
+ | Name | Type | Description | Notes |
131
+ |------------- | ------------- | ------------- | -------------|
132
+ | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
133
+ | **attachItemCartRequest** | [AttachItemCartRequest](AttachItemCartRequest.md) | | [Optional] |
134
+
135
+ ### Return type
136
+
137
+ [**CartResource**](CartResource.md)
138
+
139
+ ### Authorization
140
+
141
+ No authorization required
142
+
143
+ ### HTTP request headers
144
+
145
+ - **Content-Type**: `application/json`
146
+ - **Accept**: `application/json`
147
+
148
+
149
+ ### HTTP response details
150
+ | Status code | Description | Response headers |
151
+ |-------------|-------------|------------------|
152
+ | **200** | Successful resource response | - |
153
+
154
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
155
+
156
+
15
157
  ## destroyCart
16
158
 
17
159
  > GenericResponse destroyCart(cart)
@@ -77,6 +219,142 @@ No authorization required
77
219
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
78
220
 
79
221
 
222
+ ## detachCouponCart
223
+
224
+ > CartResource detachCouponCart(cart, coupon)
225
+
226
+ Auto-generated: detachCouponCart
227
+
228
+ ### Example
229
+
230
+ ```ts
231
+ import {
232
+ Configuration,
233
+ CartsApi,
234
+ } from '@digital8/lighting-illusions-ts-sdk';
235
+ import type { DetachCouponCartRequest } from '@digital8/lighting-illusions-ts-sdk';
236
+
237
+ async function example() {
238
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
239
+ const api = new CartsApi();
240
+
241
+ const body = {
242
+ // number | The id of the cart
243
+ cart: 56,
244
+ // number | The id of the coupon
245
+ coupon: 56,
246
+ } satisfies DetachCouponCartRequest;
247
+
248
+ try {
249
+ const data = await api.detachCouponCart(body);
250
+ console.log(data);
251
+ } catch (error) {
252
+ console.error(error);
253
+ }
254
+ }
255
+
256
+ // Run the test
257
+ example().catch(console.error);
258
+ ```
259
+
260
+ ### Parameters
261
+
262
+
263
+ | Name | Type | Description | Notes |
264
+ |------------- | ------------- | ------------- | -------------|
265
+ | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
266
+ | **coupon** | `number` | The id of the coupon | [Defaults to `undefined`] |
267
+
268
+ ### Return type
269
+
270
+ [**CartResource**](CartResource.md)
271
+
272
+ ### Authorization
273
+
274
+ No authorization required
275
+
276
+ ### HTTP request headers
277
+
278
+ - **Content-Type**: Not defined
279
+ - **Accept**: `application/json`
280
+
281
+
282
+ ### HTTP response details
283
+ | Status code | Description | Response headers |
284
+ |-------------|-------------|------------------|
285
+ | **200** | Successful resource response | - |
286
+
287
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
288
+
289
+
290
+ ## detachItemCart
291
+
292
+ > CartResource detachItemCart(cart, cartItem)
293
+
294
+ Auto-generated: detachItemCart
295
+
296
+ ### Example
297
+
298
+ ```ts
299
+ import {
300
+ Configuration,
301
+ CartsApi,
302
+ } from '@digital8/lighting-illusions-ts-sdk';
303
+ import type { DetachItemCartRequest } from '@digital8/lighting-illusions-ts-sdk';
304
+
305
+ async function example() {
306
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
307
+ const api = new CartsApi();
308
+
309
+ const body = {
310
+ // number | The id of the cart
311
+ cart: 56,
312
+ // number | The id of the cartItem
313
+ cartItem: 56,
314
+ } satisfies DetachItemCartRequest;
315
+
316
+ try {
317
+ const data = await api.detachItemCart(body);
318
+ console.log(data);
319
+ } catch (error) {
320
+ console.error(error);
321
+ }
322
+ }
323
+
324
+ // Run the test
325
+ example().catch(console.error);
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+
331
+ | Name | Type | Description | Notes |
332
+ |------------- | ------------- | ------------- | -------------|
333
+ | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
334
+ | **cartItem** | `number` | The id of the cartItem | [Defaults to `undefined`] |
335
+
336
+ ### Return type
337
+
338
+ [**CartResource**](CartResource.md)
339
+
340
+ ### Authorization
341
+
342
+ No authorization required
343
+
344
+ ### HTTP request headers
345
+
346
+ - **Content-Type**: Not defined
347
+ - **Accept**: `application/json`
348
+
349
+
350
+ ### HTTP response details
351
+ | Status code | Description | Response headers |
352
+ |-------------|-------------|------------------|
353
+ | **200** | Successful resource response | - |
354
+
355
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
356
+
357
+
80
358
  ## indexCart
81
359
 
82
360
  > PaginatedCartListResourceResponse indexCart(indexCartRequest)
@@ -142,6 +420,71 @@ No authorization required
142
420
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
143
421
 
144
422
 
423
+ ## sendPaymentLinkCart
424
+
425
+ > CartResource sendPaymentLinkCart(cart)
426
+
427
+ Auto-generated: sendPaymentLinkCart
428
+
429
+ ### Example
430
+
431
+ ```ts
432
+ import {
433
+ Configuration,
434
+ CartsApi,
435
+ } from '@digital8/lighting-illusions-ts-sdk';
436
+ import type { SendPaymentLinkCartRequest } from '@digital8/lighting-illusions-ts-sdk';
437
+
438
+ async function example() {
439
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
440
+ const api = new CartsApi();
441
+
442
+ const body = {
443
+ // number | The id of the cart
444
+ cart: 56,
445
+ } satisfies SendPaymentLinkCartRequest;
446
+
447
+ try {
448
+ const data = await api.sendPaymentLinkCart(body);
449
+ console.log(data);
450
+ } catch (error) {
451
+ console.error(error);
452
+ }
453
+ }
454
+
455
+ // Run the test
456
+ example().catch(console.error);
457
+ ```
458
+
459
+ ### Parameters
460
+
461
+
462
+ | Name | Type | Description | Notes |
463
+ |------------- | ------------- | ------------- | -------------|
464
+ | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
465
+
466
+ ### Return type
467
+
468
+ [**CartResource**](CartResource.md)
469
+
470
+ ### Authorization
471
+
472
+ No authorization required
473
+
474
+ ### HTTP request headers
475
+
476
+ - **Content-Type**: Not defined
477
+ - **Accept**: `application/json`
478
+
479
+
480
+ ### HTTP response details
481
+ | Status code | Description | Response headers |
482
+ |-------------|-------------|------------------|
483
+ | **200** | Successful resource response | - |
484
+
485
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
486
+
487
+
145
488
  ## showCart
146
489
 
147
490
  > CartResource showCart(cart)
@@ -339,3 +682,74 @@ No authorization required
339
682
 
340
683
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
341
684
 
685
+
686
+ ## updateItemCart
687
+
688
+ > CartResource updateItemCart(cart, cartItem, updateItemCartRequest)
689
+
690
+ Auto-generated: updateItemCart
691
+
692
+ ### Example
693
+
694
+ ```ts
695
+ import {
696
+ Configuration,
697
+ CartsApi,
698
+ } from '@digital8/lighting-illusions-ts-sdk';
699
+ import type { UpdateItemCartOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
700
+
701
+ async function example() {
702
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
703
+ const api = new CartsApi();
704
+
705
+ const body = {
706
+ // number | The id of the cart
707
+ cart: 56,
708
+ // number | The id of the cartItem
709
+ cartItem: 56,
710
+ // UpdateItemCartRequest (optional)
711
+ updateItemCartRequest: ...,
712
+ } satisfies UpdateItemCartOperationRequest;
713
+
714
+ try {
715
+ const data = await api.updateItemCart(body);
716
+ console.log(data);
717
+ } catch (error) {
718
+ console.error(error);
719
+ }
720
+ }
721
+
722
+ // Run the test
723
+ example().catch(console.error);
724
+ ```
725
+
726
+ ### Parameters
727
+
728
+
729
+ | Name | Type | Description | Notes |
730
+ |------------- | ------------- | ------------- | -------------|
731
+ | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
732
+ | **cartItem** | `number` | The id of the cartItem | [Defaults to `undefined`] |
733
+ | **updateItemCartRequest** | [UpdateItemCartRequest](UpdateItemCartRequest.md) | | [Optional] |
734
+
735
+ ### Return type
736
+
737
+ [**CartResource**](CartResource.md)
738
+
739
+ ### Authorization
740
+
741
+ No authorization required
742
+
743
+ ### HTTP request headers
744
+
745
+ - **Content-Type**: `application/json`
746
+ - **Accept**: `application/json`
747
+
748
+
749
+ ### HTTP response details
750
+ | Status code | Description | Response headers |
751
+ |-------------|-------------|------------------|
752
+ | **200** | Successful resource response | - |
753
+
754
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
755
+
@@ -13,7 +13,6 @@ Name | Type
13
13
  `page` | number
14
14
  `siteId` | Array<string>
15
15
  `source` | Array<string>
16
- `status` | Array<string>
17
16
  `beforeCreatedAt` | Date
18
17
  `afterCreatedAt` | Date
19
18
  `beforeExpiryDate` | Date
@@ -23,6 +22,7 @@ Name | Type
23
22
  `relatedId` | number
24
23
  `relatedType` | string
25
24
  `includesRelations` | boolean
25
+ `status` | Array<string>
26
26
 
27
27
  ## Example
28
28
 
@@ -38,7 +38,6 @@ const example = {
38
38
  "page": null,
39
39
  "siteId": null,
40
40
  "source": null,
41
- "status": null,
42
41
  "beforeCreatedAt": null,
43
42
  "afterCreatedAt": null,
44
43
  "beforeExpiryDate": null,
@@ -48,6 +47,7 @@ const example = {
48
47
  "relatedId": null,
49
48
  "relatedType": null,
50
49
  "includesRelations": null,
50
+ "status": null,
51
51
  } satisfies IndexCartRequest
52
52
 
53
53
  console.log(example)
@@ -13,6 +13,7 @@ Name | Type
13
13
  `rrpPrice` | number
14
14
  `salePrice` | number
15
15
  `isDisabled` | boolean
16
+ `label` | [LabelResource](LabelResource.md)
16
17
 
17
18
  ## Example
18
19
 
@@ -28,6 +29,7 @@ const example = {
28
29
  "rrpPrice": null,
29
30
  "salePrice": null,
30
31
  "isDisabled": null,
32
+ "label": null,
31
33
  } satisfies ProductChildSiteDetailLiteResource
32
34
 
33
35
  console.log(example)
@@ -0,0 +1,36 @@
1
+
2
+ # UpdateItemCartRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `quantity` | number
10
+ `productPrice` | number
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { UpdateItemCartRequest } from '@digital8/lighting-illusions-ts-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "quantity": null,
20
+ "productPrice": null,
21
+ } satisfies UpdateItemCartRequest
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as UpdateItemCartRequest
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.1776",
3
+ "version": "0.0.1777",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {