@digital8/lighting-illusions-ts-sdk 0.0.1652 → 0.0.1654

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` | string
+`createdAt` | string
+`updatedAt` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`productChild` | Array<number>
+`customer` | object
+`admin` | object
+`approver` | object
+
+## 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/{PageType.md → ReviewResourceArrayResponse.md}

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

package/docs/StoreReviewRequest.md

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

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | string
+`date` | object
 `closed` | boolean
 `displayStartDate` | object
 `displayEndDate` | object

package/docs/{BlogCategoryLiteResourceArrayResponse.md → UpdateReviewRequest.md}

@@ -1,22 +1,32 @@
 
-# BlogCategoryLiteResourceArrayResponse
+# UpdateReviewRequest
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<BlogCategoryLiteResource>](BlogCategoryLiteResource.md)
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`location` | string
+`approved` | boolean
 
 ## Example
 
 ```typescript
-import type { BlogCategoryLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { UpdateReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
-} satisfies BlogCategoryLiteResourceArrayResponse
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "replyFromAdmin": null,
+  "location": null,
+  "approved": null,
+} satisfies UpdateReviewRequest
 
 console.log(example)
 
@@ -25,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 BlogCategoryLiteResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as UpdateReviewRequest
 console.log(exampleParsed)
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/lighting-illusions-ts-sdk",
-  "version": "0.0.1652",
+  "version": "0.0.1654",
   "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ReviewApi.ts

