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

package/docs/ProductChildSiteDetailFrontendResource.md

@@ -1,48 +0,0 @@
-
-# ProductChildSiteDetailFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`siteId` | number
-`name` | string
-`slug` | string
-`rrpPrice` | number
-`salePrice` | number
-`label` | [LabelLiteResource](LabelLiteResource.md)
-`averageRating` | string
-
-## Example
-
-```typescript
-import type { ProductChildSiteDetailFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "siteId": null,
-  "name": null,
-  "slug": null,
-  "rrpPrice": null,
-  "salePrice": null,
-  "label": null,
-  "averageRating": null,
-} satisfies ProductChildSiteDetailFrontendResource
-
-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 ProductChildSiteDetailFrontendResource
-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/ProductChildSiteDetailFrontendResourceArrayResponse.md

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

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

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

@@ -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/StoreBlogCategoryRequest.md

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

@@ -1,50 +0,0 @@
-
-# StorePageComponentRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`pageId` | number
-`componentId` | number
-`type` | string
-`disabled` | boolean
-`order` | number
-`startDate` | Date
-`endDate` | Date
-`componentData` | object
-`relations` | [Array<StorePageComponentRequestRelationsInner>](StorePageComponentRequestRelationsInner.md)
-
-## Example
-
-```typescript
-import type { StorePageComponentRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "pageId": null,
-  "componentId": null,
-  "type": null,
-  "disabled": null,
-  "order": null,
-  "startDate": null,
-  "endDate": null,
-  "componentData": null,
-  "relations": null,
-} satisfies StorePageComponentRequest
-
-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 StorePageComponentRequest
-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/StorePageComponentRequestRelationsInner.md

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

@@ -1,48 +0,0 @@
-
-# StorePageRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`siteId` | number
-`slug` | string
-`type` | string
-`enabled` | boolean
-`startDate` | Date
-`blog` | [StorePageRequestBlog](StorePageRequestBlog.md)
-`seo` | [Array<StoreBlogCategoryRequestSeoInner>](StoreBlogCategoryRequestSeoInner.md)
-
-## Example
-
-```typescript
-import type { StorePageRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "name": null,
-  "siteId": null,
-  "slug": null,
-  "type": null,
-  "enabled": null,
-  "startDate": null,
-  "blog": null,
-  "seo": null,
-} satisfies StorePageRequest
-
-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 StorePageRequest
-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/StorePageRequestBlog.md

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

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

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