@digital8/lighting-illusions-ts-sdk 0.0.1528 → 0.0.1529

package/dist/models/UpdateMenuRequest.d.ts

@@ -1,61 +0,0 @@
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { UpdateMenuRequestMenuItemOrderInner } from './UpdateMenuRequestMenuItemOrderInner';
-/**
- *
- * @export
- * @interface UpdateMenuRequest
- */
-export interface UpdateMenuRequest {
-    /**
-     *
-     * @type {number}
-     * @memberof UpdateMenuRequest
-     */
-    siteId?: number;
-    /**
-     *
-     * @type {UpdateMenuRequestPositionEnum}
-     * @memberof UpdateMenuRequest
-     */
-    position?: UpdateMenuRequestPositionEnum;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateMenuRequest
-     */
-    name?: string;
-    /**
-     *
-     * @type {Array<UpdateMenuRequestMenuItemOrderInner>}
-     * @memberof UpdateMenuRequest
-     */
-    menuItemOrder?: Array<UpdateMenuRequestMenuItemOrderInner>;
-}
-/**
- * @export
- */
-export declare const UpdateMenuRequestPositionEnum: {
-    readonly Header: "header";
-    readonly HeaderSecondary: "header_secondary";
-    readonly Footer: "footer";
-    readonly FooterSecondary: "footer_secondary";
-};
-export type UpdateMenuRequestPositionEnum = typeof UpdateMenuRequestPositionEnum[keyof typeof UpdateMenuRequestPositionEnum];
-/**
- * Check if a given object implements the UpdateMenuRequest interface.
- */
-export declare function instanceOfUpdateMenuRequest(value: object): value is UpdateMenuRequest;
-export declare function UpdateMenuRequestFromJSON(json: any): UpdateMenuRequest;
-export declare function UpdateMenuRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateMenuRequest;
-export declare function UpdateMenuRequestToJSON(json: any): UpdateMenuRequest;
-export declare function UpdateMenuRequestToJSONTyped(value?: UpdateMenuRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateMenuRequest.js

@@ -1,66 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateMenuRequestPositionEnum = void 0;
-exports.instanceOfUpdateMenuRequest = instanceOfUpdateMenuRequest;
-exports.UpdateMenuRequestFromJSON = UpdateMenuRequestFromJSON;
-exports.UpdateMenuRequestFromJSONTyped = UpdateMenuRequestFromJSONTyped;
-exports.UpdateMenuRequestToJSON = UpdateMenuRequestToJSON;
-exports.UpdateMenuRequestToJSONTyped = UpdateMenuRequestToJSONTyped;
-var UpdateMenuRequestMenuItemOrderInner_1 = require("./UpdateMenuRequestMenuItemOrderInner");
-/**
- * @export
- */
-exports.UpdateMenuRequestPositionEnum = {
-    Header: 'header',
-    HeaderSecondary: 'header_secondary',
-    Footer: 'footer',
-    FooterSecondary: 'footer_secondary'
-};
-/**
- * Check if a given object implements the UpdateMenuRequest interface.
- */
-function instanceOfUpdateMenuRequest(value) {
-    return true;
-}
-function UpdateMenuRequestFromJSON(json) {
-    return UpdateMenuRequestFromJSONTyped(json, false);
-}
-function UpdateMenuRequestFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'siteId': json['site_id'] == null ? undefined : json['site_id'],
-        'position': json['position'] == null ? undefined : json['position'],
-        'name': json['name'] == null ? undefined : json['name'],
-        'menuItemOrder': json['menu_item_order'] == null ? undefined : (json['menu_item_order'].map(UpdateMenuRequestMenuItemOrderInner_1.UpdateMenuRequestMenuItemOrderInnerFromJSON)),
-    };
-}
-function UpdateMenuRequestToJSON(json) {
-    return UpdateMenuRequestToJSONTyped(json, false);
-}
-function UpdateMenuRequestToJSONTyped(value, ignoreDiscriminator) {
-    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
-    if (value == null) {
-        return value;
-    }
-    return {
-        'site_id': value['siteId'],
-        'position': value['position'],
-        'name': value['name'],
-        'menu_item_order': value['menuItemOrder'] == null ? undefined : (value['menuItemOrder'].map(UpdateMenuRequestMenuItemOrderInner_1.UpdateMenuRequestMenuItemOrderInnerToJSON)),
-    };
-}

