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

package/docs/ProductResource.md

@@ -1,52 +0,0 @@
-
-# ProductResource
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`name` | string
-`displayName` | string
-`isAccessory` | boolean
-`warranty` | string
-`categoryIDs` | Array<boolean>
-`supplier` | [SupplierLiteResource](SupplierLiteResource.md)
-`productType` | [ProductTypeLiteResource](ProductTypeLiteResource.md)
-`sites` | object
-`children` | object
-
-## Example
-
-```typescript
-import type { ProductResource } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "displayName": null,
-  "isAccessory": null,
-  "warranty": null,
-  "categoryIDs": null,
-  "supplier": null,
-  "productType": null,
-  "sites": null,
-  "children": null,
-} satisfies ProductResource
-
-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 ProductResource
-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/ProductResourceArrayResponse.md

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

@@ -1,614 +0,0 @@
-# ProductTypeApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**destroyProductType**](ProductTypeApi.md#destroyproducttype) | **DELETE** /admin-api/product-type/{productType}/delete | Auto-generated: destroyProductType |
-| [**getAllProductType**](ProductTypeApi.md#getallproducttypeoperation) | **POST** /admin-api/product-type/all | Auto-generated: getAllProductType |
-| [**indexProductType**](ProductTypeApi.md#indexproducttypeoperation) | **POST** /admin-api/product-type/list | Auto-generated: indexProductType |
-| [**linkAttributeProductType**](ProductTypeApi.md#linkattributeproducttypeoperation) | **POST** /admin-api/product-type/{productType}/link-attribute | Auto-generated: linkAttributeProductType |
-| [**showProductType**](ProductTypeApi.md#showproducttype) | **GET** /admin-api/product-type/{productType} | Auto-generated: showProductType |
-| [**storeProductType**](ProductTypeApi.md#storeproducttypeoperation) | **POST** /admin-api/product-type/create | Auto-generated: storeProductType |
-| [**unlinkAttributeProductType**](ProductTypeApi.md#unlinkattributeproducttype) | **POST** /admin-api/product-type/{productType}/remove-attribute/{attribute} | Auto-generated: unlinkAttributeProductType |
-| [**updateLinkedAttributeProductType**](ProductTypeApi.md#updatelinkedattributeproducttype) | **PUT** /admin-api/product-type/{productType}/update-attribute | Auto-generated: updateLinkedAttributeProductType |
-| [**updateProductType**](ProductTypeApi.md#updateproducttypeoperation) | **PUT** /admin-api/product-type/{productType}/update | Auto-generated: updateProductType |
-
-
-
-## destroyProductType
-
-> GenericResponse destroyProductType(productType)
-
-Auto-generated: destroyProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // number | The id of the productType
-    productType: 56,
-  } satisfies DestroyProductTypeRequest;
-
-  try {
-    const data = await api.destroyProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productType** | `number` | The id of the productType | [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)
-
-
-## getAllProductType
-
-> PaginatedProductTypeLiteResourceResponse getAllProductType(getAllProductTypeRequest)
-
-Auto-generated: getAllProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // GetAllProductTypeRequest (optional)
-    getAllProductTypeRequest: ...,
-  } satisfies GetAllProductTypeOperationRequest;
-
-  try {
-    const data = await api.getAllProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllProductTypeRequest** | [GetAllProductTypeRequest](GetAllProductTypeRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductTypeLiteResourceResponse**](PaginatedProductTypeLiteResourceResponse.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<\\ProductTypeLiteResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## indexProductType
-
-> PaginatedProductTypeListResourceResponse indexProductType(indexProductTypeRequest)
-
-Auto-generated: indexProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // IndexProductTypeRequest (optional)
-    indexProductTypeRequest: ...,
-  } satisfies IndexProductTypeOperationRequest;
-
-  try {
-    const data = await api.indexProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexProductTypeRequest** | [IndexProductTypeRequest](IndexProductTypeRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductTypeListResourceResponse**](PaginatedProductTypeListResourceResponse.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<\\ProductTypeListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## linkAttributeProductType
-
-> ProductTypeResource linkAttributeProductType(productType, linkAttributeProductTypeRequest)
-
-Auto-generated: linkAttributeProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { LinkAttributeProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // number | The id of the productType
-    productType: 56,
-    // LinkAttributeProductTypeRequest (optional)
-    linkAttributeProductTypeRequest: ...,
-  } satisfies LinkAttributeProductTypeOperationRequest;
-
-  try {
-    const data = await api.linkAttributeProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
-| **linkAttributeProductTypeRequest** | [LinkAttributeProductTypeRequest](LinkAttributeProductTypeRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductTypeResource**](ProductTypeResource.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)
-
-
-## showProductType
-
-> ProductTypeResource showProductType(productType)
-
-Auto-generated: showProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // number | The id of the productType
-    productType: 56,
-  } satisfies ShowProductTypeRequest;
-
-  try {
-    const data = await api.showProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductTypeResource**](ProductTypeResource.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)
-
-
-## storeProductType
-
-> ProductTypeResource storeProductType(storeProductTypeRequest)
-
-Auto-generated: storeProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // StoreProductTypeRequest (optional)
-    storeProductTypeRequest: ...,
-  } satisfies StoreProductTypeOperationRequest;
-
-  try {
-    const data = await api.storeProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **storeProductTypeRequest** | [StoreProductTypeRequest](StoreProductTypeRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductTypeResource**](ProductTypeResource.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)
-
-
-## unlinkAttributeProductType
-
-> ProductTypeResource unlinkAttributeProductType(productType, attribute)
-
-Auto-generated: unlinkAttributeProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UnlinkAttributeProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // number | The id of the productType
-    productType: 56,
-    // number | The id of the attribute
-    attribute: 56,
-  } satisfies UnlinkAttributeProductTypeRequest;
-
-  try {
-    const data = await api.unlinkAttributeProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
-| **attribute** | `number` | The id of the attribute | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductTypeResource**](ProductTypeResource.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)
-
-
-## updateLinkedAttributeProductType
-
-> ProductTypeResource updateLinkedAttributeProductType(productType, linkAttributeProductTypeRequest)
-
-Auto-generated: updateLinkedAttributeProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateLinkedAttributeProductTypeRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // number | The id of the productType
-    productType: 56,
-    // LinkAttributeProductTypeRequest (optional)
-    linkAttributeProductTypeRequest: ...,
-  } satisfies UpdateLinkedAttributeProductTypeRequest;
-
-  try {
-    const data = await api.updateLinkedAttributeProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
-| **linkAttributeProductTypeRequest** | [LinkAttributeProductTypeRequest](LinkAttributeProductTypeRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductTypeResource**](ProductTypeResource.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)
-
-
-## updateProductType
-
-> ProductTypeResource updateProductType(productType, updateProductTypeRequest)
-
-Auto-generated: updateProductType
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductTypeApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateProductTypeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductTypeApi();
-
-  const body = {
-    // number | The id of the productType
-    productType: 56,
-    // UpdateProductTypeRequest (optional)
-    updateProductTypeRequest: ...,
-  } satisfies UpdateProductTypeOperationRequest;
-
-  try {
-    const data = await api.updateProductType(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productType** | `number` | The id of the productType | [Defaults to `undefined`] |
-| **updateProductTypeRequest** | [UpdateProductTypeRequest](UpdateProductTypeRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductTypeResource**](ProductTypeResource.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)
-