@digital8/lighting-illusions-ts-sdk 0.0.1527 → 0.0.1529

package/docs/PaginatedProductRegistrationAssetResourceResponse.md

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

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

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

@@ -21,7 +21,6 @@ Name | Type
 `seo` | object
 `assets` | object
 `thumbnail` | string
-`attributes` | [Array<ModelAttributeResource>](ModelAttributeResource.md)
 
 ## Example
 
@@ -45,7 +44,6 @@ const example = {
   "seo": null,
   "assets": null,
   "thumbnail": null,
-  "attributes": null,
 } satisfies ProductRangeFrontendResource
 
 console.log(example)

package/docs/ProductRegistrationApi.md

@@ -0,0 +1,275 @@
+# 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 |
+| [**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)
+
+
+## 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

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

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

package/docs/ProductRegistrationAssetType.md

@@ -0,0 +1,32 @@
+
+# ProductRegistrationAssetType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ProductRegistrationAssetType } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ProductRegistrationAssetType
+
+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 ProductRegistrationAssetType
+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/ProductRegistrationCustomerResource.md

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

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

@@ -0,0 +1,42 @@
+
+# ProductRegistrationListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`purchasedDate` | Date
+`customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
+`productChildrenCount` | number
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ProductRegistrationListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "purchasedDate": null,
+  "customer": null,
+  "productChildrenCount": null,
+  "createdAt": null,
+} satisfies ProductRegistrationListResource
+
+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 ProductRegistrationListResource
+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/ProductRegistrationListResourceArrayResponse.md

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