package/dist/models/UpdateMenuRequestMenuItemOrderInner.d.ts

@@ -1,44 +0,0 @@
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface UpdateMenuRequestMenuItemOrderInner
- */
-export interface UpdateMenuRequestMenuItemOrderInner {
-    /**
-     *
-     * @type {number}
-     * @memberof UpdateMenuRequestMenuItemOrderInner
-     */
-    id?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof UpdateMenuRequestMenuItemOrderInner
-     */
-    index?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof UpdateMenuRequestMenuItemOrderInner
-     */
-    parentId?: number;
-}
-/**
- * Check if a given object implements the UpdateMenuRequestMenuItemOrderInner interface.
- */
-export declare function instanceOfUpdateMenuRequestMenuItemOrderInner(value: object): value is UpdateMenuRequestMenuItemOrderInner;
-export declare function UpdateMenuRequestMenuItemOrderInnerFromJSON(json: any): UpdateMenuRequestMenuItemOrderInner;
-export declare function UpdateMenuRequestMenuItemOrderInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateMenuRequestMenuItemOrderInner;
-export declare function UpdateMenuRequestMenuItemOrderInnerToJSON(json: any): UpdateMenuRequestMenuItemOrderInner;
-export declare function UpdateMenuRequestMenuItemOrderInnerToJSONTyped(value?: UpdateMenuRequestMenuItemOrderInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateMenuRequestMenuItemOrderInner.js

@@ -1,53 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfUpdateMenuRequestMenuItemOrderInner = instanceOfUpdateMenuRequestMenuItemOrderInner;
-exports.UpdateMenuRequestMenuItemOrderInnerFromJSON = UpdateMenuRequestMenuItemOrderInnerFromJSON;
-exports.UpdateMenuRequestMenuItemOrderInnerFromJSONTyped = UpdateMenuRequestMenuItemOrderInnerFromJSONTyped;
-exports.UpdateMenuRequestMenuItemOrderInnerToJSON = UpdateMenuRequestMenuItemOrderInnerToJSON;
-exports.UpdateMenuRequestMenuItemOrderInnerToJSONTyped = UpdateMenuRequestMenuItemOrderInnerToJSONTyped;
-/**
- * Check if a given object implements the UpdateMenuRequestMenuItemOrderInner interface.
- */
-function instanceOfUpdateMenuRequestMenuItemOrderInner(value) {
-    return true;
-}
-function UpdateMenuRequestMenuItemOrderInnerFromJSON(json) {
-    return UpdateMenuRequestMenuItemOrderInnerFromJSONTyped(json, false);
-}
-function UpdateMenuRequestMenuItemOrderInnerFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'id': json['id'] == null ? undefined : json['id'],
-        'index': json['index'] == null ? undefined : json['index'],
-        'parentId': json['parent_id'] == null ? undefined : json['parent_id'],
-    };
-}
-function UpdateMenuRequestMenuItemOrderInnerToJSON(json) {
-    return UpdateMenuRequestMenuItemOrderInnerToJSONTyped(json, false);
-}
-function UpdateMenuRequestMenuItemOrderInnerToJSONTyped(value, ignoreDiscriminator) {
-    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
-    if (value == null) {
-        return value;
-    }
-    return {
-        'id': value['id'],
-        'index': value['index'],
-        'parent_id': value['parentId'],
-    };
-}

package/docs/GetHierarchyMenuItemRequest.md

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

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