@digital8/lighting-illusions-ts-sdk 0.0.1997 → 0.0.1999

package/docs/ReviewApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost/api*
 | [**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 |
+| [**importFileReview**](ReviewApi.md#importfilereview) | **POST** /admin-api/review/import-file | Auto-generated: importFileReview |
 | [**importReview**](ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview |
 | [**indexReview**](ReviewApi.md#indexreview) | **POST** /admin-api/review/list | Auto-generated: indexReview |
 | [**showReview**](ReviewApi.md#showreview) | **GET** /admin-api/review/{review} | Auto-generated: showReview |
@@ -82,7 +83,7 @@ No authorization required
 
 ## exportReview
 
-> Blob exportReview(searchReviewsRequest)
+> ReviewExportDownloadUrlResource exportReview(searchReviewsRequest)
 
 Auto-generated: exportReview
 
@@ -125,7 +126,7 @@ example().catch(console.error);
 
 ### Return type
 
-**Blob**
+[**ReviewExportDownloadUrlResource**](ReviewExportDownloadUrlResource.md)
 
 ### Authorization
 
@@ -134,13 +135,13 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: `application/json`
-- **Accept**: ``
+- **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | File download () |  -  |
+| **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)
 
@@ -210,9 +211,74 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## importFileReview
+
+> ReviewImportUploadUrlResource importFileReview(createReviewImportFileRequest)
+
+Auto-generated: importFileReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ImportFileReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReviewApi();
+
+  const body = {
+    // CreateReviewImportFileRequest (optional)
+    createReviewImportFileRequest: ...,
+  } satisfies ImportFileReviewRequest;
+
+  try {
+    const data = await api.importFileReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createReviewImportFileRequest** | [CreateReviewImportFileRequest](CreateReviewImportFileRequest.md) |  | [Optional] |
+
+### Return type
+
+[**ReviewImportUploadUrlResource**](ReviewImportUploadUrlResource.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)
+> GenericResponse importReview(importReviewsRequest)
 
 Auto-generated: importReview
 
@@ -230,8 +296,8 @@ async function example() {
   const api = new ReviewApi();
 
   const body = {
-    // Blob
-    file: BINARY_DATA_HERE,
+    // ImportReviewsRequest (optional)
+    importReviewsRequest: ...,
   } satisfies ImportReviewRequest;
 
   try {
@@ -251,7 +317,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **file** | `Blob` |  | [Defaults to `undefined`] |
+| **importReviewsRequest** | [ImportReviewsRequest](ImportReviewsRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -263,7 +329,7 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: `application/x-www-form-urlencoded`
+- **Content-Type**: `application/json`
 - **Accept**: `application/json`
 
 

package/docs/ReviewExportDownloadUrlResource.md

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

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

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

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

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

package/src/apis/ReviewApi.ts

@@ -13,6 +13,11 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type CreateReviewImportFileRequest,
+    CreateReviewImportFileRequestFromJSON,
+    CreateReviewImportFileRequestToJSON,
+} from '../models/CreateReviewImportFileRequest';
 import {
     type CreateReviewRequest,
     CreateReviewRequestFromJSON,
@@ -23,11 +28,26 @@ import {
     GenericResponseFromJSON,
     GenericResponseToJSON,
 } from '../models/GenericResponse';
+import {
+    type ImportReviewsRequest,
+    ImportReviewsRequestFromJSON,
+    ImportReviewsRequestToJSON,
+} from '../models/ImportReviewsRequest';
 import {
     type PaginatedReviewListResourceResponse,
     PaginatedReviewListResourceResponseFromJSON,
     PaginatedReviewListResourceResponseToJSON,
 } from '../models/PaginatedReviewListResourceResponse';
+import {
+    type ReviewExportDownloadUrlResource,
+    ReviewExportDownloadUrlResourceFromJSON,
+    ReviewExportDownloadUrlResourceToJSON,
+} from '../models/ReviewExportDownloadUrlResource';
+import {
+    type ReviewImportUploadUrlResource,
+    ReviewImportUploadUrlResourceFromJSON,
+    ReviewImportUploadUrlResourceToJSON,
+} from '../models/ReviewImportUploadUrlResource';
 import {
     type ReviewLiteResourceArrayResponse,
     ReviewLiteResourceArrayResponseFromJSON,
@@ -61,8 +81,12 @@ export interface GetAllReviewRequest {
     searchReviewsRequest?: SearchReviewsRequest;
 }
 
+export interface ImportFileReviewRequest {
+    createReviewImportFileRequest?: CreateReviewImportFileRequest;
+}
+
 export interface ImportReviewRequest {
-    file: Blob;
+    importReviewsRequest?: ImportReviewsRequest;
 }
 
 export interface IndexReviewRequest {
@@ -157,17 +181,17 @@ export class ReviewApi extends runtime.BaseAPI {
     /**
      * Auto-generated: exportReview
      */
-    async exportReviewRaw(requestParameters: ExportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+    async exportReviewRaw(requestParameters: ExportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReviewExportDownloadUrlResource>> {
         const requestOptions = await this.exportReviewRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.BlobApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReviewExportDownloadUrlResourceFromJSON(jsonValue));
     }
 
     /**
      * Auto-generated: exportReview
      */
-    async exportReview(requestParameters: ExportReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+    async exportReview(requestParameters: ExportReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewExportDownloadUrlResource> {
         const response = await this.exportReviewRaw(requestParameters, initOverrides);
         return await response.value();
     }
@@ -212,40 +236,55 @@ export class ReviewApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for importFileReview without sending the request
+     */
+    async importFileReviewRequestOpts(requestParameters: ImportFileReviewRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/review/import-file`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateReviewImportFileRequestToJSON(requestParameters['createReviewImportFileRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: importFileReview
+     */
+    async importFileReviewRaw(requestParameters: ImportFileReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReviewImportUploadUrlResource>> {
+        const requestOptions = await this.importFileReviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReviewImportUploadUrlResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: importFileReview
+     */
+    async importFileReview(requestParameters: ImportFileReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewImportUploadUrlResource> {
+        const response = await this.importFileReviewRaw(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);
-        }
+        headerParameters['Content-Type'] = 'application/json';
 
 
         let urlPath = `/admin-api/review/import`;
@@ -255,7 +294,7 @@ export class ReviewApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: formParams,
+            body: ImportReviewsRequestToJSON(requestParameters['importReviewsRequest']),
         };
     }
 
@@ -272,7 +311,7 @@ export class ReviewApi extends runtime.BaseAPI {
     /**
      * Auto-generated: importReview
      */
-    async importReview(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+    async importReview(requestParameters: ImportReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
         const response = await this.importReviewRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/models/AddressFrontendResource.ts

@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    company?: string | null;
+    company: string;
     /**
      * 
      * @type {string}
@@ -36,7 +36,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    line2?: string | null;
+    line2: string;
     /**
      * 
      * @type {string}
@@ -73,7 +73,9 @@ 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;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
     if (!('country' in value) || value['country'] === undefined) return false;
@@ -92,9 +94,9 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'company': json['company'] == null ? undefined : json['company'],
+        'company': json['company'],
         'line1': json['line1'],
-        'line2': json['line2'] == null ? undefined : json['line2'],
+        'line2': json['line2'],
         'postcode': json['postcode'],
         'suburb': json['suburb'],
         'country': json['country'],

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/CreateReviewImportFileRequest.ts

@@ -0,0 +1,75 @@
+/* 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 CreateReviewImportFileRequest
+ */
+export interface CreateReviewImportFileRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReviewImportFileRequest
+     */
+    fileName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReviewImportFileRequest
+     */
+    fileType: string;
+}
+
+/**
+ * Check if a given object implements the CreateReviewImportFileRequest interface.
+ */
+export function instanceOfCreateReviewImportFileRequest(value: object): value is CreateReviewImportFileRequest {
+    if (!('fileName' in value) || value['fileName'] === undefined) return false;
+    if (!('fileType' in value) || value['fileType'] === undefined) return false;
+    return true;
+}
+
+export function CreateReviewImportFileRequestFromJSON(json: any): CreateReviewImportFileRequest {
+    return CreateReviewImportFileRequestFromJSONTyped(json, false);
+}
+
+export function CreateReviewImportFileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateReviewImportFileRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fileName': json['file_name'],
+        'fileType': json['file_type'],
+    };
+}
+
+export function CreateReviewImportFileRequestToJSON(json: any): CreateReviewImportFileRequest {
+    return CreateReviewImportFileRequestToJSONTyped(json, false);
+}
+
+export function CreateReviewImportFileRequestToJSONTyped(value?: CreateReviewImportFileRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'file_name': value['fileName'],
+        'file_type': value['fileType'],
+    };
+}
+

package/src/models/ExternalApiLogResource.ts

@@ -74,7 +74,7 @@ export interface ExternalApiLogResource {
      * @type {string}
      * @memberof ExternalApiLogResource
      */
-    requestPayload: string;
+    requestPayload?: string | null;
     /**
      * 
      * @type {string}
@@ -106,7 +106,6 @@ export function instanceOfExternalApiLogResource(value: object): value is Extern
     if (!('exteranlApiLoggableId' in value) || value['exteranlApiLoggableId'] === undefined) return false;
     if (!('endpoint' in value) || value['endpoint'] === undefined) return false;
     if (!('responseCode' in value) || value['responseCode'] === undefined) return false;
-    if (!('requestPayload' in value) || value['requestPayload'] === undefined) return false;
     if (!('responsePayload' in value) || value['responsePayload'] === undefined) return false;
     if (!('site' in value) || value['site'] === undefined) return false;
     return true;
@@ -129,7 +128,7 @@ export function ExternalApiLogResourceFromJSONTyped(json: any, ignoreDiscriminat
         'exteranlApiLoggableId': json['exteranlApiLoggableId'],
         'endpoint': json['endpoint'],
         'responseCode': json['responseCode'],
-        'requestPayload': json['requestPayload'],
+        'requestPayload': json['requestPayload'] == null ? undefined : json['requestPayload'],
         'responsePayload': json['responsePayload'],
         'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
         'site': SiteLiteResourceFromJSON(json['site']),