@emilgroup/document-sdk-node 1.1.0 → 1.2.1

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.
Files changed (111) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/document-templates-api.ts +84 -92
  4. package/api/documents-api.ts +16 -107
  5. package/api/layouts-api.ts +52 -28
  6. package/api/search-keywords-api.ts +12 -8
  7. package/api/searchable-document-owners-api.ts +8 -4
  8. package/api/searchable-documents-api.ts +16 -12
  9. package/base.ts +3 -3
  10. package/dist/api/document-templates-api.d.ts +78 -75
  11. package/dist/api/document-templates-api.js +73 -67
  12. package/dist/api/documents-api.d.ts +16 -61
  13. package/dist/api/documents-api.js +8 -93
  14. package/dist/api/layouts-api.d.ts +52 -30
  15. package/dist/api/layouts-api.js +43 -23
  16. package/dist/api/search-keywords-api.d.ts +12 -8
  17. package/dist/api/search-keywords-api.js +11 -7
  18. package/dist/api/searchable-document-owners-api.d.ts +8 -4
  19. package/dist/api/searchable-document-owners-api.js +8 -4
  20. package/dist/api/searchable-documents-api.d.ts +16 -12
  21. package/dist/api/searchable-documents-api.js +14 -10
  22. package/dist/base.d.ts +1 -1
  23. package/dist/base.js +3 -3
  24. package/dist/models/create-doc-template-request-dto.d.ts +3 -3
  25. package/dist/models/create-doc-template-response-class.d.ts +1 -1
  26. package/dist/models/create-document-request-dto.d.ts +11 -11
  27. package/dist/models/create-document-sync-response-class.d.ts +25 -0
  28. package/dist/models/create-document-sync-response-class.js +15 -0
  29. package/dist/models/create-layout-request-dto.d.ts +10 -10
  30. package/dist/models/create-layout-response-class.d.ts +25 -0
  31. package/dist/models/create-layout-response-class.js +15 -0
  32. package/dist/models/create-presigned-post-request-dto.d.ts +10 -10
  33. package/dist/models/create-presigned-post-response-class.d.ts +2 -2
  34. package/dist/models/delete-layout-request-dto.d.ts +1 -1
  35. package/dist/models/delete-request-dto.d.ts +1 -1
  36. package/dist/models/delete-response-class.d.ts +24 -0
  37. package/dist/models/delete-response-class.js +15 -0
  38. package/dist/models/doc-template-class.d.ts +2 -2
  39. package/dist/models/document-class.d.ts +8 -8
  40. package/dist/models/download-document-request-dto.d.ts +2 -2
  41. package/dist/models/get-doc-template-request-dto.d.ts +1 -1
  42. package/dist/models/get-doc-template-response-class.d.ts +1 -1
  43. package/dist/models/get-document-download-url-response-class.d.ts +1 -1
  44. package/dist/models/get-layout-request-dto.d.ts +1 -1
  45. package/dist/models/html-template-class.d.ts +1 -1
  46. package/dist/models/index.d.ts +8 -0
  47. package/dist/models/index.js +8 -0
  48. package/dist/models/layout-class.d.ts +1 -1
  49. package/dist/models/list-doc-template-request-dto.d.ts +48 -0
  50. package/dist/models/list-doc-template-request-dto.js +15 -0
  51. package/dist/models/list-doc-templates-response-class.d.ts +1 -1
  52. package/dist/models/list-documents-response-class.d.ts +1 -1
  53. package/dist/models/list-layouts-response-class.d.ts +1 -1
  54. package/dist/models/list-search-keywords-request-dto.d.ts +1 -1
  55. package/dist/models/list-search-keywords-response-class.d.ts +1 -1
  56. package/dist/models/list-searchable-document-owners-response-class.d.ts +3 -2
  57. package/dist/models/list-searchable-documents-request-dto.d.ts +2 -2
  58. package/dist/models/list-searchable-documents-response-class.d.ts +5 -4
  59. package/dist/models/searchable-document-class.d.ts +66 -0
  60. package/dist/models/searchable-document-class.js +15 -0
  61. package/dist/models/searchable-document-owner-class.d.ts +30 -0
  62. package/dist/models/searchable-document-owner-class.js +15 -0
  63. package/dist/models/update-doc-template-request-dto.d.ts +7 -7
  64. package/dist/models/update-doc-template-response-class.d.ts +1 -1
  65. package/dist/models/update-document-request-dto.d.ts +5 -5
  66. package/dist/models/update-document-response-class.d.ts +25 -0
  67. package/dist/models/update-document-response-class.js +15 -0
  68. package/dist/models/update-html-template-dto.d.ts +42 -0
  69. package/dist/models/update-html-template-dto.js +21 -0
  70. package/dist/models/update-layout-request-dto.d.ts +15 -15
  71. package/dist/models/update-layout-response-class.d.ts +1 -1
  72. package/models/create-doc-template-request-dto.ts +3 -3
  73. package/models/create-doc-template-response-class.ts +1 -1
  74. package/models/create-document-request-dto.ts +11 -11
  75. package/models/create-document-sync-response-class.ts +31 -0
  76. package/models/create-layout-request-dto.ts +10 -10
  77. package/models/create-layout-response-class.ts +31 -0
  78. package/models/create-presigned-post-request-dto.ts +10 -10
  79. package/models/create-presigned-post-response-class.ts +2 -2
  80. package/models/delete-layout-request-dto.ts +1 -1
  81. package/models/delete-request-dto.ts +1 -1
  82. package/models/delete-response-class.ts +30 -0
  83. package/models/doc-template-class.ts +2 -2
  84. package/models/document-class.ts +8 -8
  85. package/models/download-document-request-dto.ts +2 -2
  86. package/models/get-doc-template-request-dto.ts +1 -1
  87. package/models/get-doc-template-response-class.ts +1 -1
  88. package/models/get-document-download-url-response-class.ts +1 -1
  89. package/models/get-layout-request-dto.ts +1 -1
  90. package/models/html-template-class.ts +1 -1
  91. package/models/index.ts +8 -0
  92. package/models/layout-class.ts +1 -1
  93. package/models/list-doc-template-request-dto.ts +54 -0
  94. package/models/list-doc-templates-response-class.ts +1 -1
  95. package/models/list-documents-response-class.ts +1 -1
  96. package/models/list-layouts-response-class.ts +1 -1
  97. package/models/list-search-keywords-request-dto.ts +1 -1
  98. package/models/list-search-keywords-response-class.ts +1 -1
  99. package/models/list-searchable-document-owners-response-class.ts +3 -2
  100. package/models/list-searchable-documents-request-dto.ts +2 -2
  101. package/models/list-searchable-documents-response-class.ts +5 -4
  102. package/models/searchable-document-class.ts +72 -0
  103. package/models/searchable-document-owner-class.ts +36 -0
  104. package/models/update-doc-template-request-dto.ts +7 -7
  105. package/models/update-doc-template-response-class.ts +1 -1
  106. package/models/update-document-request-dto.ts +5 -5
  107. package/models/update-document-response-class.ts +31 -0
  108. package/models/update-html-template-dto.ts +51 -0
  109. package/models/update-layout-request-dto.ts +15 -15
  110. package/models/update-layout-response-class.ts +1 -1
  111. package/package.json +2 -2
