@digital8/lighting-illusions-ts-sdk 0.0.460 → 0.0.462

package/docs/ProductApi.md

@@ -1,872 +0,0 @@
-# ProductApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyProduct**](ProductApi.md#destroyproduct) | **DELETE** /admin-api/product/parent/{product}/delete | Auto-generated: destroyProduct |
-| [**destroyProductChild**](ProductApi.md#destroyproductchild) | **DELETE** /admin-api/product/children/{productChild}/delete | Auto-generated: destroyProductChild |
-| [**getAllProduct**](ProductApi.md#getallproductoperation) | **POST** /admin-api/product/parent/all | Auto-generated: getAllProduct |
-| [**getAllProductChild**](ProductApi.md#getallproductchildoperation) | **POST** /admin-api/product/children/all | Auto-generated: getAllProductChild |
-| [**indexProduct**](ProductApi.md#indexproductoperation) | **POST** /admin-api/product/parent/list | Auto-generated: indexProduct |
-| [**indexProductChild**](ProductApi.md#indexproductchildoperation) | **POST** /admin-api/product/children/list | Auto-generated: indexProductChild |
-| [**showAssetsProductChild**](ProductApi.md#showassetsproductchild) | **GET** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild |
-| [**showProduct**](ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct |
-| [**showProductChild**](ProductApi.md#showproductchild) | **GET** /admin-api/product/children/{productChild} | Auto-generated: showProductChild |
-| [**storeProduct**](ProductApi.md#storeproductoperation) | **POST** /admin-api/product/parent/create | Auto-generated: storeProduct |
-| [**storeProductChild**](ProductApi.md#storeproductchildoperation) | **POST** /admin-api/product/children/create | Auto-generated: storeProductChild |
-| [**updateProduct**](ProductApi.md#updateproductoperation) | **PUT** /admin-api/product/parent/{product}/update | Auto-generated: updateProduct |
-| [**updateProductChild**](ProductApi.md#updateproductchildoperation) | **PUT** /admin-api/product/children/{productChild}/update | Auto-generated: updateProductChild |
-
-
-
-## destroyProduct
-
-> GenericResponse destroyProduct(product)
-
-Auto-generated: destroyProduct
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyProductRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the product
-    product: 56,
-  } satisfies DestroyProductRequest;
-
-  try {
-    const data = await api.destroyProduct(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **product** | `number` | The id of the product | [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)
-
-
-## destroyProductChild
-
-> GenericResponse destroyProductChild(productChild)
-
-Auto-generated: destroyProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the productChild
-    productChild: 56,
-  } satisfies DestroyProductChildRequest;
-
-  try {
-    const data = await api.destroyProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productChild** | `number` | The id of the productChild | [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)
-
-
-## getAllProduct
-
-> ProductLiteResourceArrayResponse getAllProduct(getAllProductRequest)
-
-Auto-generated: getAllProduct
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllProductOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // GetAllProductRequest (optional)
-    getAllProductRequest: ...,
-  } satisfies GetAllProductOperationRequest;
-
-  try {
-    const data = await api.getAllProduct(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllProductRequest** | [GetAllProductRequest](GetAllProductRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductLiteResourceArrayResponse**](ProductLiteResourceArrayResponse.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)
-
-
-## getAllProductChild
-
-> ProductChildLiteResourceArrayResponse getAllProductChild(getAllProductChildRequest)
-
-Auto-generated: getAllProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // GetAllProductChildRequest (optional)
-    getAllProductChildRequest: ...,
-  } satisfies GetAllProductChildOperationRequest;
-
-  try {
-    const data = await api.getAllProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllProductChildRequest** | [GetAllProductChildRequest](GetAllProductChildRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductChildLiteResourceArrayResponse**](ProductChildLiteResourceArrayResponse.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)
-
-
-## indexProduct
-
-> PaginatedProductListResourceResponse indexProduct(indexProductRequest)
-
-Auto-generated: indexProduct
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexProductOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // IndexProductRequest (optional)
-    indexProductRequest: ...,
-  } satisfies IndexProductOperationRequest;
-
-  try {
-    const data = await api.indexProduct(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexProductRequest** | [IndexProductRequest](IndexProductRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductListResourceResponse**](PaginatedProductListResourceResponse.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<\\ProductListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## indexProductChild
-
-> PaginatedProductChildListResourceResponse indexProductChild(indexProductChildRequest)
-
-Auto-generated: indexProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // IndexProductChildRequest (optional)
-    indexProductChildRequest: ...,
-  } satisfies IndexProductChildOperationRequest;
-
-  try {
-    const data = await api.indexProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexProductChildRequest** | [IndexProductChildRequest](IndexProductChildRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductChildListResourceResponse**](PaginatedProductChildListResourceResponse.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<\\ProductChildListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## showAssetsProductChild
-
-> AssetResourceArrayResponse showAssetsProductChild(productChild)
-
-Auto-generated: showAssetsProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowAssetsProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the productChild
-    productChild: 56,
-  } satisfies ShowAssetsProductChildRequest;
-
-  try {
-    const data = await api.showAssetsProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
-
-### Return type
-
-[**AssetResourceArrayResponse**](AssetResourceArrayResponse.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)
-
-
-## showProduct
-
-> ProductResource showProduct(product)
-
-Auto-generated: showProduct
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowProductRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the product
-    product: 56,
-  } satisfies ShowProductRequest;
-
-  try {
-    const data = await api.showProduct(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **product** | `number` | The id of the product | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductResource**](ProductResource.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)
-
-
-## showProductChild
-
-> ProductChildResource showProductChild(productChild)
-
-Auto-generated: showProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowProductChildRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the productChild
-    productChild: 56,
-  } satisfies ShowProductChildRequest;
-
-  try {
-    const data = await api.showProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductChildResource**](ProductChildResource.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)
-
-
-## storeProduct
-
-> ProductResource storeProduct(storeProductRequest)
-
-Auto-generated: storeProduct
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreProductOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // StoreProductRequest (optional)
-    storeProductRequest: ...,
-  } satisfies StoreProductOperationRequest;
-
-  try {
-    const data = await api.storeProduct(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeProductRequest** | [StoreProductRequest](StoreProductRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductResource**](ProductResource.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)
-
-
-## storeProductChild
-
-> ProductChildResource storeProductChild(storeProductChildRequest)
-
-Auto-generated: storeProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // StoreProductChildRequest (optional)
-    storeProductChildRequest: ...,
-  } satisfies StoreProductChildOperationRequest;
-
-  try {
-    const data = await api.storeProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeProductChildRequest** | [StoreProductChildRequest](StoreProductChildRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductChildResource**](ProductChildResource.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)
-
-
-## updateProduct
-
-> ProductResource updateProduct(product, updateProductRequest)
-
-Auto-generated: updateProduct
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateProductOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the product
-    product: 56,
-    // UpdateProductRequest (optional)
-    updateProductRequest: ...,
-  } satisfies UpdateProductOperationRequest;
-
-  try {
-    const data = await api.updateProduct(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **product** | `number` | The id of the product | [Defaults to `undefined`] |
-| **updateProductRequest** | [UpdateProductRequest](UpdateProductRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductResource**](ProductResource.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)
-
-
-## updateProductChild
-
-> ProductChildResource updateProductChild(productChild, updateProductChildRequest)
-
-Auto-generated: updateProductChild
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductApi();
-
-  const body = {
-    // number | The id of the productChild
-    productChild: 56,
-    // UpdateProductChildRequest (optional)
-    updateProductChildRequest: ...,
-  } satisfies UpdateProductChildOperationRequest;
-
-  try {
-    const data = await api.updateProductChild(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
-| **updateProductChildRequest** | [UpdateProductChildRequest](UpdateProductChildRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductChildResource**](ProductChildResource.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)
-