@digital8/lighting-illusions-ts-sdk 0.0.1739 → 0.0.1740

package/docs/StoreSpecialDateResource.md

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

package/package.json

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

package/src/apis/ReviewApi.ts

@@ -44,10 +44,18 @@ 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;
 }
@@ -115,6 +123,46 @@ export class ReviewApi extends runtime.BaseAPI {
         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
      */
@@ -155,6 +203,71 @@ export class ReviewApi extends runtime.BaseAPI {
         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
      */

package/src/models/AddressFrontendResource.ts

@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    company: string;
+    company?: string | null;
     /**
      * 
      * @type {string}
@@ -73,7 +73,6 @@ export interface AddressFrontendResource {
  * Check if a given object implements the AddressFrontendResource interface.
  */
 export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
-    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
     if (!('line2' in value) || value['line2'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
@@ -94,7 +93,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'company': json['company'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line1'],
         'line2': json['line2'],
         'postcode': json['postcode'],

package/src/models/ProductReviewsResource.ts

@@ -0,0 +1,118 @@
+/* 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 { mapValues } from '../runtime';
+import type { ReviewPublicResource } from './ReviewPublicResource';
+import {
+    ReviewPublicResourceFromJSON,
+    ReviewPublicResourceFromJSONTyped,
+    ReviewPublicResourceToJSON,
+    ReviewPublicResourceToJSONTyped,
+} from './ReviewPublicResource';
+
+/**
+ * 
+ * @export
+ * @interface ProductReviewsResource
+ */
+export interface ProductReviewsResource {
+    /**
+     * 
+     * @type {Array<ReviewPublicResource>}
+     * @memberof ProductReviewsResource
+     */
+    reviews: Array<ReviewPublicResource> | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ProductReviewsResource
+     */
+    totalReview: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ProductReviewsResource
+     */
+    averageRating: number;
+    /**
+     * 
+     * @type {Array<object>}
+     * @memberof ProductReviewsResource
+     */
+    stats: Array<object>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProductReviewsResource
+     */
+    myReview?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProductReviewsResource
+     */
+    canReview: boolean;
+}
+
+/**
+ * Check if a given object implements the ProductReviewsResource interface.
+ */
+export function instanceOfProductReviewsResource(value: object): value is ProductReviewsResource {
+    if (!('reviews' in value) || value['reviews'] === undefined) return false;
+    if (!('totalReview' in value) || value['totalReview'] === undefined) return false;
+    if (!('averageRating' in value) || value['averageRating'] === undefined) return false;
+    if (!('stats' in value) || value['stats'] === undefined) return false;
+    if (!('canReview' in value) || value['canReview'] === undefined) return false;
+    return true;
+}
+
+export function ProductReviewsResourceFromJSON(json: any): ProductReviewsResource {
+    return ProductReviewsResourceFromJSONTyped(json, false);
+}
+
+export function ProductReviewsResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductReviewsResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reviews': (json['reviews'] == null ? null : (json['reviews'] as Array<any>).map(ReviewPublicResourceFromJSON)),
+        'totalReview': json['totalReview'],
+        'averageRating': json['averageRating'],
+        'stats': json['stats'],
+        'myReview': json['myReview'] == null ? undefined : json['myReview'],
+        'canReview': json['canReview'],
+    };
+}
+
+export function ProductReviewsResourceToJSON(json: any): ProductReviewsResource {
+    return ProductReviewsResourceToJSONTyped(json, false);
+}
+
+export function ProductReviewsResourceToJSONTyped(value?: ProductReviewsResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reviews': (value['reviews'] == null ? null : (value['reviews'] as Array<any>).map(ReviewPublicResourceToJSON)),
+        'totalReview': value['totalReview'],
+        'averageRating': value['averageRating'],
+        'stats': value['stats'],
+        'myReview': value['myReview'],
+        'canReview': value['canReview'],
+    };
+}
+

package/src/models/ProductReviewsResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* 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 { mapValues } from '../runtime';
+import type { ProductReviewsResource } from './ProductReviewsResource';
+import {
+    ProductReviewsResourceFromJSON,
+    ProductReviewsResourceFromJSONTyped,
+    ProductReviewsResourceToJSON,
+    ProductReviewsResourceToJSONTyped,
+} from './ProductReviewsResource';
+
+/**
+ * 
+ * @export
+ * @interface ProductReviewsResourceArrayResponse
+ */
+export interface ProductReviewsResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<ProductReviewsResource>}
+     * @memberof ProductReviewsResourceArrayResponse
+     */
+    data?: Array<ProductReviewsResource>;
+}
+
+/**
+ * Check if a given object implements the ProductReviewsResourceArrayResponse interface.
+ */
+export function instanceOfProductReviewsResourceArrayResponse(value: object): value is ProductReviewsResourceArrayResponse {
+    return true;
+}
+
+export function ProductReviewsResourceArrayResponseFromJSON(json: any): ProductReviewsResourceArrayResponse {
+    return ProductReviewsResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function ProductReviewsResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductReviewsResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(ProductReviewsResourceFromJSON)),
+    };
+}
+
+export function ProductReviewsResourceArrayResponseToJSON(json: any): ProductReviewsResourceArrayResponse {
+    return ProductReviewsResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function ProductReviewsResourceArrayResponseToJSONTyped(value?: ProductReviewsResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(ProductReviewsResourceToJSON)),
+    };
+}
+

