@digital8/lighting-illusions-ts-sdk 0.0.1513 → 0.0.1514

package/docs/MenuItemsApi.md

@@ -1,473 +0,0 @@
-# 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
-
-> MenuItemResourceArrayResponse 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
-
-[**MenuItemResourceArrayResponse**](MenuItemResourceArrayResponse.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
-
-> MenuItemEditResource 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
-
-[**MenuItemEditResource**](MenuItemEditResource.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
-
-> MenuItemEditResource 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
-
-[**MenuItemEditResource**](MenuItemEditResource.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
-
-> MenuItemEditResource 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
-
-[**MenuItemEditResource**](MenuItemEditResource.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/MenuListResourceArrayResponse.md

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

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

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

@@ -1,38 +0,0 @@
-
-# SearchLinkablesMenuItemRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`types` | Array<string>
-`siteId` | number
-
-## Example
-
-```typescript
-import type { SearchLinkablesMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "types": null,
-  "siteId": null,
-} satisfies SearchLinkablesMenuItemRequest
-
-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 SearchLinkablesMenuItemRequest
-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/StoreMenuItemRequest.md

@@ -1,52 +0,0 @@
-
-# StoreMenuItemRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`menuId` | number
-`parentId` | number
-`type` | string
-`heading` | string
-`subheading` | string
-`css` | string
-`cssMobile` | string
-`javascript` | string
-`index` | number
-`menuItemLink` | [StoreMenuItemRequestMenuItemLink](StoreMenuItemRequestMenuItemLink.md)
-
-## Example
-
-```typescript
-import type { StoreMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "menuId": null,
-  "parentId": null,
-  "type": null,
-  "heading": null,
-  "subheading": null,
-  "css": null,
-  "cssMobile": null,
-  "javascript": null,
-  "index": null,
-  "menuItemLink": null,
-} satisfies StoreMenuItemRequest
-
-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 StoreMenuItemRequest
-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/StoreMenuItemRequestMenuItemLink.md

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