@@ -0,0 +1,444 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  GenericResponse,
+  IndexReviewRequest,
+  PaginatedReviewListResourceResponse,
+  ReviewLiteResourceArrayResponse,
+  ReviewResource,
+  StoreReviewRequest,
+  UpdateReviewRequest,
+} from '../models/index';
+import {
+    GenericResponseFromJSON,
+    GenericResponseToJSON,
+    IndexReviewRequestFromJSON,
+    IndexReviewRequestToJSON,
+    PaginatedReviewListResourceResponseFromJSON,
+    PaginatedReviewListResourceResponseToJSON,
+    ReviewLiteResourceArrayResponseFromJSON,
+    ReviewLiteResourceArrayResponseToJSON,
+    ReviewResourceFromJSON,
+    ReviewResourceToJSON,
+    StoreReviewRequestFromJSON,
+    StoreReviewRequestToJSON,
+    UpdateReviewRequestFromJSON,
+    UpdateReviewRequestToJSON,
+} from '../models/index';
+
+export interface DestroyReviewRequest {
+    review: number;
+}
+
+export interface ExportReviewRequest {
+    indexReviewRequest?: IndexReviewRequest;
+}
+
+export interface GetAllReviewRequest {
+    indexReviewRequest?: IndexReviewRequest;
+}
+
+export interface ImportReviewRequest {
+    file: Blob;
+}
+
+export interface IndexReviewOperationRequest {
+    indexReviewRequest?: IndexReviewRequest;
+}
+
+export interface ShowReviewRequest {
+    review: number;
+}
+
+export interface StoreReviewOperationRequest {
+    storeReviewRequest?: StoreReviewRequest;
+}
+
+export interface UpdateReviewOperationRequest {
+    review: number;
+    updateReviewRequest?: UpdateReviewRequest;
+}
+
+/**
+ * 
+ */
+export class ReviewApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for destroyReview without sending the request
+     */
+    async destroyReviewRequestOpts(requestParameters: DestroyReviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['review'] == null) {
+            throw new runtime.RequiredError(
+                'review',
+                'Required parameter "review" was null or undefined when calling destroyReview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/review/{review}/delete`;
+        urlPath = urlPath.replace(`{${"review"}}`, encodeURIComponent(String(requestParameters['review'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Auto-generated: destroyReview
+     */
+    async destroyReviewRaw(requestParameters: DestroyReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        const requestOptions = await this.destroyReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: destroyReview
+     */
+    async destroyReview(requestParameters: DestroyReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.destroyReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for exportReview without sending the request
+     */
+    async exportReviewRequestOpts(requestParameters: ExportReviewRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/review/export`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexReviewRequestToJSON(requestParameters['indexReviewRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: exportReview
+     */
+    async exportReviewRaw(requestParameters: ExportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.exportReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Auto-generated: exportReview
+     */
+    async exportReview(requestParameters: ExportReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.exportReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getAllReview without sending the request
+     */
+    async getAllReviewRequestOpts(requestParameters: GetAllReviewRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/review/all`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexReviewRequestToJSON(requestParameters['indexReviewRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: getAllReview
+     */
+    async getAllReviewRaw(requestParameters: GetAllReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReviewLiteResourceArrayResponse>> {
+        const requestOptions = await this.getAllReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReviewLiteResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getAllReview
+     */
+    async getAllReview(requestParameters: GetAllReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewLiteResourceArrayResponse> {
+        const response = await this.getAllReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for importReview without sending the request
+     */
+    async importReviewRequestOpts(requestParameters: ImportReviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling importReview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+
+        let urlPath = `/admin-api/review/import`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Auto-generated: importReview
+     */
+    async importReviewRaw(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        const requestOptions = await this.importReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: importReview
+     */
+    async importReview(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.importReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for indexReview without sending the request
+     */
+    async indexReviewRequestOpts(requestParameters: IndexReviewOperationRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/review/list`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IndexReviewRequestToJSON(requestParameters['indexReviewRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: indexReview
+     */
+    async indexReviewRaw(requestParameters: IndexReviewOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedReviewListResourceResponse>> {
+        const requestOptions = await this.indexReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedReviewListResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: indexReview
+     */
+    async indexReview(requestParameters: IndexReviewOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedReviewListResourceResponse> {
+        const response = await this.indexReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for showReview without sending the request
+     */
+    async showReviewRequestOpts(requestParameters: ShowReviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['review'] == null) {
+            throw new runtime.RequiredError(
+                'review',
+                'Required parameter "review" was null or undefined when calling showReview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/review/{review}`;
+        urlPath = urlPath.replace(`{${"review"}}`, encodeURIComponent(String(requestParameters['review'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Auto-generated: showReview
+     */
+    async showReviewRaw(requestParameters: ShowReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReviewResource>> {
+        const requestOptions = await this.showReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReviewResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: showReview
+     */
+    async showReview(requestParameters: ShowReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewResource> {
+        const response = await this.showReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for storeReview without sending the request
+     */
+    async storeReviewRequestOpts(requestParameters: StoreReviewOperationRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/review/create`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: StoreReviewRequestToJSON(requestParameters['storeReviewRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: storeReview
+     */
+    async storeReviewRaw(requestParameters: StoreReviewOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReviewResource>> {
+        const requestOptions = await this.storeReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReviewResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: storeReview
+     */
+    async storeReview(requestParameters: StoreReviewOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewResource> {
+        const response = await this.storeReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateReview without sending the request
+     */
+    async updateReviewRequestOpts(requestParameters: UpdateReviewOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['review'] == null) {
+            throw new runtime.RequiredError(
+                'review',
+                'Required parameter "review" was null or undefined when calling updateReview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/review/{review}/update`;
+        urlPath = urlPath.replace(`{${"review"}}`, encodeURIComponent(String(requestParameters['review'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateReviewRequestToJSON(requestParameters['updateReviewRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: updateReview
+     */
+    async updateReviewRaw(requestParameters: UpdateReviewOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReviewResource>> {
+        const requestOptions = await this.updateReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReviewResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: updateReview
+     */
+    async updateReview(requestParameters: UpdateReviewOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewResource> {
+        const response = await this.updateReviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -14,6 +14,7 @@ export * from './ProductCategoryApi';
 export * from './ProductRangeApi';
 export * from './ProductTypeApi';
 export * from './RedirectApi';
+export * from './ReviewApi';
 export * from './SiteApi';
 export * from './StoreApi';
 export * from './SupplierApi';