@digital8/lighting-illusions-ts-sdk 0.0.1539 → 0.0.1541

package/docs/MenuItemsApi.md

@@ -0,0 +1,473 @@
+# MenuItemsApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyMenuItem**](MenuItemsApi.md#destroymenuitem) | **DELETE** /admin-api/menu-items/{menuItem}/delete | Auto-generated: destroyMenuItem |
+| [**getAllMenuItem**](MenuItemsApi.md#getallmenuitemoperation) | **POST** /admin-api/menu-items/all | Auto-generated: getAllMenuItem |
+| [**getHierarchyMenuItem**](MenuItemsApi.md#gethierarchymenuitemoperation) | **POST** /admin-api/menu-items/hierarchy | Auto-generated: getHierarchyMenuItem |
+| [**searchLinkablesMenuItem**](MenuItemsApi.md#searchlinkablesmenuitemoperation) | **POST** /admin-api/menu-items/linkables/search | Auto-generated: searchLinkablesMenuItem |
+| [**showMenuItem**](MenuItemsApi.md#showmenuitem) | **GET** /admin-api/menu-items/{menuItem} | Auto-generated: showMenuItem |
+| [**storeMenuItem**](MenuItemsApi.md#storemenuitemoperation) | **POST** /admin-api/menu-items/create | Auto-generated: storeMenuItem |
+| [**updateMenuItem**](MenuItemsApi.md#updatemenuitemoperation) | **PUT** /admin-api/menu-items/{menuItem}/update | Auto-generated: updateMenuItem |
+
+
+
+## destroyMenuItem
+
+> GenericResponse destroyMenuItem(menuItem)
+
+Auto-generated: destroyMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // number | The id of the menuItem
+    menuItem: 56,
+  } satisfies DestroyMenuItemRequest;
+
+  try {
+    const data = await api.destroyMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **menuItem** | `number` | The id of the menuItem | [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<array{message: string}> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAllMenuItem
+
+> MenuItemLiteResourceArrayResponse getAllMenuItem(getAllMenuItemRequest)
+
+Auto-generated: getAllMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // GetAllMenuItemRequest (optional)
+    getAllMenuItemRequest: ...,
+  } satisfies GetAllMenuItemOperationRequest;
+
+  try {
+    const data = await api.getAllMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllMenuItemRequest** | [GetAllMenuItemRequest](GetAllMenuItemRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuItemLiteResourceArrayResponse**](MenuItemLiteResourceArrayResponse.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)
+
+
+## getHierarchyMenuItem
+
+> MenuItemHierarchyResourceArrayResponse getHierarchyMenuItem(getHierarchyMenuItemRequest)
+
+Auto-generated: getHierarchyMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetHierarchyMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // GetHierarchyMenuItemRequest (optional)
+    getHierarchyMenuItemRequest: ...,
+  } satisfies GetHierarchyMenuItemOperationRequest;
+
+  try {
+    const data = await api.getHierarchyMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuItemHierarchyResourceArrayResponse**](MenuItemHierarchyResourceArrayResponse.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)
+
+
+## searchLinkablesMenuItem
+
+> GenericResponse searchLinkablesMenuItem(searchLinkablesMenuItemRequest)
+
+Auto-generated: searchLinkablesMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { SearchLinkablesMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // SearchLinkablesMenuItemRequest (optional)
+    searchLinkablesMenuItemRequest: ...,
+  } satisfies SearchLinkablesMenuItemOperationRequest;
+
+  try {
+    const data = await api.searchLinkablesMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchLinkablesMenuItemRequest** | [SearchLinkablesMenuItemRequest](SearchLinkablesMenuItemRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse<array{data: array<int,array{id: int, slug: string|null, name: string, linkable_type: string}>}> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showMenuItem
+
+> MenuItemResource showMenuItem(menuItem)
+
+Auto-generated: showMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // number | The id of the menuItem
+    menuItem: 56,
+  } satisfies ShowMenuItemRequest;
+
+  try {
+    const data = await api.showMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
+
+### Return type
+
+[**MenuItemResource**](MenuItemResource.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)
+
+
+## storeMenuItem
+
+> MenuItemResource storeMenuItem(storeMenuItemRequest)
+
+Auto-generated: storeMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // StoreMenuItemRequest (optional)
+    storeMenuItemRequest: ...,
+  } satisfies StoreMenuItemOperationRequest;
+
+  try {
+    const data = await api.storeMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeMenuItemRequest** | [StoreMenuItemRequest](StoreMenuItemRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuItemResource**](MenuItemResource.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)
+
+
+## updateMenuItem
+
+> MenuItemResource updateMenuItem(menuItem, updateMenuItemRequest)
+
+Auto-generated: updateMenuItem
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuItemsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateMenuItemOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new MenuItemsApi();
+
+  const body = {
+    // number | The id of the menuItem
+    menuItem: 56,
+    // UpdateMenuItemRequest (optional)
+    updateMenuItemRequest: ...,
+  } satisfies UpdateMenuItemOperationRequest;
+
+  try {
+    const data = await api.updateMenuItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **menuItem** | `number` | The id of the menuItem | [Defaults to `undefined`] |
+| **updateMenuItemRequest** | [UpdateMenuItemRequest](UpdateMenuItemRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuItemResource**](MenuItemResource.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/MenuListResource.md

@@ -0,0 +1,44 @@
+
+# MenuListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`position` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`items` | [Array<MenuItemLiteResource>](MenuItemLiteResource.md)
+`menuItemCount` | number
+
+## Example
+
+```typescript
+import type { MenuListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "position": null,
+  "site": null,
+  "items": null,
+  "menuItemCount": null,
+} satisfies MenuListResource
+
+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 MenuListResource
+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/MenuListResourceArrayResponse.md

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

@@ -0,0 +1,32 @@
+
+# MenuPosition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MenuPosition } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MenuPosition
+
+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 MenuPosition
+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/MenuResource.md

@@ -0,0 +1,44 @@
+
+# MenuResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`siteId` | number
+`position` | string
+`name` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`menuItemCount` | number
+
+## Example
+
+```typescript
+import type { MenuResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "siteId": null,
+  "position": null,
+  "name": null,
+  "site": null,
+  "menuItemCount": null,
+} satisfies MenuResource
+
+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 MenuResource
+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/MenuResourceArrayResponse.md

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

@@ -0,0 +1,44 @@
+
+# ModelAttributeListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`value` | string
+`attribute` | [AttributeLiteResource](AttributeLiteResource.md)
+`attributeValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
+`selectedValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
+`order` | string
+
+## Example
+
+```typescript
+import type { ModelAttributeListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "value": null,
+  "attribute": null,
+  "attributeValues": null,
+  "selectedValues": null,
+  "order": null,
+} satisfies ModelAttributeListResource
+
+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 ModelAttributeListResource
+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)
+
+