@@ -23,6 +23,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
23
23
  // @ts-ignore
24
24
  import { CreateDocumentRequestDto } from '../models';
25
25
  // @ts-ignore
26
+ import { CreateDocumentSyncResponseClass } from '../models';
27
+ // @ts-ignore
26
28
  import { CreatePresignedPostRequestDto } from '../models';
27
29
  // @ts-ignore
28
30
  import { CreatePresignedPostResponseClass } from '../models';
@@ -34,6 +36,8 @@ import { GetSignedS3KeyUrlResponseClass } from '../models';
34
36
  import { ListDocumentsResponseClass } from '../models';
35
37
  // @ts-ignore
36
38
  import { UpdateDocumentRequestDto } from '../models';
39
+ // @ts-ignore
40
+ import { UpdateDocumentResponseClass } from '../models';
37
41
  // URLSearchParams not necessarily used
38
42
  // @ts-ignore
39
43
  import { URL, URLSearchParams } from 'url';
@@ -92,7 +96,8 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
92
96
  };
93
97
  },
94
98
  /**
95
- *
99
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
100
+ * @summary Upload documents using pre-signed URL
96
101
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
97
102
  * @param {string} [authorization] Bearer Token
98
103
  * @param {*} [options] Override http request option.
@@ -137,52 +142,6 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
137
142
  options: localVarRequestOptions,
138
143
  };
139
144
  },
140
- /**
141
- *
142
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
143
- * @param {string} [authorization] Bearer Token
144
- * @param {*} [options] Override http request option.
145
- * @throws {RequiredError}
146
- */
147
- createTemporaryDocument: async (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
148
- // verify required parameter 'createDocumentRequestDto' is not null or undefined
149
- assertParamExists('createTemporaryDocument', 'createDocumentRequestDto', createDocumentRequestDto)
150
- const localVarPath = `/documentservice/v1/documents/temporary`;
151
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
152
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
153
- let baseOptions;
154
- let baseAccessToken;
155
- if (configuration) {
156
- baseOptions = configuration.baseOptions;
157
- baseAccessToken = configuration.accessToken;
158
- }
159
-
160
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
161
- const localVarHeaderParameter = {} as any;
162
- const localVarQueryParameter = {} as any;
163
-
164
- // authentication bearer required
165
- // http bearer authentication required
166
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
167
-
168
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
169
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
170
- }
171
-
172
-
173
-
174
- localVarHeaderParameter['Content-Type'] = 'application/json';
175
-
176
- setSearchParams(localVarUrlObj, localVarQueryParameter);
177
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
178
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
179
- localVarRequestOptions.data = serializeDataIfNeeded(createDocumentRequestDto, localVarRequestOptions, configuration)
180
-
181
- return {
182
- url: toPathString(localVarUrlObj),
183
- options: localVarRequestOptions,
184
- };
185
- },
186
145
  /**
187
146
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
188
147
  * @summary Delete the document
@@ -461,12 +420,13 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
461
420
  * @param {*} [options] Override http request option.
462
421
  * @throws {RequiredError}
463
422
  */
