@digital8/lighting-illusions-ts-sdk 0.0.1791 → 0.0.1792

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @digital8/lighting-illusions-ts-sdk@0.0.1791
1
+ # @digital8/lighting-illusions-ts-sdk@0.0.1792
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -191,7 +191,9 @@ All URIs are relative to *http://localhost/api*
191
191
  *ProductTypeApi* | [**updateProductType**](docs/ProductTypeApi.md#updateproducttypeoperation) | **PUT** /admin-api/product-type/{productType}/update | Auto-generated: updateProductType
192
192
  *RedirectApi* | [**indexRedirect**](docs/RedirectApi.md#indexredirectoperation) | **POST** /admin-api/redirect/list | Auto-generated: indexRedirect
193
193
  *ReviewApi* | [**destroyReview**](docs/ReviewApi.md#destroyreview) | **DELETE** /admin-api/review/{review}/delete | Auto-generated: destroyReview
194
+ *ReviewApi* | [**exportReview**](docs/ReviewApi.md#exportreview) | **POST** /admin-api/review/export | Auto-generated: exportReview
194
195
  *ReviewApi* | [**getAllReview**](docs/ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview
196
+ *ReviewApi* | [**importReview**](docs/ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview
195
197
  *ReviewApi* | [**indexReview**](docs/ReviewApi.md#indexreviewoperation) | **POST** /admin-api/review/list | Auto-generated: indexReview
196
198
  *ReviewApi* | [**showReview**](docs/ReviewApi.md#showreview) | **GET** /admin-api/review/{review} | Auto-generated: showReview
197
199
  *ReviewApi* | [**storeReview**](docs/ReviewApi.md#storereviewoperation) | **POST** /admin-api/review/create | Auto-generated: storeReview
@@ -701,7 +703,7 @@ and is automatically generated by the
701
703
  [OpenAPI Generator](https://openapi-generator.tech) project:
702
704
 
703
705
  - API version: `1.0.0`
704
- - Package version: `0.0.1791`
706
+ - Package version: `0.0.1792`
705
707
  - Generator version: `7.21.0`
706
708
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
707
709
 
@@ -14,9 +14,15 @@ import type { GenericResponse, IndexReviewRequest, PaginatedReviewListResourceRe
14
14
  export interface DestroyReviewRequest {
15
15
  review: number;
16
16
  }
17
+ export interface ExportReviewRequest {
18
+ indexReviewRequest?: IndexReviewRequest;
19
+ }
17
20
  export interface GetAllReviewRequest {
18
21
  indexReviewRequest?: IndexReviewRequest;
19
22
  }
23
+ export interface ImportReviewRequest {
24
+ file: Blob;
25
+ }
20
26
  export interface IndexReviewOperationRequest {
21
27
  indexReviewRequest?: IndexReviewRequest;
22
28
  }
@@ -46,6 +52,18 @@ export declare class ReviewApi extends runtime.BaseAPI {
46
52
  * Auto-generated: destroyReview
47
53
  */
48
54
  destroyReview(requestParameters: DestroyReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse>;
55
+ /**
56
+ * Creates request options for exportReview without sending the request
57
+ */
58
+ exportReviewRequestOpts(requestParameters: ExportReviewRequest): Promise<runtime.RequestOpts>;
59
+ /**
60
+ * Auto-generated: exportReview
61
+ */
62
+ exportReviewRaw(requestParameters: ExportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
63
+ /**
64
+ * Auto-generated: exportReview
65
+ */
66
+ exportReview(requestParameters?: ExportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
49
67
  /**
50
68
  * Creates request options for getAllReview without sending the request
51
69
  */
@@ -58,6 +76,18 @@ export declare class ReviewApi extends runtime.BaseAPI {
58
76
  * Auto-generated: getAllReview
59
77
  */
60
78
  getAllReview(requestParameters?: GetAllReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReviewLiteResourceArrayResponse>;
79
+ /**
80
+ * Creates request options for importReview without sending the request
81
+ */
82
+ importReviewRequestOpts(requestParameters: ImportReviewRequest): Promise<runtime.RequestOpts>;
83
+ /**
84
+ * Auto-generated: importReview
85
+ */
86
+ importReviewRaw(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>>;
87
+ /**
88
+ * Auto-generated: importReview
89
+ */
90
+ importReview(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse>;
61
91
  /**
62
92
  * Creates request options for indexReview without sending the request
63
93
  */
@@ -134,6 +134,64 @@ var ReviewApi = /** @class */ (function (_super) {
134
134
  });
135
135
  });
136
136
  };
137
+ /**
138
+ * Creates request options for exportReview without sending the request
139
+ */
140
+ ReviewApi.prototype.exportReviewRequestOpts = function (requestParameters) {
141
+ return __awaiter(this, void 0, void 0, function () {
142
+ var queryParameters, headerParameters, urlPath;
143
+ return __generator(this, function (_a) {
144
+ queryParameters = {};
145
+ headerParameters = {};
146
+ headerParameters['Content-Type'] = 'application/json';
147
+ urlPath = "/admin-api/review/export";
148
+ return [2 /*return*/, {
149
+ path: urlPath,
150
+ method: 'POST',
151
+ headers: headerParameters,
152
+ query: queryParameters,
153
+ body: (0, index_1.IndexReviewRequestToJSON)(requestParameters['indexReviewRequest']),
154
+ }];
155
+ });
156
+ });
157
+ };
158
+ /**
159
+ * Auto-generated: exportReview
160
+ */
161
+ ReviewApi.prototype.exportReviewRaw = function (requestParameters, initOverrides) {
162
+ return __awaiter(this, void 0, void 0, function () {
163
+ var requestOptions, response;
164
+ return __generator(this, function (_a) {
165
+ switch (_a.label) {
166
+ case 0: return [4 /*yield*/, this.exportReviewRequestOpts(requestParameters)];
167
+ case 1:
168
+ requestOptions = _a.sent();
169
+ return [4 /*yield*/, this.request(requestOptions, initOverrides)];
170
+ case 2:
171
+ response = _a.sent();
172
+ return [2 /*return*/, new runtime.BlobApiResponse(response)];
173
+ }
174
+ });
175
+ });
176
+ };
177
+ /**
178
+ * Auto-generated: exportReview
179
+ */
180
+ ReviewApi.prototype.exportReview = function () {
181
+ return __awaiter(this, arguments, void 0, function (requestParameters, initOverrides) {
182
+ var response;
183
+ if (requestParameters === void 0) { requestParameters = {}; }
184
+ return __generator(this, function (_a) {
185
+ switch (_a.label) {
186
+ case 0: return [4 /*yield*/, this.exportReviewRaw(requestParameters, initOverrides)];
187
+ case 1:
188
+ response = _a.sent();
189
+ return [4 /*yield*/, response.value()];
190
+ case 2: return [2 /*return*/, _a.sent()];
191
+ }
192
+ });
193
+ });
194
+ };
137
195
  /**
138
196
  * Creates request options for getAllReview without sending the request
139
197
  */
@@ -192,6 +250,81 @@ var ReviewApi = /** @class */ (function (_super) {
192
250
  });
193
251
  });
194
252
  };
253
+ /**
254
+ * Creates request options for importReview without sending the request
255
+ */
256
+ ReviewApi.prototype.importReviewRequestOpts = function (requestParameters) {
257
+ return __awaiter(this, void 0, void 0, function () {
258
+ var queryParameters, headerParameters, consumes, canConsumeForm, formParams, useForm, urlPath;
259
+ return __generator(this, function (_a) {
260
+ if (requestParameters['file'] == null) {
261
+ throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling importReview().');
262
+ }
263
+ queryParameters = {};
264
+ headerParameters = {};
265
+ consumes = [
266
+ { contentType: 'application/x-www-form-urlencoded' },
267
+ ];
268
+ canConsumeForm = runtime.canConsumeForm(consumes);
269
+ useForm = false;
270
+ // use FormData to transmit files using content-type "multipart/form-data"
271
+ useForm = canConsumeForm;
272
+ if (useForm) {
273
+ formParams = new FormData();
274
+ }
275
+ else {
276
+ formParams = new URLSearchParams();
277
+ }
278
+ if (requestParameters['file'] != null) {
279
+ formParams.append('file', requestParameters['file']);
280
+ }
281
+ urlPath = "/admin-api/review/import";
282
+ return [2 /*return*/, {
283
+ path: urlPath,
284
+ method: 'POST',
285
+ headers: headerParameters,
286
+ query: queryParameters,
287
+ body: formParams,
288
+ }];
289
+ });
290
+ });
291
+ };
292
+ /**
293
+ * Auto-generated: importReview
294
+ */
295
+ ReviewApi.prototype.importReviewRaw = function (requestParameters, initOverrides) {
296
+ return __awaiter(this, void 0, void 0, function () {
297
+ var requestOptions, response;
298
+ return __generator(this, function (_a) {
299
+ switch (_a.label) {
300
+ case 0: return [4 /*yield*/, this.importReviewRequestOpts(requestParameters)];
301
+ case 1:
302
+ requestOptions = _a.sent();
303
+ return [4 /*yield*/, this.request(requestOptions, initOverrides)];
304
+ case 2:
305
+ response = _a.sent();
306
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GenericResponseFromJSON)(jsonValue); })];
307
+ }
308
+ });
309
+ });
310
+ };
311
+ /**
312
+ * Auto-generated: importReview
313
+ */
314
+ ReviewApi.prototype.importReview = function (requestParameters, initOverrides) {
315
+ return __awaiter(this, void 0, void 0, function () {
316
+ var response;
317
+ return __generator(this, function (_a) {
318
+ switch (_a.label) {
319
+ case 0: return [4 /*yield*/, this.importReviewRaw(requestParameters, initOverrides)];
320
+ case 1:
321
+ response = _a.sent();
322
+ return [4 /*yield*/, response.value()];
323
+ case 2: return [2 /*return*/, _a.sent()];
324
+ }
325
+ });
326
+ });
327
+ };
195
328
  /**
196
329
  * Creates request options for indexReview without sending the request
197
330
  */
@@ -20,7 +20,7 @@ export interface AddressFrontendResource {
20
20
  * @type {string}
21
21
  * @memberof AddressFrontendResource
22
22
  */
23
- company?: string | null;
23
+ company: string;
24
24
  /**
25
25
  *
26
26
  * @type {string}
@@ -22,6 +22,8 @@ exports.AddressFrontendResourceToJSONTyped = AddressFrontendResourceToJSONTyped;
22
22
  * Check if a given object implements the AddressFrontendResource interface.
23
23
  */
24
24
  function instanceOfAddressFrontendResource(value) {
25
+ if (!('company' in value) || value['company'] === undefined)
26
+ return false;
25
27
  if (!('line1' in value) || value['line1'] === undefined)
26
28
  return false;
27
29
  if (!('postcode' in value) || value['postcode'] === undefined)
@@ -44,7 +46,7 @@ function AddressFrontendResourceFromJSONTyped(json, ignoreDiscriminator) {
44
46
  return json;
45
47
  }
46
48
  return {
47
- 'company': json['company'] == null ? undefined : json['company'],
49
+ 'company': json['company'],
48
50
  'line1': json['line1'],
49
51
  'line2': json['line2'] == null ? undefined : json['line2'],
50
52
  'postcode': json['postcode'],
@@ -26,7 +26,7 @@ export interface AddressResource {
26
26
  * @type {string}
27
27
  * @memberof AddressResource
28
28
  */
29
- company?: string | null;
29
+ company: string;
30
30
  /**
31
31
  *
32
32
  * @type {string}
@@ -22,6 +22,8 @@ exports.AddressResourceToJSONTyped = AddressResourceToJSONTyped;
22
22
  * Check if a given object implements the AddressResource interface.
23
23
  */
24
24
  function instanceOfAddressResource(value) {
25
+ if (!('company' in value) || value['company'] === undefined)
26
+ return false;
25
27
  if (!('line1' in value) || value['line1'] === undefined)
26
28
  return false;
27
29
  if (!('postcode' in value) || value['postcode'] === undefined)
@@ -45,7 +47,7 @@ function AddressResourceFromJSONTyped(json, ignoreDiscriminator) {
45
47
  }
46
48
  return {
47
49
  'id': json['id'] == null ? undefined : json['id'],
48
- 'company': json['company'] == null ? undefined : json['company'],
50
+ 'company': json['company'],
49
51
  'line1': json['line_1'],
50
52
  'line2': json['line_2'] == null ? undefined : json['line_2'],
51
53
  'postcode': json['postcode'],
@@ -44,7 +44,7 @@ export interface StoreFrontendResource {
44
44
  * @type {string}
45
45
  * @memberof StoreFrontendResource
46
46
  */
47
- website: string;
47
+ website?: string | null;
48
48
  /**
49
49
  *
50
50
  * @type {string}
@@ -74,7 +74,7 @@ export interface StoreFrontendResource {
74
74
  * @type {string}
75
75
  * @memberof StoreFrontendResource
76
76
  */
77
- tagLine: string;
77
+ tagLine?: string | null;
78
78
  /**
79
79
  *
80
80
  * @type {string}
@@ -28,16 +28,12 @@ function instanceOfStoreFrontendResource(value) {
28
28
  return false;
29
29
  if (!('email' in value) || value['email'] === undefined)
30
30
  return false;
31
- if (!('website' in value) || value['website'] === undefined)
32
- return false;
33
31
  if (!('phone' in value) || value['phone'] === undefined)
34
32
  return false;
35
33
  if (!('latitude' in value) || value['latitude'] === undefined)
36
34
  return false;
37
35
  if (!('longitude' in value) || value['longitude'] === undefined)
38
36
  return false;
39
- if (!('tagLine' in value) || value['tagLine'] === undefined)
40
- return false;
41
37
  if (!('specialDates' in value) || value['specialDates'] === undefined)
42
38
  return false;
43
39
  if (!('suppliers' in value) || value['suppliers'] === undefined)
@@ -56,12 +52,12 @@ function StoreFrontendResourceFromJSONTyped(json, ignoreDiscriminator) {
56
52
  'siteId': json['siteId'],
57
53
  'name': json['name'],
58
54
  'email': json['email'],
59
- 'website': json['website'],
55
+ 'website': json['website'] == null ? undefined : json['website'],
60
56
  'phone': json['phone'],
61
57
  'address': json['address'] == null ? undefined : json['address'],
62
58
  'latitude': json['latitude'],
63
59
  'longitude': json['longitude'],
64
- 'tagLine': json['tagLine'],
60
+ 'tagLine': json['tagLine'] == null ? undefined : json['tagLine'],
65
61
  'openingHours': json['openingHours'] == null ? undefined : json['openingHours'],
66
62
  'specialDates': json['specialDates'],
67
63
  'suppliers': json['suppliers'],
@@ -35,10 +35,10 @@ export interface StoreSpecialDateFrontendResource {
35
35
  hours: string;
36
36
  /**
37
37
  *
38
- * @type {string}
38
+ * @type {object}
39
39
  * @memberof StoreSpecialDateFrontendResource
40
40
  */
41
- date?: string | null;
41
+ date: object;
42
42
  /**
43
43
  *
44
44
  * @type {boolean}
@@ -26,6 +26,8 @@ function instanceOfStoreSpecialDateFrontendResource(value) {
26
26
  return false;
27
27
  if (!('hours' in value) || value['hours'] === undefined)
28
28
  return false;
29
+ if (!('date' in value) || value['date'] === undefined)
30
+ return false;
29
31
  if (!('closed' in value) || value['closed'] === undefined)
30
32
  return false;
31
33
  if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
@@ -45,7 +47,7 @@ function StoreSpecialDateFrontendResourceFromJSONTyped(json, ignoreDiscriminator
45
47
  'id': json['id'] == null ? undefined : json['id'],
46
48
  'name': json['name'],
47
49
  'hours': json['hours'],
48
- 'date': json['date'] == null ? undefined : json['date'],
50
+ 'date': json['date'],
49
51
  'closed': json['closed'],
50
52
  'displayStartDate': json['displayStartDate'],
51
53
  'displayEndDate': json['displayEndDate'],
@@ -35,10 +35,10 @@ export interface StoreSpecialDateResource {
35
35
  hours: string;
36
36
  /**
37
37
  *
38
- * @type {string}
38
+ * @type {object}
39
39
  * @memberof StoreSpecialDateResource
40
40
  */
41
- date?: string | null;
41
+ date: object;
42
42
  /**
43
43
  *
44
44
  * @type {boolean}
@@ -26,6 +26,8 @@ function instanceOfStoreSpecialDateResource(value) {
26
26
  return false;
27
27
  if (!('hours' in value) || value['hours'] === undefined)
28
28
  return false;
29
+ if (!('date' in value) || value['date'] === undefined)
30
+ return false;
29
31
  if (!('closed' in value) || value['closed'] === undefined)
30
32
  return false;
31
33
  if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
@@ -45,7 +47,7 @@ function StoreSpecialDateResourceFromJSONTyped(json, ignoreDiscriminator) {
45
47
  'id': json['id'] == null ? undefined : json['id'],
46
48
  'name': json['name'],
47
49
  'hours': json['hours'],
48
- 'date': json['date'] == null ? undefined : json['date'],
50
+ 'date': json['date'],
49
51
  'closed': json['closed'],
50
52
  'displayStartDate': json['display_start_date'],
51
53
  'displayEndDate': json['display_end_date'],
package/docs/ReviewApi.md CHANGED
@@ -5,7 +5,9 @@ All URIs are relative to *http://localhost/api*
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
7
  | [**destroyReview**](ReviewApi.md#destroyreview) | **DELETE** /admin-api/review/{review}/delete | Auto-generated: destroyReview |
8
+ | [**exportReview**](ReviewApi.md#exportreview) | **POST** /admin-api/review/export | Auto-generated: exportReview |
8
9
  | [**getAllReview**](ReviewApi.md#getallreview) | **POST** /admin-api/review/all | Auto-generated: getAllReview |
10
+ | [**importReview**](ReviewApi.md#importreview) | **POST** /admin-api/review/import | Auto-generated: importReview |
9
11
  | [**indexReview**](ReviewApi.md#indexreviewoperation) | **POST** /admin-api/review/list | Auto-generated: indexReview |
10
12
  | [**showReview**](ReviewApi.md#showreview) | **GET** /admin-api/review/{review} | Auto-generated: showReview |
11
13
  | [**storeReview**](ReviewApi.md#storereviewoperation) | **POST** /admin-api/review/create | Auto-generated: storeReview |
@@ -78,6 +80,71 @@ No authorization required
78
80
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
79
81
 
80
82
 
83
+ ## exportReview
84
+
85
+ > Blob exportReview(indexReviewRequest)
86
+
87
+ Auto-generated: exportReview
88
+
89
+ ### Example
90
+
91
+ ```ts
92
+ import {
93
+ Configuration,
94
+ ReviewApi,
95
+ } from '@digital8/lighting-illusions-ts-sdk';
96
+ import type { ExportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
97
+
98
+ async function example() {
99
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
100
+ const api = new ReviewApi();
101
+
102
+ const body = {
103
+ // IndexReviewRequest (optional)
104
+ indexReviewRequest: ...,
105
+ } satisfies ExportReviewRequest;
106
+
107
+ try {
108
+ const data = await api.exportReview(body);
109
+ console.log(data);
110
+ } catch (error) {
111
+ console.error(error);
112
+ }
113
+ }
114
+
115
+ // Run the test
116
+ example().catch(console.error);
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+
122
+ | Name | Type | Description | Notes |
123
+ |------------- | ------------- | ------------- | -------------|
124
+ | **indexReviewRequest** | [IndexReviewRequest](IndexReviewRequest.md) | | [Optional] |
125
+
126
+ ### Return type
127
+
128
+ **Blob**
129
+
130
+ ### Authorization
131
+
132
+ No authorization required
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: `application/json`
137
+ - **Accept**: ``
138
+
139
+
140
+ ### HTTP response details
141
+ | Status code | Description | Response headers |
142
+ |-------------|-------------|------------------|
143
+ | **200** | File download () | - |
144
+
145
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
146
+
147
+
81
148
  ## getAllReview
82
149
 
83
150
  > ReviewLiteResourceArrayResponse getAllReview(indexReviewRequest)
@@ -143,6 +210,71 @@ No authorization required
143
210
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
144
211
 
145
212
 
213
+ ## importReview
214
+
215
+ > GenericResponse importReview(file)
216
+
217
+ Auto-generated: importReview
218
+
219
+ ### Example
220
+
221
+ ```ts
222
+ import {
223
+ Configuration,
224
+ ReviewApi,
225
+ } from '@digital8/lighting-illusions-ts-sdk';
226
+ import type { ImportReviewRequest } from '@digital8/lighting-illusions-ts-sdk';
227
+
228
+ async function example() {
229
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
230
+ const api = new ReviewApi();
231
+
232
+ const body = {
233
+ // Blob
234
+ file: BINARY_DATA_HERE,
235
+ } satisfies ImportReviewRequest;
236
+
237
+ try {
238
+ const data = await api.importReview(body);
239
+ console.log(data);
240
+ } catch (error) {
241
+ console.error(error);
242
+ }
243
+ }
244
+
245
+ // Run the test
246
+ example().catch(console.error);
247
+ ```
248
+
249
+ ### Parameters
250
+
251
+
252
+ | Name | Type | Description | Notes |
253
+ |------------- | ------------- | ------------- | -------------|
254
+ | **file** | `Blob` | | [Defaults to `undefined`] |
255
+
256
+ ### Return type
257
+
258
+ [**GenericResponse**](GenericResponse.md)
259
+
260
+ ### Authorization
261
+
262
+ No authorization required
263
+
264
+ ### HTTP request headers
265
+
266
+ - **Content-Type**: `application/x-www-form-urlencoded`
267
+ - **Accept**: `application/json`
268
+
269
+
270
+ ### HTTP response details
271
+ | Status code | Description | Response headers |
272
+ |-------------|-------------|------------------|
273
+ | **200** | \\JsonResponse | - |
274
+
275
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
276
+
277
+
146
278
  ## indexReview
147
279
 
148
280
  > PaginatedReviewListResourceResponse indexReview(indexReviewRequest)
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | string
12
+ `date` | object
13
13
  `closed` | boolean
14
14
  `displayStartDate` | object
15
15
  `displayEndDate` | object
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | string
12
+ `date` | object
13
13
  `closed` | boolean
14
14
  `displayStartDate` | string
15
15
  `displayEndDate` | string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.1791",
3
+ "version": "0.0.1792",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -44,10 +44,18 @@ export interface DestroyReviewRequest {
44
44
  review: number;
45
45
  }
46
46
 
47
+ export interface ExportReviewRequest {
48
+ indexReviewRequest?: IndexReviewRequest;
49
+ }
50
+
47
51
  export interface GetAllReviewRequest {
48
52
  indexReviewRequest?: IndexReviewRequest;
49
53
  }
50
54
 
55
+ export interface ImportReviewRequest {
56
+ file: Blob;
57
+ }
58
+
51
59
  export interface IndexReviewOperationRequest {
52
60
  indexReviewRequest?: IndexReviewRequest;
53
61
  }
@@ -115,6 +123,46 @@ export class ReviewApi extends runtime.BaseAPI {
115
123
  return await response.value();
116
124
  }
117
125
 
126
+ /**
127
+ * Creates request options for exportReview without sending the request
128
+ */
129
+ async exportReviewRequestOpts(requestParameters: ExportReviewRequest): Promise<runtime.RequestOpts> {
130
+ const queryParameters: any = {};
131
+
132
+ const headerParameters: runtime.HTTPHeaders = {};
133
+
134
+ headerParameters['Content-Type'] = 'application/json';
135
+
136
+
137
+ let urlPath = `/admin-api/review/export`;
138
+
139
+ return {
140
+ path: urlPath,
141
+ method: 'POST',
142
+ headers: headerParameters,
143
+ query: queryParameters,
144
+ body: IndexReviewRequestToJSON(requestParameters['indexReviewRequest']),
145
+ };
146
+ }
147
+
148
+ /**
149
+ * Auto-generated: exportReview
150
+ */
151
+ async exportReviewRaw(requestParameters: ExportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
152
+ const requestOptions = await this.exportReviewRequestOpts(requestParameters);
153
+ const response = await this.request(requestOptions, initOverrides);
154
+
155
+ return new runtime.BlobApiResponse(response);
156
+ }
157
+
158
+ /**
159
+ * Auto-generated: exportReview
160
+ */
161
+ async exportReview(requestParameters: ExportReviewRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
162
+ const response = await this.exportReviewRaw(requestParameters, initOverrides);
163
+ return await response.value();
164
+ }
165
+
118
166
  /**
119
167
  * Creates request options for getAllReview without sending the request
120
168
  */
@@ -155,6 +203,71 @@ export class ReviewApi extends runtime.BaseAPI {
155
203
  return await response.value();
156
204
  }
157
205
 
206
+ /**
207
+ * Creates request options for importReview without sending the request
208
+ */
209
+ async importReviewRequestOpts(requestParameters: ImportReviewRequest): Promise<runtime.RequestOpts> {
210
+ if (requestParameters['file'] == null) {
211
+ throw new runtime.RequiredError(
212
+ 'file',
213
+ 'Required parameter "file" was null or undefined when calling importReview().'
214
+ );
215
+ }
216
+
217
+ const queryParameters: any = {};
218
+
219
+ const headerParameters: runtime.HTTPHeaders = {};
220
+
221
+ const consumes: runtime.Consume[] = [
222
+ { contentType: 'application/x-www-form-urlencoded' },
223
+ ];
224
+ // @ts-ignore: canConsumeForm may be unused
225
+ const canConsumeForm = runtime.canConsumeForm(consumes);
226
+
227
+ let formParams: { append(param: string, value: any): any };
228
+ let useForm = false;
229
+ // use FormData to transmit files using content-type "multipart/form-data"
230
+ useForm = canConsumeForm;
231
+ if (useForm) {
232
+ formParams = new FormData();
233
+ } else {
234
+ formParams = new URLSearchParams();
235
+ }
236
+
237
+ if (requestParameters['file'] != null) {
238
+ formParams.append('file', requestParameters['file'] as any);
239
+ }
240
+
241
+
242
+ let urlPath = `/admin-api/review/import`;
243
+
244
+ return {
245
+ path: urlPath,
246
+ method: 'POST',
247
+ headers: headerParameters,
248
+ query: queryParameters,
249
+ body: formParams,
250
+ };
251
+ }
252
+
253
+ /**
254
+ * Auto-generated: importReview
255
+ */
256
+ async importReviewRaw(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
257
+ const requestOptions = await this.importReviewRequestOpts(requestParameters);
258
+ const response = await this.request(requestOptions, initOverrides);
259
+
260
+ return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
261
+ }
262
+
263
+ /**
264
+ * Auto-generated: importReview
265
+ */
266
+ async importReview(requestParameters: ImportReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
267
+ const response = await this.importReviewRaw(requestParameters, initOverrides);
268
+ return await response.value();
269
+ }
270
+
158
271
  /**
159
272
  * Creates request options for indexReview without sending the request
160
273
  */
@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
24
24
  * @type {string}
25
25
  * @memberof AddressFrontendResource
26
26
  */
27
- company?: string | null;
27
+ company: string;
28
28
  /**
29
29
  *
30
30
  * @type {string}
@@ -73,6 +73,7 @@ export interface AddressFrontendResource {
73
73
  * Check if a given object implements the AddressFrontendResource interface.
74
74
  */
75
75
  export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
76
+ if (!('company' in value) || value['company'] === undefined) return false;
76
77
  if (!('line1' in value) || value['line1'] === undefined) return false;
77
78
  if (!('postcode' in value) || value['postcode'] === undefined) return false;
78
79
  if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -92,7 +93,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
92
93
  }
93
94
  return {
94
95
 
95
- 'company': json['company'] == null ? undefined : json['company'],
96
+ 'company': json['company'],
96
97
  'line1': json['line1'],
97
98
  'line2': json['line2'] == null ? undefined : json['line2'],
98
99
  'postcode': json['postcode'],
@@ -30,7 +30,7 @@ export interface AddressResource {
30
30
  * @type {string}
31
31
  * @memberof AddressResource
32
32
  */
33
- company?: string | null;
33
+ company: string;
34
34
  /**
35
35
  *
36
36
  * @type {string}
@@ -79,6 +79,7 @@ export interface AddressResource {
79
79
  * Check if a given object implements the AddressResource interface.
80
80
  */
81
81
  export function instanceOfAddressResource(value: object): value is AddressResource {
82
+ if (!('company' in value) || value['company'] === undefined) return false;
82
83
  if (!('line1' in value) || value['line1'] === undefined) return false;
83
84
  if (!('postcode' in value) || value['postcode'] === undefined) return false;
84
85
  if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -99,7 +100,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
99
100
  return {
100
101
 
101
102
  'id': json['id'] == null ? undefined : json['id'],
102
- 'company': json['company'] == null ? undefined : json['company'],
103
+ 'company': json['company'],
103
104
  'line1': json['line_1'],
104
105
  'line2': json['line_2'] == null ? undefined : json['line_2'],
105
106
  'postcode': json['postcode'],
@@ -48,7 +48,7 @@ export interface StoreFrontendResource {
48
48
  * @type {string}
49
49
  * @memberof StoreFrontendResource
50
50
  */
51
- website: string;
51
+ website?: string | null;
52
52
  /**
53
53
  *
54
54
  * @type {string}
@@ -78,7 +78,7 @@ export interface StoreFrontendResource {
78
78
  * @type {string}
79
79
  * @memberof StoreFrontendResource
80
80
  */
81
- tagLine: string;
81
+ tagLine?: string | null;
82
82
  /**
83
83
  *
84
84
  * @type {string}
@@ -106,11 +106,9 @@ export function instanceOfStoreFrontendResource(value: object): value is StoreFr
106
106
  if (!('siteId' in value) || value['siteId'] === undefined) return false;
107
107
  if (!('name' in value) || value['name'] === undefined) return false;
108
108
  if (!('email' in value) || value['email'] === undefined) return false;
109
- if (!('website' in value) || value['website'] === undefined) return false;
110
109
  if (!('phone' in value) || value['phone'] === undefined) return false;
111
110
  if (!('latitude' in value) || value['latitude'] === undefined) return false;
112
111
  if (!('longitude' in value) || value['longitude'] === undefined) return false;
113
- if (!('tagLine' in value) || value['tagLine'] === undefined) return false;
114
112
  if (!('specialDates' in value) || value['specialDates'] === undefined) return false;
115
113
  if (!('suppliers' in value) || value['suppliers'] === undefined) return false;
116
114
  return true;
@@ -130,12 +128,12 @@ export function StoreFrontendResourceFromJSONTyped(json: any, ignoreDiscriminato
130
128
  'siteId': json['siteId'],
131
129
  'name': json['name'],
132
130
  'email': json['email'],
133
- 'website': json['website'],
131
+ 'website': json['website'] == null ? undefined : json['website'],
134
132
  'phone': json['phone'],
135
133
  'address': json['address'] == null ? undefined : json['address'],
136
134
  'latitude': json['latitude'],
137
135
  'longitude': json['longitude'],
138
- 'tagLine': json['tagLine'],
136
+ 'tagLine': json['tagLine'] == null ? undefined : json['tagLine'],
139
137
  'openingHours': json['openingHours'] == null ? undefined : json['openingHours'],
140
138
  'specialDates': json['specialDates'],
141
139
  'suppliers': json['suppliers'],
@@ -39,10 +39,10 @@ export interface StoreSpecialDateFrontendResource {
39
39
  hours: string;
40
40
  /**
41
41
  *
42
- * @type {string}
42
+ * @type {object}
43
43
  * @memberof StoreSpecialDateFrontendResource
44
44
  */
45
- date?: string | null;
45
+ date: object;
46
46
  /**
47
47
  *
48
48
  * @type {boolean}
@@ -69,6 +69,7 @@ export interface StoreSpecialDateFrontendResource {
69
69
  export function instanceOfStoreSpecialDateFrontendResource(value: object): value is StoreSpecialDateFrontendResource {
70
70
  if (!('name' in value) || value['name'] === undefined) return false;
71
71
  if (!('hours' in value) || value['hours'] === undefined) return false;
72
+ if (!('date' in value) || value['date'] === undefined) return false;
72
73
  if (!('closed' in value) || value['closed'] === undefined) return false;
73
74
  if (!('displayStartDate' in value) || value['displayStartDate'] === undefined) return false;
74
75
  if (!('displayEndDate' in value) || value['displayEndDate'] === undefined) return false;
@@ -88,7 +89,7 @@ export function StoreSpecialDateFrontendResourceFromJSONTyped(json: any, ignoreD
88
89
  'id': json['id'] == null ? undefined : json['id'],
89
90
  'name': json['name'],
90
91
  'hours': json['hours'],
91
- 'date': json['date'] == null ? undefined : json['date'],
92
+ 'date': json['date'],
92
93
  'closed': json['closed'],
93
94
  'displayStartDate': json['displayStartDate'],
94
95
  'displayEndDate': json['displayEndDate'],
@@ -39,10 +39,10 @@ export interface StoreSpecialDateResource {
39
39
  hours: string;
40
40
  /**
41
41
  *
42
- * @type {string}
42
+ * @type {object}
43
43
  * @memberof StoreSpecialDateResource
44
44
  */
45
- date?: string | null;
45
+ date: object;
46
46
  /**
47
47
  *
48
48
  * @type {boolean}
@@ -69,6 +69,7 @@ export interface StoreSpecialDateResource {
69
69
  export function instanceOfStoreSpecialDateResource(value: object): value is StoreSpecialDateResource {
70
70
  if (!('name' in value) || value['name'] === undefined) return false;
71
71
  if (!('hours' in value) || value['hours'] === undefined) return false;
72
+ if (!('date' in value) || value['date'] === undefined) return false;
72
73
  if (!('closed' in value) || value['closed'] === undefined) return false;
73
74
  if (!('displayStartDate' in value) || value['displayStartDate'] === undefined) return false;
74
75
  if (!('displayEndDate' in value) || value['displayEndDate'] === undefined) return false;
@@ -88,7 +89,7 @@ export function StoreSpecialDateResourceFromJSONTyped(json: any, ignoreDiscrimin
88
89
  'id': json['id'] == null ? undefined : json['id'],
89
90
  'name': json['name'],
90
91
  'hours': json['hours'],
91
- 'date': json['date'] == null ? undefined : json['date'],
92
+ 'date': json['date'],
92
93
  'closed': json['closed'],
93
94
  'displayStartDate': json['display_start_date'],
94
95
  'displayEndDate': json['display_end_date'],