@digital8/lighting-illusions-ts-sdk 0.0.1733 → 0.0.1735

package/docs/ReviewApi.md

@@ -0,0 +1,539 @@
+# ReviewApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**destroyReview**](ReviewApi.md#destroyreview) | **DELETE** /admin-api/review/{review}/delete | Auto-generated: destroyReview |
+| [**exportReview**](ReviewApi.md#exportreview) | **POST** /admin-api/review/export | Auto-generated: exportReview |
+| [**getAllReview**](ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview |
+| [**importReview**](ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview |
+| [**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 |
+
+
+
+## destroyReview
+
+> GenericResponse destroyReview(review)
+
+Auto-generated: destroyReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} 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 ReviewApi();
+
+  const body = {
+    // number | The id of the review
+    review: 56,
+  } satisfies DestroyReviewRequest;
+
+  try {
+    const data = await api.destroyReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **review** | `number` | The id of the review | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **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)
+
+
+## exportReview
+
+> Blob exportReview(indexReviewRequest)
+
+Auto-generated: exportReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ExportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReviewApi();
+
+  const body = {
+    // IndexReviewRequest (optional)
+    indexReviewRequest: ...,
+  } satisfies ExportReviewRequest;
+
+  try {
+    const data = await api.exportReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: ``
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | File download () |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAllReview
+
+> ReviewLiteResourceArrayResponse getAllReview(indexReviewRequest)
+
+Auto-generated: getAllReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} 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 ReviewApi();
+
+  const body = {
+    // IndexReviewRequest (optional)
+    indexReviewRequest: ...,
+  } satisfies GetAllReviewRequest;
+
+  try {
+    const data = await api.getAllReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReviewLiteResourceArrayResponse**](ReviewLiteResourceArrayResponse.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)
+
+
+## importReview
+
+> GenericResponse importReview(file)
+
+Auto-generated: importReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ImportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReviewApi();
+
+  const body = {
+    // Blob
+    file: BINARY_DATA_HERE,
+  } satisfies ImportReviewRequest;
+
+  try {
+    const data = await api.importReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/x-www-form-urlencoded`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **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)
+
+
+## indexReview
+
+> PaginatedReviewListResourceResponse indexReview(indexReviewRequest)
+
+Auto-generated: indexReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} 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 ReviewApi();
+
+  const body = {
+    // IndexReviewRequest (optional)
+    indexReviewRequest: ...,
+  } satisfies IndexReviewOperationRequest;
+
+  try {
+    const data = await api.indexReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedReviewListResourceResponse**](PaginatedReviewListResourceResponse.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<\\ReviewListResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## showReview
+
+> ReviewResource showReview(review)
+
+Auto-generated: showReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} 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 ReviewApi();
+
+  const body = {
+    // number | The id of the review
+    review: 56,
+  } satisfies ShowReviewRequest;
+
+  try {
+    const data = await api.showReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **review** | `number` | The id of the review | [Defaults to `undefined`] |
+
+### Return type
+
+[**ReviewResource**](ReviewResource.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)
+
+
+## storeReview
+
+> ReviewResource storeReview(storeReviewRequest)
+
+Auto-generated: storeReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} 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 ReviewApi();
+
+  const body = {
+    // StoreReviewRequest (optional)
+    storeReviewRequest: ...,
+  } satisfies StoreReviewOperationRequest;
+
+  try {
+    const data = await api.storeReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeReviewRequest** | [StoreReviewRequest](StoreReviewRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReviewResource**](ReviewResource.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)
+
+
+## updateReview
+
+> ReviewResource updateReview(review, updateReviewRequest)
+
+Auto-generated: updateReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} 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 ReviewApi();
+
+  const body = {
+    // number | The id of the review
+    review: 56,
+    // UpdateReviewRequest (optional)
+    updateReviewRequest: ...,
+  } satisfies UpdateReviewOperationRequest;
+
+  try {
+    const data = await api.updateReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **review** | `number` | The id of the review | [Defaults to `undefined`] |
+| **updateReviewRequest** | [UpdateReviewRequest](UpdateReviewRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReviewResource**](ReviewResource.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)
+

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

@@ -1,5 +1,5 @@
 
-# PageListResource
+# ReviewListResource
 
 
 ## Properties
@@ -7,34 +7,34 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`name` | string
-`slug` | string
-`type` | object
-`enabled` | boolean
-`siteId` | number
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`createdByAdmin` | boolean
+`approvedAt` | Date
+`createdAt` | Date
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`startDate` | Date
-`createdAt` | string
-`updatedAt` | string
+`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
 
 ## Example
 
 ```typescript
-import type { PageListResource } 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,
-  "slug": null,
-  "type": null,
-  "enabled": null,
-  "siteId": null,
-  "site": null,
-  "startDate": null,
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "replyFromAdmin": null,
+  "createdByAdmin": null,
+  "approvedAt": null,
   "createdAt": null,
-  "updatedAt": null,
-} satisfies PageListResource
+  "site": null,
+  "productChild": null,
+} satisfies ReviewListResource
 
 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 PageListResource
+const exampleParsed = JSON.parse(exampleJSON) as ReviewListResource
 console.log(exampleParsed)
 ```
 

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

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

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

@@ -1,5 +1,5 @@
 
-# PageLiteResource
+# ReviewLiteResource
 
 
 ## Properties
@@ -7,18 +7,20 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`name` | string
+`reviewerName` | string
+`rating` | number
 
 ## Example
 
 ```typescript
-import type { PageLiteResource } 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 = {
   "id": null,
-  "name": null,
-} satisfies PageLiteResource
+  "reviewerName": null,
+  "rating": null,
+} satisfies ReviewLiteResource
 
 console.log(example)
 
@@ -27,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 PageLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as ReviewLiteResource
 console.log(exampleParsed)
 ```
 

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

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