@digital8/lighting-illusions-ts-sdk 0.0.1708 → 0.0.1709

package/docs/ReviewApi.md

@@ -0,0 +1,407 @@
+# 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 |
+| [**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 |
+
+
+
+## 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)
+
+
+## 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)
+
+
+## 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/ReviewListResource.md

@@ -0,0 +1,52 @@
+
+# ReviewListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`createdByAdmin` | boolean
+`approvedAt` | Date
+`createdAt` | Date
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
+
+## Example
+
+```typescript
+import type { ReviewListResource } 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,
+  "createdByAdmin": null,
+  "approvedAt": null,
+  "createdAt": null,
+  "site": null,
+  "productChild": null,
+} satisfies ReviewListResource
+
+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 ReviewListResource
+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/ReviewListResourceArrayResponse.md

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

@@ -0,0 +1,38 @@
+
+# ReviewLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`reviewerName` | string
+`rating` | number
+
+## Example
+
+```typescript
+import type { ReviewLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "reviewerName": null,
+  "rating": null,
+} satisfies ReviewLiteResource
+
+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 ReviewLiteResource
+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/ReviewLiteResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# ReviewLiteResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ReviewLiteResource>](ReviewLiteResource.md)
+
+## Example
+
+```typescript
+import type { ReviewLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ReviewLiteResourceArrayResponse
+
+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 ReviewLiteResourceArrayResponse
+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/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/{StoreStockType.md → ReviewResourceArrayResponse.md}

@@ -1,20 +1,22 @@
 
-# StoreStockType
+# ReviewResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`data` | [Array<ReviewResource>](ReviewResource.md)
 
 ## Example
 
 ```typescript
-import type { StoreStockType } 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 = {
-} satisfies StoreStockType
+  "data": null,
+} satisfies ReviewResourceArrayResponse
 
 console.log(example)
 
@@ -23,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 StoreStockType
+const exampleParsed = JSON.parse(exampleJSON) as ReviewResourceArrayResponse
 console.log(exampleParsed)
 ```