@digital8/lighting-illusions-ts-sdk 0.0.1459 → 0.0.1460

package/docs/AddressResource.md

@@ -1,50 +0,0 @@
-
-# AddressResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`company` | string
-`line1` | string
-`line2` | string
-`postcode` | string
-`suburb` | string
-`country` | string
-`state` | string
-`fullAddress` | string
-
-## Example
-
-```typescript
-import type { AddressResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "company": null,
-  "line1": null,
-  "line2": null,
-  "postcode": null,
-  "suburb": null,
-  "country": null,
-  "state": null,
-  "fullAddress": null,
-} satisfies AddressResource
-
-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 AddressResource
-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/AddressResourceArrayResponse.md

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

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

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

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

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

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

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

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

@@ -1,50 +0,0 @@
-
-# GetAllProductRangeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`siteDetailsSiteId` | Array<string>
-`supplierId` | Array<string>
-`siteDetailsCategoriesId` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllProductRangeRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "siteDetailsSiteId": null,
-  "supplierId": null,
-  "siteDetailsCategoriesId": null,
-} satisfies GetAllProductRangeRequest
-
-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 GetAllProductRangeRequest
-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/GetAllProductRegistrationRequest.md

@@ -1,44 +0,0 @@
-
-# GetAllProductRegistrationRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { GetAllProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies GetAllProductRegistrationRequest
-
-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 GetAllProductRegistrationRequest
-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/IndexModelAttributeRequest.md

@@ -1,54 +0,0 @@
-
-# IndexModelAttributeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`attributableType` | Array<string>
-`attributableId` | Array<string>
-`attributeId` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexModelAttributeRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "attributableType": null,
-  "attributableId": null,
-  "attributeId": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexModelAttributeRequest
-
-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 IndexModelAttributeRequest
-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/IndexProductRangeRequest.md

@@ -1,54 +0,0 @@
-
-# IndexProductRangeRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteDetailsSiteId` | Array<string>
-`supplierId` | Array<string>
-`siteDetailsCategoriesId` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexProductRangeRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "siteDetailsSiteId": null,
-  "supplierId": null,
-  "siteDetailsCategoriesId": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexProductRangeRequest
-
-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 IndexProductRangeRequest
-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/IndexProductRegistrationRequest.md

@@ -1,56 +0,0 @@
-
-# IndexProductRegistrationRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`beforePurchasedDate` | Date
-`afterPurchasedDate` | Date
-`beforeCreatedAt` | Date
-`afterCreatedAt` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "beforePurchasedDate": null,
-  "afterPurchasedDate": null,
-  "beforeCreatedAt": null,
-  "afterCreatedAt": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexProductRegistrationRequest
-
-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 IndexProductRegistrationRequest
-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/ListAssetsProductRegistrationRequest.md

@@ -1,52 +0,0 @@
-
-# ListAssetsProductRegistrationRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`productRegistrationId` | Array<string>
-`type` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { ListAssetsProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "perPage": null,
-  "page": null,
-  "productRegistrationId": null,
-  "type": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies ListAssetsProductRegistrationRequest
-
-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 ListAssetsProductRegistrationRequest
-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/ModelAttributeListResource.md

@@ -1,44 +0,0 @@
-
-# ModelAttributeListResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`value` | string
-`attribute` | [AttributeLiteResource](AttributeLiteResource.md)
-`attributeValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
-`selectedValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
-`order` | string
-
-## Example
-
-```typescript
-import type { ModelAttributeListResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "value": null,
-  "attribute": null,
-  "attributeValues": null,
-  "selectedValues": null,
-  "order": null,
-} satisfies ModelAttributeListResource
-
-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 ModelAttributeListResource
-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)
-
-