@digital8/lighting-illusions-ts-sdk 0.0.1659 → 0.0.1660

package/dist/models/index.js

@@ -20,8 +20,6 @@ __exportStar(require("./AddressFrontendResource"), exports);
 __exportStar(require("./AddressFrontendResourceArrayResponse"), exports);
 __exportStar(require("./AddressResource"), exports);
 __exportStar(require("./AddressResourceArrayResponse"), exports);
-__exportStar(require("./AdminUserLiteResource"), exports);
-__exportStar(require("./AdminUserLiteResourceArrayResponse"), exports);
 __exportStar(require("./AssetFileForUploadResource"), exports);
 __exportStar(require("./AssetFileForUploadResourceArrayResponse"), exports);
 __exportStar(require("./AssetFrontendResource"), exports);
@@ -69,8 +67,6 @@ __exportStar(require("./CategoryFrontendResourceArrayResponse"), exports);
 __exportStar(require("./CategoryWithChildrenFrontendResource"), exports);
 __exportStar(require("./CategoryWithChildrenFrontendResourceArrayResponse"), exports);
 __exportStar(require("./CouponDiscountType"), exports);
-__exportStar(require("./CustomerLiteResource"), exports);
-__exportStar(require("./CustomerLiteResourceArrayResponse"), exports);
 __exportStar(require("./DefinitionListResource"), exports);
 __exportStar(require("./DefinitionListResourceArrayResponse"), exports);
 __exportStar(require("./DefinitionResource"), exports);

package/docs/ReviewApi.md

