@digital8/lighting-illusions-ts-sdk 0.0.1703 → 0.0.1705

package/docs/{MenuApi.md → ReviewApi.md}

@@ -1,44 +1,44 @@
-# MenuApi
+# ReviewApi
 
 All URIs are relative to *http://localhost/api*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**destroyMenu**](MenuApi.md#destroymenu) | **DELETE** /admin-api/menu/{menu}/delete | Auto-generated: destroyMenu |
-| [**getAllMenu**](MenuApi.md#getallmenuoperation) | **POST** /admin-api/menu/all | Auto-generated: getAllMenu |
-| [**indexMenu**](MenuApi.md#indexmenuoperation) | **POST** /admin-api/menu/list | Auto-generated: indexMenu |
-| [**showMenu**](MenuApi.md#showmenu) | **GET** /admin-api/menu/{menu} | Auto-generated: showMenu |
-| [**storeMenu**](MenuApi.md#storemenuoperation) | **POST** /admin-api/menu/create | Auto-generated: storeMenu |
-| [**updateMenu**](MenuApi.md#updatemenuoperation) | **PUT** /admin-api/menu/{menu}/update | Auto-generated: updateMenu |
+| [**destroyReview**](ReviewApi.md#destroyreview) | **DELETE** /admin-api/review/{review}/delete | Auto-generated: destroyReview |
+| [**getAllReview**](ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview |
+| [**indexReview**](ReviewApi.md#indexreviewoperation) | **POST** /admin-api/review/list | Auto-generated: indexReview |
+| [**showReview**](ReviewApi.md#showreview) | **GET** /admin-api/review/{review} | Auto-generated: showReview |
+| [**storeReview**](ReviewApi.md#storereviewoperation) | **POST** /admin-api/review/create | Auto-generated: storeReview |
+| [**updateReview**](ReviewApi.md#updatereviewoperation) | **PUT** /admin-api/review/{review}/update | Auto-generated: updateReview |
 
 
 
-## destroyMenu
+## destroyReview
 
-> GenericResponse destroyMenu(menu)
+> GenericResponse destroyReview(review)
 
-Auto-generated: destroyMenu
+Auto-generated: destroyReview
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  MenuApi,
+  ReviewApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyMenuRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { DestroyReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuApi();
+  const api = new ReviewApi();
 
   const body = {
-    // number | The id of the menu
-    menu: 56,
-  } satisfies DestroyMenuRequest;
+    // number | The id of the review
+    review: 56,
+  } satisfies DestroyReviewRequest;
 
   try {
-    const data = await api.destroyMenu(body);
+    const data = await api.destroyReview(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -54,7 +54,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+| **review** | `number` | The id of the review | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -73,37 +73,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | \\JsonResponse<array{message: string}> |  -  |
+| **200** | \\JsonResponse |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getAllMenu
+## getAllReview
 
-> MenuListResourceArrayResponse getAllMenu(getAllMenuRequest)
+> ReviewLiteResourceArrayResponse getAllReview(indexReviewRequest)
 
-Auto-generated: getAllMenu
+Auto-generated: getAllReview
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  MenuApi,
+  ReviewApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { GetAllReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuApi();
+  const api = new ReviewApi();
 
   const body = {
-    // GetAllMenuRequest (optional)
-    getAllMenuRequest: ...,
-  } satisfies GetAllMenuOperationRequest;
+    // IndexReviewRequest (optional)
+    indexReviewRequest: ...,
+  } satisfies GetAllReviewRequest;
 
   try {
-    const data = await api.getAllMenu(body);
+    const data = await api.getAllReview(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -119,11 +119,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **getAllMenuRequest** | [GetAllMenuRequest](GetAllMenuRequest.md) |  | [Optional] |
+| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**MenuListResourceArrayResponse**](MenuListResourceArrayResponse.md)
+[**ReviewLiteResourceArrayResponse**](ReviewLiteResourceArrayResponse.md)
 
 ### Authorization
 
@@ -143,32 +143,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## indexMenu
+## indexReview
 
-> PaginatedMenuListResourceResponse indexMenu(indexMenuRequest)
+> PaginatedReviewListResourceResponse indexReview(indexReviewRequest)
 
-Auto-generated: indexMenu
+Auto-generated: indexReview
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  MenuApi,
+  ReviewApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { IndexMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuApi();
+  const api = new ReviewApi();
 
   const body = {
-    // IndexMenuRequest (optional)
-    indexMenuRequest: ...,
-  } satisfies IndexMenuOperationRequest;
+    // IndexReviewRequest (optional)
+    indexReviewRequest: ...,
+  } satisfies IndexReviewOperationRequest;
 
   try {
-    const data = await api.indexMenu(body);
+    const data = await api.indexReview(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -184,11 +184,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **indexMenuRequest** | [IndexMenuRequest](IndexMenuRequest.md) |  | [Optional] |
+| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**PaginatedMenuListResourceResponse**](PaginatedMenuListResourceResponse.md)
+[**PaginatedReviewListResourceResponse**](PaginatedReviewListResourceResponse.md)
 
 ### Authorization
 
@@ -203,37 +203,37 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\MenuListResource[]>> |  -  |
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ReviewListResource[]>> |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## showMenu
+## showReview
 
-> MenuResource showMenu(menu)
+> ReviewResource showReview(review)
 
-Auto-generated: showMenu
+Auto-generated: showReview
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  MenuApi,
+  ReviewApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { ShowMenuRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { ShowReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuApi();
+  const api = new ReviewApi();
 
   const body = {
-    // number | The id of the menu
-    menu: 56,
-  } satisfies ShowMenuRequest;
+    // number | The id of the review
+    review: 56,
+  } satisfies ShowReviewRequest;
 
   try {
-    const data = await api.showMenu(body);
+    const data = await api.showReview(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -249,11 +249,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
+| **review** | `number` | The id of the review | [Defaults to `undefined`] |
 
 ### Return type
 
-[**MenuResource**](MenuResource.md)
+[**ReviewResource**](ReviewResource.md)
 
 ### Authorization
 
@@ -273,32 +273,32 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## storeMenu
+## storeReview
 
-> MenuResource storeMenu(storeMenuRequest)
+> ReviewResource storeReview(storeReviewRequest)
 
-Auto-generated: storeMenu
+Auto-generated: storeReview
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  MenuApi,
+  ReviewApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { StoreMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuApi();
+  const api = new ReviewApi();
 
   const body = {
-    // StoreMenuRequest (optional)
-    storeMenuRequest: ...,
-  } satisfies StoreMenuOperationRequest;
+    // StoreReviewRequest (optional)
+    storeReviewRequest: ...,
+  } satisfies StoreReviewOperationRequest;
 
   try {
-    const data = await api.storeMenu(body);
+    const data = await api.storeReview(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -314,11 +314,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **storeMenuRequest** | [StoreMenuRequest](StoreMenuRequest.md) |  | [Optional] |
+| **storeReviewRequest** | [StoreReviewRequest](StoreReviewRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**MenuResource**](MenuResource.md)
+[**ReviewResource**](ReviewResource.md)
 
 ### Authorization
 
@@ -338,34 +338,34 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## updateMenu
+## updateReview
 
-> MenuResource updateMenu(menu, updateMenuRequest)
+> ReviewResource updateReview(review, updateReviewRequest)
 
-Auto-generated: updateMenu
+Auto-generated: updateReview
 
 ### Example
 
 ```ts
 import {
   Configuration,
-  MenuApi,
+  ReviewApi,
 } from '@digital8/lighting-illusions-ts-sdk';
-import type { UpdateMenuOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateReviewOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
 
 async function example() {
   console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new MenuApi();
+  const api = new ReviewApi();
 
   const body = {
-    // number | The id of the menu
-    menu: 56,
-    // UpdateMenuRequest (optional)
-    updateMenuRequest: ...,
-  } satisfies UpdateMenuOperationRequest;
+    // number | The id of the review
+    review: 56,
+    // UpdateReviewRequest (optional)
+    updateReviewRequest: ...,
+  } satisfies UpdateReviewOperationRequest;
 
   try {
-    const data = await api.updateMenu(body);
+    const data = await api.updateReview(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -381,12 +381,12 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **menu** | `number` | The id of the menu | [Defaults to `undefined`] |
-| **updateMenuRequest** | [UpdateMenuRequest](UpdateMenuRequest.md) |  | [Optional] |
+| **review** | `number` | The id of the review | [Defaults to `undefined`] |
+| **updateReviewRequest** | [UpdateReviewRequest](UpdateReviewRequest.md) |  | [Optional] |
 
 ### Return type
 
-[**MenuResource**](MenuResource.md)
+[**ReviewResource**](ReviewResource.md)
 
 ### Authorization
 

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

@@ -1,5 +1,5 @@
 
-# MenuListResource
+# ReviewListResource
 
 
 ## Properties
@@ -7,26 +7,34 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`name` | string
-`position` | string
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`createdByAdmin` | boolean
+`approvedAt` | Date
+`createdAt` | Date
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`items` | [Array<MenuItemLiteResource>](MenuItemLiteResource.md)
-`menuItemCount` | number
+`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { MenuListResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { ReviewListResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "name": null,
-  "position": null,
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "replyFromAdmin": null,
+  "createdByAdmin": null,
+  "approvedAt": null,
+  "createdAt": null,
   "site": null,
-  "items": null,
-  "menuItemCount": null,
-} satisfies MenuListResource
+  "productChild": null,
+} satisfies ReviewListResource
 
 console.log(example)
 
@@ -35,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 MenuListResource
+const exampleParsed = JSON.parse(exampleJSON) as ReviewListResource
 console.log(exampleParsed)
 ```
 

package/docs/{MenuResourceArrayResponse.md → ReviewListResourceArrayResponse.md}

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

package/docs/{MenuPosition.md → ReviewLiteResource.md}

@@ -1,20 +1,26 @@
 
-# MenuPosition
+# ReviewLiteResource
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`id` | number
+`reviewerName` | string
+`rating` | number
 
 ## Example
 
 ```typescript
-import type { MenuPosition } from '@digital8/lighting-illusions-ts-sdk'
+import type { ReviewLiteResource } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies MenuPosition
+  "id": null,
+  "reviewerName": null,
+  "rating": null,
+} satisfies ReviewLiteResource
 
 console.log(example)
 
@@ -23,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 MenuPosition
+const exampleParsed = JSON.parse(exampleJSON) as ReviewLiteResource
 console.log(exampleParsed)
 ```
 

package/docs/{MenuListResourceArrayResponse.md → ReviewLiteResourceArrayResponse.md}

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

package/docs/ReviewResource.md

@@ -0,0 +1,62 @@
+
+# ReviewResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`location` | string
+`createdByAdmin` | boolean
+`approvedAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
+`customer` | [CustomerLiteResource](CustomerLiteResource.md)
+`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
+`approver` | [AdminUserLiteResource](AdminUserLiteResource.md)
+
+## Example
+
+```typescript
+import type { ReviewResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "replyFromAdmin": null,
+  "location": null,
+  "createdByAdmin": null,
+  "approvedAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "site": null,
+  "productChild": null,
+  "customer": null,
+  "admin": null,
+  "approver": null,
+} satisfies ReviewResource
+
+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 ReviewResource
+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/{GetHierarchyMenuItemRequest.md → ReviewResourceArrayResponse.md}

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