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

package/docs/AdminApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost/api*
 
 ## generateGoogleFeedAdmin
 
-> GenericResponse generateGoogleFeedAdmin(getHierarchyMenuItemRequest)
+> GenericResponse generateGoogleFeedAdmin(getHierarchyProductCategoryRequest)
 
 Auto-generated: generateGoogleFeedAdmin
 
@@ -30,8 +30,8 @@ async function example() {
   const api = new AdminApi();
 
   const body = {
-    // GetHierarchyMenuItemRequest (optional)
-    getHierarchyMenuItemRequest: ...,
+    // GetHierarchyProductCategoryRequest (optional)
+    getHierarchyProductCategoryRequest: ...,
   } satisfies GenerateGoogleFeedAdminRequest;
 
   try {
@@ -51,7 +51,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) |  | [Optional] |
+| **getHierarchyProductCategoryRequest** | [GetHierarchyProductCategoryRequest](GetHierarchyProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -77,7 +77,7 @@ No authorization required
 
 ## generateSocialFeedAdmin
 
-> GenericResponse generateSocialFeedAdmin(getHierarchyMenuItemRequest)
+> GenericResponse generateSocialFeedAdmin(getHierarchyProductCategoryRequest)
 
 Auto-generated: generateSocialFeedAdmin
 
@@ -95,8 +95,8 @@ async function example() {
   const api = new AdminApi();
 
   const body = {
-    // GetHierarchyMenuItemRequest (optional)
-    getHierarchyMenuItemRequest: ...,
+    // GetHierarchyProductCategoryRequest (optional)
+    getHierarchyProductCategoryRequest: ...,
   } satisfies GenerateSocialFeedAdminRequest;
 
   try {
@@ -116,7 +116,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) |  | [Optional] |
+| **getHierarchyProductCategoryRequest** | [GetHierarchyProductCategoryRequest](GetHierarchyProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -142,7 +142,7 @@ No authorization required
 
 ## generateTGNDataFeedAdmin
 
-> GenericResponse generateTGNDataFeedAdmin(getHierarchyMenuItemRequest)
+> GenericResponse generateTGNDataFeedAdmin(getHierarchyProductCategoryRequest)
 
 Auto-generated: generateTGNDataFeedAdmin
 
@@ -160,8 +160,8 @@ async function example() {
   const api = new AdminApi();
 
   const body = {
-    // GetHierarchyMenuItemRequest (optional)
-    getHierarchyMenuItemRequest: ...,
+    // GetHierarchyProductCategoryRequest (optional)
+    getHierarchyProductCategoryRequest: ...,
   } satisfies GenerateTGNDataFeedAdminRequest;
 
   try {
@@ -181,7 +181,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) |  | [Optional] |
+| **getHierarchyProductCategoryRequest** | [GetHierarchyProductCategoryRequest](GetHierarchyProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/{GetAllMenuRequest.md → GetAllProductRegistrationRequest.md}

@@ -1,5 +1,5 @@
 
-# GetAllMenuRequest
+# GetAllProductRegistrationRequest
 
 
 ## Properties
@@ -13,12 +13,11 @@ Name | Type
 `relatedType` | string
 `includesRelations` | boolean
 `siteId` | Array<string>
-`position` | Array<string>
 
 ## Example
 
 ```typescript
-import type { GetAllMenuRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { GetAllProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -29,8 +28,7 @@ const example = {
   "relatedType": null,
   "includesRelations": null,
   "siteId": null,
-  "position": null,
-} satisfies GetAllMenuRequest
+} satisfies GetAllProductRegistrationRequest
 
 console.log(example)
 
@@ -39,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GetAllMenuRequest
+const exampleParsed = JSON.parse(exampleJSON) as GetAllProductRegistrationRequest
 console.log(exampleParsed)
 ```
 

package/docs/{StoreMenuRequest.md → GetHierarchyProductCategoryRequest.md}

@@ -1,5 +1,5 @@
 
-# StoreMenuRequest
+# GetHierarchyProductCategoryRequest
 
 
 ## Properties
@@ -7,20 +7,16 @@
 Name | Type
 ------------ | -------------
 `siteId` | number
-`position` | string
-`name` | string
 
 ## Example
 
 ```typescript
-import type { StoreMenuRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "siteId": null,
-  "position": null,
-  "name": null,
-} satisfies StoreMenuRequest
+} satisfies GetHierarchyProductCategoryRequest
 
 console.log(example)
 
@@ -29,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 StoreMenuRequest
+const exampleParsed = JSON.parse(exampleJSON) as GetHierarchyProductCategoryRequest
 console.log(exampleParsed)
 ```
 

package/docs/{GetAllMenuItemRequest.md → IndexProductRegistrationRequest.md}

@@ -1,5 +1,5 @@
 
-# GetAllMenuItemRequest
+# IndexProductRegistrationRequest
 
 
 ## Properties
@@ -9,28 +9,38 @@ 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
-`menuId` | Array<string>
-`type` | Array<string>
 
 ## Example
 
 ```typescript
-import type { GetAllMenuItemRequest } from '@digital8/lighting-illusions-ts-sdk'
+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,
-  "menuId": null,
-  "type": null,
-} satisfies GetAllMenuItemRequest
+} satisfies IndexProductRegistrationRequest
 
 console.log(example)
 
@@ -39,7 +49,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GetAllMenuItemRequest
+const exampleParsed = JSON.parse(exampleJSON) as IndexProductRegistrationRequest
 console.log(exampleParsed)
 ```
 

package/docs/{IndexMenuRequest.md → ListAssetsProductRegistrationRequest.md}

@@ -1,5 +1,5 @@
 
-# IndexMenuRequest
+# ListAssetsProductRegistrationRequest
 
 
 ## Properties
@@ -11,8 +11,8 @@ Name | Type
 `sortDirection` | string
 `perPage` | number
 `page` | number
-`siteId` | Array<string>
-`position` | Array<string>
+`productRegistrationId` | Array<string>
+`type` | Array<string>
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
@@ -20,7 +20,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { IndexMenuRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { ListAssetsProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -29,12 +29,12 @@ const example = {
   "sortDirection": null,
   "perPage": null,
   "page": null,
-  "siteId": null,
-  "position": null,
+  "productRegistrationId": null,
+  "type": null,
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-} satisfies IndexMenuRequest
+} satisfies ListAssetsProductRegistrationRequest
 
 console.log(example)
 
@@ -43,7 +43,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as IndexMenuRequest
+const exampleParsed = JSON.parse(exampleJSON) as ListAssetsProductRegistrationRequest
 console.log(exampleParsed)
 ```
 

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/{PaginatedMenuListResourceResponse.md → PaginatedProductRegistrationResourceResponse.md}

@@ -1,24 +1,24 @@
 
-# PaginatedMenuListResourceResponse
+# PaginatedProductRegistrationResourceResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<MenuListResource>](MenuListResource.md)
+`data` | [Array<ProductRegistrationResource>](ProductRegistrationResource.md)
 `meta` | [PagingMetadata](PagingMetadata.md)
 
 ## Example
 
 ```typescript
-import type { PaginatedMenuListResourceResponse } 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 PaginatedMenuListResourceResponse
+} 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 PaginatedMenuListResourceResponse
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductRegistrationResourceResponse
 console.log(exampleParsed)
 ```
 

package/docs/ProductCategoryApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost/api*
 | [**getAllChildrenProductCategory**](ProductCategoryApi.md#getallchildrenproductcategory) | **POST** /admin-api/product-category/{productCategory}/children/all | Auto-generated: getAllChildrenProductCategory |
 | [**getAllProductCategory**](ProductCategoryApi.md#getallproductcategoryoperation) | **POST** /admin-api/product-category/all | Auto-generated: getAllProductCategory |
 | [**getChildrenProductCategory**](ProductCategoryApi.md#getchildrenproductcategory) | **GET** /admin-api/product-category/{productCategory}/children | Auto-generated: getChildrenProductCategory |
-| [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategory) | **POST** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
+| [**getHierarchyProductCategory**](ProductCategoryApi.md#gethierarchyproductcategoryoperation) | **POST** /admin-api/product-category/hierarchy | Auto-generated: getHierarchyProductCategory |
 | [**indexProductCategory**](ProductCategoryApi.md#indexproductcategoryoperation) | **POST** /admin-api/product-category/list | Auto-generated: indexProductCategory |
 | [**previewAutomationRulesProductCategory**](ProductCategoryApi.md#previewautomationrulesproductcategoryoperation) | **POST** /admin-api/product-category/preview-automation-rules | Auto-generated: previewAutomationRulesProductCategory |
 | [**showProductCategory**](ProductCategoryApi.md#showproductcategory) | **GET** /admin-api/product-category/{productCategory} | Auto-generated: showProductCategory |
@@ -489,7 +489,7 @@ No authorization required
 
 ## getHierarchyProductCategory
 
-> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(getHierarchyMenuItemRequest)
+> ProductCategoryHierarchyResourceArrayResponse getHierarchyProductCategory(getHierarchyProductCategoryRequest)
 
 Auto-generated: getHierarchyProductCategory
 
@@ -500,16 +500,16 @@ import {
   Configuration,
   ProductCategoryApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetHierarchyProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetHierarchyProductCategoryOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
   const api = new ProductCategoryApi();
 
   const body = {
-    // GetHierarchyMenuItemRequest (optional)
-    getHierarchyMenuItemRequest: ...,
-  } satisfies GetHierarchyProductCategoryRequest;
+    // GetHierarchyProductCategoryRequest (optional)
+    getHierarchyProductCategoryRequest: ...,
+  } satisfies GetHierarchyProductCategoryOperationRequest;
 
   try {
     const data = await api.getHierarchyProductCategory(body);
@@ -528,7 +528,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getHierarchyMenuItemRequest** | [GetHierarchyMenuItemRequest](GetHierarchyMenuItemRequest.md) |  | [Optional] |
+| **getHierarchyProductCategoryRequest** | [GetHierarchyProductCategoryRequest](GetHierarchyProductCategoryRequest.md) |  | [Optional] |
 
 ### Return type