@digital8/lighting-illusions-ts-sdk 0.0.1564 → 0.0.1565

package/docs/{PaginatedRedirectListResourceResponse.md → PaginatedProductRegistrationResourceResponse.md}

@@ -1,24 +1,24 @@
 
-# PaginatedRedirectListResourceResponse
+# PaginatedProductRegistrationResourceResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<RedirectListResource>](RedirectListResource.md)
+`data` | [Array<ProductRegistrationResource>](ProductRegistrationResource.md)
 `meta` | [PagingMetadata](PagingMetadata.md)
 
 ## Example
 
 ```typescript
-import type { PaginatedRedirectListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { PaginatedProductRegistrationResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
   "meta": null,
-} satisfies PaginatedRedirectListResourceResponse
+} satisfies PaginatedProductRegistrationResourceResponse
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PaginatedRedirectListResourceResponse
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductRegistrationResourceResponse
 console.log(exampleParsed)
 ```
 

package/docs/ProductChildListResource.md

@@ -14,6 +14,7 @@ Name | Type
 `stock` | number
 `isDisabled` | string
 `displayInSocialFeed` | boolean
+`quantity` | string
 `netsuiteId` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
 `siteDetails` | [Array<ProductChildSiteDetailLiteResource>](ProductChildSiteDetailLiteResource.md)
@@ -33,6 +34,7 @@ const example = {
   "stock": null,
   "isDisabled": null,
   "displayInSocialFeed": null,
+  "quantity": null,
   "netsuiteId": null,
   "thumbnail": null,
   "siteDetails": null,

package/docs/ProductRangeFrontendResource.md

@@ -21,7 +21,6 @@ Name | Type
 `seo` | object
 `assets` | object
 `thumbnail` | string
-`attributes` | [Array<ModelAttributeFrontendResource>](ModelAttributeFrontendResource.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,344 @@
+# 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

@@ -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/{ModelAttributeFrontendResource.md → ProductRegistrationAssetType.md}

@@ -1,24 +1,20 @@
 
-# ModelAttributeFrontendResource
+# ProductRegistrationAssetType
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`name` | string
-`value` | string
 
 ## Example
 
 ```typescript
-import type { ModelAttributeFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationAssetType } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "name": null,
-  "value": null,
-} satisfies ModelAttributeFrontendResource
+} satisfies ProductRegistrationAssetType
 
 console.log(example)
 
@@ -27,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ModelAttributeFrontendResource
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationAssetType
 console.log(exampleParsed)
 ```
 

package/docs/{RedirectListResource.md → ProductRegistrationCustomerResource.md}

@@ -1,5 +1,5 @@
 
-# RedirectListResource
+# ProductRegistrationCustomerResource
 
 
 ## Properties
@@ -7,28 +7,26 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`site` | [SiteLiteResource](SiteLiteResource.md)
-`redirectableType` | string
-`redirectableId` | number
-`fromSlug` | string
-`toSlug` | string
-`status` | number
+`name` | string
+`email` | string
+`phone` | string
+`omnisendId` | string
+`omnisendSyncStatus` | string
 
 ## Example
 
 ```typescript
-import type { RedirectListResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationCustomerResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "site": null,
-  "redirectableType": null,
-  "redirectableId": null,
-  "fromSlug": null,
-  "toSlug": null,
-  "status": null,
-} satisfies RedirectListResource
+  "name": null,
+  "email": null,
+  "phone": null,
+  "omnisendId": null,
+  "omnisendSyncStatus": null,
+} satisfies ProductRegistrationCustomerResource
 
 console.log(example)
 
@@ -37,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RedirectListResource
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationCustomerResource
 console.log(exampleParsed)
 ```
 

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/{ModelAttributeFrontendResourceArrayResponse.md → ProductRegistrationListResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# ModelAttributeFrontendResourceArrayResponse
+# ProductRegistrationListResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<ModelAttributeFrontendResource>](ModelAttributeFrontendResource.md)
+`data` | [Array<ProductRegistrationListResource>](ProductRegistrationListResource.md)
 
 ## Example
 
 ```typescript
-import type { ModelAttributeFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies ModelAttributeFrontendResourceArrayResponse
+} satisfies ProductRegistrationListResourceArrayResponse
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ModelAttributeFrontendResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationListResourceArrayResponse
 console.log(exampleParsed)
 ```