@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
@@ -13,6 +13,8 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateLayoutRequestDto } from '../models';
16
+ import { CreateLayoutResponseClass } from '../models';
17
+ import { DeleteResponseClass } from '../models';
16
18
  import { GetLayoutResponseClass } from '../models';
17
19
  import { ListLayoutsResponseClass } from '../models';
18
20
  import { UpdateLayoutRequestDto } from '../models';
@@ -23,7 +25,8 @@ import { UpdateLayoutResponseClass } from '../models';
23
25
  */
24
26
  export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration) => {
25
27
  /**
26
- *
28
+ * This will create a layout.
29
+ * @summary Create the layout
27
30
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
28
31
  * @param {string} [authorization] Bearer Token
29
32
  * @param {*} [options] Override http request option.
@@ -31,7 +34,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
31
34
  */
32
35
  createLayout: (createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
36
  /**
34
- *
37
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
38
+ * @summary Delete the layout
35
39
  * @param {number} id
36
40
  * @param {string} [authorization] Bearer Token
37
41
  * @param {*} [options] Override http request option.
@@ -39,16 +43,18 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
39
43
  */
40
44
  deleteLayout: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
45
  /**
42
- *
46
+ * 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.
47
+ * @summary Retrieve the layout
43
48
  * @param {string} id
44
- * @param {number} id2 Layout id
49
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
45
50
  * @param {string} [authorization] Bearer Token
46
51
  * @param {*} [options] Override http request option.
47
52
  * @throws {RequiredError}
48
53
  */
49
54
  getLayout: (id: string, id2: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
55
  /**
51
- *
56
+ * 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.
57
+ * @summary List layouts
52
58
  * @param {string} [authorization] Bearer Token
53
59
  * @param {number} [pageSize] Page size
54
60
  * @param {string} [pageToken] Page token
@@ -61,7 +67,8 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
61
67
  */
62
68
  listLayouts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
69
  /**
64
- *
70
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
71
+ * @summary Update the layout
65
72
  * @param {number} id
66
73
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
67
74
  * @param {string} [authorization] Bearer Token
@@ -76,32 +83,36 @@ export declare const LayoutsApiAxiosParamCreator: (configuration?: Configuration
76
83
  */
77
84
  export declare const LayoutsApiFp: (configuration?: Configuration) => {
78
85
  /**
79
- *
86
+ * This will create a layout.
87
+ * @summary Create the layout
80
88
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
81
89
  * @param {string} [authorization] Bearer Token
82
90
  * @param {*} [options] Override http request option.
83
91
  * @throws {RequiredError}
84
92
  */
85
- createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
93
+ createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
86
94
  /**
87
- *
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
88
97
  * @param {number} id
89
98
  * @param {string} [authorization] Bearer Token
90
99
  * @param {*} [options] Override http request option.
91
100
  * @throws {RequiredError}
92
101
  */
93
- deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
102
+ deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
94
103
  /**
95
- *
104
+ * 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.
105
+ * @summary Retrieve the layout
96
106
  * @param {string} id
97
- * @param {number} id2 Layout id
107
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
98
108
  * @param {string} [authorization] Bearer Token
99
109
  * @param {*} [options] Override http request option.
100
110
  * @throws {RequiredError}
101
111
  */
102
112
  getLayout(id: string, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
103
113
  /**
104
- *
114
+ * 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.
115
+ * @summary List layouts
105
116
  * @param {string} [authorization] Bearer Token
106
117
  * @param {number} [pageSize] Page size
107
118
  * @param {string} [pageToken] Page token
@@ -114,7 +125,8 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
114
125
  */
115
126
  listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>>;
116
127
  /**
117
- *
128
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
129
+ * @summary Update the layout
118
130
  * @param {number} id
119
131
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
120
132
  * @param {string} [authorization] Bearer Token
@@ -129,32 +141,36 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
129
141
  */
130
142
  export declare const LayoutsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
131
143
  /**
132
- *
144
+ * This will create a layout.
145
+ * @summary Create the layout
133
146
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
134
147
  * @param {string} [authorization] Bearer Token
135
148
  * @param {*} [options] Override http request option.
136
149
  * @throws {RequiredError}
137
150
  */
138
- createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
151
+ createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
139
152
  /**
140
- *
153
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
154
+ * @summary Delete the layout
141
155
  * @param {number} id
142
156
  * @param {string} [authorization] Bearer Token
143
157
  * @param {*} [options] Override http request option.
144
158
  * @throws {RequiredError}
145
159
  */
146
- deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<object>;
160
+ deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
147
161
  /**
148
- *
162
+ * 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.
163
+ * @summary Retrieve the layout
149
164
  * @param {string} id
150
- * @param {number} id2 Layout id
165
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
151
166
  * @param {string} [authorization] Bearer Token
152
167
  * @param {*} [options] Override http request option.
153
168
  * @throws {RequiredError}
154
169
  */
155
170
  getLayout(id: string, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
156
171
  /**
157
- *
172
+ * 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.
173
+ * @summary List layouts
158
174
  * @param {string} [authorization] Bearer Token
159
175
  * @param {number} [pageSize] Page size
160
176
  * @param {string} [pageToken] Page token
@@ -167,7 +183,8 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
167
183
  */
168
184
  listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
169
185
  /**
170
- *
186
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
187
+ * @summary Update the layout
171
188
  * @param {number} id
172
189
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
173
190
  * @param {string} [authorization] Bearer Token
@@ -227,7 +244,7 @@ export interface LayoutsApiGetLayoutRequest {
227
244
  */
228
245
  readonly id: string;
229
246
  /**
230
- * Layout id
247
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
231
248
  * @type {number}
232
249
  * @memberof LayoutsApiGetLayout
233
250
  */
@@ -321,23 +338,26 @@ export interface LayoutsApiUpdateLayoutRequest {
321
338
  */
322
339
  export declare class LayoutsApi extends BaseAPI {
323
340
  /**
324
- *
341
+ * This will create a layout.
342
+ * @summary Create the layout
325
343
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
326
344
  * @param {*} [options] Override http request option.
327
345
  * @throws {RequiredError}
328
346
  * @memberof LayoutsApi
329
347
  */
330
- createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
348
+ createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any>>;
331
349
  /**
332
- *
350
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
351
+ * @summary Delete the layout
333
352
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
334
353
  * @param {*} [options] Override http request option.
335
354
  * @throws {RequiredError}
336
355
  * @memberof LayoutsApi
337
356
  */
338
- deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
357
+ deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
339
358
  /**
340
- *
359
+ * 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.
360
+ * @summary Retrieve the layout
341
361
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
342
362
  * @param {*} [options] Override http request option.
343
363
  * @throws {RequiredError}
@@ -345,7 +365,8 @@ export declare class LayoutsApi extends BaseAPI {
345
365
  */
346
366
  getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any>>;
347
367
  /**
348
- *
368
+ * 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.
369
+ * @summary List layouts
349
370
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
350
371
  * @param {*} [options] Override http request option.
351
372
  * @throws {RequiredError}
@@ -353,7 +374,8 @@ export declare class LayoutsApi extends BaseAPI {
353
374
  */
354
375
  listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any>>;
355
376
  /**
356
- *
377
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
378
+ * @summary Update the layout
357
379
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
358
380
  * @param {*} [options] Override http request option.
359
381
  * @throws {RequiredError}
@@ -97,7 +97,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * This will create a layout.
101
+ * @summary Create the layout
101
102
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
102
103
  * @param {string} [authorization] Bearer Token
103
104
  * @param {*} [options] Override http request option.
@@ -145,7 +146,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
145
146
  });
146
147
  },
147
148
  /**
148
- *
149
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
150
+ * @summary Delete the layout
149
151
  * @param {number} id
150
152
  * @param {string} [authorization] Bearer Token
151
153
  * @param {*} [options] Override http request option.
@@ -192,9 +194,10 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
192
194
  });
193
195
  },
194
196
  /**
195
- *
197
+ * 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.
198
+ * @summary Retrieve the layout
196
199
  * @param {string} id
197
- * @param {number} id2 Layout id
200
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
198
201
  * @param {string} [authorization] Bearer Token
199
202
  * @param {*} [options] Override http request option.
200
203
  * @throws {RequiredError}
@@ -245,7 +248,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
245
248
  });
246
249
  },
247
250
  /**
248
- *
251
+ * 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.
252
+ * @summary List layouts
249
253
  * @param {string} [authorization] Bearer Token
250
254
  * @param {number} [pageSize] Page size
251
255
  * @param {string} [pageToken] Page token
@@ -312,7 +316,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
312
316
  });
313
317
  },
314
318
  /**
315
- *
319
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
320
+ * @summary Update the layout
316
321
  * @param {number} id
317
322
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
318
323
  * @param {string} [authorization] Bearer Token
@@ -374,7 +379,8 @@ var LayoutsApiFp = function (configuration) {
374
379
  var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
375
380
  return {
376
381
  /**
377
- *
382
+ * This will create a layout.
383
+ * @summary Create the layout
378
384
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
379
385
  * @param {string} [authorization] Bearer Token
380
386
  * @param {*} [options] Override http request option.
@@ -394,7 +400,8 @@ var LayoutsApiFp = function (configuration) {
394
400
  });
395
401
  },
396
402
  /**
397
- *
403
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
404
+ * @summary Delete the layout
398
405
  * @param {number} id
399
406
  * @param {string} [authorization] Bearer Token
400
407
  * @param {*} [options] Override http request option.
@@ -414,9 +421,10 @@ var LayoutsApiFp = function (configuration) {
414
421
  });
415
422
  },
416
423
  /**
417
- *
424
+ * 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.
425
+ * @summary Retrieve the layout
418
426
  * @param {string} id
419
- * @param {number} id2 Layout id
427
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
420
428
  * @param {string} [authorization] Bearer Token
421
429
  * @param {*} [options] Override http request option.
422
430
  * @throws {RequiredError}
@@ -435,7 +443,8 @@ var LayoutsApiFp = function (configuration) {
435
443
  });
436
444
  },
437
445
  /**
438
- *
446
+ * 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.
447
+ * @summary List layouts
439
448
  * @param {string} [authorization] Bearer Token
440
449
  * @param {number} [pageSize] Page size
441
450
  * @param {string} [pageToken] Page token
@@ -460,7 +469,8 @@ var LayoutsApiFp = function (configuration) {
460
469
  });
461
470
  },
462
471
  /**
463
- *
472
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
473
+ * @summary Update the layout
464
474
  * @param {number} id
465
475
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
466
476
  * @param {string} [authorization] Bearer Token
@@ -491,7 +501,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
491
501
  var localVarFp = (0, exports.LayoutsApiFp)(configuration);
492
502
  return {
493
503
  /**
494
- *
504
+ * This will create a layout.
505
+ * @summary Create the layout
495
506
  * @param {CreateLayoutRequestDto} createLayoutRequestDto
496
507
  * @param {string} [authorization] Bearer Token
497
508
  * @param {*} [options] Override http request option.
@@ -501,7 +512,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
501
512
  return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
502
513
  },
503
514
  /**
504
- *
515
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
516
+ * @summary Delete the layout
505
517
  * @param {number} id
506
518
  * @param {string} [authorization] Bearer Token
507
519
  * @param {*} [options] Override http request option.
@@ -511,9 +523,10 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
511
523
  return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
512
524
  },
513
525
  /**
514
- *
526
+ * 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.
527
+ * @summary Retrieve the layout
515
528
  * @param {string} id
516
- * @param {number} id2 Layout id
529
+ * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
517
530
  * @param {string} [authorization] Bearer Token
518
531
  * @param {*} [options] Override http request option.
519
532
  * @throws {RequiredError}
@@ -522,7 +535,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
522
535
  return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
523
536
  },
524
537
  /**
525
- *
538
+ * 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.
539
+ * @summary List layouts
526
540
  * @param {string} [authorization] Bearer Token
527
541
  * @param {number} [pageSize] Page size
528
542
  * @param {string} [pageToken] Page token
@@ -537,7 +551,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
537
551
  return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
538
552
  },
539
553
  /**
540
- *
554
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
555
+ * @summary Update the layout
541
556
  * @param {number} id
542
557
  * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
543
558
  * @param {string} [authorization] Bearer Token
@@ -562,7 +577,8 @@ var LayoutsApi = /** @class */ (function (_super) {
562
577
  return _super !== null && _super.apply(this, arguments) || this;
563
578
  }
564
579
  /**
565
- *
580
+ * This will create a layout.
581
+ * @summary Create the layout
566
582
  * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
567
583
  * @param {*} [options] Override http request option.
568
584
  * @throws {RequiredError}
@@ -573,7 +589,8 @@ var LayoutsApi = /** @class */ (function (_super) {
573
589
  return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
574
590
  };
575
591
  /**
576
- *
592
+ * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
593
+ * @summary Delete the layout
577
594
  * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
578
595
  * @param {*} [options] Override http request option.
579
596
  * @throws {RequiredError}
@@ -584,7 +601,8 @@ var LayoutsApi = /** @class */ (function (_super) {
584
601
  return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
585
602
  };
586
603
  /**
587
- *
604
+ * 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.
605
+ * @summary Retrieve the layout
588
606
  * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
589
607
  * @param {*} [options] Override http request option.
590
608
  * @throws {RequiredError}
@@ -595,7 +613,8 @@ var LayoutsApi = /** @class */ (function (_super) {
595
613
  return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
596
614
  };
597
615
  /**
598
- *
616
+ * 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.
617
+ * @summary List layouts
599
618
  * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
600
619
  * @param {*} [options] Override http request option.
601
620
  * @throws {RequiredError}
@@ -607,7 +626,8 @@ var LayoutsApi = /** @class */ (function (_super) {
607
626
  return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
608
627
  };
609
628
  /**
610
- *
629
+ * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
630
+ * @summary Update the layout
611
631
  * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
612
632
  * @param {*} [options] Override http request option.
613
633
  * @throws {RequiredError}
@@ -19,8 +19,9 @@ import { ListSearchKeywordsResponseClass } from '../models';
19
19
  */
20
20
  export declare const SearchKeywordsApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
23
- * @param {string} searchText Text to search in the documents
22
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
23
+ * @summary List keywords
24
+ * @param {string} searchText Text to search in the documents.
24
25
  * @param {string} [authorization] Bearer Token
25
26
  * @param {*} [options] Override http request option.
26
27
  * @throws {RequiredError}
@@ -33,8 +34,9 @@ export declare const SearchKeywordsApiAxiosParamCreator: (configuration?: Config
33
34
  */
34
35
  export declare const SearchKeywordsApiFp: (configuration?: Configuration) => {
35
36
  /**
36
- *
37
- * @param {string} searchText Text to search in the documents
37
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
38
+ * @summary List keywords
39
+ * @param {string} searchText Text to search in the documents.
38
40
  * @param {string} [authorization] Bearer Token
39
41
  * @param {*} [options] Override http request option.
40
42
  * @throws {RequiredError}
@@ -47,8 +49,9 @@ export declare const SearchKeywordsApiFp: (configuration?: Configuration) => {
47
49
  */
48
50
  export declare const SearchKeywordsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
49
51
  /**
50
- *
51
- * @param {string} searchText Text to search in the documents
52
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
53
+ * @summary List keywords
54
+ * @param {string} searchText Text to search in the documents.
52
55
  * @param {string} [authorization] Bearer Token
53
56
  * @param {*} [options] Override http request option.
54
57
  * @throws {RequiredError}
@@ -62,7 +65,7 @@ export declare const SearchKeywordsApiFactory: (configuration?: Configuration, b
62
65
  */
63
66
  export interface SearchKeywordsApiListSearchKeywordsRequest {
64
67
  /**
65
- * Text to search in the documents
68
+ * Text to search in the documents.
66
69
  * @type {string}
67
70
  * @memberof SearchKeywordsApiListSearchKeywords
68
71
  */
@@ -82,7 +85,8 @@ export interface SearchKeywordsApiListSearchKeywordsRequest {
82
85
  */
83
86
  export declare class SearchKeywordsApi extends BaseAPI {
84
87
  /**
85
- *
88
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
89
+ * @summary List keywords
86
90
  * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
87
91
  * @param {*} [options] Override http request option.
88
92
  * @throws {RequiredError}
@@ -97,8 +97,9 @@ var SearchKeywordsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
101
- * @param {string} searchText Text to search in the documents
100
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
101
+ * @summary List keywords
102
+ * @param {string} searchText Text to search in the documents.
102
103
  * @param {string} [authorization] Bearer Token
103
104
  * @param {*} [options] Override http request option.
104
105
  * @throws {RequiredError}
@@ -156,8 +157,9 @@ var SearchKeywordsApiFp = function (configuration) {
156
157
  var localVarAxiosParamCreator = (0, exports.SearchKeywordsApiAxiosParamCreator)(configuration);
157
158
  return {
158
159
  /**
159
- *
160
- * @param {string} searchText Text to search in the documents
160
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
161
+ * @summary List keywords
162
+ * @param {string} searchText Text to search in the documents.
161
163
  * @param {string} [authorization] Bearer Token
162
164
  * @param {*} [options] Override http request option.
163
165
  * @throws {RequiredError}
@@ -186,8 +188,9 @@ var SearchKeywordsApiFactory = function (configuration, basePath, axios) {
186
188
  var localVarFp = (0, exports.SearchKeywordsApiFp)(configuration);
187
189
  return {
188
190
  /**
189
- *
190
- * @param {string} searchText Text to search in the documents
191
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
192
+ * @summary List keywords
193
+ * @param {string} searchText Text to search in the documents.
191
194
  * @param {string} [authorization] Bearer Token
192
195
  * @param {*} [options] Override http request option.
193
196
  * @throws {RequiredError}
@@ -210,7 +213,8 @@ var SearchKeywordsApi = /** @class */ (function (_super) {
210
213
  return _super !== null && _super.apply(this, arguments) || this;
211
214
  }
212
215
  /**
213
- *
216
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
217
+ * @summary List keywords
214
218
  * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
215
219
  * @param {*} [options] Override http request option.
216
220
  * @throws {RequiredError}
@@ -19,7 +19,8 @@ import { ListSearchableDocumentOwnersResponseClass } from '../models';
19
19
  */
20
20
  export declare const SearchableDocumentOwnersApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
22
+ * Returns the list of the searchable document owners.
23
+ * @summary List searchable document owners
23
24
  * @param {string} [authorization] Bearer Token
24
25
  * @param {number} [pageSize] Page size
25
26
  * @param {string} [pageToken] Page token
@@ -38,7 +39,8 @@ export declare const SearchableDocumentOwnersApiAxiosParamCreator: (configuratio
38
39
  */
39
40
  export declare const SearchableDocumentOwnersApiFp: (configuration?: Configuration) => {
40
41
  /**
41
- *
42
+ * Returns the list of the searchable document owners.
43
+ * @summary List searchable document owners
42
44
  * @param {string} [authorization] Bearer Token
43
45
  * @param {number} [pageSize] Page size
44
46
  * @param {string} [pageToken] Page token
@@ -57,7 +59,8 @@ export declare const SearchableDocumentOwnersApiFp: (configuration?: Configurati
57
59
  */
58
60
  export declare const SearchableDocumentOwnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
59
61
  /**
60
- *
62
+ * Returns the list of the searchable document owners.
63
+ * @summary List searchable document owners
61
64
  * @param {string} [authorization] Bearer Token
62
65
  * @param {number} [pageSize] Page size
63
66
  * @param {string} [pageToken] Page token
@@ -127,7 +130,8 @@ export interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest
127
130
  */
128
131
  export declare class SearchableDocumentOwnersApi extends BaseAPI {
129
132
  /**
130
- *
133
+ * Returns the list of the searchable document owners.
134
+ * @summary List searchable document owners
131
135
  * @param {SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest} requestParameters Request parameters.
132
136
  * @param {*} [options] Override http request option.
133
137
  * @throws {RequiredError}
@@ -97,7 +97,8 @@ var SearchableDocumentOwnersApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * Returns the list of the searchable document owners.
101
+ * @summary List searchable document owners
101
102
  * @param {string} [authorization] Bearer Token
102
103
  * @param {number} [pageSize] Page size
103
104
  * @param {string} [pageToken] Page token
@@ -174,7 +175,8 @@ var SearchableDocumentOwnersApiFp = function (configuration) {
174
175
  var localVarAxiosParamCreator = (0, exports.SearchableDocumentOwnersApiAxiosParamCreator)(configuration);
175
176
  return {
176
177
  /**
177
- *
178
+ * Returns the list of the searchable document owners.
179
+ * @summary List searchable document owners
178
180
  * @param {string} [authorization] Bearer Token
179
181
  * @param {number} [pageSize] Page size
180
182
  * @param {string} [pageToken] Page token
@@ -209,7 +211,8 @@ var SearchableDocumentOwnersApiFactory = function (configuration, basePath, axio
209
211
  var localVarFp = (0, exports.SearchableDocumentOwnersApiFp)(configuration);
210
212
  return {
211
213
  /**
212
- *
214
+ * Returns the list of the searchable document owners.
215
+ * @summary List searchable document owners
213
216
  * @param {string} [authorization] Bearer Token
214
217
  * @param {number} [pageSize] Page size
215
218
  * @param {string} [pageToken] Page token
@@ -238,7 +241,8 @@ var SearchableDocumentOwnersApi = /** @class */ (function (_super) {
238
241
  return _super !== null && _super.apply(this, arguments) || this;
239
242
  }
240
243
  /**
241
- *
244
+ * Returns the list of the searchable document owners.
245
+ * @summary List searchable document owners
242
246
  * @param {SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest} requestParameters Request parameters.
243
247
  * @param {*} [options] Override http request option.
244
248
  * @throws {RequiredError}