@digital8/lighting-illusions-ts-sdk 0.0.1637 → 0.0.1638

package/docs/GetAllProductRegistrationRequest.md

@@ -1,46 +0,0 @@
-
-# GetAllProductRegistrationRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-`siteId` | Array<string>
-
-## Example
-
-```typescript
-import type { GetAllProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
-
-// TODO: Update the object below with actual values
-const example = {
-  "search": null,
-  "sortBy": null,
-  "sortDirection": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-  "siteId": null,
-} satisfies GetAllProductRegistrationRequest
-
-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 GetAllProductRegistrationRequest
-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/IndexProductRegistrationRequest.md

@@ -1,58 +0,0 @@
-
-# IndexProductRegistrationRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`siteId` | Array<string>
-`beforePurchasedDate` | Date
-`afterPurchasedDate` | Date
-`beforeCreatedAt` | Date
-`afterCreatedAt` | Date
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { IndexProductRegistrationRequest } 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,
-  "siteId": null,
-  "beforePurchasedDate": null,
-  "afterPurchasedDate": null,
-  "beforeCreatedAt": null,
-  "afterCreatedAt": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies IndexProductRegistrationRequest
-
-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 IndexProductRegistrationRequest
-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/ListAssetsProductRegistrationRequest.md

@@ -1,52 +0,0 @@
-
-# ListAssetsProductRegistrationRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`search` | string
-`sortBy` | string
-`sortDirection` | string
-`perPage` | number
-`page` | number
-`productRegistrationId` | Array<string>
-`type` | Array<string>
-`relatedId` | number
-`relatedType` | string
-`includesRelations` | boolean
-
-## Example
-
-```typescript
-import type { ListAssetsProductRegistrationRequest } 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,
-  "productRegistrationId": null,
-  "type": null,
-  "relatedId": null,
-  "relatedType": null,
-  "includesRelations": null,
-} satisfies ListAssetsProductRegistrationRequest
-
-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 ListAssetsProductRegistrationRequest
-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/PaginatedProductRegistrationAssetResourceResponse.md

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

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

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

@@ -1,344 +0,0 @@
-# ProductRegistrationApi
-
-All URIs are relative to *http://localhost/api*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**getAllProductRegistration**](ProductRegistrationApi.md#getallproductregistrationoperation) | **POST** /admin-api/product-registration/all | Auto-generated: getAllProductRegistration |
-| [**indexProductRegistration**](ProductRegistrationApi.md#indexproductregistrationoperation) | **POST** /admin-api/product-registration/list | Auto-generated: indexProductRegistration |
-| [**listAssetsProductRegistration**](ProductRegistrationApi.md#listassetsproductregistrationoperation) | **POST** /admin-api/product-registration/{productRegistration}/assets | Auto-generated: listAssetsProductRegistration |
-| [**listProductsProductRegistration**](ProductRegistrationApi.md#listproductsproductregistration) | **POST** /admin-api/product-registration/{productRegistration}/product/list | Auto-generated: listProductsProductRegistration |
-| [**showProductRegistration**](ProductRegistrationApi.md#showproductregistration) | **GET** /admin-api/product-registration/{productRegistration} | Auto-generated: showProductRegistration |
-
-
-
-## getAllProductRegistration
-
-> ProductRegistrationLiteResourceArrayResponse getAllProductRegistration(getAllProductRegistrationRequest)
-
-Auto-generated: getAllProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // GetAllProductRegistrationRequest (optional)
-    getAllProductRegistrationRequest: ...,
-  } satisfies GetAllProductRegistrationOperationRequest;
-
-  try {
-    const data = await api.getAllProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getAllProductRegistrationRequest** | [GetAllProductRegistrationRequest](GetAllProductRegistrationRequest.md) |  | [Optional] |
-
-### Return type
-
-[**ProductRegistrationLiteResourceArrayResponse**](ProductRegistrationLiteResourceArrayResponse.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)
-
-
-## indexProductRegistration
-
-> PaginatedProductRegistrationListResourceResponse indexProductRegistration(indexProductRegistrationRequest)
-
-Auto-generated: indexProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // IndexProductRegistrationRequest (optional)
-    indexProductRegistrationRequest: ...,
-  } satisfies IndexProductRegistrationOperationRequest;
-
-  try {
-    const data = await api.indexProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **indexProductRegistrationRequest** | [IndexProductRegistrationRequest](IndexProductRegistrationRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductRegistrationListResourceResponse**](PaginatedProductRegistrationListResourceResponse.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<\\ProductRegistrationListResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## listAssetsProductRegistration
-
-> PaginatedProductRegistrationAssetResourceResponse listAssetsProductRegistration(productRegistration, listAssetsProductRegistrationRequest)
-
-Auto-generated: listAssetsProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ListAssetsProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // number | The id of the productRegistration
-    productRegistration: 56,
-    // ListAssetsProductRegistrationRequest (optional)
-    listAssetsProductRegistrationRequest: ...,
-  } satisfies ListAssetsProductRegistrationOperationRequest;
-
-  try {
-    const data = await api.listAssetsProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
-| **listAssetsProductRegistrationRequest** | [ListAssetsProductRegistrationRequest](ListAssetsProductRegistrationRequest.md) |  | [Optional] |
-
-### Return type
-
-[**PaginatedProductRegistrationAssetResourceResponse**](PaginatedProductRegistrationAssetResourceResponse.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<\\ProductRegistrationAssetResource[]>> |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## listProductsProductRegistration
-
-> PaginatedProductChildListResourceResponse listProductsProductRegistration(productRegistration, indexProductChildRequest)
-
-Auto-generated: listProductsProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ListProductsProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // number | The id of the productRegistration
-    productRegistration: 56,
-    // IndexProductChildRequest (optional)
-    indexProductChildRequest: ...,
-  } satisfies ListProductsProductRegistrationRequest;
-
-  try {
-    const data = await api.listProductsProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
-| **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)
-
-
-## showProductRegistration
-
-> ProductRegistrationResource showProductRegistration(productRegistration)
-
-Auto-generated: showProductRegistration
-
-### Example
-
-```ts
-import {
-  Configuration,
-  ProductRegistrationApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new ProductRegistrationApi();
-
-  const body = {
-    // number | The id of the productRegistration
-    productRegistration: 56,
-  } satisfies ShowProductRegistrationRequest;
-
-  try {
-    const data = await api.showProductRegistration(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
-
-### Return type
-
-[**ProductRegistrationResource**](ProductRegistrationResource.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)
-

package/docs/ProductRegistrationAssetResource.md

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

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