@digital8/lighting-illusions-ts-sdk 0.0.1816 → 0.0.1817

package/docs/PageResource.md

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

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

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

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

@@ -1,48 +0,0 @@
-
-# ProductChildFrontendResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`sku` | number
-`model` | string
-`parentName` | string
-`variations` | number
-`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-`supplier` | [SupplierFrontendResource](SupplierFrontendResource.md)
-`siteDetails` | [Array<ProductChildSiteDetailFrontendResource>](ProductChildSiteDetailFrontendResource.md)
-
-## Example
-
-```typescript
-import type { ProductChildFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "sku": null,
-  "model": null,
-  "parentName": null,
-  "variations": null,
-  "thumbnail": null,
-  "supplier": null,
-  "siteDetails": null,
-} satisfies ProductChildFrontendResource
-
-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 ProductChildFrontendResource
-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/ProductChildFrontendResourceArrayResponse.md

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

package/docs/UpdatePageComponentRequest.md

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

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