@digital8/lighting-illusions-ts-sdk 0.0.618 → 0.0.620

package/docs/DefinitionApi.md

@@ -1,407 +0,0 @@
-# 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
-
-> DefinitionLiteResourceArrayResponse 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
-
-[**DefinitionLiteResourceArrayResponse**](DefinitionLiteResourceArrayResponse.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/GetAllDefinitionRequest.md

@@ -1,44 +0,0 @@
-
-# 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

@@ -1,48 +0,0 @@
-
-# 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/PaginatedDefinitionLiteResourceResponse.md

@@ -1,36 +0,0 @@
-
-# PaginatedDefinitionLiteResourceResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<DefinitionLiteResource>](DefinitionLiteResource.md)
-`meta` | [PagingMetadata](PagingMetadata.md)
-
-## Example
-
-```typescript
-import type { PaginatedDefinitionLiteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-  "meta": null,
-} satisfies PaginatedDefinitionLiteResourceResponse
-
-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 PaginatedDefinitionLiteResourceResponse
-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/PaginatedDefinitionResourceResponse.md

@@ -1,36 +0,0 @@
-
-# PaginatedDefinitionResourceResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`data` | [Array<DefinitionResource>](DefinitionResource.md)
-`meta` | [PagingMetadata](PagingMetadata.md)
-
-## Example
-
-```typescript
-import type { PaginatedDefinitionResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "data": null,
-  "meta": null,
-} satisfies PaginatedDefinitionResourceResponse
-
-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 PaginatedDefinitionResourceResponse
-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/UpdateDefinitionRequest.md

@@ -1,36 +0,0 @@
-
-# UpdateDefinitionRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`content` | string
-
-## Example
-
-```typescript
-import type { UpdateDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "content": null,
-} satisfies UpdateDefinitionRequest
-
-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 UpdateDefinitionRequest
-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)
-
-