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

package/docs/MenuPosition.md

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,38 @@
+
+# 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/StoreFrontendResource.md

@@ -10,7 +10,6 @@ Name | Type
 `siteId` | number
 `name` | string
 `email` | string
-`website` | string
 `phone` | string
 `address` | string
 `latitude` | number
@@ -31,7 +30,6 @@ const example = {
   "siteId": null,
   "name": null,
   "email": null,
-  "website": null,
   "phone": null,
   "address": null,
   "latitude": null,

package/docs/StoreListResource.md

@@ -14,7 +14,6 @@ Name | Type
 `latitude` | number
 `tagLine` | string
 `email` | string
-`website` | string
 `openingHours` | string
 
 ## Example
@@ -32,7 +31,6 @@ const example = {
   "latitude": null,
   "tagLine": null,
   "email": null,
-  "website": null,
   "openingHours": null,
 } satisfies StoreListResource
 

package/docs/StoreMenuItemRequest.md

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

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

@@ -0,0 +1,38 @@
+
+# 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/StoreResource.md

@@ -14,7 +14,6 @@ Name | Type
 `latitude` | number
 `tagLine` | string
 `email` | string
-`website` | string
 `openingHours` | string
 `suppliers` | [Array<SupplierLiteResource>](SupplierLiteResource.md)
 `address` | [AddressResource](AddressResource.md)
@@ -35,7 +34,6 @@ const example = {
   "latitude": null,
   "tagLine": null,
   "email": null,
-  "website": null,
   "openingHours": null,
   "suppliers": null,
   "address": null,

package/docs/StoreStoreRequest.md

@@ -13,8 +13,7 @@ Name | Type
 `latitude` | number
 `tagLine` | string
 `email` | string
-`website` | string
-`openingHours` | Array<string | null>
+`openingHours` | Array<string>
 `supplierIds` | Array<number>
 `specialDates` | [Array<StoreStoreRequestSpecialDatesInner>](StoreStoreRequestSpecialDatesInner.md)
 `address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
@@ -33,7 +32,6 @@ const example = {
   "latitude": null,
   "tagLine": null,
   "email": null,
-  "website": null,
   "openingHours": null,
   "supplierIds": null,
   "specialDates": null,