package/src/models/ReviewPublicResource.ts

@@ -0,0 +1,144 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReviewPublicResource
+ */
+export interface ReviewPublicResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReviewPublicResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReviewPublicResource
+     */
+    overallRating: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReviewPublicResource
+     */
+    comment: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReviewPublicResource
+     */
+    replyText?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReviewPublicResource
+     */
+    reviewerName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReviewPublicResource
+     */
+    location: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ReviewPublicResource
+     */
+    createdAt?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReviewPublicResource
+     */
+    customerId?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReviewPublicResource
+     */
+    productId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReviewPublicResource
+     */
+    siteId: number;
+}
+
+/**
+ * Check if a given object implements the ReviewPublicResource interface.
+ */
+export function instanceOfReviewPublicResource(value: object): value is ReviewPublicResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('overallRating' in value) || value['overallRating'] === undefined) return false;
+    if (!('comment' in value) || value['comment'] === undefined) return false;
+    if (!('reviewerName' in value) || value['reviewerName'] === undefined) return false;
+    if (!('location' in value) || value['location'] === undefined) return false;
+    if (!('productId' in value) || value['productId'] === undefined) return false;
+    if (!('siteId' in value) || value['siteId'] === undefined) return false;
+    return true;
+}
+
+export function ReviewPublicResourceFromJSON(json: any): ReviewPublicResource {
+    return ReviewPublicResourceFromJSONTyped(json, false);
+}
+
+export function ReviewPublicResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewPublicResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'overallRating': json['overallRating'],
+        'comment': json['comment'],
+        'replyText': json['replyText'] == null ? undefined : json['replyText'],
+        'reviewerName': json['reviewerName'],
+        'location': json['location'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'customerId': json['customerId'] == null ? undefined : json['customerId'],
+        'productId': json['productId'],
+        'siteId': json['siteId'],
+    };
+}
+
+export function ReviewPublicResourceToJSON(json: any): ReviewPublicResource {
+    return ReviewPublicResourceToJSONTyped(json, false);
+}
+
+export function ReviewPublicResourceToJSONTyped(value?: ReviewPublicResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'overallRating': value['overallRating'],
+        'comment': value['comment'],
+        'replyText': value['replyText'],
+        'reviewerName': value['reviewerName'],
+        'location': value['location'],
+        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'customerId': value['customerId'],
+        'productId': value['productId'],
+        'siteId': value['siteId'],
+    };
+}
+