464
- async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
423
+ async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>> {
465
424
  const localVarAxiosArgs = await localVarAxiosParamCreator.createDocument(createDocumentRequestDto, authorization, options);
466
425
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
467
426
  },
468
427
  /**
469
- *
428
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
429
+ * @summary Upload documents using pre-signed URL
470
430
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
471
431
  * @param {string} [authorization] Bearer Token
472
432
  * @param {*} [options] Override http request option.
@@ -476,17 +436,6 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
476
436
  const localVarAxiosArgs = await localVarAxiosParamCreator.createPresignedPost(createPresignedPostRequestDto, authorization, options);
477
437
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
478
438
  },
479
- /**
480
- *
481
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
482
- * @param {string} [authorization] Bearer Token
483
- * @param {*} [options] Override http request option.
484
- * @throws {RequiredError}
485
- */
486
- async createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
487
- const localVarAxiosArgs = await localVarAxiosParamCreator.createTemporaryDocument(createDocumentRequestDto, authorization, options);
488
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
489
- },
490
439
  /**
491
440
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
492
441
  * @summary Delete the document
@@ -549,7 +498,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
549
498
  * @param {*} [options] Override http request option.
550
499
  * @throws {RequiredError}
551
500
  */
552
- async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
501
+ async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>> {
553
502
  const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocument(code, updateDocumentRequestDto, authorization, options);
554
503
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
555
504
  },
