@digital8/lighting-illusions-ts-sdk 0.0.1613 → 0.0.1614

package/docs/IndexRedirectRequest.md

@@ -0,0 +1,52 @@
+
+# IndexRedirectRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`redirectableType` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexRedirectRequest } 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,
+  "siteId": null,
+  "redirectableType": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexRedirectRequest
+
+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 IndexRedirectRequest
+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/LabelListResource.md

@@ -9,7 +9,6 @@ Name | Type
 `id` | number
 `shortName` | string
 `longName` | string
-`productCount` | number
 `colour` | string
 `textColour` | string
 `startDate` | string
@@ -26,7 +25,6 @@ const example = {
   "id": null,
   "shortName": null,
   "longName": null,
-  "productCount": null,
   "colour": null,
   "textColour": null,
   "startDate": null,

package/docs/MenuApi.md

@@ -0,0 +1,407 @@
+# MenuApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**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 |
+
+
+
+## destroyMenu
+
+> GenericResponse destroyMenu(menu)
+
+Auto-generated: destroyMenu
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuApi,
+} 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 MenuApi();
+
+  const body = {
+    // number | The id of the menu
+    menu: 56,
+  } satisfies DestroyMenuRequest;
+
+  try {
+    const data = await api.destroyMenu(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **menu** | `number` | The id of the menu | [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)
+
+
+## getAllMenu
+
+> MenuListResourceArrayResponse getAllMenu(getAllMenuRequest)
+
+Auto-generated: getAllMenu
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuApi,
+} 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 MenuApi();
+
+  const body = {
+    // GetAllMenuRequest (optional)
+    getAllMenuRequest: ...,
+  } satisfies GetAllMenuOperationRequest;
+
+  try {
+    const data = await api.getAllMenu(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllMenuRequest** | [GetAllMenuRequest](GetAllMenuRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuListResourceArrayResponse**](MenuListResourceArrayResponse.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)
+
+
+## indexMenu
+
+> PaginatedMenuListResourceResponse indexMenu(indexMenuRequest)
+
+Auto-generated: indexMenu
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuApi,
+} 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 MenuApi();
+
+  const body = {
+    // IndexMenuRequest (optional)
+    indexMenuRequest: ...,
+  } satisfies IndexMenuOperationRequest;
+
+  try {
+    const data = await api.indexMenu(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexMenuRequest** | [IndexMenuRequest](IndexMenuRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedMenuListResourceResponse**](PaginatedMenuListResourceResponse.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<\\MenuListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showMenu
+
+> MenuResource showMenu(menu)
+
+Auto-generated: showMenu
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuApi,
+} 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 MenuApi();
+
+  const body = {
+    // number | The id of the menu
+    menu: 56,
+  } satisfies ShowMenuRequest;
+
+  try {
+    const data = await api.showMenu(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+
+### Return type
+
+[**MenuResource**](MenuResource.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)
+
+
+## storeMenu
+
+> MenuResource storeMenu(storeMenuRequest)
+
+Auto-generated: storeMenu
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuApi,
+} 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 MenuApi();
+
+  const body = {
+    // StoreMenuRequest (optional)
+    storeMenuRequest: ...,
+  } satisfies StoreMenuOperationRequest;
+
+  try {
+    const data = await api.storeMenu(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeMenuRequest** | [StoreMenuRequest](StoreMenuRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuResource**](MenuResource.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)
+
+
+## updateMenu
+
+> MenuResource updateMenu(menu, updateMenuRequest)
+
+Auto-generated: updateMenu
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MenuApi,
+} 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 MenuApi();
+
+  const body = {
+    // number | The id of the menu
+    menu: 56,
+    // UpdateMenuRequest (optional)
+    updateMenuRequest: ...,
+  } satisfies UpdateMenuOperationRequest;
+
+  try {
+    const data = await api.updateMenu(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+| **updateMenuRequest** | [UpdateMenuRequest](UpdateMenuRequest.md) |  | [Optional] |
+
+### Return type
+
+[**MenuResource**](MenuResource.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/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/MenuItemHierarchyResourceArrayResponse.md

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

@@ -0,0 +1,46 @@
+
+# MenuItemLinkResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`menuItemId` | number
+`linkableId` | number
+`linkableType` | string
+`name` | string
+`link` | string
+`isExternalLink` | boolean
+
+## Example
+
+```typescript
+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,
+  "link": null,
+  "isExternalLink": null,
+} satisfies MenuItemLinkResource
+
+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 MenuItemLinkResource
+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/MenuItemLinkResourceArrayResponse.md

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