@digital8/lighting-illusions-ts-sdk 0.0.1638 → 0.0.1639

package/docs/StoreSpecialDateResource.md

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

package/docs/UpdateReviewRequest.md

@@ -0,0 +1,44 @@
+
+# UpdateReviewRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reviewerName` | string
+`rating` | number
+`comment` | string
+`replyFromAdmin` | string
+`location` | string
+`approved` | boolean
+
+## Example
+
+```typescript
+import type { UpdateReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reviewerName": null,
+  "rating": null,
+  "comment": null,
+  "replyFromAdmin": null,
+  "location": null,
+  "approved": null,
+} satisfies UpdateReviewRequest
+
+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 UpdateReviewRequest
+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/package.json

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

package/src/apis/ReviewApi.ts

@@ -0,0 +1,331 @@
+/* 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 GetAllReviewRequest {
+    indexReviewRequest?: IndexReviewRequest;
+}
+
+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 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 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';

package/src/models/AddressFrontendResource.ts

@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    company?: string | null;
+    company: string;
     /**
      * 
      * @type {string}
@@ -73,6 +73,7 @@ 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;
@@ -93,7 +94,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'company': json['company'] == null ? undefined : json['company'],
+        'company': json['company'],
         'line1': json['line1'],
         'line2': json['line2'],
         'postcode': json['postcode'],

package/src/models/AddressResource.ts

@@ -42,7 +42,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    line2: string;
+    line2?: string | null;
     /**
      * 
      * @type {string}
@@ -81,7 +81,6 @@ export interface AddressResource {
 export function instanceOfAddressResource(value: object): value is AddressResource {
     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;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
     if (!('country' in value) || value['country'] === undefined) return false;
@@ -103,7 +102,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'id': json['id'] == null ? undefined : json['id'],
         'company': json['company'],
         'line1': json['line_1'],
-        'line2': json['line_2'],
+        'line2': json['line_2'] == null ? undefined : json['line_2'],
         'postcode': json['postcode'],
         'suburb': json['suburb'],
         'country': json['country'],

package/src/models/IndexReviewRequest.ts

@@ -0,0 +1,167 @@
+/* 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 IndexReviewRequest
+ */
+export interface IndexReviewRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IndexReviewRequest
+     */
+    search?: string | null;
+    /**
+     * 
+     * @type {IndexReviewRequestSortByEnum}
+     * @memberof IndexReviewRequest
+     */
+    sortBy?: IndexReviewRequestSortByEnum;
+    /**
+     * 
+     * @type {IndexReviewRequestSortDirectionEnum}
+     * @memberof IndexReviewRequest
+     */
+    sortDirection?: IndexReviewRequestSortDirectionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexReviewRequest
+     */
+    perPage?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexReviewRequest
+     */
+    page?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IndexReviewRequest
+     */
+    siteId?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IndexReviewRequest
+     */
+    createdByAdmin?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IndexReviewRequest
+     */
+    hasApprovedAt?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof IndexReviewRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IndexReviewRequest
+     */
+    relatedType?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IndexReviewRequest
+     */
+    includesRelations?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const IndexReviewRequestSortByEnum = {
+    Id: 'id',
+    Rating: 'rating',
+    ApprovedAt: 'approved_at',
+    CreatedAt: 'created_at'
+} as const;
+export type IndexReviewRequestSortByEnum = typeof IndexReviewRequestSortByEnum[keyof typeof IndexReviewRequestSortByEnum];
+
+/**
+ * @export
+ */
+export const IndexReviewRequestSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type IndexReviewRequestSortDirectionEnum = typeof IndexReviewRequestSortDirectionEnum[keyof typeof IndexReviewRequestSortDirectionEnum];
+
+
+/**
+ * Check if a given object implements the IndexReviewRequest interface.
+ */
+export function instanceOfIndexReviewRequest(value: object): value is IndexReviewRequest {
+    return true;
+}
+
+export function IndexReviewRequestFromJSON(json: any): IndexReviewRequest {
+    return IndexReviewRequestFromJSONTyped(json, false);
+}
+
+export function IndexReviewRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndexReviewRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'search': json['search'] == null ? undefined : json['search'],
+        'sortBy': json['sortBy'] == null ? undefined : json['sortBy'],
+        'sortDirection': json['sortDirection'] == null ? undefined : json['sortDirection'],
+        'perPage': json['per_page'] == null ? undefined : json['per_page'],
+        'page': json['page'] == null ? undefined : json['page'],
+        'siteId': json['site_id'] == null ? undefined : json['site_id'],
+        'createdByAdmin': json['created_by_admin'] == null ? undefined : json['created_by_admin'],
+        'hasApprovedAt': json['has_approved_at'] == null ? undefined : json['has_approved_at'],
+        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
+        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
+        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
+    };
+}
+
+export function IndexReviewRequestToJSON(json: any): IndexReviewRequest {
+    return IndexReviewRequestToJSONTyped(json, false);
+}
+
+export function IndexReviewRequestToJSONTyped(value?: IndexReviewRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'search': value['search'],
+        'sortBy': value['sortBy'],
+        'sortDirection': value['sortDirection'],
+        'per_page': value['perPage'],
+        'page': value['page'],
+        'site_id': value['siteId'],
+        'created_by_admin': value['createdByAdmin'],
+        'has_approved_at': value['hasApprovedAt'],
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
+    };
+}
+