@@ -571,11 +520,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
571
520
  * @param {*} [options] Override http request option.
572
521
  * @throws {RequiredError}
573
522
  */
574
- createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
523
+ createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass> {
575
524
  return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
576
525
  },
577
526
  /**
578
- *
527
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
528
+ * @summary Upload documents using pre-signed URL
579
529
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
580
530
  * @param {string} [authorization] Bearer Token
581
531
  * @param {*} [options] Override http request option.
@@ -584,16 +534,6 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
584
534
  createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass> {
585
535
  return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then((request) => request(axios, basePath));
586
536
  },
587
- /**
588
- *
589
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
590
- * @param {string} [authorization] Bearer Token
591
- * @param {*} [options] Override http request option.
592
- * @throws {RequiredError}
593
- */
594
- createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
595
- return localVarFp.createTemporaryDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
596
- },
597
537
  /**
598
538
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
599
539
  * @summary Delete the document
@@ -652,7 +592,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
652
592
  * @param {*} [options] Override http request option.
653
593
  * @throws {RequiredError}
654
594
  */
655
- updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
595
+ updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass> {
656
596
  return localVarFp.updateDocument(code, updateDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
657
597
  },
658
598
  };
@@ -700,27 +640,6 @@ export interface DocumentsApiCreatePresignedPostRequest {
700
640
  readonly authorization?: string
701
641
  }
702
642
 