package/src/models/ReviewPublicResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* 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 { mapValues } from '../runtime';
+import type { ReviewPublicResource } from './ReviewPublicResource';
+import {
+    ReviewPublicResourceFromJSON,
+    ReviewPublicResourceFromJSONTyped,
+    ReviewPublicResourceToJSON,
+    ReviewPublicResourceToJSONTyped,
+} from './ReviewPublicResource';
+
+/**
+ * 
+ * @export
+ * @interface ReviewPublicResourceArrayResponse
+ */
+export interface ReviewPublicResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<ReviewPublicResource>}
+     * @memberof ReviewPublicResourceArrayResponse
+     */
+    data?: Array<ReviewPublicResource>;
+}
+
+/**
+ * Check if a given object implements the ReviewPublicResourceArrayResponse interface.
+ */
+export function instanceOfReviewPublicResourceArrayResponse(value: object): value is ReviewPublicResourceArrayResponse {
+    return true;
+}
+
+export function ReviewPublicResourceArrayResponseFromJSON(json: any): ReviewPublicResourceArrayResponse {
+    return ReviewPublicResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function ReviewPublicResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewPublicResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(ReviewPublicResourceFromJSON)),
+    };
+}
+
+export function ReviewPublicResourceArrayResponseToJSON(json: any): ReviewPublicResourceArrayResponse {
+    return ReviewPublicResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function ReviewPublicResourceArrayResponseToJSONTyped(value?: ReviewPublicResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(ReviewPublicResourceToJSON)),
+    };
+}
+

package/src/models/StoreFrontendResource.ts

@@ -48,7 +48,7 @@ export interface StoreFrontendResource {
      * @type {string}
      * @memberof StoreFrontendResource
      */
-    website?: string | null;
+    website: string;
     /**
      * 
      * @type {string}
@@ -78,7 +78,7 @@ export interface StoreFrontendResource {
      * @type {string}
      * @memberof StoreFrontendResource
      */
-    tagLine?: string | null;
+    tagLine: string;
     /**
      * 
      * @type {string}
@@ -106,9 +106,11 @@ export function instanceOfStoreFrontendResource(value: object): value is StoreFr
     if (!('siteId' in value) || value['siteId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('website' in value) || value['website'] === undefined) return false;
     if (!('phone' in value) || value['phone'] === undefined) return false;
     if (!('latitude' in value) || value['latitude'] === undefined) return false;
     if (!('longitude' in value) || value['longitude'] === undefined) return false;
+    if (!('tagLine' in value) || value['tagLine'] === undefined) return false;
     if (!('specialDates' in value) || value['specialDates'] === undefined) return false;
     if (!('suppliers' in value) || value['suppliers'] === undefined) return false;
     return true;
@@ -128,12 +130,12 @@ export function StoreFrontendResourceFromJSONTyped(json: any, ignoreDiscriminato
         'siteId': json['siteId'],
         'name': json['name'],
         'email': json['email'],
-        'website': json['website'] == null ? undefined : json['website'],
+        'website': json['website'],
         'phone': json['phone'],
         'address': json['address'] == null ? undefined : json['address'],
         'latitude': json['latitude'],
         'longitude': json['longitude'],
-        'tagLine': json['tagLine'] == null ? undefined : json['tagLine'],
+        'tagLine': json['tagLine'],
         'openingHours': json['openingHours'] == null ? undefined : json['openingHours'],
         'specialDates': json['specialDates'],
         'suppliers': json['suppliers'],

package/src/models/StoreListResource.ts

@@ -68,7 +68,7 @@ export interface StoreListResource {
      * @type {string}
      * @memberof StoreListResource
      */
-    tagLine: string;
+    tagLine?: string | null;
     /**
      * 
      * @type {string}
@@ -98,7 +98,6 @@ export function instanceOfStoreListResource(value: object): value is StoreListRe
     if (!('phone' in value) || value['phone'] === undefined) return false;
     if (!('longitude' in value) || value['longitude'] === undefined) return false;
     if (!('latitude' in value) || value['latitude'] === undefined) return false;
-    if (!('tagLine' in value) || value['tagLine'] === undefined) return false;
     if (!('email' in value) || value['email'] === undefined) return false;
     if (!('website' in value) || value['website'] === undefined) return false;
     return true;
@@ -120,7 +119,7 @@ export function StoreListResourceFromJSONTyped(json: any, ignoreDiscriminator: b
         'phone': json['phone'],
         'longitude': json['longitude'],
         'latitude': json['latitude'],
-        'tagLine': json['tag_line'],
+        'tagLine': json['tag_line'] == null ? undefined : json['tag_line'],
         'email': json['email'],
         'website': json['website'],
         'openingHours': json['opening_hours'] == null ? undefined : json['opening_hours'],