@digital8/lighting-illusions-ts-sdk 0.0.396 → 0.0.397

package/docs/OverlayTemplateApi.md

@@ -0,0 +1,746 @@
+# OverlayTemplateApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyOverlayTemplate**](OverlayTemplateApi.md#destroyoverlaytemplate) | **DELETE** /admin-api/overlay-template/{overlayTemplate}/delete | Auto-generated: destroyOverlayTemplate |
+| [**destroyOverlayTemplateAsset**](OverlayTemplateApi.md#destroyoverlaytemplateasset) | **DELETE** /admin-api/overlay-template/asset/{overlayTemplateAsset}/delete | Auto-generated: destroyOverlayTemplateAsset |
+| [**getAllOverlayTemplate**](OverlayTemplateApi.md#getalloverlaytemplateoperation) | **POST** /admin-api/overlay-template/all | Auto-generated: getAllOverlayTemplate |
+| [**indexOverlayTemplate**](OverlayTemplateApi.md#indexoverlaytemplateoperation) | **POST** /admin-api/overlay-template/list | Auto-generated: indexOverlayTemplate |
+| [**linkAssetsOverlayTemplate**](OverlayTemplateApi.md#linkassetsoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/link-assets | Auto-generated: linkAssetsOverlayTemplate |
+| [**showOverlayTemplate**](OverlayTemplateApi.md#showoverlaytemplate) | **GET** /admin-api/overlay-template/{overlayTemplate} | Auto-generated: showOverlayTemplate |
+| [**storeOverlayTemplate**](OverlayTemplateApi.md#storeoverlaytemplateoperation) | **POST** /admin-api/overlay-template/create | Auto-generated: storeOverlayTemplate |
+| [**storeOverlayTemplateAsset**](OverlayTemplateApi.md#storeoverlaytemplateassetoperation) | **POST** /admin-api/overlay-template/asset/create | Auto-generated: storeOverlayTemplateAsset |
+| [**unlinkAssetOverlayTemplate**](OverlayTemplateApi.md#unlinkassetoverlaytemplate) | **POST** /admin-api/overlay-template/{overlayTemplate}/remove-asset/{asset} | Auto-generated: unlinkAssetOverlayTemplate |
+| [**updateOverlayTemplate**](OverlayTemplateApi.md#updateoverlaytemplateoperation) | **PUT** /admin-api/overlay-template/{overlayTemplate}/update | Auto-generated: updateOverlayTemplate |
+| [**updateOverlayTemplateAsset**](OverlayTemplateApi.md#updateoverlaytemplateassetoperation) | **PUT** /admin-api/overlay-template/asset/{overlayTemplateAsset}/update | Auto-generated: updateOverlayTemplateAsset |
+
+
+
+## destroyOverlayTemplate
+
+> GenericResponse destroyOverlayTemplate(overlayTemplate)
+
+Auto-generated: destroyOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplate
+    overlayTemplate: 56,
+  } satisfies DestroyOverlayTemplateRequest;
+
+  try {
+    const data = await api.destroyOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## destroyOverlayTemplateAsset
+
+> GenericResponse destroyOverlayTemplateAsset(overlayTemplateAsset)
+
+Auto-generated: destroyOverlayTemplateAsset
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyOverlayTemplateAssetRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplateAsset
+    overlayTemplateAsset: 56,
+  } satisfies DestroyOverlayTemplateAssetRequest;
+
+  try {
+    const data = await api.destroyOverlayTemplateAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplateAsset** | `number` | The id of the overlayTemplateAsset | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAllOverlayTemplate
+
+> OverlayTemplateLiteResourceArrayResponse getAllOverlayTemplate(getAllOverlayTemplateRequest)
+
+Auto-generated: getAllOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // GetAllOverlayTemplateRequest (optional)
+    getAllOverlayTemplateRequest: ...,
+  } satisfies GetAllOverlayTemplateOperationRequest;
+
+  try {
+    const data = await api.getAllOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllOverlayTemplateRequest** | [GetAllOverlayTemplateRequest](GetAllOverlayTemplateRequest.md) |  | [Optional] |
+
+### Return type
+
+[**OverlayTemplateLiteResourceArrayResponse**](OverlayTemplateLiteResourceArrayResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## indexOverlayTemplate
+
+> PaginatedOverlayTemplateLiteResourceResponse indexOverlayTemplate(indexOverlayTemplateRequest)
+
+Auto-generated: indexOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // IndexOverlayTemplateRequest (optional)
+    indexOverlayTemplateRequest: ...,
+  } satisfies IndexOverlayTemplateOperationRequest;
+
+  try {
+    const data = await api.indexOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexOverlayTemplateRequest** | [IndexOverlayTemplateRequest](IndexOverlayTemplateRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedOverlayTemplateLiteResourceResponse**](PaginatedOverlayTemplateLiteResourceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\OverlayTemplateLiteResource>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## linkAssetsOverlayTemplate
+
+> OverlayTemplateResource linkAssetsOverlayTemplate(overlayTemplate, linkAssetsOverlayTemplateRequest)
+
+Auto-generated: linkAssetsOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { LinkAssetsOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplate
+    overlayTemplate: 56,
+    // LinkAssetsOverlayTemplateRequest (optional)
+    linkAssetsOverlayTemplateRequest: ...,
+  } satisfies LinkAssetsOverlayTemplateOperationRequest;
+
+  try {
+    const data = await api.linkAssetsOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
+| **linkAssetsOverlayTemplateRequest** | [LinkAssetsOverlayTemplateRequest](LinkAssetsOverlayTemplateRequest.md) |  | [Optional] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showOverlayTemplate
+
+> OverlayTemplateResource showOverlayTemplate(overlayTemplate)
+
+Auto-generated: showOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplate
+    overlayTemplate: 56,
+  } satisfies ShowOverlayTemplateRequest;
+
+  try {
+    const data = await api.showOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## storeOverlayTemplate
+
+> OverlayTemplateResource storeOverlayTemplate(storeOverlayTemplateRequest)
+
+Auto-generated: storeOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // StoreOverlayTemplateRequest (optional)
+    storeOverlayTemplateRequest: ...,
+  } satisfies StoreOverlayTemplateOperationRequest;
+
+  try {
+    const data = await api.storeOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeOverlayTemplateRequest** | [StoreOverlayTemplateRequest](StoreOverlayTemplateRequest.md) |  | [Optional] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## storeOverlayTemplateAsset
+
+> OverlayTemplateResource storeOverlayTemplateAsset(storeOverlayTemplateAssetRequest)
+
+Auto-generated: storeOverlayTemplateAsset
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreOverlayTemplateAssetOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // StoreOverlayTemplateAssetRequest (optional)
+    storeOverlayTemplateAssetRequest: ...,
+  } satisfies StoreOverlayTemplateAssetOperationRequest;
+
+  try {
+    const data = await api.storeOverlayTemplateAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeOverlayTemplateAssetRequest** | [StoreOverlayTemplateAssetRequest](StoreOverlayTemplateAssetRequest.md) |  | [Optional] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## unlinkAssetOverlayTemplate
+
+> OverlayTemplateResource unlinkAssetOverlayTemplate(overlayTemplate, asset)
+
+Auto-generated: unlinkAssetOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UnlinkAssetOverlayTemplateRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplate
+    overlayTemplate: 56,
+    // number | The id of the asset
+    asset: 56,
+  } satisfies UnlinkAssetOverlayTemplateRequest;
+
+  try {
+    const data = await api.unlinkAssetOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
+| **asset** | `number` | The id of the asset | [Defaults to `undefined`] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateOverlayTemplate
+
+> OverlayTemplateResource updateOverlayTemplate(overlayTemplate, updateOverlayTemplateRequest)
+
+Auto-generated: updateOverlayTemplate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateOverlayTemplateOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplate
+    overlayTemplate: 56,
+    // UpdateOverlayTemplateRequest (optional)
+    updateOverlayTemplateRequest: ...,
+  } satisfies UpdateOverlayTemplateOperationRequest;
+
+  try {
+    const data = await api.updateOverlayTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplate** | `number` | The id of the overlayTemplate | [Defaults to `undefined`] |
+| **updateOverlayTemplateRequest** | [UpdateOverlayTemplateRequest](UpdateOverlayTemplateRequest.md) |  | [Optional] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateOverlayTemplateAsset
+
+> OverlayTemplateResource updateOverlayTemplateAsset(overlayTemplateAsset, updateOverlayTemplateAssetRequest)
+
+Auto-generated: updateOverlayTemplateAsset
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OverlayTemplateApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateOverlayTemplateAssetOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OverlayTemplateApi();
+
+  const body = {
+    // number | The id of the overlayTemplateAsset
+    overlayTemplateAsset: 56,
+    // UpdateOverlayTemplateAssetRequest (optional)
+    updateOverlayTemplateAssetRequest: ...,
+  } satisfies UpdateOverlayTemplateAssetOperationRequest;
+
+  try {
+    const data = await api.updateOverlayTemplateAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **overlayTemplateAsset** | `number` | The id of the overlayTemplateAsset | [Defaults to `undefined`] |
+| **updateOverlayTemplateAssetRequest** | [UpdateOverlayTemplateAssetRequest](UpdateOverlayTemplateAssetRequest.md) |  | [Optional] |
+
+### Return type
+
+[**OverlayTemplateResource**](OverlayTemplateResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+