@digital8/lighting-illusions-ts-sdk 0.0.463 → 0.0.465

package/docs/AttributeListResource.md

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

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

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

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

@@ -9,11 +9,12 @@ Name | Type
 `search` | string
 `sortBy` | string
 `sortDirection` | string
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 `type` | Array<string>
 `isFilterable` | Array<string>
 `isExpandedByDefault` | Array<string>
-`relatedId` | number
-`relatedType` | string
 
 ## Example
 
@@ -25,11 +26,12 @@ const example = {
   "search": null,
   "sortBy": null,
   "sortDirection": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
   "type": null,
   "isFilterable": null,
   "isExpandedByDefault": null,
-  "relatedId": null,
-  "relatedType": null,
 } satisfies GetAllAttributeRequest
 
 console.log(example)

package/docs/GetAllOverlayTemplateRequest.md

@@ -9,9 +9,10 @@ Name | Type
 `search` | string
 `sortBy` | string
 `sortDirection` | string
-`sitesId` | Array<string>
 `relatedId` | number
 `relatedType` | string
+`includesRelations` | boolean
+`sitesId` | Array<string>
 
 ## Example
 
@@ -23,9 +24,10 @@ const example = {
   "search": null,
   "sortBy": null,
   "sortDirection": null,
-  "sitesId": null,
   "relatedId": null,
   "relatedType": null,
+  "includesRelations": null,
+  "sitesId": null,
 } satisfies GetAllOverlayTemplateRequest
 
 console.log(example)

package/docs/GetAllProductChildRequest.md

@@ -11,6 +11,7 @@ Name | Type
 `sortDirection` | string
 `relatedId` | number
 `relatedType` | string
+`includesRelations` | boolean
 `parentProductTypeId` | Array<string>
 `parentSupplierId` | Array<string>
 `siteDetailsSiteId` | Array<string>
@@ -29,6 +30,7 @@ const example = {
   "sortDirection": null,
   "relatedId": null,
   "relatedType": null,
+  "includesRelations": null,
   "parentProductTypeId": null,
   "parentSupplierId": null,
   "siteDetailsSiteId": null,

package/docs/GetAllProductRequest.md

@@ -11,6 +11,12 @@ Name | Type
 `sortDirection` | string
 `relatedId` | number
 `relatedType` | string
+`includesRelations` | boolean
+`productTypeId` | Array<string>
+`supplierId` | Array<string>
+`isDisabled` | Array<string>
+`isAccessory` | Array<string>
+`categoriesId` | Array<string>
 
 ## Example
 
@@ -24,6 +30,12 @@ const example = {
   "sortDirection": null,
   "relatedId": null,
   "relatedType": null,
+  "includesRelations": null,
+  "productTypeId": null,
+  "supplierId": null,
+  "isDisabled": null,
+  "isAccessory": null,
+  "categoriesId": null,
 } satisfies GetAllProductRequest
 
 console.log(example)

package/docs/GetAllProductTypeRequest.md

@@ -11,6 +11,7 @@ Name | Type
 `sortDirection` | string
 `relatedId` | number
 `relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "sortDirection": null,
   "relatedId": null,
   "relatedType": null,
+  "includesRelations": null,
 } satisfies GetAllProductTypeRequest
 
 console.log(example)

package/docs/GetAllSupplierRequest.md

@@ -11,6 +11,7 @@ Name | Type
 `sortDirection` | string
 `relatedId` | number
 `relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "sortDirection": null,
   "relatedId": null,
   "relatedType": null,
+  "includesRelations": null,
 } satisfies GetAllSupplierRequest
 
 console.log(example)

package/docs/IndexAttributeRequest.md

