@digital8/lighting-illusions-ts-sdk 0.0.1893 → 0.0.1894

package/docs/ProductCategoryApi.md

@@ -4,25 +4,25 @@ All URIs are relative to *http://localhost/api*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**attachProductsProductCategory**](ProductCategoryApi.md#attachproductsproductcategoryoperation) | **POST** /admin-api/product-category/{productCategory}/attach-products | Auto-generated: attachProductsProductCategory |
+| [**attachProductsProductCategory**](ProductCategoryApi.md#attachproductsproductcategory) | **POST** /admin-api/product-category/{productCategory}/attach-products | Auto-generated: attachProductsProductCategory |
 | [**bulkDetachProductsProductCategory**](ProductCategoryApi.md#bulkdetachproductsproductcategory) | **DELETE** /admin-api/product-category/{productCategory}/bulk-detach-products | Auto-generated: bulkDetachProductsProductCategory |
 | [**destroyProductCategory**](ProductCategoryApi.md#destroyproductcategory) | **DELETE** /admin-api/product-category/{productCategory}/delete | Auto-generated: destroyProductCategory |
-| [**detachProductsProductCategory**](ProductCategoryApi.md#detachproductsproductcategoryoperation) | **POST** /admin-api/product-category/{productCategory}/detach-products | Auto-generated: detachProductsProductCategory |
+| [**detachProductsProductCategory**](ProductCategoryApi.md#detachproductsproductcategory) | **POST** /admin-api/product-category/{productCategory}/detach-products | Auto-generated: detachProductsProductCategory |
 | [**getAllChildrenProductCategory**](ProductCategoryApi.md#getallchildrenproductcategory) | **POST** /admin-api/product-category/{productCategory}/children/all | Auto-generated: getAllChildrenProductCategory |
-| [**getAllProductCategory**](ProductCategoryApi.md#getallproductcategoryoperation) | **POST** /admin-api/product-category/all | Auto-generated: getAllProductCategory |
+| [**getAllProductCategory**](ProductCategoryApi.md#getallproductcategory) | **POST** /admin-api/product-category/all | Auto-generated: getAllProductCategory |
 | [**getChildrenProductCategory**](ProductCategoryApi.md#getchildrenproductcategory) | **GET** /admin-api/product-category/{productCategory}/children | Auto-generated: getChildrenProductCategory |
-| [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategoryoperation) | **POST** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
-| [**indexProductCategory**](ProductCategoryApi.md#indexproductcategoryoperation) | **POST** /admin-api/product-category/list | Auto-generated: indexProductCategory |
-| [**previewAutomationRulesProductCategory**](ProductCategoryApi.md#previewautomationrulesproductcategoryoperation) | **POST** /admin-api/product-category/preview-automation-rules | Auto-generated: previewAutomationRulesProductCategory |
+| [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategory) | **POST** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
+| [**indexProductCategory**](ProductCategoryApi.md#indexproductcategory) | **POST** /admin-api/product-category/list | Auto-generated: indexProductCategory |
+| [**previewAutomationRulesProductCategory**](ProductCategoryApi.md#previewautomationrulesproductcategory) | **POST** /admin-api/product-category/preview-automation-rules | Auto-generated: previewAutomationRulesProductCategory |
 | [**showProductCategory**](ProductCategoryApi.md#showproductcategory) | **GET** /admin-api/product-category/{productCategory} | Auto-generated: showProductCategory |
-| [**storeProductCategory**](ProductCategoryApi.md#storeproductcategoryoperation) | **POST** /admin-api/product-category/create | Auto-generated: storeProductCategory |
+| [**storeProductCategory**](ProductCategoryApi.md#storeproductcategory) | **POST** /admin-api/product-category/create | Auto-generated: storeProductCategory |
 | [**updateProductCategory**](ProductCategoryApi.md#updateproductcategoryoperation) | **PUT** /admin-api/product-category/{productCategory}/update | Auto-generated: updateProductCategory |
 
 
 
 ## attachProductsProductCategory
 
-> ProductCategoryResource attachProductsProductCategory(productCategory, attachProductsProductCategoryRequest)
+> ProductCategoryResource attachProductsProductCategory(productCategory, attachProductsToProductCategoryRequest)
 
 Auto-generated: attachProductsProductCategory
 
@@ -33,7 +33,7 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { AttachProductsProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { AttachProductsProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -42,9 +42,9 @@ async function example() {
   const body = {
     // number | The id of the productCategory
     productCategory: 56,
-    // AttachProductsProductCategoryRequest (optional)
-    attachProductsProductCategoryRequest: ...,
-  } satisfies AttachProductsProductCategoryOperationRequest;
+    // AttachProductsToProductCategoryRequest (optional)
+    attachProductsToProductCategoryRequest: ...,
+  } satisfies AttachProductsProductCategoryRequest;
 
   try {
     const data = await api.attachProductsProductCategory(body);
@@ -64,7 +64,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
-| **attachProductsProductCategoryRequest** | [AttachProductsProductCategoryRequest](AttachProductsProductCategoryRequest.md) |  | [Optional] |
+| **attachProductsToProductCategoryRequest** | [AttachProductsToProductCategoryRequest](AttachProductsToProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -220,7 +220,7 @@ No authorization required
 
 ## detachProductsProductCategory
 
-> ProductCategoryResource detachProductsProductCategory(productCategory, detachProductsProductCategoryRequest)
+> ProductCategoryResource detachProductsProductCategory(productCategory, detachProductsFromProductCategoryRequest)
 
 Auto-generated: detachProductsProductCategory
 
@@ -231,7 +231,7 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DetachProductsProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { DetachProductsProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
@@ -240,9 +240,9 @@ async function example() {
   const body = {
     // number | The id of the productCategory
     productCategory: 56,
-    // DetachProductsProductCategoryRequest (optional)
-    detachProductsProductCategoryRequest: ...,
-  } satisfies DetachProductsProductCategoryOperationRequest;
+    // DetachProductsFromProductCategoryRequest (optional)
+    detachProductsFromProductCategoryRequest: ...,
+  } satisfies DetachProductsProductCategoryRequest;
 
   try {
     const data = await api.detachProductsProductCategory(body);
@@ -262,7 +262,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
-| **detachProductsProductCategoryRequest** | [DetachProductsProductCategoryRequest](DetachProductsProductCategoryRequest.md) |  | [Optional] |
+| **detachProductsFromProductCategoryRequest** | [DetachProductsFromProductCategoryRequest](DetachProductsFromProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -288,7 +288,7 @@ No authorization required
 
 ## getAllChildrenProductCategory
 
-> ProductCategoryListResourceArrayResponse getAllChildrenProductCategory(productCategory, getAllProductCategoryRequest)
+> ProductCategoryListResourceArrayResponse getAllChildrenProductCategory(productCategory, searchAllProductCategoriesRequest)
 
 Auto-generated: getAllChildrenProductCategory
 
@@ -308,8 +308,8 @@ async function example() {
   const body = {
     // number | The id of the productCategory
     productCategory: 56,
-    // GetAllProductCategoryRequest (optional)
-    getAllProductCategoryRequest: ...,
+    // SearchAllProductCategoriesRequest (optional)
+    searchAllProductCategoriesRequest: ...,
   } satisfies GetAllChildrenProductCategoryRequest;
 
   try {
@@ -330,7 +330,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
-| **getAllProductCategoryRequest** | [GetAllProductCategoryRequest](GetAllProductCategoryRequest.md) |  | [Optional] |
+| **searchAllProductCategoriesRequest** | [SearchAllProductCategoriesRequest](SearchAllProductCategoriesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -356,7 +356,7 @@ No authorization required
 
 ## getAllProductCategory
 
-> ProductCategoryLiteResourceArrayResponse getAllProductCategory(getAllProductCategoryRequest)
+> ProductCategoryLiteResourceArrayResponse getAllProductCategory(searchAllProductCategoriesRequest)
 
 Auto-generated: getAllProductCategory
 
@@ -367,16 +367,16 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new ProductCategoryApi();
 
   const body = {
-    // GetAllProductCategoryRequest (optional)
-    getAllProductCategoryRequest: ...,
-  } satisfies GetAllProductCategoryOperationRequest;
+    // SearchAllProductCategoriesRequest (optional)
+    searchAllProductCategoriesRequest: ...,
+  } satisfies GetAllProductCategoryRequest;
 
   try {
     const data = await api.getAllProductCategory(body);
@@ -395,7 +395,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getAllProductCategoryRequest** | [GetAllProductCategoryRequest](GetAllProductCategoryRequest.md) |  | [Optional] |
+| **searchAllProductCategoriesRequest** | [SearchAllProductCategoriesRequest](SearchAllProductCategoriesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -421,7 +421,7 @@ No authorization required
 
 ## getChildrenProductCategory
 
-> PaginatedProductCategoryListResourceResponse getChildrenProductCategory(productCategory, indexProductCategoryRequest)
+> PaginatedProductCategoryListResourceResponse getChildrenProductCategory(productCategory, searchProductCategoriesRequest)
 
 Auto-generated: getChildrenProductCategory
 
@@ -441,8 +441,8 @@ async function example() {
   const body = {
     // number | The id of the productCategory
     productCategory: 56,
-    // IndexProductCategoryRequest (optional)
-    indexProductCategoryRequest: ...,
+    // SearchProductCategoriesRequest (optional)
+    searchProductCategoriesRequest: ...,
   } satisfies GetChildrenProductCategoryRequest;
 
   try {
@@ -463,7 +463,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
-| **indexProductCategoryRequest** | [IndexProductCategoryRequest](IndexProductCategoryRequest.md) |  | [Optional] |
+| **searchProductCategoriesRequest** | [SearchProductCategoriesRequest](SearchProductCategoriesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -489,7 +489,7 @@ No authorization required
 
 ## getHierarchyProductCategory
 
-> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(getHierarchyProductCategoryRequest)
+> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(siteIdRequest)
 
 Auto-generated: getHierarchyProductCategory
 
@@ -500,16 +500,16 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetHierarchyProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new ProductCategoryApi();
 
   const body = {
-    // GetHierarchyProductCategoryRequest (optional)
-    getHierarchyProductCategoryRequest: ...,
-  } satisfies GetHierarchyProductCategoryOperationRequest;
+    // SiteIdRequest (optional)
+    siteIdRequest: ...,
+  } satisfies GetHierarchyProductCategoryRequest;
 
   try {
     const data = await api.getHierarchyProductCategory(body);
@@ -528,7 +528,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getHierarchyProductCategoryRequest** | [GetHierarchyProductCategoryRequest](GetHierarchyProductCategoryRequest.md) |  | [Optional] |
+| **siteIdRequest** | [SiteIdRequest](SiteIdRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -554,7 +554,7 @@ No authorization required
 
 ## indexProductCategory
 
-> PaginatedProductCategoryListResourceResponse indexProductCategory(indexProductCategoryRequest)
+> PaginatedProductCategoryListResourceResponse indexProductCategory(searchProductCategoriesRequest)
 
 Auto-generated: indexProductCategory
 
@@ -565,16 +565,16 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new ProductCategoryApi();
 
   const body = {
-    // IndexProductCategoryRequest (optional)
-    indexProductCategoryRequest: ...,
-  } satisfies IndexProductCategoryOperationRequest;
+    // SearchProductCategoriesRequest (optional)
+    searchProductCategoriesRequest: ...,
+  } satisfies IndexProductCategoryRequest;
 
   try {
     const data = await api.indexProductCategory(body);
@@ -593,7 +593,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexProductCategoryRequest** | [IndexProductCategoryRequest](IndexProductCategoryRequest.md) |  | [Optional] |
+| **searchProductCategoriesRequest** | [SearchProductCategoriesRequest](SearchProductCategoriesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -619,7 +619,7 @@ No authorization required
 
 ## previewAutomationRulesProductCategory
 
-> PreviewAutomationRulesResource previewAutomationRulesProductCategory(previewAutomationRulesProductCategoryRequest)
+> PreviewAutomationRulesResource previewAutomationRulesProductCategory(previewAutomationRulesRequest)
 
 Auto-generated: previewAutomationRulesProductCategory
 
@@ -630,16 +630,16 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { PreviewAutomationRulesProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { PreviewAutomationRulesProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new ProductCategoryApi();
 
   const body = {
-    // PreviewAutomationRulesProductCategoryRequest (optional)
-    previewAutomationRulesProductCategoryRequest: ...,
-  } satisfies PreviewAutomationRulesProductCategoryOperationRequest;
+    // PreviewAutomationRulesRequest (optional)
+    previewAutomationRulesRequest: ...,
+  } satisfies PreviewAutomationRulesProductCategoryRequest;
 
   try {
     const data = await api.previewAutomationRulesProductCategory(body);
@@ -658,7 +658,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **previewAutomationRulesProductCategoryRequest** | [PreviewAutomationRulesProductCategoryRequest](PreviewAutomationRulesProductCategoryRequest.md) |  | [Optional] |
+| **previewAutomationRulesRequest** | [PreviewAutomationRulesRequest](PreviewAutomationRulesRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -749,7 +749,7 @@ No authorization required
 
 ## storeProductCategory
 
-> ProductCategoryResource storeProductCategory(storeProductCategoryRequest)
+> ProductCategoryResource storeProductCategory(createProductCategoryRequest)
 
 Auto-generated: storeProductCategory
 
@@ -760,16 +760,16 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new ProductCategoryApi();
 
   const body = {
-    // StoreProductCategoryRequest (optional)
-    storeProductCategoryRequest: ...,
-  } satisfies StoreProductCategoryOperationRequest;
+    // CreateProductCategoryRequest (optional)
+    createProductCategoryRequest: ...,
+  } satisfies StoreProductCategoryRequest;
 
   try {
     const data = await api.storeProductCategory(body);
@@ -788,7 +788,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **storeProductCategoryRequest** | [StoreProductCategoryRequest](StoreProductCategoryRequest.md) |  | [Optional] |
+| **createProductCategoryRequest** | [CreateProductCategoryRequest](CreateProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/ProductChildFrontendResource.md

@@ -0,0 +1,48 @@
+
+# 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

@@ -0,0 +1,34 @@
+
+# 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

@@ -0,0 +1,48 @@
+
+# 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/ProductChildSiteDetailFrontendResourceArrayResponse.md

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