@digital8/lighting-illusions-ts-sdk 0.0.1884 → 0.0.1886

package/docs/CreateAttributeRequest.md

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

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

@@ -0,0 +1,40 @@
+
+# CreateBlogCategoryRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`slug` | string
+`descriptions` | [Array<CreateBlogCategoryRequestDescriptionsInner>](CreateBlogCategoryRequestDescriptionsInner.md)
+`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
+
+## Example
+
+```typescript
+import type { CreateBlogCategoryRequest } 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 CreateBlogCategoryRequest
+
+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 CreateBlogCategoryRequest
+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/CreateBlogCategoryRequestDescriptionsInner.md

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

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

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

@@ -0,0 +1,48 @@
+
+# CreateLabelRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | number
+`shortName` | string
+`longName` | string
+`cartButtonText` | string
+`colour` | string
+`textColour` | string
+`startDate` | Date
+`endDate` | Date
+
+## Example
+
+```typescript
+import type { CreateLabelRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "siteId": null,
+  "shortName": null,
+  "longName": null,
+  "cartButtonText": null,
+  "colour": null,
+  "textColour": null,
+  "startDate": null,
+  "endDate": null,
+} satisfies CreateLabelRequest
+
+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 CreateLabelRequest
+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/CreateMenuItemRequest.md

@@ -0,0 +1,52 @@
+
+# CreateMenuItemRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`menuId` | number
+`parentId` | number
+`type` | string
+`heading` | string
+`subheading` | string
+`css` | string
+`cssMobile` | string
+`javascript` | string
+`index` | number
+`menuItemLink` | [CreateMenuItemRequestMenuItemLink](CreateMenuItemRequestMenuItemLink.md)
+
+## Example
+
+```typescript
+import type { CreateMenuItemRequest } 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 CreateMenuItemRequest
+
+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 CreateMenuItemRequest
+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/CreateMenuItemRequestMenuItemLink.md

@@ -0,0 +1,40 @@
+
+# CreateMenuItemRequestMenuItemLink
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`linkableType` | string
+`linkableId` | number
+`link` | string
+`isExternalLink` | boolean
+
+## Example
+
+```typescript
+import type { CreateMenuItemRequestMenuItemLink } 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 CreateMenuItemRequestMenuItemLink
+
+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 CreateMenuItemRequestMenuItemLink
+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/CreateMenuRequest.md

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

@@ -0,0 +1,52 @@
+
+# CreateOverlayTemplateAssetRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`overlayTemplateId` | number
+`position` | string
+`padding` | number
+`horizontalMargin` | number
+`verticalMargin` | number
+`altText` | string
+`mimeType` | string
+`fileId` | number
+`isExternal` | boolean
+`externalUrl` | string
+
+## Example
+
+```typescript
+import type { CreateOverlayTemplateAssetRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "overlayTemplateId": null,
+  "position": null,
+  "padding": null,
+  "horizontalMargin": null,
+  "verticalMargin": null,
+  "altText": null,
+  "mimeType": null,
+  "fileId": null,
+  "isExternal": null,
+  "externalUrl": null,
+} satisfies CreateOverlayTemplateAssetRequest
+
+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 CreateOverlayTemplateAssetRequest
+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/CreateOverlayTemplateRequest.md

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

@@ -0,0 +1,50 @@
+
+# CreatePageComponentRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pageId` | number
+`componentId` | number
+`type` | string
+`disabled` | boolean
+`order` | number
+`startDate` | Date
+`endDate` | Date
+`componentData` | object
+`relations` | [Array<CreatePageComponentRequestRelationsInner>](CreatePageComponentRequestRelationsInner.md)
+
+## Example
+
+```typescript
+import type { CreatePageComponentRequest } 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 CreatePageComponentRequest
+
+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 CreatePageComponentRequest
+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/CreatePageComponentRequestRelationsInner.md

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

@@ -0,0 +1,48 @@
+
+# CreatePageRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`siteId` | number
+`slug` | string
+`type` | string
+`enabled` | boolean
+`startDate` | Date
+`blog` | [CreatePageRequestBlog](CreatePageRequestBlog.md)
+`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
+
+## Example
+
+```typescript
+import type { CreatePageRequest } 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 CreatePageRequest
+
+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 CreatePageRequest
+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/CreatePageRequestBlog.md

@@ -0,0 +1,40 @@
+
+# CreatePageRequestBlog
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`excerpt` | string
+`featured` | boolean
+`blogCategories` | Array<number>
+`thumbnail` | [Thumbnail](Thumbnail.md)
+
+## Example
+
+```typescript
+import type { CreatePageRequestBlog } 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 CreatePageRequestBlog
+
+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 CreatePageRequestBlog
+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)
+
+