@@ -14,6 +14,9 @@ Name | Type
 `type` | Array<string>
 `isFilterable` | Array<string>
 `isExpandedByDefault` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -30,6 +33,9 @@ const example = {
   "type": null,
   "isFilterable": null,
   "isExpandedByDefault": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexAttributeRequest
 
 console.log(example)

package/docs/IndexExternalApiLogRequest.md

@@ -9,14 +9,17 @@ Name | Type
 `search` | string
 `sortBy` | string
 `sortDirection` | string
+`perPage` | number
+`page` | number
 `provider` | Array<string>
 `responseCode` | Array<string>
 `httpMethod` | Array<string>
 `externalApiLoggableType` | Array<string>
 `externalApiLoggableId` | Array<string>
 `siteId` | Array<string>
-`perPage` | number
-`page` | number
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -28,14 +31,17 @@ const example = {
   "search": null,
   "sortBy": null,
   "sortDirection": null,
+  "perPage": null,
+  "page": null,
   "provider": null,
   "responseCode": null,
   "httpMethod": null,
   "externalApiLoggableType": null,
   "externalApiLoggableId": null,
   "siteId": null,
-  "perPage": null,
-  "page": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexExternalApiLogRequest
 
 console.log(example)

package/docs/IndexOverlayTemplateRequest.md

@@ -12,6 +12,9 @@ Name | Type
 `perPage` | number
 `page` | number
 `sitesId` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -26,6 +29,9 @@ const example = {
   "perPage": null,
   "page": null,
   "sitesId": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexOverlayTemplateRequest
 
 console.log(example)

package/docs/IndexProductChildRequest.md

@@ -18,6 +18,7 @@ Name | Type
 `hasNetsuiteId` | Array<string>
 `relatedId` | number
 `relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -38,6 +39,7 @@ const example = {
   "hasNetsuiteId": null,
   "relatedId": null,
   "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexProductChildRequest
 
 console.log(example)

package/docs/IndexProductRequest.md

@@ -0,0 +1,58 @@
+
+# IndexProductRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`productTypeId` | Array<string>
+`supplierId` | Array<string>
+`isDisabled` | Array<string>
+`isAccessory` | Array<string>
+`categoriesId` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexProductRequest } 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,
+  "productTypeId": null,
+  "supplierId": null,
+  "isDisabled": null,
+  "isAccessory": null,
+  "categoriesId": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexProductRequest
+
+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 IndexProductRequest
+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/IndexProductTypeRequest.md

@@ -11,6 +11,9 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -24,6 +27,9 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexProductTypeRequest
 
 console.log(example)

package/docs/IndexSiteNotificationRequest.md

@@ -12,6 +12,9 @@ Name | Type
 `perPage` | number
 `page` | number
 `siteId` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -26,6 +29,9 @@ const example = {
   "perPage": null,
   "page": null,
   "siteId": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexSiteNotificationRequest
 
 console.log(example)

package/docs/IndexSiteRequest.md

@@ -11,6 +11,9 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -24,6 +27,9 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexSiteRequest
 
 console.log(example)

package/docs/IndexSupplierRequest.md

@@ -11,6 +11,9 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -24,6 +27,9 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexSupplierRequest
 
 console.log(example)

package/docs/IndexTagRequest.md

@@ -13,6 +13,9 @@ Name | Type
 `page` | number
 `siteId` | Array<string>
 `type` | Array<string>
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
 
 ## Example
 
@@ -28,6 +31,9 @@ const example = {
   "page": null,
   "siteId": null,
   "type": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
 } satisfies IndexTagRequest
 
 console.log(example)

package/docs/OverlayTemplateApi.md

@@ -216,7 +216,7 @@ No authorization required
 
 ## indexOverlayTemplate
 
-> PaginatedOverlayTemplateLiteResourceResponse indexOverlayTemplate(indexOverlayTemplateRequest)
+> PaginatedOverlayTemplateListResourceResponse indexOverlayTemplate(indexOverlayTemplateRequest)
 
 Auto-generated: indexOverlayTemplate
 
@@ -259,7 +259,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**PaginatedOverlayTemplateLiteResourceResponse**](PaginatedOverlayTemplateLiteResourceResponse.md)
+[**PaginatedOverlayTemplateListResourceResponse**](PaginatedOverlayTemplateListResourceResponse.md)
 
 ### Authorization
 
@@ -274,7 +274,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\OverlayTemplateLiteResource>> |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\OverlayTemplateListResource>> |  -  |
 
 [[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/OverlayTemplateListResource.md

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

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

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