@digital8/lighting-illusions-ts-sdk 0.0.472 → 0.0.473
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 +10 -72
- package/README.md +20 -56
- package/dist/apis/AttributeApi.d.ts +33 -33
- package/dist/apis/AttributeApi.js +92 -92
- package/dist/apis/OverlayTemplateApi.d.ts +39 -39
- package/dist/apis/OverlayTemplateApi.js +110 -110
- package/dist/apis/ProductApi.d.ts +17 -78
- package/dist/apis/ProductApi.js +24 -271
- package/dist/apis/ProductTypeApi.d.ts +33 -33
- package/dist/apis/ProductTypeApi.js +89 -89
- package/dist/apis/SiteApi.d.ts +5 -5
- package/dist/apis/SiteApi.js +2 -2
- package/dist/apis/SupplierApi.d.ts +3 -3
- package/dist/apis/SupplierApi.js +1 -1
- package/dist/apis/TagApi.d.ts +27 -27
- package/dist/apis/TagApi.js +81 -81
- package/dist/models/AssetLiteResource.d.ts +0 -6
- package/dist/models/AssetLiteResource.js +0 -4
- package/dist/models/GetAllAttributeRequest.d.ts +9 -15
- package/dist/models/GetAllAttributeRequest.js +4 -6
- package/dist/models/GetAllOverlayTemplateRequest.d.ts +6 -12
- package/dist/models/GetAllOverlayTemplateRequest.js +2 -4
- package/dist/models/GetAllProductChildRequest.d.ts +0 -6
- package/dist/models/GetAllProductChildRequest.js +0 -2
- package/dist/models/GetAllProductRequest.d.ts +0 -36
- package/dist/models/GetAllProductRequest.js +0 -12
- package/dist/models/GetAllProductTypeRequest.d.ts +0 -6
- package/dist/models/GetAllProductTypeRequest.js +0 -2
- package/dist/models/GetAllSupplierRequest.d.ts +0 -6
- package/dist/models/GetAllSupplierRequest.js +0 -2
- package/dist/models/IndexAttributeRequest.d.ts +0 -25
- package/dist/models/IndexAttributeRequest.js +1 -13
- package/dist/models/IndexExternalApiLogRequest.d.ts +3 -21
- package/dist/models/IndexExternalApiLogRequest.js +4 -10
- package/dist/models/IndexOverlayTemplateRequest.d.ts +0 -25
- package/dist/models/IndexOverlayTemplateRequest.js +1 -13
- package/dist/models/IndexProductChildRequest.d.ts +0 -6
- package/dist/models/IndexProductChildRequest.js +0 -2
- package/dist/models/IndexProductTypeRequest.d.ts +0 -25
- package/dist/models/IndexProductTypeRequest.js +1 -13
- package/dist/models/IndexSiteNotificationRequest.d.ts +0 -18
- package/dist/models/IndexSiteNotificationRequest.js +0 -6
- package/dist/models/IndexSiteRequest.d.ts +0 -18
- package/dist/models/IndexSiteRequest.js +0 -6
- package/dist/models/IndexSupplierRequest.d.ts +0 -25
- package/dist/models/IndexSupplierRequest.js +1 -13
- package/dist/models/IndexTagRequest.d.ts +0 -25
- package/dist/models/IndexTagRequest.js +1 -13
- package/dist/models/LinkAssetsOverlayTemplateRequest.d.ts +32 -0
- package/dist/models/LinkAssetsOverlayTemplateRequest.js +51 -0
- package/dist/models/LinkAttributeProductTypeRequest.d.ts +48 -0
- package/dist/models/LinkAttributeProductTypeRequest.js +65 -0
- package/dist/models/LinkProductChildrenTagRequest.d.ts +32 -0
- package/dist/models/LinkProductChildrenTagRequest.js +51 -0
- package/dist/models/LinkProductTypeAttributeRequest.d.ts +48 -0
- package/dist/models/LinkProductTypeAttributeRequest.js +65 -0
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.d.ts +45 -0
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.js +62 -0
- package/dist/models/index.d.ts +5 -36
- package/dist/models/index.js +5 -36
- package/docs/AssetLiteResource.md +0 -2
- package/docs/AttributeApi.md +117 -117
- package/docs/GetAllAttributeRequest.md +4 -6
- package/docs/GetAllOverlayTemplateRequest.md +2 -4
- package/docs/GetAllProductChildRequest.md +0 -2
- package/docs/GetAllProductRequest.md +0 -12
- package/docs/GetAllProductTypeRequest.md +0 -2
- package/docs/GetAllSupplierRequest.md +0 -2
- package/docs/IndexAttributeRequest.md +0 -6
- package/docs/IndexExternalApiLogRequest.md +4 -10
- package/docs/IndexOverlayTemplateRequest.md +0 -6
- package/docs/IndexProductChildRequest.md +0 -2
- package/docs/IndexProductTypeRequest.md +0 -6
- package/docs/IndexSiteNotificationRequest.md +0 -6
- package/docs/IndexSiteRequest.md +0 -6
- package/docs/IndexSupplierRequest.md +0 -6
- package/docs/IndexTagRequest.md +0 -6
- package/docs/{AttachAssetsOverlayTemplateRequest.md → LinkAssetsOverlayTemplateRequest.md} +4 -4
- package/docs/{AttachAttributeProductTypeRequest.md → LinkAttributeProductTypeRequest.md} +4 -4
- package/docs/{AttachAccessoriesProductChildRequest.md → LinkProductChildrenTagRequest.md} +4 -4
- package/docs/{AttachProductTypeAttributeRequest.md → LinkProductTypeAttributeRequest.md} +4 -4
- package/docs/OverlayTemplateApi.md +115 -115
- package/docs/ProductApi.md +29 -377
- package/docs/ProductTypeApi.md +94 -94
- package/docs/SiteApi.md +6 -6
- package/docs/SupplierApi.md +3 -3
- package/docs/TagApi.md +84 -84
- package/docs/{DetachAssetableOverlayTemplateRequest.md → UnlinkAssetableOverlayTemplateRequest.md} +4 -6
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +108 -108
- package/src/apis/OverlayTemplateApi.ts +141 -141
- package/src/apis/ProductApi.ts +32 -282
- package/src/apis/ProductTypeApi.ts +104 -104
- package/src/apis/SiteApi.ts +12 -12
- package/src/apis/SupplierApi.ts +6 -6
- package/src/apis/TagApi.ts +94 -94
- package/src/models/AssetLiteResource.ts +0 -9
- package/src/models/GetAllAttributeRequest.ts +13 -21
- package/src/models/GetAllOverlayTemplateRequest.ts +8 -16
- package/src/models/GetAllProductChildRequest.ts +0 -8
- package/src/models/GetAllProductRequest.ts +0 -48
- package/src/models/GetAllProductTypeRequest.ts +0 -8
- package/src/models/GetAllSupplierRequest.ts +0 -8
- package/src/models/IndexAttributeRequest.ts +0 -32
- package/src/models/IndexExternalApiLogRequest.ts +7 -31
- package/src/models/IndexOverlayTemplateRequest.ts +0 -32
- package/src/models/IndexProductChildRequest.ts +0 -8
- package/src/models/IndexProductTypeRequest.ts +0 -32
- package/src/models/IndexSiteNotificationRequest.ts +0 -24
- package/src/models/IndexSiteRequest.ts +0 -24
- package/src/models/IndexSupplierRequest.ts +0 -32
- package/src/models/IndexTagRequest.ts +0 -32
- package/src/models/LinkAssetsOverlayTemplateRequest.ts +66 -0
- package/src/models/LinkAttributeProductTypeRequest.ts +88 -0
- package/src/models/LinkProductChildrenTagRequest.ts +66 -0
- package/src/models/LinkProductTypeAttributeRequest.ts +88 -0
- package/src/models/UnlinkAssetableOverlayTemplateRequest.ts +85 -0
- package/src/models/index.ts +5 -36
- package/dist/models/AttachAccessoriesProductChildRequest.d.ts +0 -32
- package/dist/models/AttachAccessoriesProductChildRequest.js +0 -51
- package/dist/models/AttachAssetsOverlayTemplateRequest.d.ts +0 -32
- package/dist/models/AttachAssetsOverlayTemplateRequest.js +0 -51
- package/dist/models/AttachAttributeProductTypeRequest.d.ts +0 -48
- package/dist/models/AttachAttributeProductTypeRequest.js +0 -65
- package/dist/models/AttachProductTypeAttributeRequest.d.ts +0 -48
- package/dist/models/AttachProductTypeAttributeRequest.js +0 -65
- package/dist/models/AttributeListResource.d.ts +0 -56
- package/dist/models/AttributeListResource.js +0 -67
- package/dist/models/AttributeListResourceArrayResponse.d.ts +0 -33
- package/dist/models/AttributeListResourceArrayResponse.js +0 -50
- package/dist/models/DetachAssetableOverlayTemplateRequest.d.ts +0 -51
- package/dist/models/DetachAssetableOverlayTemplateRequest.js +0 -64
- package/dist/models/ExternalApiLogListResource.d.ts +0 -56
- package/dist/models/ExternalApiLogListResource.js +0 -63
- package/dist/models/ExternalApiLogListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ExternalApiLogListResourceArrayResponse.js +0 -50
- package/dist/models/IndexProductRequest.d.ts +0 -130
- package/dist/models/IndexProductRequest.js +0 -97
- package/dist/models/OverlayTemplateListResource.d.ts +0 -45
- package/dist/models/OverlayTemplateListResource.js +0 -60
- package/dist/models/OverlayTemplateListResourceArrayResponse.d.ts +0 -33
- package/dist/models/OverlayTemplateListResourceArrayResponse.js +0 -50
- package/dist/models/PaginatedAttributeListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedAttributeListResourceResponse.js +0 -57
- package/dist/models/PaginatedExternalApiLogListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedExternalApiLogListResourceResponse.js +0 -57
- package/dist/models/PaginatedOverlayTemplateListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedOverlayTemplateListResourceResponse.js +0 -57
- package/dist/models/PaginatedProductChildListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductChildListResourceResponse.js +0 -57
- package/dist/models/PaginatedProductListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductListResourceResponse.js +0 -57
- package/dist/models/PaginatedProductTypeListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductTypeListResourceResponse.js +0 -57
- package/dist/models/PaginatedSiteListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedSiteListResourceResponse.js +0 -57
- package/dist/models/PaginatedSiteNotificationListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedSiteNotificationListResourceResponse.js +0 -57
- package/dist/models/PaginatedSupplierListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedSupplierListResourceResponse.js +0 -57
- package/dist/models/PaginatedTagListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedTagListResourceResponse.js +0 -57
- package/dist/models/ProductChildListResource.d.ts +0 -63
- package/dist/models/ProductChildListResource.js +0 -72
- package/dist/models/ProductChildListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductChildListResourceArrayResponse.js +0 -50
- package/dist/models/ProductListResource.d.ts +0 -38
- package/dist/models/ProductListResource.js +0 -55
- package/dist/models/ProductListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductListResourceArrayResponse.js +0 -50
- package/dist/models/ProductTypeListResource.d.ts +0 -44
- package/dist/models/ProductTypeListResource.js +0 -59
- package/dist/models/ProductTypeListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductTypeListResourceArrayResponse.js +0 -50
- package/dist/models/SiteListResource.d.ts +0 -50
- package/dist/models/SiteListResource.js +0 -63
- package/dist/models/SiteListResourceArrayResponse.d.ts +0 -33
- package/dist/models/SiteListResourceArrayResponse.js +0 -50
- package/dist/models/SiteNotificationListResource.d.ts +0 -87
- package/dist/models/SiteNotificationListResource.js +0 -84
- package/dist/models/SiteNotificationListResourceArrayResponse.d.ts +0 -33
- package/dist/models/SiteNotificationListResourceArrayResponse.js +0 -50
- package/dist/models/SupplierListResource.d.ts +0 -57
- package/dist/models/SupplierListResource.js +0 -68
- package/dist/models/SupplierListResourceArrayResponse.d.ts +0 -33
- package/dist/models/SupplierListResourceArrayResponse.js +0 -50
- package/dist/models/TagListResource.d.ts +0 -57
- package/dist/models/TagListResource.js +0 -68
- package/dist/models/TagListResourceArrayResponse.d.ts +0 -33
- package/dist/models/TagListResourceArrayResponse.js +0 -50
- package/docs/AttributeListResource.md +0 -42
- package/docs/AttributeListResourceArrayResponse.md +0 -34
- package/docs/ExternalApiLogListResource.md +0 -42
- package/docs/ExternalApiLogListResourceArrayResponse.md +0 -34
- package/docs/IndexProductRequest.md +0 -58
- package/docs/OverlayTemplateListResource.md +0 -38
- package/docs/OverlayTemplateListResourceArrayResponse.md +0 -34
- package/docs/PaginatedAttributeListResourceResponse.md +0 -36
- package/docs/PaginatedExternalApiLogListResourceResponse.md +0 -36
- package/docs/PaginatedOverlayTemplateListResourceResponse.md +0 -36
- package/docs/PaginatedProductChildListResourceResponse.md +0 -36
- package/docs/PaginatedProductListResourceResponse.md +0 -36
- package/docs/PaginatedProductTypeListResourceResponse.md +0 -36
- package/docs/PaginatedSiteListResourceResponse.md +0 -36
- package/docs/PaginatedSiteNotificationListResourceResponse.md +0 -36
- package/docs/PaginatedSupplierListResourceResponse.md +0 -36
- package/docs/PaginatedTagListResourceResponse.md +0 -36
- package/docs/ProductChildListResource.md +0 -44
- package/docs/ProductChildListResourceArrayResponse.md +0 -34
- package/docs/ProductListResource.md +0 -36
- package/docs/ProductListResourceArrayResponse.md +0 -34
- package/docs/ProductTypeListResource.md +0 -38
- package/docs/ProductTypeListResourceArrayResponse.md +0 -34
- package/docs/SiteListResource.md +0 -40
- package/docs/SiteListResourceArrayResponse.md +0 -34
- package/docs/SiteNotificationListResource.md +0 -52
- package/docs/SiteNotificationListResourceArrayResponse.md +0 -34
- package/docs/SupplierListResource.md +0 -42
- package/docs/SupplierListResourceArrayResponse.md +0 -34
- package/docs/TagListResource.md +0 -42
- package/docs/TagListResourceArrayResponse.md +0 -34
- package/src/models/AttachAccessoriesProductChildRequest.ts +0 -66
- package/src/models/AttachAssetsOverlayTemplateRequest.ts +0 -66
- package/src/models/AttachAttributeProductTypeRequest.ts +0 -88
- package/src/models/AttachProductTypeAttributeRequest.ts +0 -88
- package/src/models/AttributeListResource.ts +0 -102
- package/src/models/AttributeListResourceArrayResponse.ts +0 -73
- package/src/models/DetachAssetableOverlayTemplateRequest.ts +0 -93
- package/src/models/ExternalApiLogListResource.ts +0 -100
- package/src/models/ExternalApiLogListResourceArrayResponse.ts +0 -73
- package/src/models/IndexProductRequest.ts +0 -192
- package/src/models/OverlayTemplateListResource.ts +0 -92
- package/src/models/OverlayTemplateListResourceArrayResponse.ts +0 -73
- package/src/models/PaginatedAttributeListResourceResponse.ts +0 -90
- package/src/models/PaginatedExternalApiLogListResourceResponse.ts +0 -90
- package/src/models/PaginatedOverlayTemplateListResourceResponse.ts +0 -90
- package/src/models/PaginatedProductChildListResourceResponse.ts +0 -90
- package/src/models/PaginatedProductListResourceResponse.ts +0 -90
- package/src/models/PaginatedProductTypeListResourceResponse.ts +0 -90
- package/src/models/PaginatedSiteListResourceResponse.ts +0 -90
- package/src/models/PaginatedSiteNotificationListResourceResponse.ts +0 -90
- package/src/models/PaginatedSupplierListResourceResponse.ts +0 -90
- package/src/models/PaginatedTagListResourceResponse.ts +0 -90
- package/src/models/ProductChildListResource.ts +0 -119
- package/src/models/ProductChildListResourceArrayResponse.ts +0 -73
- package/src/models/ProductListResource.ts +0 -75
- package/src/models/ProductListResourceArrayResponse.ts +0 -73
- package/src/models/ProductTypeListResource.ts +0 -84
- package/src/models/ProductTypeListResourceArrayResponse.ts +0 -73
- package/src/models/SiteListResource.ts +0 -93
- package/src/models/SiteListResourceArrayResponse.ts +0 -73
- package/src/models/SiteNotificationListResource.ts +0 -153
- package/src/models/SiteNotificationListResourceArrayResponse.ts +0 -73
- package/src/models/SupplierListResource.ts +0 -110
- package/src/models/SupplierListResourceArrayResponse.ts +0 -73
- package/src/models/TagListResource.ts +0 -110
- package/src/models/TagListResourceArrayResponse.ts +0 -73
package/docs/TagApi.md
CHANGED
|
@@ -4,22 +4,22 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**attachProductChildrenTag**](TagApi.md#attachproductchildrentag) | **POST** /admin-api/tag/{tag}/attach-product-children | Auto-generated: attachProductChildrenTag |
|
|
8
7
|
| [**destroyTag**](TagApi.md#destroytag) | **DELETE** /admin-api/tag/{tag}/delete | Auto-generated: destroyTag |
|
|
9
|
-
| [**detachProductChildTag**](TagApi.md#detachproductchildtag) | **POST** /admin-api/tag/{tag}/detach-product-child/{productChild} | Auto-generated: detachProductChildTag |
|
|
10
8
|
| [**getAllTag**](TagApi.md#getalltag) | **POST** /admin-api/tag/all | Auto-generated: getAllTag |
|
|
11
9
|
| [**indexTag**](TagApi.md#indextagoperation) | **POST** /admin-api/tag/list | Auto-generated: indexTag |
|
|
10
|
+
| [**linkProductChildrenTag**](TagApi.md#linkproductchildrentagoperation) | **POST** /admin-api/tag/{tag}/link-product-children | Auto-generated: linkProductChildrenTag |
|
|
12
11
|
| [**showTag**](TagApi.md#showtag) | **GET** /admin-api/tag/{tag} | Auto-generated: showTag |
|
|
13
12
|
| [**storeTag**](TagApi.md#storetagoperation) | **POST** /admin-api/tag/create | Auto-generated: storeTag |
|
|
13
|
+
| [**unlinkProductChildTag**](TagApi.md#unlinkproductchildtag) | **POST** /admin-api/tag/{tag}/remove-product-child/{productChild} | Auto-generated: unlinkProductChildTag |
|
|
14
14
|
| [**updateTag**](TagApi.md#updatetagoperation) | **PUT** /admin-api/tag/{tag}/update | Auto-generated: updateTag |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## destroyTag
|
|
19
19
|
|
|
20
|
-
>
|
|
20
|
+
> GenericResponse destroyTag(tag)
|
|
21
21
|
|
|
22
|
-
Auto-generated:
|
|
22
|
+
Auto-generated: destroyTag
|
|
23
23
|
|
|
24
24
|
### Example
|
|
25
25
|
|
|
@@ -28,7 +28,7 @@ import {
|
|
|
28
28
|
Configuration,
|
|
29
29
|
TagApi,
|
|
30
30
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
31
|
-
import type {
|
|
31
|
+
import type { DestroyTagRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
32
32
|
|
|
33
33
|
async function example() {
|
|
34
34
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -37,12 +37,10 @@ async function example() {
|
|
|
37
37
|
const body = {
|
|
38
38
|
// number | The id of the tag
|
|
39
39
|
tag: 56,
|
|
40
|
-
|
|
41
|
-
attachAccessoriesProductChildRequest: ...,
|
|
42
|
-
} satisfies AttachProductChildrenTagRequest;
|
|
40
|
+
} satisfies DestroyTagRequest;
|
|
43
41
|
|
|
44
42
|
try {
|
|
45
|
-
const data = await api.
|
|
43
|
+
const data = await api.destroyTag(body);
|
|
46
44
|
console.log(data);
|
|
47
45
|
} catch (error) {
|
|
48
46
|
console.error(error);
|
|
@@ -59,11 +57,10 @@ example().catch(console.error);
|
|
|
59
57
|
| Name | Type | Description | Notes |
|
|
60
58
|
|------------- | ------------- | ------------- | -------------|
|
|
61
59
|
| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
|
|
62
|
-
| **attachAccessoriesProductChildRequest** | [AttachAccessoriesProductChildRequest](AttachAccessoriesProductChildRequest.md) | | [Optional] |
|
|
63
60
|
|
|
64
61
|
### Return type
|
|
65
62
|
|
|
66
|
-
[**
|
|
63
|
+
[**GenericResponse**](GenericResponse.md)
|
|
67
64
|
|
|
68
65
|
### Authorization
|
|
69
66
|
|
|
@@ -71,23 +68,23 @@ No authorization required
|
|
|
71
68
|
|
|
72
69
|
### HTTP request headers
|
|
73
70
|
|
|
74
|
-
- **Content-Type**:
|
|
71
|
+
- **Content-Type**: Not defined
|
|
75
72
|
- **Accept**: `application/json`
|
|
76
73
|
|
|
77
74
|
|
|
78
75
|
### HTTP response details
|
|
79
76
|
| Status code | Description | Response headers |
|
|
80
77
|
|-------------|-------------|------------------|
|
|
81
|
-
| **200** |
|
|
78
|
+
| **200** | \\JsonResponse | - |
|
|
82
79
|
|
|
83
80
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
81
|
|
|
85
82
|
|
|
86
|
-
##
|
|
83
|
+
## getAllTag
|
|
87
84
|
|
|
88
|
-
>
|
|
85
|
+
> TagLiteResourceArrayResponse getAllTag(indexTagRequest)
|
|
89
86
|
|
|
90
|
-
Auto-generated:
|
|
87
|
+
Auto-generated: getAllTag
|
|
91
88
|
|
|
92
89
|
### Example
|
|
93
90
|
|
|
@@ -96,19 +93,19 @@ import {
|
|
|
96
93
|
Configuration,
|
|
97
94
|
TagApi,
|
|
98
95
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
99
|
-
import type {
|
|
96
|
+
import type { GetAllTagRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
100
97
|
|
|
101
98
|
async function example() {
|
|
102
99
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
103
100
|
const api = new TagApi();
|
|
104
101
|
|
|
105
102
|
const body = {
|
|
106
|
-
//
|
|
107
|
-
|
|
108
|
-
} satisfies
|
|
103
|
+
// IndexTagRequest (optional)
|
|
104
|
+
indexTagRequest: ...,
|
|
105
|
+
} satisfies GetAllTagRequest;
|
|
109
106
|
|
|
110
107
|
try {
|
|
111
|
-
const data = await api.
|
|
108
|
+
const data = await api.getAllTag(body);
|
|
112
109
|
console.log(data);
|
|
113
110
|
} catch (error) {
|
|
114
111
|
console.error(error);
|
|
@@ -124,11 +121,11 @@ example().catch(console.error);
|
|
|
124
121
|
|
|
125
122
|
| Name | Type | Description | Notes |
|
|
126
123
|
|------------- | ------------- | ------------- | -------------|
|
|
127
|
-
| **
|
|
124
|
+
| **indexTagRequest** | [IndexTagRequest](IndexTagRequest.md) | | [Optional] |
|
|
128
125
|
|
|
129
126
|
### Return type
|
|
130
127
|
|
|
131
|
-
[**
|
|
128
|
+
[**TagLiteResourceArrayResponse**](TagLiteResourceArrayResponse.md)
|
|
132
129
|
|
|
133
130
|
### Authorization
|
|
134
131
|
|
|
@@ -136,23 +133,23 @@ No authorization required
|
|
|
136
133
|
|
|
137
134
|
### HTTP request headers
|
|
138
135
|
|
|
139
|
-
- **Content-Type**:
|
|
136
|
+
- **Content-Type**: `application/json`
|
|
140
137
|
- **Accept**: `application/json`
|
|
141
138
|
|
|
142
139
|
|
|
143
140
|
### HTTP response details
|
|
144
141
|
| Status code | Description | Response headers |
|
|
145
142
|
|-------------|-------------|------------------|
|
|
146
|
-
| **200** |
|
|
143
|
+
| **200** | Successful resource response | - |
|
|
147
144
|
|
|
148
145
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
149
146
|
|
|
150
147
|
|
|
151
|
-
##
|
|
148
|
+
## indexTag
|
|
152
149
|
|
|
153
|
-
>
|
|
150
|
+
> PaginatedTagResourceResponse indexTag(indexTagRequest)
|
|
154
151
|
|
|
155
|
-
Auto-generated:
|
|
152
|
+
Auto-generated: indexTag
|
|
156
153
|
|
|
157
154
|
### Example
|
|
158
155
|
|
|
@@ -161,21 +158,19 @@ import {
|
|
|
161
158
|
Configuration,
|
|
162
159
|
TagApi,
|
|
163
160
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
164
|
-
import type {
|
|
161
|
+
import type { IndexTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
165
162
|
|
|
166
163
|
async function example() {
|
|
167
164
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
168
165
|
const api = new TagApi();
|
|
169
166
|
|
|
170
167
|
const body = {
|
|
171
|
-
//
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
productChild: 56,
|
|
175
|
-
} satisfies DetachProductChildTagRequest;
|
|
168
|
+
// IndexTagRequest (optional)
|
|
169
|
+
indexTagRequest: ...,
|
|
170
|
+
} satisfies IndexTagOperationRequest;
|
|
176
171
|
|
|
177
172
|
try {
|
|
178
|
-
const data = await api.
|
|
173
|
+
const data = await api.indexTag(body);
|
|
179
174
|
console.log(data);
|
|
180
175
|
} catch (error) {
|
|
181
176
|
console.error(error);
|
|
@@ -191,12 +186,11 @@ example().catch(console.error);
|
|
|
191
186
|
|
|
192
187
|
| Name | Type | Description | Notes |
|
|
193
188
|
|------------- | ------------- | ------------- | -------------|
|
|
194
|
-
| **
|
|
195
|
-
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
189
|
+
| **indexTagRequest** | [IndexTagRequest](IndexTagRequest.md) | | [Optional] |
|
|
196
190
|
|
|
197
191
|
### Return type
|
|
198
192
|
|
|
199
|
-
[**
|
|
193
|
+
[**PaginatedTagResourceResponse**](PaginatedTagResourceResponse.md)
|
|
200
194
|
|
|
201
195
|
### Authorization
|
|
202
196
|
|
|
@@ -204,23 +198,23 @@ No authorization required
|
|
|
204
198
|
|
|
205
199
|
### HTTP request headers
|
|
206
200
|
|
|
207
|
-
- **Content-Type**:
|
|
201
|
+
- **Content-Type**: `application/json`
|
|
208
202
|
- **Accept**: `application/json`
|
|
209
203
|
|
|
210
204
|
|
|
211
205
|
### HTTP response details
|
|
212
206
|
| Status code | Description | Response headers |
|
|
213
207
|
|-------------|-------------|------------------|
|
|
214
|
-
| **200** |
|
|
208
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\TagResource[]>> | - |
|
|
215
209
|
|
|
216
210
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
217
211
|
|
|
218
212
|
|
|
219
|
-
##
|
|
213
|
+
## linkProductChildrenTag
|
|
220
214
|
|
|
221
|
-
>
|
|
215
|
+
> ProductChildRelationResourceArrayResponse linkProductChildrenTag(tag, linkProductChildrenTagRequest)
|
|
222
216
|
|
|
223
|
-
Auto-generated:
|
|
217
|
+
Auto-generated: linkProductChildrenTag
|
|
224
218
|
|
|
225
219
|
### Example
|
|
226
220
|
|
|
@@ -229,19 +223,21 @@ import {
|
|
|
229
223
|
Configuration,
|
|
230
224
|
TagApi,
|
|
231
225
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
232
|
-
import type {
|
|
226
|
+
import type { LinkProductChildrenTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
233
227
|
|
|
234
228
|
async function example() {
|
|
235
229
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
236
230
|
const api = new TagApi();
|
|
237
231
|
|
|
238
232
|
const body = {
|
|
239
|
-
//
|
|
240
|
-
|
|
241
|
-
|
|
233
|
+
// number | The id of the tag
|
|
234
|
+
tag: 56,
|
|
235
|
+
// LinkProductChildrenTagRequest (optional)
|
|
236
|
+
linkProductChildrenTagRequest: ...,
|
|
237
|
+
} satisfies LinkProductChildrenTagOperationRequest;
|
|
242
238
|
|
|
243
239
|
try {
|
|
244
|
-
const data = await api.
|
|
240
|
+
const data = await api.linkProductChildrenTag(body);
|
|
245
241
|
console.log(data);
|
|
246
242
|
} catch (error) {
|
|
247
243
|
console.error(error);
|
|
@@ -257,11 +253,12 @@ example().catch(console.error);
|
|
|
257
253
|
|
|
258
254
|
| Name | Type | Description | Notes |
|
|
259
255
|
|------------- | ------------- | ------------- | -------------|
|
|
260
|
-
| **
|
|
256
|
+
| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
|
|
257
|
+
| **linkProductChildrenTagRequest** | [LinkProductChildrenTagRequest](LinkProductChildrenTagRequest.md) | | [Optional] |
|
|
261
258
|
|
|
262
259
|
### Return type
|
|
263
260
|
|
|
264
|
-
[**
|
|
261
|
+
[**ProductChildRelationResourceArrayResponse**](ProductChildRelationResourceArrayResponse.md)
|
|
265
262
|
|
|
266
263
|
### Authorization
|
|
267
264
|
|
|
@@ -281,11 +278,11 @@ No authorization required
|
|
|
281
278
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
282
279
|
|
|
283
280
|
|
|
284
|
-
##
|
|
281
|
+
## showTag
|
|
285
282
|
|
|
286
|
-
>
|
|
283
|
+
> TagResource showTag(tag)
|
|
287
284
|
|
|
288
|
-
Auto-generated:
|
|
285
|
+
Auto-generated: showTag
|
|
289
286
|
|
|
290
287
|
### Example
|
|
291
288
|
|
|
@@ -294,19 +291,19 @@ import {
|
|
|
294
291
|
Configuration,
|
|
295
292
|
TagApi,
|
|
296
293
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
297
|
-
import type {
|
|
294
|
+
import type { ShowTagRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
298
295
|
|
|
299
296
|
async function example() {
|
|
300
297
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
301
298
|
const api = new TagApi();
|
|
302
299
|
|
|
303
300
|
const body = {
|
|
304
|
-
//
|
|
305
|
-
|
|
306
|
-
} satisfies
|
|
301
|
+
// number | The id of the tag
|
|
302
|
+
tag: 56,
|
|
303
|
+
} satisfies ShowTagRequest;
|
|
307
304
|
|
|
308
305
|
try {
|
|
309
|
-
const data = await api.
|
|
306
|
+
const data = await api.showTag(body);
|
|
310
307
|
console.log(data);
|
|
311
308
|
} catch (error) {
|
|
312
309
|
console.error(error);
|
|
@@ -322,11 +319,11 @@ example().catch(console.error);
|
|
|
322
319
|
|
|
323
320
|
| Name | Type | Description | Notes |
|
|
324
321
|
|------------- | ------------- | ------------- | -------------|
|
|
325
|
-
| **
|
|
322
|
+
| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
|
|
326
323
|
|
|
327
324
|
### Return type
|
|
328
325
|
|
|
329
|
-
[**
|
|
326
|
+
[**TagResource**](TagResource.md)
|
|
330
327
|
|
|
331
328
|
### Authorization
|
|
332
329
|
|
|
@@ -334,23 +331,23 @@ No authorization required
|
|
|
334
331
|
|
|
335
332
|
### HTTP request headers
|
|
336
333
|
|
|
337
|
-
- **Content-Type**:
|
|
334
|
+
- **Content-Type**: Not defined
|
|
338
335
|
- **Accept**: `application/json`
|
|
339
336
|
|
|
340
337
|
|
|
341
338
|
### HTTP response details
|
|
342
339
|
| Status code | Description | Response headers |
|
|
343
340
|
|-------------|-------------|------------------|
|
|
344
|
-
| **200** |
|
|
341
|
+
| **200** | Successful resource response | - |
|
|
345
342
|
|
|
346
343
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
347
344
|
|
|
348
345
|
|
|
349
|
-
##
|
|
346
|
+
## storeTag
|
|
350
347
|
|
|
351
|
-
> TagResource
|
|
348
|
+
> TagResource storeTag(storeTagRequest)
|
|
352
349
|
|
|
353
|
-
Auto-generated:
|
|
350
|
+
Auto-generated: storeTag
|
|
354
351
|
|
|
355
352
|
### Example
|
|
356
353
|
|
|
@@ -359,19 +356,19 @@ import {
|
|
|
359
356
|
Configuration,
|
|
360
357
|
TagApi,
|
|
361
358
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
362
|
-
import type {
|
|
359
|
+
import type { StoreTagOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
363
360
|
|
|
364
361
|
async function example() {
|
|
365
362
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
366
363
|
const api = new TagApi();
|
|
367
364
|
|
|
368
365
|
const body = {
|
|
369
|
-
//
|
|
370
|
-
|
|
371
|
-
} satisfies
|
|
366
|
+
// StoreTagRequest (optional)
|
|
367
|
+
storeTagRequest: ...,
|
|
368
|
+
} satisfies StoreTagOperationRequest;
|
|
372
369
|
|
|
373
370
|
try {
|
|
374
|
-
const data = await api.
|
|
371
|
+
const data = await api.storeTag(body);
|
|
375
372
|
console.log(data);
|
|
376
373
|
} catch (error) {
|
|
377
374
|
console.error(error);
|
|
@@ -387,7 +384,7 @@ example().catch(console.error);
|
|
|
387
384
|
|
|
388
385
|
| Name | Type | Description | Notes |
|
|
389
386
|
|------------- | ------------- | ------------- | -------------|
|
|
390
|
-
| **
|
|
387
|
+
| **storeTagRequest** | [StoreTagRequest](StoreTagRequest.md) | | [Optional] |
|
|
391
388
|
|
|
392
389
|
### Return type
|
|
393
390
|
|
|
@@ -399,7 +396,7 @@ No authorization required
|
|
|
399
396
|
|
|
400
397
|
### HTTP request headers
|
|
401
398
|
|
|
402
|
-
- **Content-Type**:
|
|
399
|
+
- **Content-Type**: `application/json`
|
|
403
400
|
- **Accept**: `application/json`
|
|
404
401
|
|
|
405
402
|
|
|
@@ -411,11 +408,11 @@ No authorization required
|
|
|
411
408
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
412
409
|
|
|
413
410
|
|
|
414
|
-
##
|
|
411
|
+
## unlinkProductChildTag
|
|
415
412
|
|
|
416
|
-
>
|
|
413
|
+
> ProductChildRelationResourceArrayResponse unlinkProductChildTag(tag, productChild)
|
|
417
414
|
|
|
418
|
-
Auto-generated:
|
|
415
|
+
Auto-generated: unlinkProductChildTag
|
|
419
416
|
|
|
420
417
|
### Example
|
|
421
418
|
|
|
@@ -424,19 +421,21 @@ import {
|
|
|
424
421
|
Configuration,
|
|
425
422
|
TagApi,
|
|
426
423
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
427
|
-
import type {
|
|
424
|
+
import type { UnlinkProductChildTagRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
428
425
|
|
|
429
426
|
async function example() {
|
|
430
427
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
431
428
|
const api = new TagApi();
|
|
432
429
|
|
|
433
430
|
const body = {
|
|
434
|
-
//
|
|
435
|
-
|
|
436
|
-
|
|
431
|
+
// number | The id of the tag
|
|
432
|
+
tag: 56,
|
|
433
|
+
// number | The id of the productChild
|
|
434
|
+
productChild: 56,
|
|
435
|
+
} satisfies UnlinkProductChildTagRequest;
|
|
437
436
|
|
|
438
437
|
try {
|
|
439
|
-
const data = await api.
|
|
438
|
+
const data = await api.unlinkProductChildTag(body);
|
|
440
439
|
console.log(data);
|
|
441
440
|
} catch (error) {
|
|
442
441
|
console.error(error);
|
|
@@ -452,11 +451,12 @@ example().catch(console.error);
|
|
|
452
451
|
|
|
453
452
|
| Name | Type | Description | Notes |
|
|
454
453
|
|------------- | ------------- | ------------- | -------------|
|
|
455
|
-
| **
|
|
454
|
+
| **tag** | `number` | The id of the tag | [Defaults to `undefined`] |
|
|
455
|
+
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
456
456
|
|
|
457
457
|
### Return type
|
|
458
458
|
|
|
459
|
-
[**
|
|
459
|
+
[**ProductChildRelationResourceArrayResponse**](ProductChildRelationResourceArrayResponse.md)
|
|
460
460
|
|
|
461
461
|
### Authorization
|
|
462
462
|
|
|
@@ -464,7 +464,7 @@ No authorization required
|
|
|
464
464
|
|
|
465
465
|
### HTTP request headers
|
|
466
466
|
|
|
467
|
-
- **Content-Type**:
|
|
467
|
+
- **Content-Type**: Not defined
|
|
468
468
|
- **Accept**: `application/json`
|
|
469
469
|
|
|
470
470
|
|
package/docs/{DetachAssetableOverlayTemplateRequest.md → UnlinkAssetableOverlayTemplateRequest.md}
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# UnlinkAssetableOverlayTemplateRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -8,19 +8,17 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`relatedId` | number
|
|
10
10
|
`relatedType` | string
|
|
11
|
-
`includesRelations` | boolean
|
|
12
11
|
|
|
13
12
|
## Example
|
|
14
13
|
|
|
15
14
|
```typescript
|
|
16
|
-
import type {
|
|
15
|
+
import type { UnlinkAssetableOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
16
|
|
|
18
17
|
// TODO: Update the object below with actual values
|
|
19
18
|
const example = {
|
|
20
19
|
"relatedId": null,
|
|
21
20
|
"relatedType": null,
|
|
22
|
-
|
|
23
|
-
} satisfies DetachAssetableOverlayTemplateRequest
|
|
21
|
+
} satisfies UnlinkAssetableOverlayTemplateRequest
|
|
24
22
|
|
|
25
23
|
console.log(example)
|
|
26
24
|
|
|
@@ -29,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
27
|
console.log(exampleJSON)
|
|
30
28
|
|
|
31
29
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as UnlinkAssetableOverlayTemplateRequest
|
|
33
31
|
console.log(exampleParsed)
|
|
34
32
|
```
|
|
35
33
|
|