@@ -5,7 +5,9 @@ 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 |
+| [**exportReview**](ReviewApi.md#exportreview) | **POST** /admin-api/review/export | Auto-generated: exportReview |
 | [**getAllReview**](ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview |
+| [**importReview**](ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview |
 | [**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 |
@@ -78,6 +80,71 @@ 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)
 
 
+## exportReview
+
+> Blob exportReview(indexReviewRequest)
+
+Auto-generated: exportReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ExportReviewRequest } 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 ExportReviewRequest;
+
+  try {
+    const data = await api.exportReview(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
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: ``
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | File download () |  -  |
+
+[[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)
@@ -143,6 +210,71 @@ 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)
 
 
+## importReview
+
+> GenericResponse importReview(file)
+
+Auto-generated: importReview
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReviewApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { ImportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new ReviewApi();
+
+  const body = {
+    // Blob
+    file: BINARY_DATA_HERE,
+  } satisfies ImportReviewRequest;
+
+  try {
+    const data = await api.importReview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/x-www-form-urlencoded`
+- **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)
+
+
 ## indexReview
 
 > PaginatedReviewListResourceResponse indexReview(indexReviewRequest)

package/docs/ReviewListResource.md

@@ -12,10 +12,10 @@ Name | Type
 `comment` | string
 `replyFromAdmin` | string
 `createdByAdmin` | boolean
-`approvedAt` | Date
-`createdAt` | Date
+`approvedAt` | string
+`createdAt` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
+`productChild` | Array<number>
 
 ## Example
 

package/docs/ReviewResource.md

@@ -13,14 +13,14 @@ Name | Type
 `replyFromAdmin` | string
 `location` | string
 `createdByAdmin` | boolean
-`approvedAt` | Date
-`createdAt` | Date
-`updatedAt` | Date
+`approvedAt` | string
+`createdAt` | string
+`updatedAt` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
-`customer` | [CustomerLiteResource](CustomerLiteResource.md)
-`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
-`approver` | [AdminUserLiteResource](AdminUserLiteResource.md)
+`productChild` | Array<number>
+`customer` | object
+`admin` | object
+`approver` | object
 
 ## Example
 

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.1659",
+  "version": "0.0.1660",
   "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/AddressResource.ts

@@ -30,7 +30,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    company: string;
+    company?: string | null;
     /**
      * 
      * @type {string}
@@ -79,7 +79,6 @@ export interface AddressResource {
  * Check if a given object implements the AddressResource interface.
  */
 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 (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -100,7 +99,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
     return {
         
         'id': json['id'] == null ? undefined : json['id'],
-        'company': json['company'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line_1'],
         'line2': json['line_2'] == null ? undefined : json['line_2'],
         'postcode': json['postcode'],

package/src/models/ReviewListResource.ts

@@ -20,13 +20,6 @@ import {
     SiteLiteResourceToJSON,
     SiteLiteResourceToJSONTyped,
 } from './SiteLiteResource';
-import type { ProductChildLiteResource } from './ProductChildLiteResource';
-import {
-    ProductChildLiteResourceFromJSON,
-    ProductChildLiteResourceFromJSONTyped,
-    ProductChildLiteResourceToJSON,
-    ProductChildLiteResourceToJSONTyped,
-} from './ProductChildLiteResource';
 
 /**
  * 
@@ -72,16 +65,16 @@ export interface ReviewListResource {
     createdByAdmin: boolean;
     /**
      * 
-     * @type {Date}
+     * @type {string}
      * @memberof ReviewListResource
      */
-    approvedAt?: Date | null;
+    approvedAt?: string | null;
     /**
      * 
-     * @type {Date}
+     * @type {string}
      * @memberof ReviewListResource
      */
-    createdAt?: Date | null;
+    createdAt?: string | null;
     /**
      * 
      * @type {SiteLiteResource}
@@ -90,10 +83,10 @@ export interface ReviewListResource {
     site: SiteLiteResource | null;
     /**
      * 
-     * @type {ProductChildLiteResource}
+     * @type {Array<number>}
      * @memberof ReviewListResource
      */
-    productChild: ProductChildLiteResource | null;
+    productChild: Array<number>;
 }
 
 /**
@@ -126,10 +119,10 @@ export function ReviewListResourceFromJSONTyped(json: any, ignoreDiscriminator:
         'comment': json['comment'],
         'replyFromAdmin': json['replyFromAdmin'] == null ? undefined : json['replyFromAdmin'],
         'createdByAdmin': json['createdByAdmin'],
-        'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
-        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'approvedAt': json['approvedAt'] == null ? undefined : json['approvedAt'],
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
         'site': SiteLiteResourceFromJSON(json['site']),
-        'productChild': ProductChildLiteResourceFromJSON(json['productChild']),
+        'productChild': json['productChild'],
     };
 }
 
@@ -150,10 +143,10 @@ export function ReviewListResourceToJSONTyped(value?: ReviewListResource | null,
         'comment': value['comment'],
         'replyFromAdmin': value['replyFromAdmin'],
         'createdByAdmin': value['createdByAdmin'],
-        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
-        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'approvedAt': value['approvedAt'],
+        'createdAt': value['createdAt'],
         'site': SiteLiteResourceToJSON(value['site']),
-        'productChild': ProductChildLiteResourceToJSON(value['productChild']),
+        'productChild': value['productChild'],
     };
 }
 

package/src/models/ReviewResource.ts

@@ -20,27 +20,6 @@ import {
     SiteLiteResourceToJSON,
     SiteLiteResourceToJSONTyped,
 } from './SiteLiteResource';
-import type { ProductChildLiteResource } from './ProductChildLiteResource';
-import {
-    ProductChildLiteResourceFromJSON,
-    ProductChildLiteResourceFromJSONTyped,
-    ProductChildLiteResourceToJSON,
-    ProductChildLiteResourceToJSONTyped,
-} from './ProductChildLiteResource';
-import type { AdminUserLiteResource } from './AdminUserLiteResource';
-import {
-    AdminUserLiteResourceFromJSON,
-    AdminUserLiteResourceFromJSONTyped,
-    AdminUserLiteResourceToJSON,
-    AdminUserLiteResourceToJSONTyped,
-} from './AdminUserLiteResource';
-import type { CustomerLiteResource } from './CustomerLiteResource';
-import {
-    CustomerLiteResourceFromJSON,
-    CustomerLiteResourceFromJSONTyped,
-    CustomerLiteResourceToJSON,
-    CustomerLiteResourceToJSONTyped,
-} from './CustomerLiteResource';
 
 /**
  * 
@@ -92,22 +71,22 @@ export interface ReviewResource {
     createdByAdmin: boolean;
     /**
      * 
-     * @type {Date}
+     * @type {string}
      * @memberof ReviewResource
      */
-    approvedAt?: Date | null;
+    approvedAt?: string | null;
     /**
      * 
-     * @type {Date}
+     * @type {string}
      * @memberof ReviewResource
      */
-    createdAt?: Date | null;
+    createdAt?: string | null;
     /**
      * 
-     * @type {Date}
+     * @type {string}
      * @memberof ReviewResource
      */
-    updatedAt?: Date | null;
+    updatedAt?: string | null;
     /**
      * 
      * @type {SiteLiteResource}
@@ -116,28 +95,28 @@ export interface ReviewResource {
     site: SiteLiteResource | null;
     /**
      * 
-     * @type {ProductChildLiteResource}
+     * @type {Array<number>}
      * @memberof ReviewResource
      */
-    productChild: ProductChildLiteResource | null;
+    productChild: Array<number>;
     /**
      * 
-     * @type {CustomerLiteResource}
+     * @type {object}
      * @memberof ReviewResource
      */
-    customer: CustomerLiteResource | null;
+    customer: object;
     /**
      * 
-     * @type {AdminUserLiteResource}
+     * @type {object}
      * @memberof ReviewResource
      */
-    admin: AdminUserLiteResource | null;
+    admin: object;
     /**
      * 
-     * @type {AdminUserLiteResource}
+     * @type {object}
      * @memberof ReviewResource
      */
-    approver: AdminUserLiteResource | null;
+    approver: object;
 }
 
 /**
@@ -175,14 +154,14 @@ export function ReviewResourceFromJSONTyped(json: any, ignoreDiscriminator: bool
         'replyFromAdmin': json['replyFromAdmin'] == null ? undefined : json['replyFromAdmin'],
         'location': json['location'],
         'createdByAdmin': json['createdByAdmin'],
-        'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
-        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
-        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+        'approvedAt': json['approvedAt'] == null ? undefined : json['approvedAt'],
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
         'site': SiteLiteResourceFromJSON(json['site']),
-        'productChild': ProductChildLiteResourceFromJSON(json['productChild']),
-        'customer': CustomerLiteResourceFromJSON(json['customer']),
-        'admin': AdminUserLiteResourceFromJSON(json['admin']),
-        'approver': AdminUserLiteResourceFromJSON(json['approver']),
+        'productChild': json['productChild'],
+        'customer': json['customer'],
+        'admin': json['admin'],
+        'approver': json['approver'],
     };
 }
 
@@ -204,14 +183,14 @@ export function ReviewResourceToJSONTyped(value?: ReviewResource | null, ignoreD
         'replyFromAdmin': value['replyFromAdmin'],
         'location': value['location'],
         'createdByAdmin': value['createdByAdmin'],
-        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
-        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
-        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'approvedAt': value['approvedAt'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
         'site': SiteLiteResourceToJSON(value['site']),
-        'productChild': ProductChildLiteResourceToJSON(value['productChild']),
-        'customer': CustomerLiteResourceToJSON(value['customer']),
-        'admin': AdminUserLiteResourceToJSON(value['admin']),
-        'approver': AdminUserLiteResourceToJSON(value['approver']),
+        'productChild': value['productChild'],
+        'customer': value['customer'],
+        'admin': value['admin'],
+        'approver': value['approver'],
     };
 }
 

package/src/models/StoreFrontendResource.ts

@@ -78,7 +78,7 @@ export interface StoreFrontendResource {
      * @type {string}
      * @memberof StoreFrontendResource
      */
-    tagLine: string;
+    tagLine?: string | null;
     /**
      * 
      * @type {string}
@@ -110,7 +110,6 @@ export function instanceOfStoreFrontendResource(value: object): value is StoreFr
     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;
@@ -135,7 +134,7 @@ export function StoreFrontendResourceFromJSONTyped(json: any, ignoreDiscriminato
         'address': json['address'] == null ? undefined : json['address'],
         'latitude': json['latitude'],
         'longitude': json['longitude'],
-        'tagLine': json['tagLine'],
+        'tagLine': json['tagLine'] == null ? undefined : 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'],