@digital8/lighting-illusions-ts-sdk 0.0.464 → 0.0.465
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 +2 -2
- package/README.md +10 -4
- package/dist/apis/ProductApi.d.ts +73 -1
- package/dist/apis/ProductApi.js +292 -0
- package/dist/apis/TagApi.d.ts +5 -5
- package/dist/apis/TagApi.js +1 -1
- package/dist/models/AssetLiteResource.d.ts +6 -0
- package/dist/models/AssetLiteResource.js +4 -0
- package/dist/models/AttachAccessoriesProductChildRequest.d.ts +32 -0
- package/dist/models/AttachAccessoriesProductChildRequest.js +51 -0
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/OverlayTemplateListResource.d.ts +7 -0
- package/dist/models/OverlayTemplateListResource.js +5 -0
- package/dist/models/ProductChildListResource.d.ts +12 -0
- package/dist/models/ProductChildListResource.js +8 -0
- package/dist/models/SiteNotificationListResource.d.ts +7 -0
- package/dist/models/SiteNotificationListResource.js +5 -0
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/docs/AssetLiteResource.md +2 -0
- package/docs/{LinkProductChildrenTagRequest.md → AttachAccessoriesProductChildRequest.md} +4 -4
- package/docs/OverlayTemplateListResource.md +2 -0
- package/docs/ProductApi.md +414 -0
- package/docs/ProductChildListResource.md +4 -0
- package/docs/SiteNotificationListResource.md +2 -0
- package/docs/TagApi.md +7 -7
- package/package.json +1 -1
- package/src/apis/ProductApi.ts +283 -0
- package/src/apis/TagApi.ts +8 -8
- package/src/models/AssetLiteResource.ts +9 -0
- package/src/models/AttachAccessoriesProductChildRequest.ts +66 -0
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/OverlayTemplateListResource.ts +17 -0
- package/src/models/ProductChildListResource.ts +18 -0
- package/src/models/SiteNotificationListResource.ts +17 -0
- package/src/models/index.ts +1 -1
- package/dist/models/LinkProductChildrenTagRequest.d.ts +0 -32
- package/dist/models/LinkProductChildrenTagRequest.js +0 -51
- package/src/models/LinkProductChildrenTagRequest.ts +0 -66
package/docs/ProductApi.md
CHANGED
|
@@ -4,10 +4,16 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**attachAccessoriesProductChild**](ProductApi.md#attachaccessoriesproductchildoperation) | **POST** /admin-api/product/children/{productChild}/accessory/attach | Auto-generated: attachAccessoriesProductChild |
|
|
8
|
+
| [**attachCompatibleProductsProductChild**](ProductApi.md#attachcompatibleproductsproductchild) | **POST** /admin-api/product/children/{productChild}/compatible-product/attach | Auto-generated: attachCompatibleProductsProductChild |
|
|
7
9
|
| [**destroyProduct**](ProductApi.md#destroyproduct) | **DELETE** /admin-api/product/parent/{product}/delete | Auto-generated: destroyProduct |
|
|
8
10
|
| [**destroyProductChild**](ProductApi.md#destroyproductchild) | **DELETE** /admin-api/product/children/{productChild}/delete | Auto-generated: destroyProductChild |
|
|
11
|
+
| [**detachAccessoryProductChild**](ProductApi.md#detachaccessoryproductchild) | **DELETE** /admin-api/product/children/{productChild}/accessory/detach/{accessory} | Auto-generated: detachAccessoryProductChild |
|
|
12
|
+
| [**detachCompatibleProductProductChild**](ProductApi.md#detachcompatibleproductproductchild) | **DELETE** /admin-api/product/children/{productChild}/compatible-product/detach/{compatibleProduct} | Auto-generated: detachCompatibleProductProductChild |
|
|
13
|
+
| [**getAccessoriesProductChild**](ProductApi.md#getaccessoriesproductchild) | **POST** /admin-api/product/children/{productChild}/accessory/list | Auto-generated: getAccessoriesProductChild |
|
|
9
14
|
| [**getAllProduct**](ProductApi.md#getallproductoperation) | **POST** /admin-api/product/parent/all | Auto-generated: getAllProduct |
|
|
10
15
|
| [**getAllProductChild**](ProductApi.md#getallproductchildoperation) | **POST** /admin-api/product/children/all | Auto-generated: getAllProductChild |
|
|
16
|
+
| [**getCompatibleProductsProductChild**](ProductApi.md#getcompatibleproductsproductchild) | **POST** /admin-api/product/children/{productChild}/compatible-product/list | Auto-generated: getCompatibleProductsProductChild |
|
|
11
17
|
| [**indexProduct**](ProductApi.md#indexproductoperation) | **POST** /admin-api/product/parent/list | Auto-generated: indexProduct |
|
|
12
18
|
| [**indexProductChild**](ProductApi.md#indexproductchildoperation) | **POST** /admin-api/product/children/list | Auto-generated: indexProductChild |
|
|
13
19
|
| [**showAssetsProductChild**](ProductApi.md#showassetsproductchild) | **GET** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild |
|
|
@@ -20,6 +26,142 @@ All URIs are relative to *http://localhost/api*
|
|
|
20
26
|
|
|
21
27
|
|
|
22
28
|
|
|
29
|
+
## attachAccessoriesProductChild
|
|
30
|
+
|
|
31
|
+
> PaginatedProductChildListResourceResponse attachAccessoriesProductChild(productChild, attachAccessoriesProductChildRequest)
|
|
32
|
+
|
|
33
|
+
Auto-generated: attachAccessoriesProductChild
|
|
34
|
+
|
|
35
|
+
### Example
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
import {
|
|
39
|
+
Configuration,
|
|
40
|
+
ProductApi,
|
|
41
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
42
|
+
import type { AttachAccessoriesProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
43
|
+
|
|
44
|
+
async function example() {
|
|
45
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
46
|
+
const api = new ProductApi();
|
|
47
|
+
|
|
48
|
+
const body = {
|
|
49
|
+
// number | The id of the productChild
|
|
50
|
+
productChild: 56,
|
|
51
|
+
// AttachAccessoriesProductChildRequest (optional)
|
|
52
|
+
attachAccessoriesProductChildRequest: ...,
|
|
53
|
+
} satisfies AttachAccessoriesProductChildOperationRequest;
|
|
54
|
+
|
|
55
|
+
try {
|
|
56
|
+
const data = await api.attachAccessoriesProductChild(body);
|
|
57
|
+
console.log(data);
|
|
58
|
+
} catch (error) {
|
|
59
|
+
console.error(error);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// Run the test
|
|
64
|
+
example().catch(console.error);
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
|------------- | ------------- | ------------- | -------------|
|
|
72
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
73
|
+
| **attachAccessoriesProductChildRequest** | [AttachAccessoriesProductChildRequest](AttachAccessoriesProductChildRequest.md) | | [Optional] |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.md)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
No authorization required
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: `application/json`
|
|
86
|
+
- **Accept**: `application/json`
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
### HTTP response details
|
|
90
|
+
| Status code | Description | Response headers |
|
|
91
|
+
|-------------|-------------|------------------|
|
|
92
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductChildListResource>> | - |
|
|
93
|
+
|
|
94
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
## attachCompatibleProductsProductChild
|
|
98
|
+
|
|
99
|
+
> PaginatedProductChildListResourceResponse attachCompatibleProductsProductChild(productChild, attachAccessoriesProductChildRequest)
|
|
100
|
+
|
|
101
|
+
Auto-generated: attachCompatibleProductsProductChild
|
|
102
|
+
|
|
103
|
+
### Example
|
|
104
|
+
|
|
105
|
+
```ts
|
|
106
|
+
import {
|
|
107
|
+
Configuration,
|
|
108
|
+
ProductApi,
|
|
109
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
110
|
+
import type { AttachCompatibleProductsProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
111
|
+
|
|
112
|
+
async function example() {
|
|
113
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
114
|
+
const api = new ProductApi();
|
|
115
|
+
|
|
116
|
+
const body = {
|
|
117
|
+
// number | The id of the productChild
|
|
118
|
+
productChild: 56,
|
|
119
|
+
// AttachAccessoriesProductChildRequest (optional)
|
|
120
|
+
attachAccessoriesProductChildRequest: ...,
|
|
121
|
+
} satisfies AttachCompatibleProductsProductChildRequest;
|
|
122
|
+
|
|
123
|
+
try {
|
|
124
|
+
const data = await api.attachCompatibleProductsProductChild(body);
|
|
125
|
+
console.log(data);
|
|
126
|
+
} catch (error) {
|
|
127
|
+
console.error(error);
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
// Run the test
|
|
132
|
+
example().catch(console.error);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
|------------- | ------------- | ------------- | -------------|
|
|
140
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
141
|
+
| **attachAccessoriesProductChildRequest** | [AttachAccessoriesProductChildRequest](AttachAccessoriesProductChildRequest.md) | | [Optional] |
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.md)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
No authorization required
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: `application/json`
|
|
154
|
+
- **Accept**: `application/json`
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
### HTTP response details
|
|
158
|
+
| Status code | Description | Response headers |
|
|
159
|
+
|-------------|-------------|------------------|
|
|
160
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductChildListResource>> | - |
|
|
161
|
+
|
|
162
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
163
|
+
|
|
164
|
+
|
|
23
165
|
## destroyProduct
|
|
24
166
|
|
|
25
167
|
> GenericResponse destroyProduct(product)
|
|
@@ -150,6 +292,210 @@ No authorization required
|
|
|
150
292
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
151
293
|
|
|
152
294
|
|
|
295
|
+
## detachAccessoryProductChild
|
|
296
|
+
|
|
297
|
+
> PaginatedProductChildListResourceResponse detachAccessoryProductChild(productChild, accessory)
|
|
298
|
+
|
|
299
|
+
Auto-generated: detachAccessoryProductChild
|
|
300
|
+
|
|
301
|
+
### Example
|
|
302
|
+
|
|
303
|
+
```ts
|
|
304
|
+
import {
|
|
305
|
+
Configuration,
|
|
306
|
+
ProductApi,
|
|
307
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
308
|
+
import type { DetachAccessoryProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
309
|
+
|
|
310
|
+
async function example() {
|
|
311
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
312
|
+
const api = new ProductApi();
|
|
313
|
+
|
|
314
|
+
const body = {
|
|
315
|
+
// number | The id of the productChild
|
|
316
|
+
productChild: 56,
|
|
317
|
+
// number | The id of the accessory
|
|
318
|
+
accessory: 56,
|
|
319
|
+
} satisfies DetachAccessoryProductChildRequest;
|
|
320
|
+
|
|
321
|
+
try {
|
|
322
|
+
const data = await api.detachAccessoryProductChild(body);
|
|
323
|
+
console.log(data);
|
|
324
|
+
} catch (error) {
|
|
325
|
+
console.error(error);
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
// Run the test
|
|
330
|
+
example().catch(console.error);
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
### Parameters
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
| Name | Type | Description | Notes |
|
|
337
|
+
|------------- | ------------- | ------------- | -------------|
|
|
338
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
339
|
+
| **accessory** | `number` | The id of the accessory | [Defaults to `undefined`] |
|
|
340
|
+
|
|
341
|
+
### Return type
|
|
342
|
+
|
|
343
|
+
[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.md)
|
|
344
|
+
|
|
345
|
+
### Authorization
|
|
346
|
+
|
|
347
|
+
No authorization required
|
|
348
|
+
|
|
349
|
+
### HTTP request headers
|
|
350
|
+
|
|
351
|
+
- **Content-Type**: Not defined
|
|
352
|
+
- **Accept**: `application/json`
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
### HTTP response details
|
|
356
|
+
| Status code | Description | Response headers |
|
|
357
|
+
|-------------|-------------|------------------|
|
|
358
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductChildListResource>> | - |
|
|
359
|
+
|
|
360
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
## detachCompatibleProductProductChild
|
|
364
|
+
|
|
365
|
+
> PaginatedProductChildListResourceResponse detachCompatibleProductProductChild(productChild, compatibleProduct)
|
|
366
|
+
|
|
367
|
+
Auto-generated: detachCompatibleProductProductChild
|
|
368
|
+
|
|
369
|
+
### Example
|
|
370
|
+
|
|
371
|
+
```ts
|
|
372
|
+
import {
|
|
373
|
+
Configuration,
|
|
374
|
+
ProductApi,
|
|
375
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
376
|
+
import type { DetachCompatibleProductProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
377
|
+
|
|
378
|
+
async function example() {
|
|
379
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
380
|
+
const api = new ProductApi();
|
|
381
|
+
|
|
382
|
+
const body = {
|
|
383
|
+
// number | The id of the productChild
|
|
384
|
+
productChild: 56,
|
|
385
|
+
// number | The id of the compatibleProduct
|
|
386
|
+
compatibleProduct: 56,
|
|
387
|
+
} satisfies DetachCompatibleProductProductChildRequest;
|
|
388
|
+
|
|
389
|
+
try {
|
|
390
|
+
const data = await api.detachCompatibleProductProductChild(body);
|
|
391
|
+
console.log(data);
|
|
392
|
+
} catch (error) {
|
|
393
|
+
console.error(error);
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
// Run the test
|
|
398
|
+
example().catch(console.error);
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
### Parameters
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
| Name | Type | Description | Notes |
|
|
405
|
+
|------------- | ------------- | ------------- | -------------|
|
|
406
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
407
|
+
| **compatibleProduct** | `number` | The id of the compatibleProduct | [Defaults to `undefined`] |
|
|
408
|
+
|
|
409
|
+
### Return type
|
|
410
|
+
|
|
411
|
+
[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.md)
|
|
412
|
+
|
|
413
|
+
### Authorization
|
|
414
|
+
|
|
415
|
+
No authorization required
|
|
416
|
+
|
|
417
|
+
### HTTP request headers
|
|
418
|
+
|
|
419
|
+
- **Content-Type**: Not defined
|
|
420
|
+
- **Accept**: `application/json`
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
### HTTP response details
|
|
424
|
+
| Status code | Description | Response headers |
|
|
425
|
+
|-------------|-------------|------------------|
|
|
426
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductChildListResource>> | - |
|
|
427
|
+
|
|
428
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
## getAccessoriesProductChild
|
|
432
|
+
|
|
433
|
+
> PaginatedProductChildListResourceResponse getAccessoriesProductChild(productChild, indexProductChildRequest)
|
|
434
|
+
|
|
435
|
+
Auto-generated: getAccessoriesProductChild
|
|
436
|
+
|
|
437
|
+
### Example
|
|
438
|
+
|
|
439
|
+
```ts
|
|
440
|
+
import {
|
|
441
|
+
Configuration,
|
|
442
|
+
ProductApi,
|
|
443
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
444
|
+
import type { GetAccessoriesProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
445
|
+
|
|
446
|
+
async function example() {
|
|
447
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
448
|
+
const api = new ProductApi();
|
|
449
|
+
|
|
450
|
+
const body = {
|
|
451
|
+
// number | The id of the productChild
|
|
452
|
+
productChild: 56,
|
|
453
|
+
// IndexProductChildRequest (optional)
|
|
454
|
+
indexProductChildRequest: ...,
|
|
455
|
+
} satisfies GetAccessoriesProductChildRequest;
|
|
456
|
+
|
|
457
|
+
try {
|
|
458
|
+
const data = await api.getAccessoriesProductChild(body);
|
|
459
|
+
console.log(data);
|
|
460
|
+
} catch (error) {
|
|
461
|
+
console.error(error);
|
|
462
|
+
}
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
// Run the test
|
|
466
|
+
example().catch(console.error);
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
### Parameters
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
| Name | Type | Description | Notes |
|
|
473
|
+
|------------- | ------------- | ------------- | -------------|
|
|
474
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
475
|
+
| **indexProductChildRequest** | [IndexProductChildRequest](IndexProductChildRequest.md) | | [Optional] |
|
|
476
|
+
|
|
477
|
+
### Return type
|
|
478
|
+
|
|
479
|
+
[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.md)
|
|
480
|
+
|
|
481
|
+
### Authorization
|
|
482
|
+
|
|
483
|
+
No authorization required
|
|
484
|
+
|
|
485
|
+
### HTTP request headers
|
|
486
|
+
|
|
487
|
+
- **Content-Type**: `application/json`
|
|
488
|
+
- **Accept**: `application/json`
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
### HTTP response details
|
|
492
|
+
| Status code | Description | Response headers |
|
|
493
|
+
|-------------|-------------|------------------|
|
|
494
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductChildListResource[]>> | - |
|
|
495
|
+
|
|
496
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
497
|
+
|
|
498
|
+
|
|
153
499
|
## getAllProduct
|
|
154
500
|
|
|
155
501
|
> ProductLiteResourceArrayResponse getAllProduct(getAllProductRequest)
|
|
@@ -280,6 +626,74 @@ No authorization required
|
|
|
280
626
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
281
627
|
|
|
282
628
|
|
|
629
|
+
## getCompatibleProductsProductChild
|
|
630
|
+
|
|
631
|
+
> PaginatedProductChildListResourceResponse getCompatibleProductsProductChild(productChild, indexProductChildRequest)
|
|
632
|
+
|
|
633
|
+
Auto-generated: getCompatibleProductsProductChild
|
|
634
|
+
|
|
635
|
+
### Example
|
|
636
|
+
|
|
637
|
+
```ts
|
|
638
|
+
import {
|
|
639
|
+
Configuration,
|
|
640
|
+
ProductApi,
|
|
641
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
642
|
+
import type { GetCompatibleProductsProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
643
|
+
|
|
644
|
+
async function example() {
|
|
645
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
646
|
+
const api = new ProductApi();
|
|
647
|
+
|
|
648
|
+
const body = {
|
|
649
|
+
// number | The id of the productChild
|
|
650
|
+
productChild: 56,
|
|
651
|
+
// IndexProductChildRequest (optional)
|
|
652
|
+
indexProductChildRequest: ...,
|
|
653
|
+
} satisfies GetCompatibleProductsProductChildRequest;
|
|
654
|
+
|
|
655
|
+
try {
|
|
656
|
+
const data = await api.getCompatibleProductsProductChild(body);
|
|
657
|
+
console.log(data);
|
|
658
|
+
} catch (error) {
|
|
659
|
+
console.error(error);
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
// Run the test
|
|
664
|
+
example().catch(console.error);
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
### Parameters
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
| Name | Type | Description | Notes |
|
|
671
|
+
|------------- | ------------- | ------------- | -------------|
|
|
672
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
673
|
+
| **indexProductChildRequest** | [IndexProductChildRequest](IndexProductChildRequest.md) | | [Optional] |
|
|
674
|
+
|
|
675
|
+
### Return type
|
|
676
|
+
|
|
677
|
+
[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.md)
|
|
678
|
+
|
|
679
|
+
### Authorization
|
|
680
|
+
|
|
681
|
+
No authorization required
|
|
682
|
+
|
|
683
|
+
### HTTP request headers
|
|
684
|
+
|
|
685
|
+
- **Content-Type**: `application/json`
|
|
686
|
+
- **Accept**: `application/json`
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
### HTTP response details
|
|
690
|
+
| Status code | Description | Response headers |
|
|
691
|
+
|-------------|-------------|------------------|
|
|
692
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductChildListResource[]>> | - |
|
|
693
|
+
|
|
694
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
695
|
+
|
|
696
|
+
|
|
283
697
|
## indexProduct
|
|
284
698
|
|
|
285
699
|
> PaginatedProductListResourceResponse indexProduct(indexProductRequest)
|
|
@@ -9,6 +9,8 @@ Name | Type
|
|
|
9
9
|
`id` | number
|
|
10
10
|
`sku` | number
|
|
11
11
|
`name` | string
|
|
12
|
+
`model` | string
|
|
13
|
+
`stock` | number
|
|
12
14
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
15
|
|
|
14
16
|
## Example
|
|
@@ -21,6 +23,8 @@ const example = {
|
|
|
21
23
|
"id": null,
|
|
22
24
|
"sku": null,
|
|
23
25
|
"name": null,
|
|
26
|
+
"model": null,
|
|
27
|
+
"stock": null,
|
|
24
28
|
"thumbnail": null,
|
|
25
29
|
} satisfies ProductChildListResource
|
|
26
30
|
|
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`heading` | string
|
|
11
11
|
`type` | string
|
|
12
12
|
`isActive` | boolean
|
|
13
|
+
`sites` | [SiteLiteResource](SiteLiteResource.md)
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,6 +23,7 @@ const example = {
|
|
|
22
23
|
"heading": null,
|
|
23
24
|
"type": null,
|
|
24
25
|
"isActive": null,
|
|
26
|
+
"sites": null,
|
|
25
27
|
} satisfies SiteNotificationListResource
|
|
26
28
|
|
|
27
29
|
console.log(example)
|
package/docs/TagApi.md
CHANGED
|
@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
7
7
|
| [**destroyTag**](TagApi.md#destroytag) | **DELETE** /admin-api/tag/{tag}/delete | Auto-generated: destroyTag |
|
|
8
8
|
| [**getAllTag**](TagApi.md#getalltag) | **POST** /admin-api/tag/all | Auto-generated: getAllTag |
|
|
9
9
|
| [**indexTag**](TagApi.md#indextagoperation) | **POST** /admin-api/tag/list | Auto-generated: indexTag |
|
|
10
|
-
| [**linkProductChildrenTag**](TagApi.md#
|
|
10
|
+
| [**linkProductChildrenTag**](TagApi.md#linkproductchildrentag) | **POST** /admin-api/tag/{tag}/link-product-children | Auto-generated: linkProductChildrenTag |
|
|
11
11
|
| [**showTag**](TagApi.md#showtag) | **GET** /admin-api/tag/{tag} | Auto-generated: showTag |
|
|
12
12
|
| [**storeTag**](TagApi.md#storetagoperation) | **POST** /admin-api/tag/create | Auto-generated: storeTag |
|
|
13
13
|
| [**unlinkProductChildTag**](TagApi.md#unlinkproductchildtag) | **POST** /admin-api/tag/{tag}/remove-product-child/{productChild} | Auto-generated: unlinkProductChildTag |
|
|
@@ -212,7 +212,7 @@ No authorization required
|
|
|
212
212
|
|
|
213
213
|
## linkProductChildrenTag
|
|
214
214
|
|
|
215
|
-
> ProductChildRelationResourceArrayResponse linkProductChildrenTag(tag,
|
|
215
|
+
> ProductChildRelationResourceArrayResponse linkProductChildrenTag(tag, attachAccessoriesProductChildRequest)
|
|
216
216
|
|
|
217
217
|
Auto-generated: linkProductChildrenTag
|
|
218
218
|
|
|
@@ -223,7 +223,7 @@ import {
|
|
|
223
223
|
Configuration,
|
|
224
224
|
TagApi,
|
|
225
225
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
226
|
-
import type {
|
|
226
|
+
import type { LinkProductChildrenTagRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
227
227
|
|
|
228
228
|
async function example() {
|
|
229
229
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -232,9 +232,9 @@ async function example() {
|
|
|
232
232
|
const body = {
|
|
233
233
|
// number | The id of the tag
|
|
234
234
|
tag: 56,
|
|
235
|
-
//
|
|
236
|
-
|
|
237
|
-
} satisfies
|
|
235
|
+
// AttachAccessoriesProductChildRequest (optional)
|
|
236
|
+
attachAccessoriesProductChildRequest: ...,
|
|
237
|
+
} satisfies LinkProductChildrenTagRequest;
|
|
238
238
|
|
|
239
239
|
try {
|
|
240
240
|
const data = await api.linkProductChildrenTag(body);
|
|
@@ -254,7 +254,7 @@ example().catch(console.error);
|
|
|
254
254
|
| Name | Type | Description | Notes |
|
|
255
255
|
|------------- | ------------- | ------------- | -------------|
|
|
256
256
|
| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
|
|
257
|
-
| **
|
|
257
|
+
| **attachAccessoriesProductChildRequest** | [AttachAccessoriesProductChildRequest](AttachAccessoriesProductChildRequest.md) | | [Optional] |
|
|
258
258
|
|
|
259
259
|
### Return type
|
|
260
260
|
|