@digital8/lighting-illusions-ts-sdk 0.0.1581 → 0.0.1583

package/docs/RedirectApi.md

@@ -1,74 +0,0 @@
-# RedirectApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**indexRedirect**](RedirectApi.md#indexredirectoperation) | **POST** /admin-api/redirect/list | Auto-generated: indexRedirect |
-
-
-
-## indexRedirect
-
-> PaginatedRedirectListResourceResponse indexRedirect(indexRedirectRequest)
-
-Auto-generated: indexRedirect
-
-### Example
-
-```ts
-import {
-  Configuration,
-  RedirectApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexRedirectOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new RedirectApi();
-
-  const body = {
-    // IndexRedirectRequest (optional)
-    indexRedirectRequest: ...,
-  } satisfies IndexRedirectOperationRequest;
-
-  try {
-    const data = await api.indexRedirect(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexRedirectRequest** | [IndexRedirectRequest](IndexRedirectRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedRedirectListResourceResponse**](PaginatedRedirectListResourceResponse.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<\\RedirectListResource[]>> |  -  |
-
-[[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/RedirectFrontendResource.md

@@ -1,44 +0,0 @@
-
-# RedirectFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`siteId` | number
-`fromSlug` | string
-`toSlug` | string
-`status` | number
-`redirectableType` | string
-
-## Example
-
-```typescript
-import type { RedirectFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "siteId": null,
-  "fromSlug": null,
-  "toSlug": null,
-  "status": null,
-  "redirectableType": null,
-} satisfies RedirectFrontendResource
-
-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 RedirectFrontendResource
-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/RedirectFrontendResourceArrayResponse.md

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

@@ -1,46 +0,0 @@
-
-# RedirectListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`redirectableType` | string
-`redirectableId` | number
-`fromSlug` | string
-`toSlug` | string
-`status` | number
-
-## Example
-
-```typescript
-import type { RedirectListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "site": null,
-  "redirectableType": null,
-  "redirectableId": null,
-  "fromSlug": null,
-  "toSlug": null,
-  "status": null,
-} satisfies RedirectListResource
-
-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 RedirectListResource
-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/RedirectListResourceArrayResponse.md

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

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

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