703
- /**
704
- * Request parameters for createTemporaryDocument operation in DocumentsApi.
705
- * @export
706
- * @interface DocumentsApiCreateTemporaryDocumentRequest
707
- */
708
- export interface DocumentsApiCreateTemporaryDocumentRequest {
709
- /**
710
- *
711
- * @type {CreateDocumentRequestDto}
712
- * @memberof DocumentsApiCreateTemporaryDocument
713
- */
714
- readonly createDocumentRequestDto: CreateDocumentRequestDto
715
-
716
- /**
717
- * Bearer Token
718
- * @type {string}
719
- * @memberof DocumentsApiCreateTemporaryDocument
720
- */
721
- readonly authorization?: string
722
- }
723
-
724
643
  /**
725
644
  * Request parameters for deleteDocument operation in DocumentsApi.
726
645
  * @export
@@ -888,7 +807,8 @@ export class DocumentsApi extends BaseAPI {
888
807
  }
889
808
 
890
809
  /**
891
- *
810
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
811
+ * @summary Upload documents using pre-signed URL
892
812
  * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
893
813
  * @param {*} [options] Override http request option.
894
814
  * @throws {RequiredError}
@@ -898,17 +818,6 @@ export class DocumentsApi extends BaseAPI {
898
818
  return DocumentsApiFp(this.configuration).createPresignedPost(requestParameters.createPresignedPostRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
899
819
  }
900
820
 
901
- /**
902
- *
903
- * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
904
- * @param {*} [options] Override http request option.
905
- * @throws {RequiredError}
906
- * @memberof DocumentsApi
907
- */
908
- public createTemporaryDocument(requestParameters: DocumentsApiCreateTemporaryDocumentRequest, options?: AxiosRequestConfig) {
909
- return DocumentsApiFp(this.configuration).createTemporaryDocument(requestParameters.createDocumentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
910
- }
911
-
912
821
  /**
913
822
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
914
823
  * @summary Delete the document
@@ -23,6 +23,10 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
23
23
  // @ts-ignore
24
24
  import { CreateLayoutRequestDto } from '../models';
25
25
  // @ts-ignore
26
+ import { CreateLayoutResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { DeleteResponseClass } from '../models';
29
+ // @ts-ignore
26
30
  import { GetLayoutResponseClass } from '../models';
27
31
  // @ts-ignore
28
32
  import { ListLayoutsResponseClass } from '../models';
@@ -41,7 +45,8 @@ const FormData = require('form-data');
41
45
  export const LayoutsApiAxiosParamCreator = function (configuration?: Configuration) {
42
46
  return {
43
47
  /**
44
- *
48
+ * This will create a layout.
49
+ * @summary Create the layout
45
50
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
46
51
  * @param {string} [authorization] Bearer Token
47
52
  * @param {*} [options] Override http request option.
@@ -87,7 +92,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
87
92
  };
88
93
  },
89
94
  /**
90
- *
95
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
96
+ * @summary Delete the layout
91
97
  * @param {number} id
92
98
  * @param {string} [authorization] Bearer Token
93
99
  * @param {*} [options] Override http request option.
@@ -131,9 +137,10 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
131
137
  };
132
138
  },
133
139
  /**
134
- *
140
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
141
+ * @summary Retrieve the layout
135
142
  * @param {string} id
136
- * @param {number} id2 Layout id
143
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
137
144
  * @param {string} [authorization] Bearer Token
138
145
  * @param {*} [options] Override http request option.
139
146
  * @throws {RequiredError}
@@ -182,7 +189,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
182
189
  };
183
190
  },
184
191
  /**
185
- *
192
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
193
+ * @summary List layouts
186
194
  * @param {string} [authorization] Bearer Token
187
195
  * @param {number} [pageSize] Page size
188
196
  * @param {string} [pageToken] Page token
@@ -252,7 +260,8 @@ export const LayoutsApiAxiosParamCreator = function (configuration?: Configurati
252
260
  };
253
261
  },
254
262
  /**
255
- *
263
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
264
+ * @summary Update the layout
256
265
  * @param {number} id
257
266
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
258
267
  * @param {string} [authorization] Bearer Token
@@ -312,31 +321,34 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
312
321
  const localVarAxiosParamCreator = LayoutsApiAxiosParamCreator(configuration)
313
322
  return {
314
323
  /**
315
- *
324
+ * This will create a layout.
325
+ * @summary Create the layout
316
326
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
317
327
  * @param {string} [authorization] Bearer Token
318
328
  * @param {*} [options] Override http request option.
319
329
  * @throws {RequiredError}
320
330
  */
321
- async createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
331
+ async createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>> {
322
332
  const localVarAxiosArgs = await localVarAxiosParamCreator.createLayout(createLayoutRequestDto, authorization, options);
323
333
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
324
334
  },
325
335
  /**
326
- *
336
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
337
+ * @summary Delete the layout
327
338
  * @param {number} id
328
339
  * @param {string} [authorization] Bearer Token
329
340
  * @param {*} [options] Override http request option.
330
341
  * @throws {RequiredError}
331
342
  */
332
- async deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
343
+ async deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
333
344
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLayout(id, authorization, options);
334
345
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
335
346
  },
336
347
  /**
337
- *
348
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
349
+ * @summary Retrieve the layout
338
350
  * @param {string} id
339
- * @param {number} id2 Layout id
351
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
340
352
  * @param {string} [authorization] Bearer Token
341
353
  * @param {*} [options] Override http request option.
342
354
  * @throws {RequiredError}
@@ -346,7 +358,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
346
358
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
347
359
  },
348
360
  /**
349
- *
361
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
362
+ * @summary List layouts
350
363
  * @param {string} [authorization] Bearer Token
351
364
  * @param {number} [pageSize] Page size
352
365
  * @param {string} [pageToken] Page token
@@ -362,7 +375,8 @@ export const LayoutsApiFp = function(configuration?: Configuration) {
362
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
363
376
  },
364
377
  /**
365
- *
378
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
379
+ * @summary Update the layout
366
380
  * @param {number} id
367
381
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
368
382
  * @param {string} [authorization] Bearer Token
@@ -384,29 +398,32 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
384
398
  const localVarFp = LayoutsApiFp(configuration)
385
399
  return {
386
400
  /**
387
- *
401
+ * This will create a layout.
402
+ * @summary Create the layout
388
403
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
389
404
  * @param {string} [authorization] Bearer Token
390
405
  * @param {*} [options] Override http request option.
391
406
  * @throws {RequiredError}
392
407
  */
