@digital8/lighting-illusions-ts-sdk 0.0.465 → 0.0.466
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 +8 -8
- package/README.md +17 -17
- package/dist/apis/AttributeApi.d.ts +31 -31
- package/dist/apis/AttributeApi.js +92 -92
- package/dist/apis/OverlayTemplateApi.d.ts +37 -37
- package/dist/apis/OverlayTemplateApi.js +110 -110
- package/dist/apis/ProductTypeApi.d.ts +31 -31
- package/dist/apis/ProductTypeApi.js +89 -89
- package/dist/apis/TagApi.d.ts +24 -24
- package/dist/apis/TagApi.js +81 -81
- package/dist/models/AttachAssetsOverlayTemplateRequest.d.ts +32 -0
- package/dist/models/AttachAssetsOverlayTemplateRequest.js +51 -0
- package/dist/models/AttachAttributeProductTypeRequest.d.ts +48 -0
- package/dist/models/AttachAttributeProductTypeRequest.js +65 -0
- package/dist/models/AttachProductTypeAttributeRequest.d.ts +48 -0
- package/dist/models/AttachProductTypeAttributeRequest.js +65 -0
- package/dist/models/DetachAssetableOverlayTemplateRequest.d.ts +51 -0
- package/dist/models/{UnlinkAssetableOverlayTemplateRequest.js → DetachAssetableOverlayTemplateRequest.js} +15 -15
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- package/dist/models/ProductTypeListResource.d.ts +6 -0
- package/dist/models/ProductTypeListResource.js +4 -0
- package/dist/models/index.d.ts +4 -4
- package/dist/models/index.js +4 -4
- package/docs/{LinkAssetsOverlayTemplateRequest.md → AttachAssetsOverlayTemplateRequest.md} +4 -4
- package/docs/{LinkAttributeProductTypeRequest.md → AttachAttributeProductTypeRequest.md} +4 -4
- package/docs/{LinkProductTypeAttributeRequest.md → AttachProductTypeAttributeRequest.md} +4 -4
- package/docs/AttributeApi.md +117 -117
- package/docs/{UnlinkAssetableOverlayTemplateRequest.md → DetachAssetableOverlayTemplateRequest.md} +4 -4
- package/docs/OverlayTemplateApi.md +115 -115
- package/docs/ProductTypeApi.md +94 -94
- package/docs/ProductTypeListResource.md +2 -0
- package/docs/TagApi.md +84 -84
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +105 -105
- package/src/apis/OverlayTemplateApi.ts +138 -138
- package/src/apis/ProductTypeApi.ts +101 -101
- package/src/apis/TagApi.ts +88 -88
- package/src/models/AttachAssetsOverlayTemplateRequest.ts +66 -0
- package/src/models/AttachAttributeProductTypeRequest.ts +88 -0
- package/src/models/AttachProductTypeAttributeRequest.ts +88 -0
- package/src/models/{UnlinkAssetableOverlayTemplateRequest.ts → DetachAssetableOverlayTemplateRequest.ts} +16 -16
- package/src/models/ExternalApiLogResource.ts +2 -3
- package/src/models/ProductTypeListResource.ts +9 -0
- package/src/models/index.ts +4 -4
- package/dist/models/LinkAssetsOverlayTemplateRequest.d.ts +0 -32
- package/dist/models/LinkAssetsOverlayTemplateRequest.js +0 -51
- package/dist/models/LinkAttributeProductTypeRequest.d.ts +0 -48
- package/dist/models/LinkAttributeProductTypeRequest.js +0 -65
- package/dist/models/LinkProductTypeAttributeRequest.d.ts +0 -48
- package/dist/models/LinkProductTypeAttributeRequest.js +0 -65
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.d.ts +0 -51
- package/src/models/LinkAssetsOverlayTemplateRequest.ts +0 -66
- package/src/models/LinkAttributeProductTypeRequest.ts +0 -88
- package/src/models/LinkProductTypeAttributeRequest.ts +0 -88
|
@@ -4,26 +4,26 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**attachAssetsOverlayTemplate**](OverlayTemplateApi.md#attachassetsoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/attach-assets | Auto-generated: attachAssetsOverlayTemplate |
|
|
7
8
|
| [**destroyOverlayTemplate**](OverlayTemplateApi.md#destroyoverlaytemplate) | **DELETE** /admin-api/overlay-template/{overlayTemplate}/delete | Auto-generated: destroyOverlayTemplate |
|
|
8
9
|
| [**destroyOverlayTemplateAsset**](OverlayTemplateApi.md#destroyoverlaytemplateasset) | **DELETE** /admin-api/overlay-template/asset/{overlayTemplateAsset}/delete | Auto-generated: destroyOverlayTemplateAsset |
|
|
10
|
+
| [**detachAssetOverlayTemplate**](OverlayTemplateApi.md#detachassetoverlaytemplate) | **POST** /admin-api/overlay-template/{overlayTemplate}/detach-asset/{asset} | Auto-generated: detachAssetOverlayTemplate |
|
|
11
|
+
| [**detachAssetableOverlayTemplate**](OverlayTemplateApi.md#detachassetableoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/detach-assetable | Auto-generated: detachAssetableOverlayTemplate |
|
|
9
12
|
| [**getAllOverlayTemplate**](OverlayTemplateApi.md#getalloverlaytemplateoperation) | **POST** /admin-api/overlay-template/all | Auto-generated: getAllOverlayTemplate |
|
|
10
13
|
| [**indexOverlayTemplate**](OverlayTemplateApi.md#indexoverlaytemplateoperation) | **POST** /admin-api/overlay-template/list | Auto-generated: indexOverlayTemplate |
|
|
11
|
-
| [**linkAssetsOverlayTemplate**](OverlayTemplateApi.md#linkassetsoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/link-assets | Auto-generated: linkAssetsOverlayTemplate |
|
|
12
14
|
| [**showOverlayTemplate**](OverlayTemplateApi.md#showoverlaytemplate) | **GET** /admin-api/overlay-template/{overlayTemplate} | Auto-generated: showOverlayTemplate |
|
|
13
15
|
| [**storeOverlayTemplate**](OverlayTemplateApi.md#storeoverlaytemplateoperation) | **POST** /admin-api/overlay-template/create | Auto-generated: storeOverlayTemplate |
|
|
14
16
|
| [**storeOverlayTemplateAsset**](OverlayTemplateApi.md#storeoverlaytemplateassetoperation) | **POST** /admin-api/overlay-template/asset/create | Auto-generated: storeOverlayTemplateAsset |
|
|
15
|
-
| [**unlinkAssetOverlayTemplate**](OverlayTemplateApi.md#unlinkassetoverlaytemplate) | **POST** /admin-api/overlay-template/{overlayTemplate}/remove-asset/{asset} | Auto-generated: unlinkAssetOverlayTemplate |
|
|
16
|
-
| [**unlinkAssetableOverlayTemplate**](OverlayTemplateApi.md#unlinkassetableoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/remove-assetable | Auto-generated: unlinkAssetableOverlayTemplate |
|
|
17
17
|
| [**updateOverlayTemplate**](OverlayTemplateApi.md#updateoverlaytemplateoperation) | **PUT** /admin-api/overlay-template/{overlayTemplate}/update | Auto-generated: updateOverlayTemplate |
|
|
18
18
|
| [**updateOverlayTemplateAsset**](OverlayTemplateApi.md#updateoverlaytemplateassetoperation) | **PUT** /admin-api/overlay-template/asset/{overlayTemplateAsset}/update | Auto-generated: updateOverlayTemplateAsset |
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## attachAssetsOverlayTemplate
|
|
23
23
|
|
|
24
|
-
>
|
|
24
|
+
> OverlayTemplateResource attachAssetsOverlayTemplate(overlayTemplate, attachAssetsOverlayTemplateRequest)
|
|
25
25
|
|
|
26
|
-
Auto-generated:
|
|
26
|
+
Auto-generated: attachAssetsOverlayTemplate
|
|
27
27
|
|
|
28
28
|
### Example
|
|
29
29
|
|
|
@@ -32,7 +32,7 @@ import {
|
|
|
32
32
|
Configuration,
|
|
33
33
|
OverlayTemplateApi,
|
|
34
34
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
35
|
-
import type {
|
|
35
|
+
import type { AttachAssetsOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
36
36
|
|
|
37
37
|
async function example() {
|
|
38
38
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -41,10 +41,12 @@ async function example() {
|
|
|
41
41
|
const body = {
|
|
42
42
|
// number | The id of the overlayTemplate
|
|
43
43
|
overlayTemplate: 56,
|
|
44
|
-
|
|
44
|
+
// AttachAssetsOverlayTemplateRequest (optional)
|
|
45
|
+
attachAssetsOverlayTemplateRequest: ...,
|
|
46
|
+
} satisfies AttachAssetsOverlayTemplateOperationRequest;
|
|
45
47
|
|
|
46
48
|
try {
|
|
47
|
-
const data = await api.
|
|
49
|
+
const data = await api.attachAssetsOverlayTemplate(body);
|
|
48
50
|
console.log(data);
|
|
49
51
|
} catch (error) {
|
|
50
52
|
console.error(error);
|
|
@@ -61,10 +63,11 @@ example().catch(console.error);
|
|
|
61
63
|
| Name | Type | Description | Notes |
|
|
62
64
|
|------------- | ------------- | ------------- | -------------|
|
|
63
65
|
| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
|
|
66
|
+
| **attachAssetsOverlayTemplateRequest** | [AttachAssetsOverlayTemplateRequest](AttachAssetsOverlayTemplateRequest.md) | | [Optional] |
|
|
64
67
|
|
|
65
68
|
### Return type
|
|
66
69
|
|
|
67
|
-
[**
|
|
70
|
+
[**OverlayTemplateResource**](OverlayTemplateResource.md)
|
|
68
71
|
|
|
69
72
|
### Authorization
|
|
70
73
|
|
|
@@ -72,23 +75,23 @@ No authorization required
|
|
|
72
75
|
|
|
73
76
|
### HTTP request headers
|
|
74
77
|
|
|
75
|
-
- **Content-Type**:
|
|
78
|
+
- **Content-Type**: `application/json`
|
|
76
79
|
- **Accept**: `application/json`
|
|
77
80
|
|
|
78
81
|
|
|
79
82
|
### HTTP response details
|
|
80
83
|
| Status code | Description | Response headers |
|
|
81
84
|
|-------------|-------------|------------------|
|
|
82
|
-
| **200** |
|
|
85
|
+
| **200** | Successful resource response | - |
|
|
83
86
|
|
|
84
87
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
85
88
|
|
|
86
89
|
|
|
87
|
-
##
|
|
90
|
+
## destroyOverlayTemplate
|
|
88
91
|
|
|
89
|
-
> GenericResponse
|
|
92
|
+
> GenericResponse destroyOverlayTemplate(overlayTemplate)
|
|
90
93
|
|
|
91
|
-
Auto-generated:
|
|
94
|
+
Auto-generated: destroyOverlayTemplate
|
|
92
95
|
|
|
93
96
|
### Example
|
|
94
97
|
|
|
@@ -97,19 +100,19 @@ import {
|
|
|
97
100
|
Configuration,
|
|
98
101
|
OverlayTemplateApi,
|
|
99
102
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
100
|
-
import type {
|
|
103
|
+
import type { DestroyOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
101
104
|
|
|
102
105
|
async function example() {
|
|
103
106
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
104
107
|
const api = new OverlayTemplateApi();
|
|
105
108
|
|
|
106
109
|
const body = {
|
|
107
|
-
// number | The id of the
|
|
108
|
-
|
|
109
|
-
} satisfies
|
|
110
|
+
// number | The id of the overlayTemplate
|
|
111
|
+
overlayTemplate: 56,
|
|
112
|
+
} satisfies DestroyOverlayTemplateRequest;
|
|
110
113
|
|
|
111
114
|
try {
|
|
112
|
-
const data = await api.
|
|
115
|
+
const data = await api.destroyOverlayTemplate(body);
|
|
113
116
|
console.log(data);
|
|
114
117
|
} catch (error) {
|
|
115
118
|
console.error(error);
|
|
@@ -125,7 +128,7 @@ example().catch(console.error);
|
|
|
125
128
|
|
|
126
129
|
| Name | Type | Description | Notes |
|
|
127
130
|
|------------- | ------------- | ------------- | -------------|
|
|
128
|
-
| **
|
|
131
|
+
| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
|
|
129
132
|
|
|
130
133
|
### Return type
|
|
131
134
|
|
|
@@ -149,11 +152,11 @@ No authorization required
|
|
|
149
152
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
150
153
|
|
|
151
154
|
|
|
152
|
-
##
|
|
155
|
+
## destroyOverlayTemplateAsset
|
|
153
156
|
|
|
154
|
-
>
|
|
157
|
+
> GenericResponse destroyOverlayTemplateAsset(overlayTemplateAsset)
|
|
155
158
|
|
|
156
|
-
Auto-generated:
|
|
159
|
+
Auto-generated: destroyOverlayTemplateAsset
|
|
157
160
|
|
|
158
161
|
### Example
|
|
159
162
|
|
|
@@ -162,19 +165,19 @@ import {
|
|
|
162
165
|
Configuration,
|
|
163
166
|
OverlayTemplateApi,
|
|
164
167
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
165
|
-
import type {
|
|
168
|
+
import type { DestroyOverlayTemplateAssetRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
166
169
|
|
|
167
170
|
async function example() {
|
|
168
171
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
169
172
|
const api = new OverlayTemplateApi();
|
|
170
173
|
|
|
171
174
|
const body = {
|
|
172
|
-
//
|
|
173
|
-
|
|
174
|
-
} satisfies
|
|
175
|
+
// number | The id of the overlayTemplateAsset
|
|
176
|
+
overlayTemplateAsset: 56,
|
|
177
|
+
} satisfies DestroyOverlayTemplateAssetRequest;
|
|
175
178
|
|
|
176
179
|
try {
|
|
177
|
-
const data = await api.
|
|
180
|
+
const data = await api.destroyOverlayTemplateAsset(body);
|
|
178
181
|
console.log(data);
|
|
179
182
|
} catch (error) {
|
|
180
183
|
console.error(error);
|
|
@@ -190,11 +193,11 @@ example().catch(console.error);
|
|
|
190
193
|
|
|
191
194
|
| Name | Type | Description | Notes |
|
|
192
195
|
|------------- | ------------- | ------------- | -------------|
|
|
193
|
-
| **
|
|
196
|
+
| **overlayTemplateAsset** | `number` | The id of the overlayTemplateAsset | [Defaults to `undefined`] |
|
|
194
197
|
|
|
195
198
|
### Return type
|
|
196
199
|
|
|
197
|
-
[**
|
|
200
|
+
[**GenericResponse**](GenericResponse.md)
|
|
198
201
|
|
|
199
202
|
### Authorization
|
|
200
203
|
|
|
@@ -202,23 +205,23 @@ No authorization required
|
|
|
202
205
|
|
|
203
206
|
### HTTP request headers
|
|
204
207
|
|
|
205
|
-
- **Content-Type**:
|
|
208
|
+
- **Content-Type**: Not defined
|
|
206
209
|
- **Accept**: `application/json`
|
|
207
210
|
|
|
208
211
|
|
|
209
212
|
### HTTP response details
|
|
210
213
|
| Status code | Description | Response headers |
|
|
211
214
|
|-------------|-------------|------------------|
|
|
212
|
-
| **200** |
|
|
215
|
+
| **200** | \\JsonResponse | - |
|
|
213
216
|
|
|
214
217
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
215
218
|
|
|
216
219
|
|
|
217
|
-
##
|
|
220
|
+
## detachAssetOverlayTemplate
|
|
218
221
|
|
|
219
|
-
>
|
|
222
|
+
> OverlayTemplateResource detachAssetOverlayTemplate(overlayTemplate, asset)
|
|
220
223
|
|
|
221
|
-
Auto-generated:
|
|
224
|
+
Auto-generated: detachAssetOverlayTemplate
|
|
222
225
|
|
|
223
226
|
### Example
|
|
224
227
|
|
|
@@ -227,19 +230,21 @@ import {
|
|
|
227
230
|
Configuration,
|
|
228
231
|
OverlayTemplateApi,
|
|
229
232
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
230
|
-
import type {
|
|
233
|
+
import type { DetachAssetOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
231
234
|
|
|
232
235
|
async function example() {
|
|
233
236
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
234
237
|
const api = new OverlayTemplateApi();
|
|
235
238
|
|
|
236
239
|
const body = {
|
|
237
|
-
//
|
|
238
|
-
|
|
239
|
-
|
|
240
|
+
// number | The id of the overlayTemplate
|
|
241
|
+
overlayTemplate: 56,
|
|
242
|
+
// number | The id of the asset
|
|
243
|
+
asset: 56,
|
|
244
|
+
} satisfies DetachAssetOverlayTemplateRequest;
|
|
240
245
|
|
|
241
246
|
try {
|
|
242
|
-
const data = await api.
|
|
247
|
+
const data = await api.detachAssetOverlayTemplate(body);
|
|
243
248
|
console.log(data);
|
|
244
249
|
} catch (error) {
|
|
245
250
|
console.error(error);
|
|
@@ -255,11 +260,12 @@ example().catch(console.error);
|
|
|
255
260
|
|
|
256
261
|
| Name | Type | Description | Notes |
|
|
257
262
|
|------------- | ------------- | ------------- | -------------|
|
|
258
|
-
| **
|
|
263
|
+
| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
|
|
264
|
+
| **asset** | `number` | The id of the asset | [Defaults to `undefined`] |
|
|
259
265
|
|
|
260
266
|
### Return type
|
|
261
267
|
|
|
262
|
-
[**
|
|
268
|
+
[**OverlayTemplateResource**](OverlayTemplateResource.md)
|
|
263
269
|
|
|
264
270
|
### Authorization
|
|
265
271
|
|
|
@@ -267,23 +273,23 @@ No authorization required
|
|
|
267
273
|
|
|
268
274
|
### HTTP request headers
|
|
269
275
|
|
|
270
|
-
- **Content-Type**:
|
|
276
|
+
- **Content-Type**: Not defined
|
|
271
277
|
- **Accept**: `application/json`
|
|
272
278
|
|
|
273
279
|
|
|
274
280
|
### HTTP response details
|
|
275
281
|
| Status code | Description | Response headers |
|
|
276
282
|
|-------------|-------------|------------------|
|
|
277
|
-
| **200** |
|
|
283
|
+
| **200** | Successful resource response | - |
|
|
278
284
|
|
|
279
285
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
280
286
|
|
|
281
287
|
|
|
282
|
-
##
|
|
288
|
+
## detachAssetableOverlayTemplate
|
|
283
289
|
|
|
284
|
-
>
|
|
290
|
+
> GenericResponse detachAssetableOverlayTemplate(overlayTemplate, detachAssetableOverlayTemplateRequest)
|
|
285
291
|
|
|
286
|
-
Auto-generated:
|
|
292
|
+
Auto-generated: detachAssetableOverlayTemplate
|
|
287
293
|
|
|
288
294
|
### Example
|
|
289
295
|
|
|
@@ -292,7 +298,7 @@ import {
|
|
|
292
298
|
Configuration,
|
|
293
299
|
OverlayTemplateApi,
|
|
294
300
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
295
|
-
import type {
|
|
301
|
+
import type { DetachAssetableOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
296
302
|
|
|
297
303
|
async function example() {
|
|
298
304
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
@@ -301,12 +307,12 @@ async function example() {
|
|
|
301
307
|
const body = {
|
|
302
308
|
// number | The id of the overlayTemplate
|
|
303
309
|
overlayTemplate: 56,
|
|
304
|
-
//
|
|
305
|
-
|
|
306
|
-
} satisfies
|
|
310
|
+
// DetachAssetableOverlayTemplateRequest (optional)
|
|
311
|
+
detachAssetableOverlayTemplateRequest: ...,
|
|
312
|
+
} satisfies DetachAssetableOverlayTemplateOperationRequest;
|
|
307
313
|
|
|
308
314
|
try {
|
|
309
|
-
const data = await api.
|
|
315
|
+
const data = await api.detachAssetableOverlayTemplate(body);
|
|
310
316
|
console.log(data);
|
|
311
317
|
} catch (error) {
|
|
312
318
|
console.error(error);
|
|
@@ -323,11 +329,11 @@ example().catch(console.error);
|
|
|
323
329
|
| Name | Type | Description | Notes |
|
|
324
330
|
|------------- | ------------- | ------------- | -------------|
|
|
325
331
|
| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
|
|
326
|
-
| **
|
|
332
|
+
| **detachAssetableOverlayTemplateRequest** | [DetachAssetableOverlayTemplateRequest](DetachAssetableOverlayTemplateRequest.md) | | [Optional] |
|
|
327
333
|
|
|
328
334
|
### Return type
|
|
329
335
|
|
|
330
|
-
[**
|
|
336
|
+
[**GenericResponse**](GenericResponse.md)
|
|
331
337
|
|
|
332
338
|
### Authorization
|
|
333
339
|
|
|
@@ -342,16 +348,16 @@ No authorization required
|
|
|
342
348
|
### HTTP response details
|
|
343
349
|
| Status code | Description | Response headers |
|
|
344
350
|
|-------------|-------------|------------------|
|
|
345
|
-
| **200** |
|
|
351
|
+
| **200** | Generic JSON success | - |
|
|
346
352
|
|
|
347
353
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
348
354
|
|
|
349
355
|
|
|
350
|
-
##
|
|
356
|
+
## getAllOverlayTemplate
|
|
351
357
|
|
|
352
|
-
>
|
|
358
|
+
> OverlayTemplateLiteResourceArrayResponse getAllOverlayTemplate(getAllOverlayTemplateRequest)
|
|
353
359
|
|
|
354
|
-
Auto-generated:
|
|
360
|
+
Auto-generated: getAllOverlayTemplate
|
|
355
361
|
|
|
356
362
|
### Example
|
|
357
363
|
|
|
@@ -360,19 +366,19 @@ import {
|
|
|
360
366
|
Configuration,
|
|
361
367
|
OverlayTemplateApi,
|
|
362
368
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
363
|
-
import type {
|
|
369
|
+
import type { GetAllOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
364
370
|
|
|
365
371
|
async function example() {
|
|
366
372
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
367
373
|
const api = new OverlayTemplateApi();
|
|
368
374
|
|
|
369
375
|
const body = {
|
|
370
|
-
//
|
|
371
|
-
|
|
372
|
-
} satisfies
|
|
376
|
+
// GetAllOverlayTemplateRequest (optional)
|
|
377
|
+
getAllOverlayTemplateRequest: ...,
|
|
378
|
+
} satisfies GetAllOverlayTemplateOperationRequest;
|
|
373
379
|
|
|
374
380
|
try {
|
|
375
|
-
const data = await api.
|
|
381
|
+
const data = await api.getAllOverlayTemplate(body);
|
|
376
382
|
console.log(data);
|
|
377
383
|
} catch (error) {
|
|
378
384
|
console.error(error);
|
|
@@ -388,11 +394,11 @@ example().catch(console.error);
|
|
|
388
394
|
|
|
389
395
|
| Name | Type | Description | Notes |
|
|
390
396
|
|------------- | ------------- | ------------- | -------------|
|
|
391
|
-
| **
|
|
397
|
+
| **getAllOverlayTemplateRequest** | [GetAllOverlayTemplateRequest](GetAllOverlayTemplateRequest.md) | | [Optional] |
|
|
392
398
|
|
|
393
399
|
### Return type
|
|
394
400
|
|
|
395
|
-
[**
|
|
401
|
+
[**OverlayTemplateLiteResourceArrayResponse**](OverlayTemplateLiteResourceArrayResponse.md)
|
|
396
402
|
|
|
397
403
|
### Authorization
|
|
398
404
|
|
|
@@ -400,7 +406,7 @@ No authorization required
|
|
|
400
406
|
|
|
401
407
|
### HTTP request headers
|
|
402
408
|
|
|
403
|
-
- **Content-Type**:
|
|
409
|
+
- **Content-Type**: `application/json`
|
|
404
410
|
- **Accept**: `application/json`
|
|
405
411
|
|
|
406
412
|
|
|
@@ -412,11 +418,11 @@ No authorization required
|
|
|
412
418
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
413
419
|
|
|
414
420
|
|
|
415
|
-
##
|
|
421
|
+
## indexOverlayTemplate
|
|
416
422
|
|
|
417
|
-
>
|
|
423
|
+
> PaginatedOverlayTemplateListResourceResponse indexOverlayTemplate(indexOverlayTemplateRequest)
|
|
418
424
|
|
|
419
|
-
Auto-generated:
|
|
425
|
+
Auto-generated: indexOverlayTemplate
|
|
420
426
|
|
|
421
427
|
### Example
|
|
422
428
|
|
|
@@ -425,19 +431,19 @@ import {
|
|
|
425
431
|
Configuration,
|
|
426
432
|
OverlayTemplateApi,
|
|
427
433
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
428
|
-
import type {
|
|
434
|
+
import type { IndexOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
429
435
|
|
|
430
436
|
async function example() {
|
|
431
437
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
432
438
|
const api = new OverlayTemplateApi();
|
|
433
439
|
|
|
434
440
|
const body = {
|
|
435
|
-
//
|
|
436
|
-
|
|
437
|
-
} satisfies
|
|
441
|
+
// IndexOverlayTemplateRequest (optional)
|
|
442
|
+
indexOverlayTemplateRequest: ...,
|
|
443
|
+
} satisfies IndexOverlayTemplateOperationRequest;
|
|
438
444
|
|
|
439
445
|
try {
|
|
440
|
-
const data = await api.
|
|
446
|
+
const data = await api.indexOverlayTemplate(body);
|
|
441
447
|
console.log(data);
|
|
442
448
|
} catch (error) {
|
|
443
449
|
console.error(error);
|
|
@@ -453,11 +459,11 @@ example().catch(console.error);
|
|
|
453
459
|
|
|
454
460
|
| Name | Type | Description | Notes |
|
|
455
461
|
|------------- | ------------- | ------------- | -------------|
|
|
456
|
-
| **
|
|
462
|
+
| **indexOverlayTemplateRequest** | [IndexOverlayTemplateRequest](IndexOverlayTemplateRequest.md) | | [Optional] |
|
|
457
463
|
|
|
458
464
|
### Return type
|
|
459
465
|
|
|
460
|
-
[**
|
|
466
|
+
[**PaginatedOverlayTemplateListResourceResponse**](PaginatedOverlayTemplateListResourceResponse.md)
|
|
461
467
|
|
|
462
468
|
### Authorization
|
|
463
469
|
|
|
@@ -472,16 +478,16 @@ No authorization required
|
|
|
472
478
|
### HTTP response details
|
|
473
479
|
| Status code | Description | Response headers |
|
|
474
480
|
|-------------|-------------|------------------|
|
|
475
|
-
| **200** |
|
|
481
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\OverlayTemplateListResource>> | - |
|
|
476
482
|
|
|
477
483
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
478
484
|
|
|
479
485
|
|
|
480
|
-
##
|
|
486
|
+
## showOverlayTemplate
|
|
481
487
|
|
|
482
|
-
> OverlayTemplateResource
|
|
488
|
+
> OverlayTemplateResource showOverlayTemplate(overlayTemplate)
|
|
483
489
|
|
|
484
|
-
Auto-generated:
|
|
490
|
+
Auto-generated: showOverlayTemplate
|
|
485
491
|
|
|
486
492
|
### Example
|
|
487
493
|
|
|
@@ -490,19 +496,19 @@ import {
|
|
|
490
496
|
Configuration,
|
|
491
497
|
OverlayTemplateApi,
|
|
492
498
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
493
|
-
import type {
|
|
499
|
+
import type { ShowOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
494
500
|
|
|
495
501
|
async function example() {
|
|
496
502
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
497
503
|
const api = new OverlayTemplateApi();
|
|
498
504
|
|
|
499
505
|
const body = {
|
|
500
|
-
//
|
|
501
|
-
|
|
502
|
-
} satisfies
|
|
506
|
+
// number | The id of the overlayTemplate
|
|
507
|
+
overlayTemplate: 56,
|
|
508
|
+
} satisfies ShowOverlayTemplateRequest;
|
|
503
509
|
|
|
504
510
|
try {
|
|
505
|
-
const data = await api.
|
|
511
|
+
const data = await api.showOverlayTemplate(body);
|
|
506
512
|
console.log(data);
|
|
507
513
|
} catch (error) {
|
|
508
514
|
console.error(error);
|
|
@@ -518,7 +524,7 @@ example().catch(console.error);
|
|
|
518
524
|
|
|
519
525
|
| Name | Type | Description | Notes |
|
|
520
526
|
|------------- | ------------- | ------------- | -------------|
|
|
521
|
-
| **
|
|
527
|
+
| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
|
|
522
528
|
|
|
523
529
|
### Return type
|
|
524
530
|
|
|
@@ -530,7 +536,7 @@ No authorization required
|
|
|
530
536
|
|
|
531
537
|
### HTTP request headers
|
|
532
538
|
|
|
533
|
-
- **Content-Type**:
|
|
539
|
+
- **Content-Type**: Not defined
|
|
534
540
|
- **Accept**: `application/json`
|
|
535
541
|
|
|
536
542
|
|
|
@@ -542,11 +548,11 @@ No authorization required
|
|
|
542
548
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
543
549
|
|
|
544
550
|
|
|
545
|
-
##
|
|
551
|
+
## storeOverlayTemplate
|
|
546
552
|
|
|
547
|
-
> OverlayTemplateResource
|
|
553
|
+
> OverlayTemplateResource storeOverlayTemplate(storeOverlayTemplateRequest)
|
|
548
554
|
|
|
549
|
-
Auto-generated:
|
|
555
|
+
Auto-generated: storeOverlayTemplate
|
|
550
556
|
|
|
551
557
|
### Example
|
|
552
558
|
|
|
@@ -555,21 +561,19 @@ import {
|
|
|
555
561
|
Configuration,
|
|
556
562
|
OverlayTemplateApi,
|
|
557
563
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
558
|
-
import type {
|
|
564
|
+
import type { StoreOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
559
565
|
|
|
560
566
|
async function example() {
|
|
561
567
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
562
568
|
const api = new OverlayTemplateApi();
|
|
563
569
|
|
|
564
570
|
const body = {
|
|
565
|
-
//
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
asset: 56,
|
|
569
|
-
} satisfies UnlinkAssetOverlayTemplateRequest;
|
|
571
|
+
// StoreOverlayTemplateRequest (optional)
|
|
572
|
+
storeOverlayTemplateRequest: ...,
|
|
573
|
+
} satisfies StoreOverlayTemplateOperationRequest;
|
|
570
574
|
|
|
571
575
|
try {
|
|
572
|
-
const data = await api.
|
|
576
|
+
const data = await api.storeOverlayTemplate(body);
|
|
573
577
|
console.log(data);
|
|
574
578
|
} catch (error) {
|
|
575
579
|
console.error(error);
|
|
@@ -585,8 +589,7 @@ example().catch(console.error);
|
|
|
585
589
|
|
|
586
590
|
| Name | Type | Description | Notes |
|
|
587
591
|
|------------- | ------------- | ------------- | -------------|
|
|
588
|
-
| **
|
|
589
|
-
| **asset** | `number` | The id of the asset | [Defaults to `undefined`] |
|
|
592
|
+
| **storeOverlayTemplateRequest** | [StoreOverlayTemplateRequest](StoreOverlayTemplateRequest.md) | | [Optional] |
|
|
590
593
|
|
|
591
594
|
### Return type
|
|
592
595
|
|
|
@@ -598,7 +601,7 @@ No authorization required
|
|
|
598
601
|
|
|
599
602
|
### HTTP request headers
|
|
600
603
|
|
|
601
|
-
- **Content-Type**:
|
|
604
|
+
- **Content-Type**: `application/json`
|
|
602
605
|
- **Accept**: `application/json`
|
|
603
606
|
|
|
604
607
|
|
|
@@ -610,11 +613,11 @@ No authorization required
|
|
|
610
613
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
611
614
|
|
|
612
615
|
|
|
613
|
-
##
|
|
616
|
+
## storeOverlayTemplateAsset
|
|
614
617
|
|
|
615
|
-
>
|
|
618
|
+
> OverlayTemplateResource storeOverlayTemplateAsset(storeOverlayTemplateAssetRequest)
|
|
616
619
|
|
|
617
|
-
Auto-generated:
|
|
620
|
+
Auto-generated: storeOverlayTemplateAsset
|
|
618
621
|
|
|
619
622
|
### Example
|
|
620
623
|
|
|
@@ -623,21 +626,19 @@ import {
|
|
|
623
626
|
Configuration,
|
|
624
627
|
OverlayTemplateApi,
|
|
625
628
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
626
|
-
import type {
|
|
629
|
+
import type { StoreOverlayTemplateAssetOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
627
630
|
|
|
628
631
|
async function example() {
|
|
629
632
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
630
633
|
const api = new OverlayTemplateApi();
|
|
631
634
|
|
|
632
635
|
const body = {
|
|
633
|
-
//
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
unlinkAssetableOverlayTemplateRequest: ...,
|
|
637
|
-
} satisfies UnlinkAssetableOverlayTemplateOperationRequest;
|
|
636
|
+
// StoreOverlayTemplateAssetRequest (optional)
|
|
637
|
+
storeOverlayTemplateAssetRequest: ...,
|
|
638
|
+
} satisfies StoreOverlayTemplateAssetOperationRequest;
|
|
638
639
|
|
|
639
640
|
try {
|
|
640
|
-
const data = await api.
|
|
641
|
+
const data = await api.storeOverlayTemplateAsset(body);
|
|
641
642
|
console.log(data);
|
|
642
643
|
} catch (error) {
|
|
643
644
|
console.error(error);
|
|
@@ -653,12 +654,11 @@ example().catch(console.error);
|
|
|
653
654
|
|
|
654
655
|
| Name | Type | Description | Notes |
|
|
655
656
|
|------------- | ------------- | ------------- | -------------|
|
|
656
|
-
| **
|
|
657
|
-
| **unlinkAssetableOverlayTemplateRequest** | [UnlinkAssetableOverlayTemplateRequest](UnlinkAssetableOverlayTemplateRequest.md) | | [Optional] |
|
|
657
|
+
| **storeOverlayTemplateAssetRequest** | [StoreOverlayTemplateAssetRequest](StoreOverlayTemplateAssetRequest.md) | | [Optional] |
|
|
658
658
|
|
|
659
659
|
### Return type
|
|
660
660
|
|
|
661
|
-
[**
|
|
661
|
+
[**OverlayTemplateResource**](OverlayTemplateResource.md)
|
|
662
662
|
|
|
663
663
|
### Authorization
|
|
664
664
|
|
|
@@ -673,7 +673,7 @@ No authorization required
|
|
|
673
673
|
### HTTP response details
|
|
674
674
|
| Status code | Description | Response headers |
|
|
675
675
|
|-------------|-------------|------------------|
|
|
676
|
-
| **200** |
|
|
676
|
+
| **200** | Successful resource response | - |
|
|
677
677
|
|
|
678
678
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
679
679
|
|