@digital8/lighting-illusions-ts-sdk 0.0.483 → 0.0.485

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.
@@ -198,6 +198,7 @@ docs/TagResourceArrayResponse.md
198
198
  docs/TagType.md
199
199
  docs/UpdateAttributeRequest.md
200
200
  docs/UpdateAttributeValueRequest.md
201
+ docs/UpdateDocumentRequest.md
201
202
  docs/UpdateFilterOrderAttributeRequest.md
202
203
  docs/UpdateFilterOrderAttributeRequestValuesInner.md
203
204
  docs/UpdateModelAttributeRequest.md
@@ -411,6 +412,7 @@ src/models/TagResourceArrayResponse.ts
411
412
  src/models/TagType.ts
412
413
  src/models/UpdateAttributeRequest.ts
413
414
  src/models/UpdateAttributeValueRequest.ts
415
+ src/models/UpdateDocumentRequest.ts
414
416
  src/models/UpdateFilterOrderAttributeRequest.ts
415
417
  src/models/UpdateFilterOrderAttributeRequestValuesInner.ts
416
418
  src/models/UpdateModelAttributeRequest.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @digital8/lighting-illusions-ts-sdk@0.0.483
1
+ # @digital8/lighting-illusions-ts-sdk@0.0.485
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -66,12 +66,14 @@ All URIs are relative to *http://localhost/api*
66
66
  *AttributeApi* | [**updateFilterOrderAttribute**](docs/AttributeApi.md#updatefilterorderattributeoperation) | **PUT** /admin-api/attribute/update-filter-order | Auto-generated: updateFilterOrderAttribute
67
67
  *AttributeApi* | [**updateModelAttribute**](docs/AttributeApi.md#updatemodelattributeoperation) | **PUT** /admin-api/attribute/model-attribute/{modelAttribute}/update | Auto-generated: updateModelAttribute
68
68
  *DocumentApi* | [**attachDocumentablesDocument**](docs/DocumentApi.md#attachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/attach-documentables | Auto-generated: attachDocumentablesDocument
69
- *DocumentApi* | [**destroyDocument**](docs/DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document} | Auto-generated: destroyDocument
69
+ *DocumentApi* | [**destroyDocument**](docs/DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document}/delete | Auto-generated: destroyDocument
70
70
  *DocumentApi* | [**detachDocumentablesDocument**](docs/DocumentApi.md#detachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/detach-documentables | Auto-generated: detachDocumentablesDocument
71
71
  *DocumentApi* | [**getAllDocument**](docs/DocumentApi.md#getalldocumentoperation) | **POST** /admin-api/document/all | Auto-generated: getAllDocument
72
72
  *DocumentApi* | [**indexDocument**](docs/DocumentApi.md#indexdocumentoperation) | **POST** /admin-api/document/list | Auto-generated: indexDocument
73
- *DocumentApi* | [**storeDocument**](docs/DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document | Auto-generated: storeDocument
73
+ *DocumentApi* | [**showDocument**](docs/DocumentApi.md#showdocument) | **GET** /admin-api/document/{document} | Auto-generated: showDocument
74
+ *DocumentApi* | [**storeDocument**](docs/DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document/create | Auto-generated: storeDocument
74
75
  *DocumentApi* | [**storeDocumentFile**](docs/DocumentApi.md#storedocumentfileoperation) | **POST** /admin-api/document/files | Auto-generated: storeDocumentFile
76
+ *DocumentApi* | [**updateDocument**](docs/DocumentApi.md#updatedocumentoperation) | **PUT** /admin-api/document/{document}/update | Auto-generated: updateDocument
75
77
  *ExternalApiLogApi* | [**indexExternalApiLog**](docs/ExternalApiLogApi.md#indexexternalapilogoperation) | **POST** /admin-api/external-api-log/list | Auto-generated: indexExternalApiLog
76
78
  *OverlayTemplateApi* | [**attachAssetsOverlayTemplate**](docs/OverlayTemplateApi.md#attachassetsoverlaytemplateoperation) | **POST** /admin-api/overlay-template/{overlayTemplate}/attach-assets | Auto-generated: attachAssetsOverlayTemplate
77
79
  *OverlayTemplateApi* | [**destroyOverlayTemplate**](docs/OverlayTemplateApi.md#destroyoverlaytemplate) | **DELETE** /admin-api/overlay-template/{overlayTemplate}/delete | Auto-generated: destroyOverlayTemplate
@@ -328,6 +330,7 @@ All URIs are relative to *http://localhost/api*
328
330
  - [TagType](docs/TagType.md)
329
331
  - [UpdateAttributeRequest](docs/UpdateAttributeRequest.md)
330
332
  - [UpdateAttributeValueRequest](docs/UpdateAttributeValueRequest.md)
333
+ - [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)
331
334
  - [UpdateFilterOrderAttributeRequest](docs/UpdateFilterOrderAttributeRequest.md)
332
335
  - [UpdateFilterOrderAttributeRequestValuesInner](docs/UpdateFilterOrderAttributeRequestValuesInner.md)
333
336
  - [UpdateModelAttributeRequest](docs/UpdateModelAttributeRequest.md)
@@ -355,7 +358,7 @@ and is automatically generated by the
355
358
  [OpenAPI Generator](https://openapi-generator.tech) project:
356
359
 
357
360
  - API version: `1.0.0`
358
- - Package version: `0.0.483`
361
+ - Package version: `0.0.485`
359
362
  - Generator version: `7.17.0`
360
363
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
361
364
 
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AttachDocumentablesDocumentRequest, DetachDocumentablesDocumentRequest, DocumentFileForUploadResource, DocumentResource, DocumentResourceArrayResponse, GenericResponse, GetAllDocumentRequest, IndexDocumentRequest, PaginatedDocumentResourceResponse, StoreDocumentFileRequest, StoreDocumentRequest } from '../models/index';
13
+ import type { AttachDocumentablesDocumentRequest, DetachDocumentablesDocumentRequest, DocumentFileForUploadResource, DocumentResource, DocumentResourceArrayResponse, GenericResponse, GetAllDocumentRequest, IndexDocumentRequest, PaginatedDocumentResourceResponse, StoreDocumentFileRequest, StoreDocumentRequest, UpdateDocumentRequest } from '../models/index';
14
14
  export interface AttachDocumentablesDocumentOperationRequest {
15
15
  document: number;
16
16
  attachDocumentablesDocumentRequest?: AttachDocumentablesDocumentRequest;
@@ -28,12 +28,19 @@ export interface GetAllDocumentOperationRequest {
28
28
  export interface IndexDocumentOperationRequest {
29
29
  indexDocumentRequest?: IndexDocumentRequest;
30
30
  }
31
+ export interface ShowDocumentRequest {
32
+ document: number;
33
+ }
31
34
  export interface StoreDocumentOperationRequest {
32
35
  storeDocumentRequest?: StoreDocumentRequest;
33
36
  }
34
37
  export interface StoreDocumentFileOperationRequest {
35
38
  storeDocumentFileRequest?: StoreDocumentFileRequest;
36
39
  }
40
+ export interface UpdateDocumentOperationRequest {
41
+ document: number;
42
+ updateDocumentRequest?: UpdateDocumentRequest;
43
+ }
37
44
  /**
38
45
  *
39
46
  */
@@ -78,6 +85,14 @@ export declare class DocumentApi extends runtime.BaseAPI {
78
85
  * Auto-generated: indexDocument
79
86
  */
80
87
  indexDocument(requestParameters?: IndexDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDocumentResourceResponse>;
88
+ /**
89
+ * Auto-generated: showDocument
90
+ */
91
+ showDocumentRaw(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResource>>;
92
+ /**
93
+ * Auto-generated: showDocument
94
+ */
95
+ showDocument(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResource>;
81
96
  /**
82
97
  * Auto-generated: storeDocument
83
98
  */
@@ -94,4 +109,12 @@ export declare class DocumentApi extends runtime.BaseAPI {
94
109
  * Auto-generated: storeDocumentFile
95
110
  */
96
111
  storeDocumentFile(requestParameters?: StoreDocumentFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentFileForUploadResource>;
112
+ /**
113
+ * Auto-generated: updateDocument
114
+ */
115
+ updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResource>>;
116
+ /**
117
+ * Auto-generated: updateDocument
118
+ */
119
+ updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResource>;
97
120
  }
@@ -137,7 +137,7 @@ var DocumentApi = /** @class */ (function (_super) {
137
137
  }
138
138
  queryParameters = {};
139
139
  headerParameters = {};
140
- urlPath = "/admin-api/document/{document}";
140
+ urlPath = "/admin-api/document/{document}/delete";
141
141
  urlPath = urlPath.replace("{".concat("document", "}"), encodeURIComponent(String(requestParameters['document'])));
142
142
  return [4 /*yield*/, this.request({
143
143
  path: urlPath,
@@ -307,6 +307,52 @@ var DocumentApi = /** @class */ (function (_super) {
307
307
  });
308
308
  });
309
309
  };
310
+ /**
311
+ * Auto-generated: showDocument
312
+ */
313
+ DocumentApi.prototype.showDocumentRaw = function (requestParameters, initOverrides) {
314
+ return __awaiter(this, void 0, void 0, function () {
315
+ var queryParameters, headerParameters, urlPath, response;
316
+ return __generator(this, function (_a) {
317
+ switch (_a.label) {
318
+ case 0:
319
+ if (requestParameters['document'] == null) {
320
+ throw new runtime.RequiredError('document', 'Required parameter "document" was null or undefined when calling showDocument().');
321
+ }
322
+ queryParameters = {};
323
+ headerParameters = {};
324
+ urlPath = "/admin-api/document/{document}";
325
+ urlPath = urlPath.replace("{".concat("document", "}"), encodeURIComponent(String(requestParameters['document'])));
326
+ return [4 /*yield*/, this.request({
327
+ path: urlPath,
328
+ method: 'GET',
329
+ headers: headerParameters,
330
+ query: queryParameters,
331
+ }, initOverrides)];
332
+ case 1:
333
+ response = _a.sent();
334
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DocumentResourceFromJSON)(jsonValue); })];
335
+ }
336
+ });
337
+ });
338
+ };
339
+ /**
340
+ * Auto-generated: showDocument
341
+ */
342
+ DocumentApi.prototype.showDocument = function (requestParameters, initOverrides) {
343
+ return __awaiter(this, void 0, void 0, function () {
344
+ var response;
345
+ return __generator(this, function (_a) {
346
+ switch (_a.label) {
347
+ case 0: return [4 /*yield*/, this.showDocumentRaw(requestParameters, initOverrides)];
348
+ case 1:
349
+ response = _a.sent();
350
+ return [4 /*yield*/, response.value()];
351
+ case 2: return [2 /*return*/, _a.sent()];
352
+ }
353
+ });
354
+ });
355
+ };
310
356
  /**
311
357
  * Auto-generated: storeDocument
312
358
  */
@@ -319,7 +365,7 @@ var DocumentApi = /** @class */ (function (_super) {
319
365
  queryParameters = {};
320
366
  headerParameters = {};
321
367
  headerParameters['Content-Type'] = 'application/json';
322
- urlPath = "/admin-api/document";
368
+ urlPath = "/admin-api/document/create";
323
369
  return [4 /*yield*/, this.request({
324
370
  path: urlPath,
325
371
  method: 'POST',
@@ -397,6 +443,54 @@ var DocumentApi = /** @class */ (function (_super) {
397
443
  });
398
444
  });
399
445
  };
446
+ /**
447
+ * Auto-generated: updateDocument
448
+ */
449
+ DocumentApi.prototype.updateDocumentRaw = function (requestParameters, initOverrides) {
450
+ return __awaiter(this, void 0, void 0, function () {
451
+ var queryParameters, headerParameters, urlPath, response;
452
+ return __generator(this, function (_a) {
453
+ switch (_a.label) {
454
+ case 0:
455
+ if (requestParameters['document'] == null) {
456
+ throw new runtime.RequiredError('document', 'Required parameter "document" was null or undefined when calling updateDocument().');
457
+ }
458
+ queryParameters = {};
459
+ headerParameters = {};
460
+ headerParameters['Content-Type'] = 'application/json';
461
+ urlPath = "/admin-api/document/{document}/update";
462
+ urlPath = urlPath.replace("{".concat("document", "}"), encodeURIComponent(String(requestParameters['document'])));
463
+ return [4 /*yield*/, this.request({
464
+ path: urlPath,
465
+ method: 'PUT',
466
+ headers: headerParameters,
467
+ query: queryParameters,
468
+ body: (0, index_1.UpdateDocumentRequestToJSON)(requestParameters['updateDocumentRequest']),
469
+ }, initOverrides)];
470
+ case 1:
471
+ response = _a.sent();
472
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DocumentResourceFromJSON)(jsonValue); })];
473
+ }
474
+ });
475
+ });
476
+ };
477
+ /**
478
+ * Auto-generated: updateDocument
479
+ */
480
+ DocumentApi.prototype.updateDocument = function (requestParameters, initOverrides) {
481
+ return __awaiter(this, void 0, void 0, function () {
482
+ var response;
483
+ return __generator(this, function (_a) {
484
+ switch (_a.label) {
485
+ case 0: return [4 /*yield*/, this.updateDocumentRaw(requestParameters, initOverrides)];
486
+ case 1:
487
+ response = _a.sent();
488
+ return [4 /*yield*/, response.value()];
489
+ case 2: return [2 /*return*/, _a.sent()];
490
+ }
491
+ });
492
+ });
493
+ };
400
494
  return DocumentApi;
401
495
  }(runtime.BaseAPI));
402
496
  exports.DocumentApi = DocumentApi;
@@ -63,7 +63,7 @@ export interface ExternalApiLogResource {
63
63
  * @type {string}
64
64
  * @memberof ExternalApiLogResource
65
65
  */
66
- requestPayload: string;
66
+ requestPayload?: string | null;
67
67
  /**
68
68
  *
69
69
  * @type {string}
@@ -37,8 +37,6 @@ function instanceOfExternalApiLogResource(value) {
37
37
  return false;
38
38
  if (!('responseCode' in value) || value['responseCode'] === undefined)
39
39
  return false;
40
- if (!('requestPayload' in value) || value['requestPayload'] === undefined)
41
- return false;
42
40
  if (!('responsePayload' in value) || value['responsePayload'] === undefined)
43
41
  return false;
44
42
  if (!('site' in value) || value['site'] === undefined)
@@ -60,7 +58,7 @@ function ExternalApiLogResourceFromJSONTyped(json, ignoreDiscriminator) {
60
58
  'exteranlApiLoggableId': json['exteranlApiLoggableId'],
61
59
  'endpoint': json['endpoint'],
62
60
  'responseCode': json['responseCode'],
63
- 'requestPayload': json['requestPayload'],
61
+ 'requestPayload': json['requestPayload'] == null ? undefined : json['requestPayload'],
64
62
  'responsePayload': json['responsePayload'],
65
63
  'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
66
64
  'site': (0, SiteLiteResource_1.SiteLiteResourceFromJSON)(json['site']),
@@ -0,0 +1,44 @@
1
+ /**
2
+ * My API
3
+ * API documentation for my Laravel app
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface UpdateDocumentRequest
16
+ */
17
+ export interface UpdateDocumentRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof UpdateDocumentRequest
22
+ */
23
+ name: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof UpdateDocumentRequest
28
+ */
29
+ documentFileId: string;
30
+ /**
31
+ *
32
+ * @type {Array<string>}
33
+ * @memberof UpdateDocumentRequest
34
+ */
35
+ siteIds?: Array<string>;
36
+ }
37
+ /**
38
+ * Check if a given object implements the UpdateDocumentRequest interface.
39
+ */
40
+ export declare function instanceOfUpdateDocumentRequest(value: object): value is UpdateDocumentRequest;
41
+ export declare function UpdateDocumentRequestFromJSON(json: any): UpdateDocumentRequest;
42
+ export declare function UpdateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateDocumentRequest;
43
+ export declare function UpdateDocumentRequestToJSON(json: any): UpdateDocumentRequest;
44
+ export declare function UpdateDocumentRequestToJSONTyped(value?: UpdateDocumentRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * My API
6
+ * API documentation for my Laravel app
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfUpdateDocumentRequest = instanceOfUpdateDocumentRequest;
17
+ exports.UpdateDocumentRequestFromJSON = UpdateDocumentRequestFromJSON;
18
+ exports.UpdateDocumentRequestFromJSONTyped = UpdateDocumentRequestFromJSONTyped;
19
+ exports.UpdateDocumentRequestToJSON = UpdateDocumentRequestToJSON;
20
+ exports.UpdateDocumentRequestToJSONTyped = UpdateDocumentRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the UpdateDocumentRequest interface.
23
+ */
24
+ function instanceOfUpdateDocumentRequest(value) {
25
+ if (!('name' in value) || value['name'] === undefined)
26
+ return false;
27
+ if (!('documentFileId' in value) || value['documentFileId'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function UpdateDocumentRequestFromJSON(json) {
32
+ return UpdateDocumentRequestFromJSONTyped(json, false);
33
+ }
34
+ function UpdateDocumentRequestFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'name': json['name'],
40
+ 'documentFileId': json['document_file_id'],
41
+ 'siteIds': json['site_ids'] == null ? undefined : json['site_ids'],
42
+ };
43
+ }
44
+ function UpdateDocumentRequestToJSON(json) {
45
+ return UpdateDocumentRequestToJSONTyped(json, false);
46
+ }
47
+ function UpdateDocumentRequestToJSONTyped(value, ignoreDiscriminator) {
48
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'name': value['name'],
54
+ 'document_file_id': value['documentFileId'],
55
+ 'site_ids': value['siteIds'],
56
+ };
57
+ }
@@ -183,6 +183,7 @@ export * from './TagResourceArrayResponse';
183
183
  export * from './TagType';
184
184
  export * from './UpdateAttributeRequest';
185
185
  export * from './UpdateAttributeValueRequest';
186
+ export * from './UpdateDocumentRequest';
186
187
  export * from './UpdateFilterOrderAttributeRequest';
187
188
  export * from './UpdateFilterOrderAttributeRequestValuesInner';
188
189
  export * from './UpdateModelAttributeRequest';
@@ -201,6 +201,7 @@ __exportStar(require("./TagResourceArrayResponse"), exports);
201
201
  __exportStar(require("./TagType"), exports);
202
202
  __exportStar(require("./UpdateAttributeRequest"), exports);
203
203
  __exportStar(require("./UpdateAttributeValueRequest"), exports);
204
+ __exportStar(require("./UpdateDocumentRequest"), exports);
204
205
  __exportStar(require("./UpdateFilterOrderAttributeRequest"), exports);
205
206
  __exportStar(require("./UpdateFilterOrderAttributeRequestValuesInner"), exports);
206
207
  __exportStar(require("./UpdateModelAttributeRequest"), exports);
@@ -5,12 +5,14 @@ All URIs are relative to *http://localhost/api*
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
7
  | [**attachDocumentablesDocument**](DocumentApi.md#attachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/attach-documentables | Auto-generated: attachDocumentablesDocument |
8
- | [**destroyDocument**](DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document} | Auto-generated: destroyDocument |
8
+ | [**destroyDocument**](DocumentApi.md#destroydocument) | **DELETE** /admin-api/document/{document}/delete | Auto-generated: destroyDocument |
9
9
  | [**detachDocumentablesDocument**](DocumentApi.md#detachdocumentablesdocumentoperation) | **POST** /admin-api/document/{document}/detach-documentables | Auto-generated: detachDocumentablesDocument |
10
10
  | [**getAllDocument**](DocumentApi.md#getalldocumentoperation) | **POST** /admin-api/document/all | Auto-generated: getAllDocument |
11
11
  | [**indexDocument**](DocumentApi.md#indexdocumentoperation) | **POST** /admin-api/document/list | Auto-generated: indexDocument |
12
- | [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document | Auto-generated: storeDocument |
12
+ | [**showDocument**](DocumentApi.md#showdocument) | **GET** /admin-api/document/{document} | Auto-generated: showDocument |
13
+ | [**storeDocument**](DocumentApi.md#storedocumentoperation) | **POST** /admin-api/document/create | Auto-generated: storeDocument |
13
14
  | [**storeDocumentFile**](DocumentApi.md#storedocumentfileoperation) | **POST** /admin-api/document/files | Auto-generated: storeDocumentFile |
15
+ | [**updateDocument**](DocumentApi.md#updatedocumentoperation) | **PUT** /admin-api/document/{document}/update | Auto-generated: updateDocument |
14
16
 
15
17
 
16
18
 
@@ -345,6 +347,71 @@ No authorization required
345
347
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
346
348
 
347
349
 
350
+ ## showDocument
351
+
352
+ > DocumentResource showDocument(document)
353
+
354
+ Auto-generated: showDocument
355
+
356
+ ### Example
357
+
358
+ ```ts
359
+ import {
360
+ Configuration,
361
+ DocumentApi,
362
+ } from '@digital8/lighting-illusions-ts-sdk';
363
+ import type { ShowDocumentRequest } from '@digital8/lighting-illusions-ts-sdk';
364
+
365
+ async function example() {
366
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
367
+ const api = new DocumentApi();
368
+
369
+ const body = {
370
+ // number | The id of the document
371
+ document: 56,
372
+ } satisfies ShowDocumentRequest;
373
+
374
+ try {
375
+ const data = await api.showDocument(body);
376
+ console.log(data);
377
+ } catch (error) {
378
+ console.error(error);
379
+ }
380
+ }
381
+
382
+ // Run the test
383
+ example().catch(console.error);
384
+ ```
385
+
386
+ ### Parameters
387
+
388
+
389
+ | Name | Type | Description | Notes |
390
+ |------------- | ------------- | ------------- | -------------|
391
+ | **document** | `number` | The id of the document | [Defaults to `undefined`] |
392
+
393
+ ### Return type
394
+
395
+ [**DocumentResource**](DocumentResource.md)
396
+
397
+ ### Authorization
398
+
399
+ No authorization required
400
+
401
+ ### HTTP request headers
402
+
403
+ - **Content-Type**: Not defined
404
+ - **Accept**: `application/json`
405
+
406
+
407
+ ### HTTP response details
408
+ | Status code | Description | Response headers |
409
+ |-------------|-------------|------------------|
410
+ | **200** | Successful resource response | - |
411
+
412
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
413
+
414
+
348
415
  ## storeDocument
349
416
 
350
417
  > DocumentResource storeDocument(storeDocumentRequest)
@@ -474,3 +541,71 @@ No authorization required
474
541
 
475
542
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
476
543
 
544
+
545
+ ## updateDocument
546
+
547
+ > DocumentResource updateDocument(document, updateDocumentRequest)
548
+
549
+ Auto-generated: updateDocument
550
+
551
+ ### Example
552
+
553
+ ```ts
554
+ import {
555
+ Configuration,
556
+ DocumentApi,
557
+ } from '@digital8/lighting-illusions-ts-sdk';
558
+ import type { UpdateDocumentOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
559
+
560
+ async function example() {
561
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
562
+ const api = new DocumentApi();
563
+
564
+ const body = {
565
+ // number | The id of the document
566
+ document: 56,
567
+ // UpdateDocumentRequest (optional)
568
+ updateDocumentRequest: ...,
569
+ } satisfies UpdateDocumentOperationRequest;
570
+
571
+ try {
572
+ const data = await api.updateDocument(body);
573
+ console.log(data);
574
+ } catch (error) {
575
+ console.error(error);
576
+ }
577
+ }
578
+
579
+ // Run the test
580
+ example().catch(console.error);
581
+ ```
582
+
583
+ ### Parameters
584
+
585
+
586
+ | Name | Type | Description | Notes |
587
+ |------------- | ------------- | ------------- | -------------|
588
+ | **document** | `number` | The id of the document | [Defaults to `undefined`] |
589
+ | **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.md) | | [Optional] |
590
+
591
+ ### Return type
592
+
593
+ [**DocumentResource**](DocumentResource.md)
594
+
595
+ ### Authorization
596
+
597
+ No authorization required
598
+
599
+ ### HTTP request headers
600
+
601
+ - **Content-Type**: `application/json`
602
+ - **Accept**: `application/json`
603
+
604
+
605
+ ### HTTP response details
606
+ | Status code | Description | Response headers |
607
+ |-------------|-------------|------------------|
608
+ | **200** | Successful resource response | - |
609
+
610
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
611
+
@@ -0,0 +1,38 @@
1
+
2
+ # UpdateDocumentRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `documentFileId` | string
11
+ `siteIds` | Array&lt;string&gt;
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { UpdateDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "name": null,
21
+ "documentFileId": null,
22
+ "siteIds": null,
23
+ } satisfies UpdateDocumentRequest
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as UpdateDocumentRequest
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.483",
3
+ "version": "0.0.485",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -26,6 +26,7 @@ import type {
26
26
  PaginatedDocumentResourceResponse,
27
27
  StoreDocumentFileRequest,
28
28
  StoreDocumentRequest,
29
+ UpdateDocumentRequest,
29
30
  } from '../models/index';
30
31
  import {
31
32
  AttachDocumentablesDocumentRequestFromJSON,
@@ -50,6 +51,8 @@ import {
50
51
  StoreDocumentFileRequestToJSON,
51
52
  StoreDocumentRequestFromJSON,
52
53
  StoreDocumentRequestToJSON,
54
+ UpdateDocumentRequestFromJSON,
55
+ UpdateDocumentRequestToJSON,
53
56
  } from '../models/index';
54
57
 
55
58
  export interface AttachDocumentablesDocumentOperationRequest {
@@ -74,6 +77,10 @@ export interface IndexDocumentOperationRequest {
74
77
  indexDocumentRequest?: IndexDocumentRequest;
75
78
  }
76
79
 
80
+ export interface ShowDocumentRequest {
81
+ document: number;
82
+ }
83
+
77
84
  export interface StoreDocumentOperationRequest {
78
85
  storeDocumentRequest?: StoreDocumentRequest;
79
86
  }
@@ -82,6 +89,11 @@ export interface StoreDocumentFileOperationRequest {
82
89
  storeDocumentFileRequest?: StoreDocumentFileRequest;
83
90
  }
84
91
 
92
+ export interface UpdateDocumentOperationRequest {
93
+ document: number;
94
+ updateDocumentRequest?: UpdateDocumentRequest;
95
+ }
96
+
85
97
  /**
86
98
  *
87
99
  */
@@ -143,7 +155,7 @@ export class DocumentApi extends runtime.BaseAPI {
143
155
  const headerParameters: runtime.HTTPHeaders = {};
144
156
 
145
157
 
146
- let urlPath = `/admin-api/document/{document}`;
158
+ let urlPath = `/admin-api/document/{document}/delete`;
147
159
  urlPath = urlPath.replace(`{${"document"}}`, encodeURIComponent(String(requestParameters['document'])));
148
160
 
149
161
  const response = await this.request({
@@ -268,6 +280,43 @@ export class DocumentApi extends runtime.BaseAPI {
268
280
  return await response.value();
269
281
  }
270
282
 
283
+ /**
284
+ * Auto-generated: showDocument
285
+ */
286
+ async showDocumentRaw(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResource>> {
287
+ if (requestParameters['document'] == null) {
288
+ throw new runtime.RequiredError(
289
+ 'document',
290
+ 'Required parameter "document" was null or undefined when calling showDocument().'
291
+ );
292
+ }
293
+
294
+ const queryParameters: any = {};
295
+
296
+ const headerParameters: runtime.HTTPHeaders = {};
297
+
298
+
299
+ let urlPath = `/admin-api/document/{document}`;
300
+ urlPath = urlPath.replace(`{${"document"}}`, encodeURIComponent(String(requestParameters['document'])));
301
+
302
+ const response = await this.request({
303
+ path: urlPath,
304
+ method: 'GET',
305
+ headers: headerParameters,
306
+ query: queryParameters,
307
+ }, initOverrides);
308
+
309
+ return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResourceFromJSON(jsonValue));
310
+ }
311
+
312
+ /**
313
+ * Auto-generated: showDocument
314
+ */
315
+ async showDocument(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResource> {
316
+ const response = await this.showDocumentRaw(requestParameters, initOverrides);
317
+ return await response.value();
318
+ }
319
+
271
320
  /**
272
321
  * Auto-generated: storeDocument
273
322
  */
@@ -279,7 +328,7 @@ export class DocumentApi extends runtime.BaseAPI {
279
328
  headerParameters['Content-Type'] = 'application/json';
280
329
 
281
330
 
282
- let urlPath = `/admin-api/document`;
331
+ let urlPath = `/admin-api/document/create`;
283
332
 
284
333
  const response = await this.request({
285
334
  path: urlPath,
@@ -332,4 +381,44 @@ export class DocumentApi extends runtime.BaseAPI {
332
381
  return await response.value();
333
382
  }
334
383
 
384
+ /**
385
+ * Auto-generated: updateDocument
386
+ */
387
+ async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResource>> {
388
+ if (requestParameters['document'] == null) {
389
+ throw new runtime.RequiredError(
390
+ 'document',
391
+ 'Required parameter "document" was null or undefined when calling updateDocument().'
392
+ );
393
+ }
394
+
395
+ const queryParameters: any = {};
396
+
397
+ const headerParameters: runtime.HTTPHeaders = {};
398
+
399
+ headerParameters['Content-Type'] = 'application/json';
400
+
401
+
402
+ let urlPath = `/admin-api/document/{document}/update`;
403
+ urlPath = urlPath.replace(`{${"document"}}`, encodeURIComponent(String(requestParameters['document'])));
404
+
405
+ const response = await this.request({
406
+ path: urlPath,
407
+ method: 'PUT',
408
+ headers: headerParameters,
409
+ query: queryParameters,
410
+ body: UpdateDocumentRequestToJSON(requestParameters['updateDocumentRequest']),
411
+ }, initOverrides);
412
+
413
+ return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResourceFromJSON(jsonValue));
414
+ }
415
+
416
+ /**
417
+ * Auto-generated: updateDocument
418
+ */
419
+ async updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResource> {
420
+ const response = await this.updateDocumentRaw(requestParameters, initOverrides);
421
+ return await response.value();
422
+ }
423
+
335
424
  }
@@ -74,7 +74,7 @@ export interface ExternalApiLogResource {
74
74
  * @type {string}
75
75
  * @memberof ExternalApiLogResource
76
76
  */
77
- requestPayload: string;
77
+ requestPayload?: string | null;
78
78
  /**
79
79
  *
80
80
  * @type {string}
@@ -106,7 +106,6 @@ export function instanceOfExternalApiLogResource(value: object): value is Extern
106
106
  if (!('exteranlApiLoggableId' in value) || value['exteranlApiLoggableId'] === undefined) return false;
107
107
  if (!('endpoint' in value) || value['endpoint'] === undefined) return false;
108
108
  if (!('responseCode' in value) || value['responseCode'] === undefined) return false;
109
- if (!('requestPayload' in value) || value['requestPayload'] === undefined) return false;
110
109
  if (!('responsePayload' in value) || value['responsePayload'] === undefined) return false;
111
110
  if (!('site' in value) || value['site'] === undefined) return false;
112
111
  return true;
@@ -129,7 +128,7 @@ export function ExternalApiLogResourceFromJSONTyped(json: any, ignoreDiscriminat
129
128
  'exteranlApiLoggableId': json['exteranlApiLoggableId'],
130
129
  'endpoint': json['endpoint'],
131
130
  'responseCode': json['responseCode'],
132
- 'requestPayload': json['requestPayload'],
131
+ 'requestPayload': json['requestPayload'] == null ? undefined : json['requestPayload'],
133
132
  'responsePayload': json['responsePayload'],
134
133
  'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
135
134
  'site': SiteLiteResourceFromJSON(json['site']),
@@ -0,0 +1,83 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * My API
5
+ * API documentation for my Laravel app
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface UpdateDocumentRequest
20
+ */
21
+ export interface UpdateDocumentRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof UpdateDocumentRequest
26
+ */
27
+ name: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof UpdateDocumentRequest
32
+ */
33
+ documentFileId: string;
34
+ /**
35
+ *
36
+ * @type {Array<string>}
37
+ * @memberof UpdateDocumentRequest
38
+ */
39
+ siteIds?: Array<string>;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the UpdateDocumentRequest interface.
44
+ */
45
+ export function instanceOfUpdateDocumentRequest(value: object): value is UpdateDocumentRequest {
46
+ if (!('name' in value) || value['name'] === undefined) return false;
47
+ if (!('documentFileId' in value) || value['documentFileId'] === undefined) return false;
48
+ return true;
49
+ }
50
+
51
+ export function UpdateDocumentRequestFromJSON(json: any): UpdateDocumentRequest {
52
+ return UpdateDocumentRequestFromJSONTyped(json, false);
53
+ }
54
+
55
+ export function UpdateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateDocumentRequest {
56
+ if (json == null) {
57
+ return json;
58
+ }
59
+ return {
60
+
61
+ 'name': json['name'],
62
+ 'documentFileId': json['document_file_id'],
63
+ 'siteIds': json['site_ids'] == null ? undefined : json['site_ids'],
64
+ };
65
+ }
66
+
67
+ export function UpdateDocumentRequestToJSON(json: any): UpdateDocumentRequest {
68
+ return UpdateDocumentRequestToJSONTyped(json, false);
69
+ }
70
+
71
+ export function UpdateDocumentRequestToJSONTyped(value?: UpdateDocumentRequest | null, ignoreDiscriminator: boolean = false): any {
72
+ if (value == null) {
73
+ return value;
74
+ }
75
+
76
+ return {
77
+
78
+ 'name': value['name'],
79
+ 'document_file_id': value['documentFileId'],
80
+ 'site_ids': value['siteIds'],
81
+ };
82
+ }
83
+
@@ -185,6 +185,7 @@ export * from './TagResourceArrayResponse';
185
185
  export * from './TagType';
186
186
  export * from './UpdateAttributeRequest';
187
187
  export * from './UpdateAttributeValueRequest';
188
+ export * from './UpdateDocumentRequest';
188
189
  export * from './UpdateFilterOrderAttributeRequest';
189
190
  export * from './UpdateFilterOrderAttributeRequestValuesInner';
190
191
  export * from './UpdateModelAttributeRequest';