393
- createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
408
+ createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass> {
394
409
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then((request) => request(axios, basePath));
395
410
  },
396
411
  /**
397
- *
412
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
413
+ * @summary Delete the layout
398
414
  * @param {number} id
399
415
  * @param {string} [authorization] Bearer Token
400
416
  * @param {*} [options] Override http request option.
401
417
  * @throws {RequiredError}
402
418
  */
403
- deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object> {
419
+ deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
404
420
  return localVarFp.deleteLayout(id, authorization, options).then((request) => request(axios, basePath));
405
421
  },
406
422
  /**
407
- *
423
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
424
+ * @summary Retrieve the layout
408
425
  * @param {string} id
409
- * @param {number} id2 Layout id
426
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
410
427
  * @param {string} [authorization] Bearer Token
411
428
  * @param {*} [options] Override http request option.
412
429
  * @throws {RequiredError}
@@ -415,7 +432,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
415
432
  return localVarFp.getLayout(id, id2, authorization, options).then((request) => request(axios, basePath));
416
433
  },
417
434
  /**
418
- *
435
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
436
+ * @summary List layouts
419
437
  * @param {string} [authorization] Bearer Token
420
438
  * @param {number} [pageSize] Page size
421
439
  * @param {string} [pageToken] Page token
@@ -430,7 +448,8 @@ export const LayoutsApiFactory = function (configuration?: Configuration, basePa
430
448
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
431
449
  },
432
450
  /**
433
- *
451
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
452
+ * @summary Update the layout
434
453
  * @param {number} id
435
454
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
436
455
  * @param {string} [authorization] Bearer Token
@@ -499,7 +518,7 @@ export interface LayoutsApiGetLayoutRequest {
499
518
  readonly id: string
500
519
 
501
520
  /**
502
- * Layout id
521
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
503
522
  * @type {number}
504
523
  * @memberof LayoutsApiGetLayout
505
524
  */
