@digital8/lighting-illusions-ts-sdk 0.0.1490 → 0.0.1491

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/{UpdateMenuRequestMenuItemOrderInner.md → ProductRegistrationAssetResource.md}

@@ -1,5 +1,5 @@
 
-# UpdateMenuRequestMenuItemOrderInner
+# ProductRegistrationAssetResource
 
 
 ## Properties
@@ -7,20 +7,20 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`index` | number
-`parentId` | number
+`type` | object
+`asset` | [AssetResource](AssetResource.md)
 
 ## Example
 
 ```typescript
-import type { UpdateMenuRequestMenuItemOrderInner } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationAssetResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "index": null,
-  "parentId": null,
-} satisfies UpdateMenuRequestMenuItemOrderInner
+  "type": null,
+  "asset": null,
+} satisfies ProductRegistrationAssetResource
 
 console.log(example)
 
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as UpdateMenuRequestMenuItemOrderInner
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationAssetResource
 console.log(exampleParsed)
 ```
 

package/docs/{MenuItemEditResourceArrayResponse.md → ProductRegistrationAssetResourceArrayResponse.md}

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

package/docs/{MenuItemType.md → ProductRegistrationAssetType.md}

@@ -1,5 +1,5 @@
 
-# MenuItemType
+# ProductRegistrationAssetType
 
 
 ## Properties
@@ -10,11 +10,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { MenuItemType } 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 = {
-} satisfies MenuItemType
+} satisfies ProductRegistrationAssetType
 
 console.log(example)
 
@@ -23,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 MenuItemType
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationAssetType
 console.log(exampleParsed)
 ```
 

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

@@ -1,28 +1,32 @@
 
-# UpdateMenuRequest
+# ProductRegistrationCustomerResource
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`siteId` | number
-`position` | string
+`id` | number
 `name` | string
-`menuItemOrder` | [Array<UpdateMenuRequestMenuItemOrderInner>](UpdateMenuRequestMenuItemOrderInner.md)
+`email` | string
+`phone` | string
+`omnisendId` | string
+`omnisendSyncStatus` | string
 
 ## Example
 
 ```typescript
-import type { UpdateMenuRequest } 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 = {
-  "siteId": null,
-  "position": null,
+  "id": null,
   "name": null,
-  "menuItemOrder": null,
-} satisfies UpdateMenuRequest
+  "email": null,
+  "phone": null,
+  "omnisendId": null,
+  "omnisendSyncStatus": null,
+} satisfies ProductRegistrationCustomerResource
 
 console.log(example)
 
@@ -31,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 UpdateMenuRequest
+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/{MenuItemLinkResource.md → ProductRegistrationListResource.md}

@@ -1,5 +1,5 @@
 
-# MenuItemLinkResource
+# ProductRegistrationListResource
 
 
 ## Properties
@@ -7,26 +7,24 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`menuItemId` | number
-`linkableId` | string
-`linkableType` | string
-`link` | string
-`isExternalLink` | boolean
+`purchasedDate` | Date
+`customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
+`productChildrenCount` | number
+`createdAt` | Date
 
 ## Example
 
 ```typescript
-import type { MenuItemLinkResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationListResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "menuItemId": null,
-  "linkableId": null,
-  "linkableType": null,
-  "link": null,
-  "isExternalLink": null,
-} satisfies MenuItemLinkResource
+  "purchasedDate": null,
+  "customer": null,
+  "productChildrenCount": null,
+  "createdAt": null,
+} satisfies ProductRegistrationListResource
 
 console.log(example)
 
@@ -35,7 +33,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as MenuItemLinkResource
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationListResource
 console.log(exampleParsed)
 ```
 

package/docs/{MenuItemHierarchyResourceArrayResponse.md → ProductRegistrationListResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# MenuItemHierarchyResourceArrayResponse
+# ProductRegistrationListResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<MenuItemHierarchyResource>](MenuItemHierarchyResource.md)
+`data` | [Array<ProductRegistrationListResource>](ProductRegistrationListResource.md)
 
 ## Example
 
 ```typescript
-import type { MenuItemHierarchyResourceArrayResponse } 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 MenuItemHierarchyResourceArrayResponse
+} 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 MenuItemHierarchyResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationListResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{MenuListResource.md → ProductRegistrationLiteResource.md}

@@ -1,5 +1,5 @@
 
-# MenuListResource
+# ProductRegistrationLiteResource
 
 
 ## Properties
@@ -7,22 +7,18 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`position` | string
-`name` | string
-`site` | [SiteLiteResource](SiteLiteResource.md)
+`purchasedDate` | Date
 
 ## Example
 
 ```typescript
-import type { MenuListResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationLiteResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "position": null,
-  "name": null,
-  "site": null,
-} satisfies MenuListResource
+  "purchasedDate": null,
+} satisfies ProductRegistrationLiteResource
 
 console.log(example)
 
@@ -31,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 MenuListResource
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationLiteResource
 console.log(exampleParsed)
 ```
 

package/docs/{MenuItemResourceArrayResponse.md → ProductRegistrationLiteResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# MenuItemResourceArrayResponse
+# ProductRegistrationLiteResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<MenuItemResource>](MenuItemResource.md)
+`data` | [Array<ProductRegistrationLiteResource>](ProductRegistrationLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { MenuItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies MenuItemResourceArrayResponse
+} satisfies ProductRegistrationLiteResourceArrayResponse
 
 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 MenuItemResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationLiteResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{MenuResource.md → ProductRegistrationProductChildResource.md}

@@ -1,5 +1,5 @@
 
-# MenuResource
+# ProductRegistrationProductChildResource
 
 
 ## Properties
@@ -7,26 +7,22 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`siteId` | number
-`position` | string
 `name` | string
-`site` | [SiteResource](SiteResource.md)
-`menuItemCount` | number
+`sku` | number
+`quantity` | number
 
 ## Example
 
 ```typescript
-import type { MenuResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { ProductRegistrationProductChildResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "siteId": null,
-  "position": null,
   "name": null,
-  "site": null,
-  "menuItemCount": null,
-} satisfies MenuResource
+  "sku": null,
+  "quantity": null,
+} satisfies ProductRegistrationProductChildResource
 
 console.log(example)
 
@@ -35,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as MenuResource
+const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationProductChildResource
 console.log(exampleParsed)
 ```