@digital8/lighting-illusions-ts-sdk 0.0.456 → 0.0.458

package/docs/ProductTypeResource.md

@@ -1,48 +0,0 @@
-
-# ProductTypeResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`totalAttributes` | number
-`performanceAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
-`dimensionAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
-`specificationAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
-`otherAttributes` | [Array<AttributeProductTypeRelationResource>](AttributeProductTypeRelationResource.md)
-`productChildren` | object
-
-## Example
-
-```typescript
-import type { ProductTypeResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "totalAttributes": null,
-  "performanceAttributes": null,
-  "dimensionAttributes": null,
-  "specificationAttributes": null,
-  "otherAttributes": null,
-  "productChildren": null,
-} satisfies ProductTypeResource
-
-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 ProductTypeResource
-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/ProductTypeResourceArrayResponse.md

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

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

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

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

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

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

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

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

@@ -1,42 +0,0 @@
-
-# StoreAttributeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`name` | string
-`type` | string
-`isFilterable` | boolean
-`isExpandedByDefault` | boolean
-`filterIndex` | number
-
-## Example
-
-```typescript
-import type { StoreAttributeRequest } 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 StoreAttributeRequest
-
-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 StoreAttributeRequest
-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/StoreAttributeValueRequest.md

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

@@ -1,48 +0,0 @@
-
-# StoreOverlayTemplateAssetRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`overlayTemplateId` | number
-`position` | string
-`padding` | number
-`horizontalMargin` | number
-`verticalMargin` | number
-`altText` | string
-`mimeType` | string
-`assetFileId` | number
-
-## Example
-
-```typescript
-import type { StoreOverlayTemplateAssetRequest } 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,
-  "assetFileId": null,
-} satisfies StoreOverlayTemplateAssetRequest
-
-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 StoreOverlayTemplateAssetRequest
-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/StoreOverlayTemplateRequest.md

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

@@ -1,68 +0,0 @@
-
-# StoreProductChildRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`productId` | number
-`name` | string
-`sku` | string
-`model` | string
-`newArrivalsStartDate` | Date
-`newArrivalsEndDate` | Date
-`warranty` | string
-`hideFromFrontend` | boolean
-`excludeFromSearch` | boolean
-`allowOversell` | boolean
-`oversizedItem` | boolean
-`popularityScore` | number
-`stock` | number
-`sites` | [Array<StoreProductChildRequestSitesInner>](StoreProductChildRequestSitesInner.md)
-`accessories` | [Array<StoreProductChildRequestAccessoriesInner>](StoreProductChildRequestAccessoriesInner.md)
-`compatibleProducts` | Array<number>
-`attributeValues` | [Array<StoreProductChildRequestAttributeValuesInner>](StoreProductChildRequestAttributeValuesInner.md)
-`assets` | [Array<StoreProductChildRequestAssetsInner>](StoreProductChildRequestAssetsInner.md)
-
-## Example
-
-```typescript
-import type { StoreProductChildRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "productId": null,
-  "name": null,
-  "sku": null,
-  "model": null,
-  "newArrivalsStartDate": null,
-  "newArrivalsEndDate": null,
-  "warranty": null,
-  "hideFromFrontend": null,
-  "excludeFromSearch": null,
-  "allowOversell": null,
-  "oversizedItem": null,
-  "popularityScore": null,
-  "stock": null,
-  "sites": null,
-  "accessories": null,
-  "compatibleProducts": null,
-  "attributeValues": null,
-  "assets": null,
-} satisfies StoreProductChildRequest
-
-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 StoreProductChildRequest
-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/StoreProductChildRequestAccessoriesInner.md

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

@@ -1,44 +0,0 @@
-
-# StoreProductChildRequestAssetsInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`altText` | string
-`mimeType` | string
-`assetFileId` | number
-`isLifestyleImage` | boolean
-`order` | number
-`overlayTemplateIds` | Array<number>
-
-## Example
-
-```typescript
-import type { StoreProductChildRequestAssetsInner } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "altText": null,
-  "mimeType": null,
-  "assetFileId": null,
-  "isLifestyleImage": null,
-  "order": null,
-  "overlayTemplateIds": null,
-} satisfies StoreProductChildRequestAssetsInner
-
-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 StoreProductChildRequestAssetsInner
-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/StoreProductChildRequestAttributeValuesInner.md

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