@@ -605,7 +624,8 @@ export interface LayoutsApiUpdateLayoutRequest {
605
624
  */
606
625
  export class LayoutsApi extends BaseAPI {
607
626
  /**
608
- *
627
+ * This will create a layout.
628
+ * @summary Create the layout
609
629
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
610
630
  * @param {*} [options] Override http request option.
611
631
  * @throws {RequiredError}
@@ -616,7 +636,8 @@ export class LayoutsApi extends BaseAPI {
616
636
  }
617
637
 
618
638
  /**
619
- *
639
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
640
+ * @summary Delete the layout
620
641
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
621
642
  * @param {*} [options] Override http request option.
622
643
  * @throws {RequiredError}
@@ -627,7 +648,8 @@ export class LayoutsApi extends BaseAPI {
627
648
  }
628
649
 
629
650
  /**
630
- *
651
+ * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
652
+ * @summary Retrieve the layout
631
653
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
632
654
  * @param {*} [options] Override http request option.
633
655
  * @throws {RequiredError}
@@ -638,7 +660,8 @@ export class LayoutsApi extends BaseAPI {
638
660
  }
639
661
 
640
662
  /**
641
- *
663
+ * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
664
+ * @summary List layouts
642
665
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
643
666
  * @param {*} [options] Override http request option.
644
667
  * @throws {RequiredError}
@@ -649,7 +672,8 @@ export class LayoutsApi extends BaseAPI {
649
672
  }
650
673
 
651
674
  /**
652
- *
675
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
676
+ * @summary Update the layout
653
677
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
654
678
  * @param {*} [options] Override http request option.
655
679
  * @throws {RequiredError}
@@ -33,8 +33,9 @@ const FormData = require('form-data');
33
33
  export const SearchKeywordsApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- *
37
- * @param {string} searchText Text to search in the documents
36
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
37
+ * @summary List keywords
38
+ * @param {string} searchText Text to search in the documents.
38
39
  * @param {string} [authorization] Bearer Token
39
40
  * @param {*} [options] Override http request option.
40
41
  * @throws {RequiredError}
@@ -90,8 +91,9 @@ export const SearchKeywordsApiFp = function(configuration?: Configuration) {
90
91
  const localVarAxiosParamCreator = SearchKeywordsApiAxiosParamCreator(configuration)
91
92
  return {
92
93
  /**
93
- *
94
- * @param {string} searchText Text to search in the documents
94
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
95
+ * @summary List keywords
96
+ * @param {string} searchText Text to search in the documents.
95
97
  * @param {string} [authorization] Bearer Token
96
98
  * @param {*} [options] Override http request option.
97
99
  * @throws {RequiredError}
@@ -111,8 +113,9 @@ export const SearchKeywordsApiFactory = function (configuration?: Configuration,
111
113
  const localVarFp = SearchKeywordsApiFp(configuration)
112
114
  return {
113
115
  /**
114
- *
115
- * @param {string} searchText Text to search in the documents
116
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
117
+ * @summary List keywords
118
+ * @param {string} searchText Text to search in the documents.
116
119
  * @param {string} [authorization] Bearer Token
117
120
  * @param {*} [options] Override http request option.
118
121
  * @throws {RequiredError}
@@ -130,7 +133,7 @@ export const SearchKeywordsApiFactory = function (configuration?: Configuration,
130
133
  */
131
134
  export interface SearchKeywordsApiListSearchKeywordsRequest {
132
135
  /**
133
- * Text to search in the documents
136
+ * Text to search in the documents.
134
137
  * @type {string}
135
138
  * @memberof SearchKeywordsApiListSearchKeywords
136
139
  */
@@ -152,7 +155,8 @@ export interface SearchKeywordsApiListSearchKeywordsRequest {
152
155
  */
153
156
  export class SearchKeywordsApi extends BaseAPI {
154
157
  /**
155
- *
158
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
159
+ * @summary List keywords
156
160
  * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
157
161
  * @param {*} [options] Override http request option.
158
162
  * @throws {RequiredError}
@@ -33,7 +33,8 @@ const FormData = require('form-data');
33
33
  export const SearchableDocumentOwnersApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- *
36
+ * Returns the list of the searchable document owners.
37
+ * @summary List searchable document owners
37
38
  * @param {string} [authorization] Bearer Token
38
39
  * @param {number} [pageSize] Page size
39
40
  * @param {string} [pageToken] Page token
@@ -113,7 +114,8 @@ export const SearchableDocumentOwnersApiFp = function(configuration?: Configurat
113
114
  const localVarAxiosParamCreator = SearchableDocumentOwnersApiAxiosParamCreator(configuration)
114
115
  return {
115
116
  /**
116
- *
117
+ * Returns the list of the searchable document owners.
118
+ * @summary List searchable document owners
117
119
  * @param {string} [authorization] Bearer Token
118
120
  * @param {number} [pageSize] Page size
119
121
  * @param {string} [pageToken] Page token
@@ -139,7 +141,8 @@ export const SearchableDocumentOwnersApiFactory = function (configuration?: Conf
139
141
  const localVarFp = SearchableDocumentOwnersApiFp(configuration)
140
142
  return {
141
143
  /**
142
- *
144
+ * Returns the list of the searchable document owners.
145
+ * @summary List searchable document owners
143
146
  * @param {string} [authorization] Bearer Token
144
147
  * @param {number} [pageSize] Page size
145
148
  * @param {string} [pageToken] Page token
@@ -220,7 +223,8 @@ export interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest
220
223
  */
221
224
  export class SearchableDocumentOwnersApi extends BaseAPI {
222
225
  /**
223
- *
226
+ * Returns the list of the searchable document owners.
227
+ * @summary List searchable document owners
224
228
  * @param {SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest} requestParameters Request parameters.
225
229
  * @param {*} [options] Override http request option.
226
230
  * @throws {RequiredError}
@@ -33,9 +33,10 @@ const FormData = require('form-data');
33
33
  export const SearchableDocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
34
34
  return {
35
35
  /**
36
- *
37
- * @param {string} searchText Text to search in the documents
38
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
36
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
37
+ * @summary List searchable documents
38
+ * @param {string} searchText Text to search in the documents.
39
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
39
40
  * @param {string} [authorization] Bearer Token
40
41
  * @param {*} [options] Override http request option.
41
42
  * @throws {RequiredError}
@@ -97,9 +98,10 @@ export const SearchableDocumentsApiFp = function(configuration?: Configuration)
97
98
  const localVarAxiosParamCreator = SearchableDocumentsApiAxiosParamCreator(configuration)
98
99
  return {
99
100
  /**
100
- *
101
- * @param {string} searchText Text to search in the documents
102
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
101
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
102
+ * @summary List searchable documents
103
+ * @param {string} searchText Text to search in the documents.
104
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
103
105
  * @param {string} [authorization] Bearer Token
104
106
  * @param {*} [options] Override http request option.
105
107
  * @throws {RequiredError}
@@ -119,9 +121,10 @@ export const SearchableDocumentsApiFactory = function (configuration?: Configura
119
121
  const localVarFp = SearchableDocumentsApiFp(configuration)
120
122
  return {
121
123
  /**
122
- *
123
- * @param {string} searchText Text to search in the documents
124
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
124
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
125
+ * @summary List searchable documents
126
+ * @param {string} searchText Text to search in the documents.
127
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
125
128
  * @param {string} [authorization] Bearer Token
126
129
  * @param {*} [options] Override http request option.
127
130
  * @throws {RequiredError}
@@ -139,14 +142,14 @@ export const SearchableDocumentsApiFactory = function (configuration?: Configura
139
142
  */
140
143
  export interface SearchableDocumentsApiListSearchableDocumentsRequest {
141
144
  /**
142
- * Text to search in the documents
145
+ * Text to search in the documents.
143
146
  * @type {string}
144
147
  * @memberof SearchableDocumentsApiListSearchableDocuments
145
148
  */
146
149
  readonly searchText: string
147
150
 
148
151
  /**
149
- * List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
152
+ * List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
150
153
  * @type {string}
151
154
  * @memberof SearchableDocumentsApiListSearchableDocuments
152
155
  */
@@ -168,7 +171,8 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
168
171
  */
169
172
  export class SearchableDocumentsApi extends BaseAPI {
170
173
  /**
171
- *
174
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
175
+ * @summary List searchable documents
172
176
  * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
173
177
  * @param {*} [options] Override http request option.
174
178
  * @throws {RequiredError}
package/base.ts CHANGED
@@ -170,7 +170,7 @@ export class BaseAPI {
170
170
  this.configuration.refreshToken = refreshToken;
171
171
  }
172
172
 
173
- async refreshToken(): Promise<string> {
173
+ async refreshTokenInternal(): Promise<string> {
174
174
  const { username, refreshToken } = this.configuration;
175
175
 
176
176
 
@@ -220,7 +220,7 @@ export class BaseAPI {
220
220
  if (err.response.status === 401 && !originalConfig._retry) {
221
221
  originalConfig._retry = true;
222
222
  try {
223
- const tokenString = await this.refreshToken();
223
+ const tokenString = await this.refreshTokenInternal();
224
224
  const accessToken = `Bearer ${tokenString}`;
225
225
 
226
226
  originalConfig.headers['Authorization'] = `Bearer ${accessToken}`
@@ -245,7 +245,7 @@ export class BaseAPI {
245
245
  ){
246
246
  _retry_count++;
247
247
  try {
248
- const tokenString = await this.refreshToken();
248
+ const tokenString = await this.refreshTokenInternal();
249
249
  const accessToken = `Bearer ${tokenString}`;
250
250
 
251
251
  _retry = true;