@digital8/lighting-illusions-ts-sdk 0.0.621 → 0.0.623

package/docs/DefinitionApi.md

@@ -0,0 +1,407 @@
+# DefinitionApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyDefinition**](DefinitionApi.md#destroydefinition) | **DELETE** /admin-api/definition/{definition}/delete | Auto-generated: destroyDefinition |
+| [**getAllDefinition**](DefinitionApi.md#getalldefinitionoperation) | **POST** /admin-api/definition/all | Auto-generated: getAllDefinition |
+| [**indexDefinition**](DefinitionApi.md#indexdefinitionoperation) | **POST** /admin-api/definition/list | Auto-generated: indexDefinition |
+| [**showDefinition**](DefinitionApi.md#showdefinition) | **GET** /admin-api/definition/{definition} | Auto-generated: showDefinition |
+| [**storeDefinition**](DefinitionApi.md#storedefinitionoperation) | **POST** /admin-api/definition/create | Auto-generated: storeDefinition |
+| [**updateDefinition**](DefinitionApi.md#updatedefinitionoperation) | **PUT** /admin-api/definition/{definition}/update | Auto-generated: updateDefinition |
+
+
+
+## destroyDefinition
+
+> GenericResponse destroyDefinition(definition)
+
+Auto-generated: destroyDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // number | The id of the definition
+    definition: 56,
+  } satisfies DestroyDefinitionRequest;
+
+  try {
+    const data = await api.destroyDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **definition** | `number` | The id of the definition | [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)
+
+
+## getAllDefinition
+
+> DefinitionListResourceArrayResponse getAllDefinition(getAllDefinitionRequest)
+
+Auto-generated: getAllDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // GetAllDefinitionRequest (optional)
+    getAllDefinitionRequest: ...,
+  } satisfies GetAllDefinitionOperationRequest;
+
+  try {
+    const data = await api.getAllDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllDefinitionRequest** | [GetAllDefinitionRequest](GetAllDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**DefinitionListResourceArrayResponse**](DefinitionListResourceArrayResponse.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)
+
+
+## indexDefinition
+
+> PaginatedDefinitionListResourceResponse indexDefinition(indexDefinitionRequest)
+
+Auto-generated: indexDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // IndexDefinitionRequest (optional)
+    indexDefinitionRequest: ...,
+  } satisfies IndexDefinitionOperationRequest;
+
+  try {
+    const data = await api.indexDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexDefinitionRequest** | [IndexDefinitionRequest](IndexDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedDefinitionListResourceResponse**](PaginatedDefinitionListResourceResponse.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<\\DefinitionListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showDefinition
+
+> DefinitionResource showDefinition(definition)
+
+Auto-generated: showDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // number | The id of the definition
+    definition: 56,
+  } satisfies ShowDefinitionRequest;
+
+  try {
+    const data = await api.showDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **definition** | `number` | The id of the definition | [Defaults to `undefined`] |
+
+### Return type
+
+[**DefinitionResource**](DefinitionResource.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)
+
+
+## storeDefinition
+
+> DefinitionResource storeDefinition(storeDefinitionRequest)
+
+Auto-generated: storeDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // StoreDefinitionRequest (optional)
+    storeDefinitionRequest: ...,
+  } satisfies StoreDefinitionOperationRequest;
+
+  try {
+    const data = await api.storeDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeDefinitionRequest** | [StoreDefinitionRequest](StoreDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**DefinitionResource**](DefinitionResource.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)
+
+
+## updateDefinition
+
+> DefinitionResource updateDefinition(definition, updateDefinitionRequest)
+
+Auto-generated: updateDefinition
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefinitionApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateDefinitionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new DefinitionApi();
+
+  const body = {
+    // number | The id of the definition
+    definition: 56,
+    // UpdateDefinitionRequest (optional)
+    updateDefinitionRequest: ...,
+  } satisfies UpdateDefinitionOperationRequest;
+
+  try {
+    const data = await api.updateDefinition(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **definition** | `number` | The id of the definition | [Defaults to `undefined`] |
+| **updateDefinitionRequest** | [UpdateDefinitionRequest](UpdateDefinitionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**DefinitionResource**](DefinitionResource.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)
+

package/docs/{DocumentFrontendResource.md → DefinitionListResource.md}

@@ -1,5 +1,5 @@
 
-# DocumentFrontendResource
+# DefinitionListResource
 
 
 ## Properties
@@ -8,19 +8,17 @@ Name | Type
 ------------ | -------------
 `id` | number
 `name` | string
-`fileUrl` | string
 
 ## Example
 
 ```typescript
-import type { DocumentFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { DefinitionListResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
   "name": null,
-  "fileUrl": null,
-} satisfies DocumentFrontendResource
+} satisfies DefinitionListResource
 
 console.log(example)
 
@@ -29,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as DocumentFrontendResource
+const exampleParsed = JSON.parse(exampleJSON) as DefinitionListResource
 console.log(exampleParsed)
 ```
 

package/docs/{ProductCompareResourceArrayResponse.md → DefinitionListResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# ProductCompareResourceArrayResponse
+# DefinitionListResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<ProductCompareResource>](ProductCompareResource.md)
+`data` | [Array<DefinitionListResource>](DefinitionListResource.md)
 
 ## Example
 
 ```typescript
-import type { ProductCompareResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { DefinitionListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies ProductCompareResourceArrayResponse
+} satisfies DefinitionListResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ProductCompareResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as DefinitionListResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{DocumentFrontendResourceArrayResponse.md → DefinitionResource.md}

@@ -1,22 +1,26 @@
 
-# DocumentFrontendResourceArrayResponse
+# DefinitionResource
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<DocumentFrontendResource>](DocumentFrontendResource.md)
+`id` | number
+`name` | string
+`content` | string
 
 ## Example
 
 ```typescript
-import type { DocumentFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { DefinitionResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
-} satisfies DocumentFrontendResourceArrayResponse
+  "id": null,
+  "name": null,
+  "content": null,
+} satisfies DefinitionResource
 
 console.log(example)
 
@@ -25,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as DocumentFrontendResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as DefinitionResource
 console.log(exampleParsed)
 ```
 

package/docs/{AssetFrontendResourceArrayResponse.md → DefinitionResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# AssetFrontendResourceArrayResponse
+# DefinitionResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<AssetFrontendResource>](AssetFrontendResource.md)
+`data` | [Array<DefinitionResource>](DefinitionResource.md)
 
 ## Example
 
 ```typescript
-import type { AssetFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { DefinitionResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies AssetFrontendResourceArrayResponse
+} satisfies DefinitionResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AssetFrontendResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as DefinitionResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/GetAllDefinitionRequest.md

@@ -0,0 +1,44 @@
+
+# GetAllDefinitionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { GetAllDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies GetAllDefinitionRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetAllDefinitionRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/IndexDefinitionRequest.md

@@ -0,0 +1,48 @@
+
+# IndexDefinitionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "perPage": null,
+  "page": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexDefinitionRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as IndexDefinitionRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/{OverlayTemplateAssetFrontendResourceArrayResponse.md → PaginatedDefinitionListResourceResponse.md}

@@ -1,22 +1,24 @@
 
-# OverlayTemplateAssetFrontendResourceArrayResponse
+# PaginatedDefinitionListResourceResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<OverlayTemplateAssetFrontendResource>](OverlayTemplateAssetFrontendResource.md)
+`data` | [Array<DefinitionListResource>](DefinitionListResource.md)
+`meta` | [PagingMetadata](PagingMetadata.md)
 
 ## Example
 
 ```typescript
-import type { OverlayTemplateAssetFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { PaginatedDefinitionListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies OverlayTemplateAssetFrontendResourceArrayResponse
+  "meta": null,
+} satisfies PaginatedDefinitionListResourceResponse
 
 console.log(example)
 
@@ -25,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as OverlayTemplateAssetFrontendResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedDefinitionListResourceResponse
 console.log(exampleParsed)
 ```