@digital8/lighting-illusions-ts-sdk 0.0.1832 → 0.0.1833

package/docs/ProductRegistrationResource.md

@@ -1,52 +0,0 @@
-
-# ProductRegistrationResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`purchasedDate` | Date
-`customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
-`address` | [AddressResource](AddressResource.md)
-`productChildren` | [Array<ProductRegistrationProductChildResource>](ProductRegistrationProductChildResource.md)
-`assets` | [Array<ProductRegistrationAssetResource>](ProductRegistrationAssetResource.md)
-`omnisendId` | string
-`omnisendSyncStatus` | string
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { ProductRegistrationResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "purchasedDate": null,
-  "customer": null,
-  "address": null,
-  "productChildren": null,
-  "assets": null,
-  "omnisendId": null,
-  "omnisendSyncStatus": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies ProductRegistrationResource
-
-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 ProductRegistrationResource
-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/ProductRegistrationResourceArrayResponse.md

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

package/docs/UpdateMenuItemRequest.md

@@ -1,52 +0,0 @@
-
-# UpdateMenuItemRequest
-
-
-## 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 { UpdateMenuItemRequest } 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 UpdateMenuItemRequest
-
-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 UpdateMenuItemRequest
-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/src/apis/MenuApi.ts

@@ -1,334 +0,0 @@
-/* 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.
- */
-
-
-import * as runtime from '../runtime';
-import type {
-  GenericResponse,
-  GetAllMenuRequest,
-  IndexMenuRequest,
-  MenuListResourceArrayResponse,
-  MenuResource,
-  PaginatedMenuListResourceResponse,
-  StoreMenuRequest,
-  UpdateMenuRequest,
-} from '../models/index';
-import {
-    GenericResponseFromJSON,
-    GenericResponseToJSON,
-    GetAllMenuRequestFromJSON,
-    GetAllMenuRequestToJSON,
-    IndexMenuRequestFromJSON,
-    IndexMenuRequestToJSON,
-    MenuListResourceArrayResponseFromJSON,
-    MenuListResourceArrayResponseToJSON,
-    MenuResourceFromJSON,
-    MenuResourceToJSON,
-    PaginatedMenuListResourceResponseFromJSON,
-    PaginatedMenuListResourceResponseToJSON,
-    StoreMenuRequestFromJSON,
-    StoreMenuRequestToJSON,
-    UpdateMenuRequestFromJSON,
-    UpdateMenuRequestToJSON,
-} from '../models/index';
-
-export interface DestroyMenuRequest {
-    menu: number;
-}
-
-export interface GetAllMenuOperationRequest {
-    getAllMenuRequest?: GetAllMenuRequest;
-}
-
-export interface IndexMenuOperationRequest {
-    indexMenuRequest?: IndexMenuRequest;
-}
-
-export interface ShowMenuRequest {
-    menu: number;
-}
-
-export interface StoreMenuOperationRequest {
-    storeMenuRequest?: StoreMenuRequest;
-}
-
-export interface UpdateMenuOperationRequest {
-    menu: number;
-    updateMenuRequest?: UpdateMenuRequest;
-}
-
-/**
- * 
- */
-export class MenuApi extends runtime.BaseAPI {
-
-    /**
-     * Creates request options for destroyMenu without sending the request
-     */
-    async destroyMenuRequestOpts(requestParameters: DestroyMenuRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['menu'] == null) {
-            throw new runtime.RequiredError(
-                'menu',
-                'Required parameter "menu" was null or undefined when calling destroyMenu().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/menu/{menu}/delete`;
-        urlPath = urlPath.replace(`{${"menu"}}`, encodeURIComponent(String(requestParameters['menu'])));
-
-        return {
-            path: urlPath,
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-
-    /**
-     * Auto-generated: destroyMenu
-     */
-    async destroyMenuRaw(requestParameters: DestroyMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
-        const requestOptions = await this.destroyMenuRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: destroyMenu
-     */
-    async destroyMenu(requestParameters: DestroyMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
-        const response = await this.destroyMenuRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for getAllMenu without sending the request
-     */
-    async getAllMenuRequestOpts(requestParameters: GetAllMenuOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/menu/all`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GetAllMenuRequestToJSON(requestParameters['getAllMenuRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: getAllMenu
-     */
-    async getAllMenuRaw(requestParameters: GetAllMenuOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MenuListResourceArrayResponse>> {
-        const requestOptions = await this.getAllMenuRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => MenuListResourceArrayResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: getAllMenu
-     */
-    async getAllMenu(requestParameters: GetAllMenuOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MenuListResourceArrayResponse> {
-        const response = await this.getAllMenuRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for indexMenu without sending the request
-     */
-    async indexMenuRequestOpts(requestParameters: IndexMenuOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/menu/list`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: IndexMenuRequestToJSON(requestParameters['indexMenuRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: indexMenu
-     */
-    async indexMenuRaw(requestParameters: IndexMenuOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedMenuListResourceResponse>> {
-        const requestOptions = await this.indexMenuRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedMenuListResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: indexMenu
-     */
-    async indexMenu(requestParameters: IndexMenuOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedMenuListResourceResponse> {
-        const response = await this.indexMenuRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for showMenu without sending the request
-     */
-    async showMenuRequestOpts(requestParameters: ShowMenuRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['menu'] == null) {
-            throw new runtime.RequiredError(
-                'menu',
-                'Required parameter "menu" was null or undefined when calling showMenu().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-
-        let urlPath = `/admin-api/menu/{menu}`;
-        urlPath = urlPath.replace(`{${"menu"}}`, encodeURIComponent(String(requestParameters['menu'])));
-
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-
-    /**
-     * Auto-generated: showMenu
-     */
-    async showMenuRaw(requestParameters: ShowMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MenuResource>> {
-        const requestOptions = await this.showMenuRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => MenuResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: showMenu
-     */
-    async showMenu(requestParameters: ShowMenuRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MenuResource> {
-        const response = await this.showMenuRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for storeMenu without sending the request
-     */
-    async storeMenuRequestOpts(requestParameters: StoreMenuOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/menu/create`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: StoreMenuRequestToJSON(requestParameters['storeMenuRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: storeMenu
-     */
-    async storeMenuRaw(requestParameters: StoreMenuOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MenuResource>> {
-        const requestOptions = await this.storeMenuRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => MenuResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: storeMenu
-     */
-    async storeMenu(requestParameters: StoreMenuOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MenuResource> {
-        const response = await this.storeMenuRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for updateMenu without sending the request
-     */
-    async updateMenuRequestOpts(requestParameters: UpdateMenuOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['menu'] == null) {
-            throw new runtime.RequiredError(
-                'menu',
-                'Required parameter "menu" was null or undefined when calling updateMenu().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/menu/{menu}/update`;
-        urlPath = urlPath.replace(`{${"menu"}}`, encodeURIComponent(String(requestParameters['menu'])));
-
-        return {
-            path: urlPath,
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: UpdateMenuRequestToJSON(requestParameters['updateMenuRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: updateMenu
-     */
-    async updateMenuRaw(requestParameters: UpdateMenuOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MenuResource>> {
-        const requestOptions = await this.updateMenuRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => MenuResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: updateMenu
-     */
-    async updateMenu(requestParameters: UpdateMenuOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MenuResource> {
-        const response = await this.updateMenuRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}