@digital8/lighting-illusions-ts-sdk 0.0.1749 → 0.0.1751

package/docs/{PageApi.md → MenuApi.md}

@@ -1,44 +1,44 @@
-# PageApi
+# MenuApi
 
 All URIs are relative to *http://localhost/api*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**destroyPage**](PageApi.md#destroypage) | **DELETE** /admin-api/page/{page}/delete | Auto-generated: destroyPage |
-| [**getAllPage**](PageApi.md#getallpageoperation) | **POST** /admin-api/page/all | Auto-generated: getAllPage |
-| [**indexPage**](PageApi.md#indexpageoperation) | **POST** /admin-api/page/list | Auto-generated: indexPage |
-| [**showPage**](PageApi.md#showpage) | **GET** /admin-api/page/{page} | Auto-generated: showPage |
-| [**storePage**](PageApi.md#storepageoperation) | **POST** /admin-api/page/create | Auto-generated: storePage |
-| [**updatePage**](PageApi.md#updatepageoperation) | **PUT** /admin-api/page/{page}/update | Auto-generated: updatePage |
+| [**destroyMenu**](MenuApi.md#destroymenu) | **DELETE** /admin-api/menu/{menu}/delete | Auto-generated: destroyMenu |
+| [**getAllMenu**](MenuApi.md#getallmenuoperation) | **POST** /admin-api/menu/all | Auto-generated: getAllMenu |
+| [**indexMenu**](MenuApi.md#indexmenuoperation) | **POST** /admin-api/menu/list | Auto-generated: indexMenu |
+| [**showMenu**](MenuApi.md#showmenu) | **GET** /admin-api/menu/{menu} | Auto-generated: showMenu |
+| [**storeMenu**](MenuApi.md#storemenuoperation) | **POST** /admin-api/menu/create | Auto-generated: storeMenu |
+| [**updateMenu**](MenuApi.md#updatemenuoperation) | **PUT** /admin-api/menu/{menu}/update | Auto-generated: updateMenu |
 
 
 
-## destroyPage
+## destroyMenu
 
-> GenericResponse destroyPage(page)
+> GenericResponse destroyMenu(menu)
 
-Auto-generated: destroyPage
+Auto-generated: destroyMenu
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  PageApi,
+  MenuApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyPageRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyMenuRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
+  const api = new MenuApi();
 
   const body = {
-    // number | The id of the page
-    page: 56,
-  } satisfies DestroyPageRequest;
+    // number | The id of the menu
+    menu: 56,
+  } satisfies DestroyMenuRequest;
 
   try {
-    const data = await api.destroyPage(body);
+    const data = await api.destroyMenu(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -54,7 +54,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **page** | `number` | The id of the page | [Defaults to `undefined`] |
+| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -73,37 +73,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | \\JsonResponse |  -  |
+| **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)
 
 
-## getAllPage
+## getAllMenu
 
-> PageLiteResourceArrayResponse getAllPage(getAllPageRequest)
+> MenuListResourceArrayResponse getAllMenu(getAllMenuRequest)
 
-Auto-generated: getAllPage
+Auto-generated: getAllMenu
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  PageApi,
+  MenuApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllPageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
+  const api = new MenuApi();
 
   const body = {
-    // GetAllPageRequest (optional)
-    getAllPageRequest: ...,
-  } satisfies GetAllPageOperationRequest;
+    // GetAllMenuRequest (optional)
+    getAllMenuRequest: ...,
+  } satisfies GetAllMenuOperationRequest;
 
   try {
-    const data = await api.getAllPage(body);
+    const data = await api.getAllMenu(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -119,11 +119,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getAllPageRequest** | [GetAllPageRequest](GetAllPageRequest.md) |  | [Optional] |
+| **getAllMenuRequest** | [GetAllMenuRequest](GetAllMenuRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PageLiteResourceArrayResponse**](PageLiteResourceArrayResponse.md)
+[**MenuListResourceArrayResponse**](MenuListResourceArrayResponse.md)
 
 ### Authorization
 
@@ -143,32 +143,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## indexPage
+## indexMenu
 
-> PaginatedPageListResourceResponse indexPage(indexPageRequest)
+> PaginatedMenuListResourceResponse indexMenu(indexMenuRequest)
 
-Auto-generated: indexPage
+Auto-generated: indexMenu
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  PageApi,
+  MenuApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexPageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
+  const api = new MenuApi();
 
   const body = {
-    // IndexPageRequest (optional)
-    indexPageRequest: ...,
-  } satisfies IndexPageOperationRequest;
+    // IndexMenuRequest (optional)
+    indexMenuRequest: ...,
+  } satisfies IndexMenuOperationRequest;
 
   try {
-    const data = await api.indexPage(body);
+    const data = await api.indexMenu(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -184,11 +184,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexPageRequest** | [IndexPageRequest](IndexPageRequest.md) |  | [Optional] |
+| **indexMenuRequest** | [IndexMenuRequest](IndexMenuRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PaginatedPageListResourceResponse**](PaginatedPageListResourceResponse.md)
+[**PaginatedMenuListResourceResponse**](PaginatedMenuListResourceResponse.md)
 
 ### Authorization
 
@@ -203,37 +203,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\PageListResource[]>> |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\MenuListResource[]>> |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## showPage
+## showMenu
 
-> PageResource showPage(page)
+> MenuResource showMenu(menu)
 
-Auto-generated: showPage
+Auto-generated: showMenu
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  PageApi,
+  MenuApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowPageRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowMenuRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
+  const api = new MenuApi();
 
   const body = {
-    // number | The id of the page
-    page: 56,
-  } satisfies ShowPageRequest;
+    // number | The id of the menu
+    menu: 56,
+  } satisfies ShowMenuRequest;
 
   try {
-    const data = await api.showPage(body);
+    const data = await api.showMenu(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -249,11 +249,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **page** | `number` | The id of the page | [Defaults to `undefined`] |
+| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
 
 ### Return type
 
-[**PageResource**](PageResource.md)
+[**MenuResource**](MenuResource.md)
 
 ### Authorization
 
@@ -273,32 +273,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## storePage
+## storeMenu
 
-> PageResource storePage(storePageRequest)
+> MenuResource storeMenu(storeMenuRequest)
 
-Auto-generated: storePage
+Auto-generated: storeMenu
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  PageApi,
+  MenuApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StorePageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
+  const api = new MenuApi();
 
   const body = {
-    // StorePageRequest (optional)
-    storePageRequest: ...,
-  } satisfies StorePageOperationRequest;
+    // StoreMenuRequest (optional)
+    storeMenuRequest: ...,
+  } satisfies StoreMenuOperationRequest;
 
   try {
-    const data = await api.storePage(body);
+    const data = await api.storeMenu(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -314,11 +314,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **storePageRequest** | [StorePageRequest](StorePageRequest.md) |  | [Optional] |
+| **storeMenuRequest** | [StoreMenuRequest](StoreMenuRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PageResource**](PageResource.md)
+[**MenuResource**](MenuResource.md)
 
 ### Authorization
 
@@ -338,34 +338,34 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## updatePage
+## updateMenu
 
-> PageResource updatePage(page, updatePageRequest)
+> MenuResource updateMenu(menu, updateMenuRequest)
 
-Auto-generated: updatePage
+Auto-generated: updateMenu
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  PageApi,
+  MenuApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdatePageOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new PageApi();
+  const api = new MenuApi();
 
   const body = {
-    // number | The id of the page
-    page: 56,
-    // UpdatePageRequest (optional)
-    updatePageRequest: ...,
-  } satisfies UpdatePageOperationRequest;
+    // number | The id of the menu
+    menu: 56,
+    // UpdateMenuRequest (optional)
+    updateMenuRequest: ...,
+  } satisfies UpdateMenuOperationRequest;
 
   try {
-    const data = await api.updatePage(body);
+    const data = await api.updateMenu(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -381,12 +381,12 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **page** | `number` | The id of the page | [Defaults to `undefined`] |
-| **updatePageRequest** | [UpdatePageRequest](UpdatePageRequest.md) |  | [Optional] |
+| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+| **updateMenuRequest** | [UpdateMenuRequest](UpdateMenuRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PageResource**](PageResource.md)
+[**MenuResource**](MenuResource.md)
 
 ### Authorization
 

package/docs/MenuItemHierarchyResource.md

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

@@ -1,22 +1,22 @@
 
-# FrontendComponentResourceArrayResponse
+# MenuItemHierarchyResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<FrontendComponentResource>](FrontendComponentResource.md)
+`data` | [Array<MenuItemHierarchyResource>](MenuItemHierarchyResource.md)
 
 ## Example
 
 ```typescript
-import type { FrontendComponentResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { MenuItemHierarchyResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies FrontendComponentResourceArrayResponse
+} satisfies MenuItemHierarchyResourceArrayResponse
 
 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 FrontendComponentResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as MenuItemHierarchyResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{BlogCategoryResource.md → MenuItemLinkResource.md}

@@ -1,5 +1,5 @@
 
-# BlogCategoryResource
+# MenuItemLinkResource
 
 
 ## Properties
@@ -7,24 +7,28 @@
 Name | Type
 ------------ | -------------
 `id` | number
+`menuItemId` | number
+`linkableId` | number
+`linkableType` | string
 `name` | string
-`slug` | string
-`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
-`seo` | [Array<SEOResource>](SEOResource.md)
+`link` | string
+`isExternalLink` | boolean
 
 ## Example
 
 ```typescript
-import type { BlogCategoryResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { MenuItemLinkResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
+  "menuItemId": null,
+  "linkableId": null,
+  "linkableType": null,
   "name": null,
-  "slug": null,
-  "descriptions": null,
-  "seo": null,
-} satisfies BlogCategoryResource
+  "link": null,
+  "isExternalLink": null,
+} satisfies MenuItemLinkResource
 
 console.log(example)
 
@@ -33,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as BlogCategoryResource
+const exampleParsed = JSON.parse(exampleJSON) as MenuItemLinkResource
 console.log(exampleParsed)
 ```
 

package/docs/{BlogCategoryResourceArrayResponse.md → MenuItemLinkResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# BlogCategoryResourceArrayResponse
+# MenuItemLinkResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<BlogCategoryResource>](BlogCategoryResource.md)
+`data` | [Array<MenuItemLinkResource>](MenuItemLinkResource.md)
 
 ## Example
 
 ```typescript
-import type { BlogCategoryResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { MenuItemLinkResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies BlogCategoryResourceArrayResponse
+} satisfies MenuItemLinkResourceArrayResponse
 
 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 BlogCategoryResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as MenuItemLinkResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/MenuItemLiteResource.md

@@ -0,0 +1,44 @@
+
+# MenuItemLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`menuId` | number
+`parentId` | number
+`type` | string
+`heading` | string
+`index` | number
+
+## Example
+
+```typescript
+import type { MenuItemLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "menuId": null,
+  "parentId": null,
+  "type": null,
+  "heading": null,
+  "index": null,
+} satisfies MenuItemLiteResource
+
+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 MenuItemLiteResource
+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/{BlogFrontendResourceArrayResponse.md → MenuItemLiteResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# BlogFrontendResourceArrayResponse
+# MenuItemLiteResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<BlogFrontendResource>](BlogFrontendResource.md)
+`data` | [Array<MenuItemLiteResource>](MenuItemLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { BlogFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { MenuItemLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies BlogFrontendResourceArrayResponse
+} satisfies MenuItemLiteResourceArrayResponse
 
 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 BlogFrontendResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as MenuItemLiteResourceArrayResponse
 console.log(exampleParsed)
 ```