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