@digital8/lighting-illusions-ts-sdk 0.0.531 → 0.0.532

package/docs/ProductCategoryApi.md

@@ -0,0 +1,534 @@
+# ProductCategoryApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyProductCategory**](ProductCategoryApi.md#destroyproductcategory) | **DELETE** /admin-api/product-category/{productCategory}/delete | Auto-generated: destroyProductCategory |
+| [**getAllProductCategory**](ProductCategoryApi.md#getallproductcategoryoperation) | **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#gethierarchyproductcategory) | **GET** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
+| [**indexProductCategory**](ProductCategoryApi.md#indexproductcategoryoperation) | **POST** /admin-api/product-category/list | Auto-generated: indexProductCategory |
+| [**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 |
+| [**updateProductCategory**](ProductCategoryApi.md#updateproductcategoryoperation) | **PUT** /admin-api/product-category/{productCategory}/update | Auto-generated: updateProductCategory |
+
+
+
+## destroyProductCategory
+
+> GenericResponse destroyProductCategory(productCategory)
+
+Auto-generated: destroyProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductCategoryApi();
+
+  const body = {
+    // number | The id of the productCategory
+    productCategory: 56,
+  } satisfies DestroyProductCategoryRequest;
+
+  try {
+    const data = await api.destroyProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAllProductCategory
+
+> ProductCategoryLiteResourceArrayResponse getAllProductCategory(getAllProductCategoryRequest)
+
+Auto-generated: getAllProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllProductCategoryOperationRequest } 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;
+
+  try {
+    const data = await api.getAllProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAllProductCategoryRequest** | [GetAllProductCategoryRequest](GetAllProductCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ProductCategoryLiteResourceArrayResponse**](ProductCategoryLiteResourceArrayResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getChildrenProductCategory
+
+> PaginatedProductCategoryListResourceResponse getChildrenProductCategory(productCategory, indexProductCategoryRequest)
+
+Auto-generated: getChildrenProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetChildrenProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductCategoryApi();
+
+  const body = {
+    // number | The id of the productCategory
+    productCategory: 56,
+    // IndexProductCategoryRequest (optional)
+    indexProductCategoryRequest: ...,
+  } satisfies GetChildrenProductCategoryRequest;
+
+  try {
+    const data = await api.getChildrenProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
+| **indexProductCategoryRequest** | [IndexProductCategoryRequest](IndexProductCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedProductCategoryListResourceResponse**](PaginatedProductCategoryListResourceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductCategoryListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getHierarchyProductCategory
+
+> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory()
+
+Auto-generated: getHierarchyProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} 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();
+
+  try {
+    const data = await api.getHierarchyProductCategory();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ProductCategoryHierarchyResourceArrayResponse**](ProductCategoryHierarchyResourceArrayResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## indexProductCategory
+
+> PaginatedProductCategoryListResourceResponse indexProductCategory(indexProductCategoryRequest)
+
+Auto-generated: indexProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexProductCategoryOperationRequest } 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;
+
+  try {
+    const data = await api.indexProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexProductCategoryRequest** | [IndexProductCategoryRequest](IndexProductCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedProductCategoryListResourceResponse**](PaginatedProductCategoryListResourceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductCategoryListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showProductCategory
+
+> ProductCategoryResource showProductCategory(productCategory)
+
+Auto-generated: showProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductCategoryApi();
+
+  const body = {
+    // number | The id of the productCategory
+    productCategory: 56,
+  } satisfies ShowProductCategoryRequest;
+
+  try {
+    const data = await api.showProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
+
+### Return type
+
+[**ProductCategoryResource**](ProductCategoryResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## storeProductCategory
+
+> ProductCategoryResource storeProductCategory(storeProductCategoryRequest)
+
+Auto-generated: storeProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreProductCategoryOperationRequest } 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;
+
+  try {
+    const data = await api.storeProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeProductCategoryRequest** | [StoreProductCategoryRequest](StoreProductCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ProductCategoryResource**](ProductCategoryResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateProductCategory
+
+> ProductCategoryResource updateProductCategory(productCategory, updateProductCategoryRequest)
+
+Auto-generated: updateProductCategory
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProductCategoryApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ProductCategoryApi();
+
+  const body = {
+    // number | The id of the productCategory
+    productCategory: 56,
+    // UpdateProductCategoryRequest (optional)
+    updateProductCategoryRequest: ...,
+  } satisfies UpdateProductCategoryOperationRequest;
+
+  try {
+    const data = await api.updateProductCategory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productCategory** | `number` | The id of the productCategory | [Defaults to `undefined`] |
+| **updateProductCategoryRequest** | [UpdateProductCategoryRequest](UpdateProductCategoryRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ProductCategoryResource**](ProductCategoryResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[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/ProductCategoryHierarchyResource.md

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

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

@@ -0,0 +1,48 @@
+
+# ProductCategoryListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`slug` | string
+`isDisabled` | boolean
+`isAutomated` | boolean
+`hasChildren` | boolean
+`productCount` | number
+`site` | [SiteLiteResource](SiteLiteResource.md)
+
+## Example
+
+```typescript
+import type { ProductCategoryListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "slug": null,
+  "isDisabled": null,
+  "isAutomated": null,
+  "hasChildren": null,
+  "productCount": null,
+  "site": null,
+} satisfies ProductCategoryListResource
+
+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 ProductCategoryListResource
+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/ProductCategoryListResourceArrayResponse.md

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