@emilgroup/document-sdk 1.26.0 → 1.27.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +36 -0
- package/README.md +2 -2
- package/api/document-templates-api.ts +67 -71
- package/api/documents-api.ts +44 -18
- package/api/docx-templates-api.ts +24 -12
- package/api/layouts-api.ts +20 -10
- package/api/product-documents-api.ts +14 -8
- package/api/search-keywords-api.ts +4 -2
- package/api/searchable-document-owners-api.ts +4 -2
- package/api/searchable-documents-api.ts +16 -16
- package/base.ts +15 -7
- package/dist/api/document-templates-api.d.ts +59 -54
- package/dist/api/document-templates-api.js +34 -47
- package/dist/api/documents-api.d.ts +37 -22
- package/dist/api/documents-api.js +12 -6
- package/dist/api/docx-templates-api.d.ts +24 -18
- package/dist/api/layouts-api.d.ts +20 -15
- package/dist/api/product-documents-api.d.ts +15 -12
- package/dist/api/search-keywords-api.d.ts +4 -3
- package/dist/api/searchable-document-owners-api.d.ts +4 -3
- package/dist/api/searchable-documents-api.d.ts +13 -12
- package/dist/api/searchable-documents-api.js +9 -11
- package/dist/base.d.ts +3 -1
- package/dist/base.js +27 -20
- package/dist/models/create-doc-template-request-dto.d.ts +2 -2
- package/dist/models/create-doc-template-response-class.d.ts +25 -0
- package/dist/models/create-doc-template-response-class.js +15 -0
- package/dist/models/create-document-request-dto.d.ts +10 -10
- package/dist/models/create-document-sync-response-class.d.ts +25 -0
- package/dist/models/create-document-sync-response-class.js +15 -0
- package/dist/models/create-layout-response-class.d.ts +25 -0
- package/dist/models/create-layout-response-class.js +15 -0
- package/dist/models/create-presigned-post-request-dto.d.ts +4 -4
- package/dist/models/create-presigned-post-response-class.d.ts +30 -0
- package/dist/models/create-presigned-post-response-class.js +15 -0
- package/dist/models/delete-response-class.d.ts +24 -0
- package/dist/models/delete-response-class.js +15 -0
- package/dist/models/doc-template-class.d.ts +92 -0
- package/dist/models/doc-template-class.js +15 -0
- package/dist/models/document-class.d.ts +165 -0
- package/dist/models/document-class.js +53 -0
- package/dist/models/docx-template-class.d.ts +90 -0
- package/dist/models/docx-template-class.js +15 -0
- package/dist/models/download-document-request-dto.d.ts +30 -0
- package/dist/models/download-document-request-dto.js +15 -0
- package/dist/models/get-doc-template-request-dto.d.ts +30 -0
- package/dist/models/get-doc-template-request-dto.js +15 -0
- package/dist/models/get-doc-template-response-class.d.ts +25 -0
- package/dist/models/get-doc-template-response-class.js +15 -0
- package/dist/models/get-document-download-url-response-class.d.ts +24 -0
- package/dist/models/get-document-download-url-response-class.js +15 -0
- package/dist/models/get-docx-template-download-url-response-class.d.ts +24 -0
- package/dist/models/get-docx-template-download-url-response-class.js +15 -0
- package/dist/models/get-docx-template-response-class.d.ts +25 -0
- package/dist/models/get-docx-template-response-class.js +15 -0
- package/dist/models/get-layout-response-class.d.ts +25 -0
- package/dist/models/get-layout-response-class.js +15 -0
- package/dist/models/get-product-document-download-url-response-class.d.ts +24 -0
- package/dist/models/get-product-document-download-url-response-class.js +15 -0
- package/dist/models/get-product-document-response-class.d.ts +25 -0
- package/dist/models/get-product-document-response-class.js +15 -0
- package/dist/models/get-signed-s3-key-url-response-class.d.ts +24 -0
- package/dist/models/get-signed-s3-key-url-response-class.js +15 -0
- package/dist/models/grpc-create-doc-template-request-dto.d.ts +55 -0
- package/dist/models/grpc-create-doc-template-request-dto.js +15 -0
- package/dist/models/grpc-update-doc-template-request-dto.d.ts +61 -0
- package/dist/models/grpc-update-doc-template-request-dto.js +15 -0
- package/dist/models/html-template-class.d.ts +66 -0
- package/dist/models/html-template-class.js +21 -0
- package/dist/models/index.d.ts +36 -0
- package/dist/models/index.js +36 -0
- package/dist/models/layout-class.d.ts +79 -0
- package/dist/models/layout-class.js +15 -0
- package/dist/models/list-doc-template-request-dto.d.ts +54 -0
- package/dist/models/list-doc-template-request-dto.js +15 -0
- package/dist/models/list-doc-templates-response-class.d.ts +31 -0
- package/dist/models/list-doc-templates-response-class.js +15 -0
- package/dist/models/list-documents-response-class.d.ts +31 -0
- package/dist/models/list-documents-response-class.js +15 -0
- package/dist/models/list-docx-templates-response-class.d.ts +31 -0
- package/dist/models/list-docx-templates-response-class.js +15 -0
- package/dist/models/list-layouts-response-class.d.ts +31 -0
- package/dist/models/list-layouts-response-class.js +15 -0
- package/dist/models/list-search-keywords-response-class.d.ts +24 -0
- package/dist/models/list-search-keywords-response-class.js +15 -0
- package/dist/models/list-searchable-document-owners-request-dto.d.ts +8 -1
- package/dist/models/list-searchable-document-owners-request-dto.js +7 -0
- package/dist/models/list-searchable-document-owners-response-class.d.ts +25 -0
- package/dist/models/list-searchable-document-owners-response-class.js +15 -0
- package/dist/models/list-searchable-documents-request-dto.d.ts +8 -1
- package/dist/models/list-searchable-documents-request-dto.js +7 -0
- package/dist/models/list-searchable-documents-response-class.d.ts +31 -0
- package/dist/models/list-searchable-documents-response-class.js +15 -0
- package/dist/models/searchable-document-class.d.ts +66 -0
- package/dist/models/searchable-document-class.js +15 -0
- package/dist/models/searchable-document-owner-class.d.ts +30 -0
- package/dist/models/searchable-document-owner-class.js +15 -0
- package/dist/models/update-doc-template-request-dto.d.ts +2 -2
- package/dist/models/update-doc-template-response-class.d.ts +25 -0
- package/dist/models/update-doc-template-response-class.js +15 -0
- package/dist/models/update-document-request-dto.d.ts +5 -5
- package/dist/models/update-document-response-class.d.ts +25 -0
- package/dist/models/update-document-response-class.js +15 -0
- package/dist/models/update-docx-template-response-class.d.ts +25 -0
- package/dist/models/update-docx-template-response-class.js +15 -0
- package/dist/models/update-layout-response-class.d.ts +25 -0
- package/dist/models/update-layout-response-class.js +15 -0
- package/dist/models/upload-docx-template-request-dto.d.ts +1 -1
- package/dist/models/upload-product-document-request-dto.d.ts +2 -2
- package/models/create-doc-template-request-dto.ts +2 -2
- package/models/create-doc-template-response-class.ts +31 -0
- package/models/create-document-request-dto.ts +10 -10
- package/models/create-document-sync-response-class.ts +31 -0
- package/models/create-layout-response-class.ts +31 -0
- package/models/create-presigned-post-request-dto.ts +4 -4
- package/models/create-presigned-post-response-class.ts +36 -0
- package/models/delete-response-class.ts +30 -0
- package/models/doc-template-class.ts +98 -0
- package/models/document-class.ts +175 -0
- package/models/docx-template-class.ts +96 -0
- package/models/download-document-request-dto.ts +36 -0
- package/models/get-doc-template-request-dto.ts +36 -0
- package/models/get-doc-template-response-class.ts +31 -0
- package/models/get-document-download-url-response-class.ts +30 -0
- package/models/get-docx-template-download-url-response-class.ts +30 -0
- package/models/get-docx-template-response-class.ts +31 -0
- package/models/get-layout-response-class.ts +31 -0
- package/models/get-product-document-download-url-response-class.ts +30 -0
- package/models/get-product-document-response-class.ts +31 -0
- package/models/get-signed-s3-key-url-response-class.ts +30 -0
- package/models/grpc-create-doc-template-request-dto.ts +61 -0
- package/models/grpc-update-doc-template-request-dto.ts +67 -0
- package/models/html-template-class.ts +75 -0
- package/models/index.ts +36 -0
- package/models/layout-class.ts +85 -0
- package/models/list-doc-template-request-dto.ts +60 -0
- package/models/list-doc-templates-response-class.ts +37 -0
- package/models/list-documents-response-class.ts +37 -0
- package/models/list-docx-templates-response-class.ts +37 -0
- package/models/list-layouts-response-class.ts +37 -0
- package/models/list-search-keywords-response-class.ts +30 -0
- package/models/list-searchable-document-owners-request-dto.ts +11 -1
- package/models/list-searchable-document-owners-response-class.ts +31 -0
- package/models/list-searchable-documents-request-dto.ts +11 -1
- package/models/list-searchable-documents-response-class.ts +37 -0
- package/models/searchable-document-class.ts +72 -0
- package/models/searchable-document-owner-class.ts +36 -0
- package/models/update-doc-template-request-dto.ts +2 -2
- package/models/update-doc-template-response-class.ts +31 -0
- package/models/update-document-request-dto.ts +5 -5
- package/models/update-document-response-class.ts +31 -0
- package/models/update-docx-template-response-class.ts +31 -0
- package/models/update-layout-response-class.ts +31 -0
- package/models/upload-docx-template-request-dto.ts +1 -1
- package/models/upload-product-document-request-dto.ts +2 -2
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -18,28 +18,64 @@ configuration.ts
|
|
|
18
18
|
git_push.sh
|
|
19
19
|
index.ts
|
|
20
20
|
models/create-doc-template-request-dto.ts
|
|
21
|
+
models/create-doc-template-response-class.ts
|
|
21
22
|
models/create-document-request-dto.ts
|
|
23
|
+
models/create-document-sync-response-class.ts
|
|
22
24
|
models/create-html-template-dto.ts
|
|
23
25
|
models/create-layout-request-dto.ts
|
|
26
|
+
models/create-layout-response-class.ts
|
|
24
27
|
models/create-presigned-post-request-dto.ts
|
|
28
|
+
models/create-presigned-post-response-class.ts
|
|
25
29
|
models/delete-layout-request-dto.ts
|
|
26
30
|
models/delete-product-document-request-dto.ts
|
|
27
31
|
models/delete-request-dto.ts
|
|
32
|
+
models/delete-response-class.ts
|
|
33
|
+
models/doc-template-class.ts
|
|
34
|
+
models/document-class.ts
|
|
35
|
+
models/docx-template-class.ts
|
|
36
|
+
models/download-document-request-dto.ts
|
|
37
|
+
models/get-doc-template-request-dto.ts
|
|
38
|
+
models/get-doc-template-response-class.ts
|
|
39
|
+
models/get-document-download-url-response-class.ts
|
|
40
|
+
models/get-docx-template-download-url-response-class.ts
|
|
41
|
+
models/get-docx-template-response-class.ts
|
|
28
42
|
models/get-layout-request-dto.ts
|
|
43
|
+
models/get-layout-response-class.ts
|
|
44
|
+
models/get-product-document-download-url-response-class.ts
|
|
45
|
+
models/get-product-document-response-class.ts
|
|
46
|
+
models/get-signed-s3-key-url-response-class.ts
|
|
47
|
+
models/grpc-create-doc-template-request-dto.ts
|
|
48
|
+
models/grpc-update-doc-template-request-dto.ts
|
|
49
|
+
models/html-template-class.ts
|
|
29
50
|
models/index.ts
|
|
30
51
|
models/inline-response200.ts
|
|
31
52
|
models/inline-response503.ts
|
|
53
|
+
models/layout-class.ts
|
|
54
|
+
models/list-doc-template-request-dto.ts
|
|
55
|
+
models/list-doc-templates-response-class.ts
|
|
56
|
+
models/list-documents-response-class.ts
|
|
57
|
+
models/list-docx-templates-response-class.ts
|
|
58
|
+
models/list-layouts-response-class.ts
|
|
32
59
|
models/list-product-documents-response-class.ts
|
|
33
60
|
models/list-request-dto.ts
|
|
34
61
|
models/list-search-keywords-request-dto.ts
|
|
62
|
+
models/list-search-keywords-response-class.ts
|
|
35
63
|
models/list-searchable-document-owners-request-dto.ts
|
|
64
|
+
models/list-searchable-document-owners-response-class.ts
|
|
36
65
|
models/list-searchable-documents-request-dto.ts
|
|
66
|
+
models/list-searchable-documents-response-class.ts
|
|
37
67
|
models/product-document-class.ts
|
|
68
|
+
models/searchable-document-class.ts
|
|
69
|
+
models/searchable-document-owner-class.ts
|
|
38
70
|
models/shared-update-docx-template-request-dto.ts
|
|
39
71
|
models/update-doc-template-request-dto.ts
|
|
72
|
+
models/update-doc-template-response-class.ts
|
|
40
73
|
models/update-document-request-dto.ts
|
|
74
|
+
models/update-document-response-class.ts
|
|
75
|
+
models/update-docx-template-response-class.ts
|
|
41
76
|
models/update-html-template-dto.ts
|
|
42
77
|
models/update-layout-request-dto.ts
|
|
78
|
+
models/update-layout-response-class.ts
|
|
43
79
|
models/upload-docx-template-request-dto.ts
|
|
44
80
|
models/upload-product-document-request-dto.ts
|
|
45
81
|
package.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/document-sdk@1.
|
|
20
|
+
npm install @emilgroup/document-sdk@1.27.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk@1.
|
|
24
|
+
yarn add @emilgroup/document-sdk@1.27.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
|
@@ -23,7 +23,17 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreateDocTemplateRequestDto } from '../models';
|
|
25
25
|
// @ts-ignore
|
|
26
|
+
import { CreateDocTemplateResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { DeleteResponseClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { GetDocTemplateResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { ListDocTemplatesResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
26
34
|
import { UpdateDocTemplateRequestDto } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
import { UpdateDocTemplateResponseClass } from '../models';
|
|
27
37
|
/**
|
|
28
38
|
* DocumentTemplatesApi - axios parameter creator
|
|
29
39
|
* @export
|
|
@@ -126,16 +136,14 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
126
136
|
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
127
137
|
* @summary Retrieve the document template
|
|
128
138
|
* @param {number} id
|
|
129
|
-
* @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
130
139
|
* @param {string} [authorization] Bearer Token
|
|
140
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
131
141
|
* @param {*} [options] Override http request option.
|
|
132
142
|
* @throws {RequiredError}
|
|
133
143
|
*/
|
|
134
|
-
getDocTemplate: async (id: number,
|
|
144
|
+
getDocTemplate: async (id: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
135
145
|
// verify required parameter 'id' is not null or undefined
|
|
136
146
|
assertParamExists('getDocTemplate', 'id', id)
|
|
137
|
-
// verify required parameter 'expand' is not null or undefined
|
|
138
|
-
assertParamExists('getDocTemplate', 'expand', expand)
|
|
139
147
|
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
140
148
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
141
149
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -177,29 +185,17 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
177
185
|
/**
|
|
178
186
|
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
179
187
|
* @summary List document templates
|
|
180
|
-
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
181
|
-
* @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
182
|
-
* @param {string} filter Filter response by productSlug, slug and name.
|
|
183
|
-
* @param {string} search Search document templates by name | slug
|
|
184
|
-
* @param {string} order Order response by createdAt.
|
|
185
|
-
* @param {string} expand Expand response by bodyTemplate.
|
|
186
188
|
* @param {string} [authorization] Bearer Token
|
|
189
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
190
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
191
|
+
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
192
|
+
* @param {string} [search] Search document templates by name | slug
|
|
193
|
+
* @param {string} [order] Order response by createdAt.
|
|
194
|
+
* @param {string} [expand] Expand response by bodyTemplate.
|
|
187
195
|
* @param {*} [options] Override http request option.
|
|
188
196
|
* @throws {RequiredError}
|
|
189
197
|
*/
|
|
190
|
-
listDocTemplates: async (pageSize
|
|
191
|
-
// verify required parameter 'pageSize' is not null or undefined
|
|
192
|
-
assertParamExists('listDocTemplates', 'pageSize', pageSize)
|
|
193
|
-
// verify required parameter 'pageToken' is not null or undefined
|
|
194
|
-
assertParamExists('listDocTemplates', 'pageToken', pageToken)
|
|
195
|
-
// verify required parameter 'filter' is not null or undefined
|
|
196
|
-
assertParamExists('listDocTemplates', 'filter', filter)
|
|
197
|
-
// verify required parameter 'search' is not null or undefined
|
|
198
|
-
assertParamExists('listDocTemplates', 'search', search)
|
|
199
|
-
// verify required parameter 'order' is not null or undefined
|
|
200
|
-
assertParamExists('listDocTemplates', 'order', order)
|
|
201
|
-
// verify required parameter 'expand' is not null or undefined
|
|
202
|
-
assertParamExists('listDocTemplates', 'expand', expand)
|
|
198
|
+
listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
203
199
|
const localVarPath = `/documentservice/v1/doc-templates`;
|
|
204
200
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
205
201
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -326,7 +322,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
326
322
|
* @param {*} [options] Override http request option.
|
|
327
323
|
* @throws {RequiredError}
|
|
328
324
|
*/
|
|
329
|
-
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
325
|
+
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocTemplateResponseClass>> {
|
|
330
326
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocTemplate(createDocTemplateRequestDto, authorization, options);
|
|
331
327
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
328
|
},
|
|
@@ -338,7 +334,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
338
334
|
* @param {*} [options] Override http request option.
|
|
339
335
|
* @throws {RequiredError}
|
|
340
336
|
*/
|
|
341
|
-
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
337
|
+
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
|
|
342
338
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
|
|
343
339
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
344
340
|
},
|
|
@@ -346,30 +342,30 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
346
342
|
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
347
343
|
* @summary Retrieve the document template
|
|
348
344
|
* @param {number} id
|
|
349
|
-
* @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
350
345
|
* @param {string} [authorization] Bearer Token
|
|
346
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
351
347
|
* @param {*} [options] Override http request option.
|
|
352
348
|
* @throws {RequiredError}
|
|
353
349
|
*/
|
|
354
|
-
async getDocTemplate(id: number,
|
|
355
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id,
|
|
350
|
+
async getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>> {
|
|
351
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, authorization, expand, options);
|
|
356
352
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
357
353
|
},
|
|
358
354
|
/**
|
|
359
355
|
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
360
356
|
* @summary List document templates
|
|
361
|
-
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
362
|
-
* @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
363
|
-
* @param {string} filter Filter response by productSlug, slug and name.
|
|
364
|
-
* @param {string} search Search document templates by name | slug
|
|
365
|
-
* @param {string} order Order response by createdAt.
|
|
366
|
-
* @param {string} expand Expand response by bodyTemplate.
|
|
367
357
|
* @param {string} [authorization] Bearer Token
|
|
358
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
359
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
360
|
+
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
361
|
+
* @param {string} [search] Search document templates by name | slug
|
|
362
|
+
* @param {string} [order] Order response by createdAt.
|
|
363
|
+
* @param {string} [expand] Expand response by bodyTemplate.
|
|
368
364
|
* @param {*} [options] Override http request option.
|
|
369
365
|
* @throws {RequiredError}
|
|
370
366
|
*/
|
|
371
|
-
async listDocTemplates(pageSize
|
|
372
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand,
|
|
367
|
+
async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
|
|
368
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
373
369
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
374
370
|
},
|
|
375
371
|
/**
|
|
@@ -381,7 +377,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
381
377
|
* @param {*} [options] Override http request option.
|
|
382
378
|
* @throws {RequiredError}
|
|
383
379
|
*/
|
|
384
|
-
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
380
|
+
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocTemplateResponseClass>> {
|
|
385
381
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options);
|
|
386
382
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
387
383
|
},
|
|
@@ -403,7 +399,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
403
399
|
* @param {*} [options] Override http request option.
|
|
404
400
|
* @throws {RequiredError}
|
|
405
401
|
*/
|
|
406
|
-
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
402
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass> {
|
|
407
403
|
return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
408
404
|
},
|
|
409
405
|
/**
|
|
@@ -414,36 +410,36 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
414
410
|
* @param {*} [options] Override http request option.
|
|
415
411
|
* @throws {RequiredError}
|
|
416
412
|
*/
|
|
417
|
-
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<
|
|
413
|
+
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
|
|
418
414
|
return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
419
415
|
},
|
|
420
416
|
/**
|
|
421
417
|
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
422
418
|
* @summary Retrieve the document template
|
|
423
419
|
* @param {number} id
|
|
424
|
-
* @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
425
420
|
* @param {string} [authorization] Bearer Token
|
|
421
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
426
422
|
* @param {*} [options] Override http request option.
|
|
427
423
|
* @throws {RequiredError}
|
|
428
424
|
*/
|
|
429
|
-
getDocTemplate(id: number,
|
|
430
|
-
return localVarFp.getDocTemplate(id,
|
|
425
|
+
getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass> {
|
|
426
|
+
return localVarFp.getDocTemplate(id, authorization, expand, options).then((request) => request(axios, basePath));
|
|
431
427
|
},
|
|
432
428
|
/**
|
|
433
429
|
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
434
430
|
* @summary List document templates
|
|
435
|
-
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
436
|
-
* @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
437
|
-
* @param {string} filter Filter response by productSlug, slug and name.
|
|
438
|
-
* @param {string} search Search document templates by name | slug
|
|
439
|
-
* @param {string} order Order response by createdAt.
|
|
440
|
-
* @param {string} expand Expand response by bodyTemplate.
|
|
441
431
|
* @param {string} [authorization] Bearer Token
|
|
432
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
433
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
434
|
+
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
435
|
+
* @param {string} [search] Search document templates by name | slug
|
|
436
|
+
* @param {string} [order] Order response by createdAt.
|
|
437
|
+
* @param {string} [expand] Expand response by bodyTemplate.
|
|
442
438
|
* @param {*} [options] Override http request option.
|
|
443
439
|
* @throws {RequiredError}
|
|
444
440
|
*/
|
|
445
|
-
listDocTemplates(pageSize
|
|
446
|
-
return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand,
|
|
441
|
+
listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
|
|
442
|
+
return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
447
443
|
},
|
|
448
444
|
/**
|
|
449
445
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -454,7 +450,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
454
450
|
* @param {*} [options] Override http request option.
|
|
455
451
|
* @throws {RequiredError}
|
|
456
452
|
*/
|
|
457
|
-
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
453
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocTemplateResponseClass> {
|
|
458
454
|
return localVarFp.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
459
455
|
},
|
|
460
456
|
};
|
|
@@ -516,18 +512,18 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
516
512
|
readonly id: number
|
|
517
513
|
|
|
518
514
|
/**
|
|
519
|
-
*
|
|
515
|
+
* Bearer Token
|
|
520
516
|
* @type {string}
|
|
521
517
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
522
518
|
*/
|
|
523
|
-
readonly
|
|
519
|
+
readonly authorization?: string
|
|
524
520
|
|
|
525
521
|
/**
|
|
526
|
-
*
|
|
522
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
527
523
|
* @type {string}
|
|
528
524
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
529
525
|
*/
|
|
530
|
-
readonly
|
|
526
|
+
readonly expand?: string
|
|
531
527
|
}
|
|
532
528
|
|
|
533
529
|
/**
|
|
@@ -536,54 +532,54 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
536
532
|
* @interface DocumentTemplatesApiListDocTemplatesRequest
|
|
537
533
|
*/
|
|
538
534
|
export interface DocumentTemplatesApiListDocTemplatesRequest {
|
|
535
|
+
/**
|
|
536
|
+
* Bearer Token
|
|
537
|
+
* @type {string}
|
|
538
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
539
|
+
*/
|
|
540
|
+
readonly authorization?: string
|
|
541
|
+
|
|
539
542
|
/**
|
|
540
543
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
541
544
|
* @type {number}
|
|
542
545
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
543
546
|
*/
|
|
544
|
-
readonly pageSize
|
|
547
|
+
readonly pageSize?: number
|
|
545
548
|
|
|
546
549
|
/**
|
|
547
550
|
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
548
551
|
* @type {string}
|
|
549
552
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
550
553
|
*/
|
|
551
|
-
readonly pageToken
|
|
554
|
+
readonly pageToken?: string
|
|
552
555
|
|
|
553
556
|
/**
|
|
554
557
|
* Filter response by productSlug, slug and name.
|
|
555
558
|
* @type {string}
|
|
556
559
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
557
560
|
*/
|
|
558
|
-
readonly filter
|
|
561
|
+
readonly filter?: string
|
|
559
562
|
|
|
560
563
|
/**
|
|
561
564
|
* Search document templates by name | slug
|
|
562
565
|
* @type {string}
|
|
563
566
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
564
567
|
*/
|
|
565
|
-
readonly search
|
|
568
|
+
readonly search?: string
|
|
566
569
|
|
|
567
570
|
/**
|
|
568
571
|
* Order response by createdAt.
|
|
569
572
|
* @type {string}
|
|
570
573
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
571
574
|
*/
|
|
572
|
-
readonly order
|
|
575
|
+
readonly order?: string
|
|
573
576
|
|
|
574
577
|
/**
|
|
575
578
|
* Expand response by bodyTemplate.
|
|
576
579
|
* @type {string}
|
|
577
580
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
578
581
|
*/
|
|
579
|
-
readonly expand
|
|
580
|
-
|
|
581
|
-
/**
|
|
582
|
-
* Bearer Token
|
|
583
|
-
* @type {string}
|
|
584
|
-
* @memberof DocumentTemplatesApiListDocTemplates
|
|
585
|
-
*/
|
|
586
|
-
readonly authorization?: string
|
|
582
|
+
readonly expand?: string
|
|
587
583
|
}
|
|
588
584
|
|
|
589
585
|
/**
|
|
@@ -654,7 +650,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
654
650
|
* @memberof DocumentTemplatesApi
|
|
655
651
|
*/
|
|
656
652
|
public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
657
|
-
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.
|
|
653
|
+
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
658
654
|
}
|
|
659
655
|
|
|
660
656
|
/**
|
|
@@ -665,8 +661,8 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
665
661
|
* @throws {RequiredError}
|
|
666
662
|
* @memberof DocumentTemplatesApi
|
|
667
663
|
*/
|
|
668
|
-
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig) {
|
|
669
|
-
return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand,
|
|
664
|
+
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest = {}, options?: AxiosRequestConfig) {
|
|
665
|
+
return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
670
666
|
}
|
|
671
667
|
|
|
672
668
|
/**
|
package/api/documents-api.ts
CHANGED
|
@@ -23,9 +23,21 @@ 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
|
|
30
|
+
import { CreatePresignedPostResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { GetDocumentDownloadUrlResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { GetSignedS3KeyUrlResponseClass } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
import { ListDocumentsResponseClass } from '../models';
|
|
37
|
+
// @ts-ignore
|
|
28
38
|
import { UpdateDocumentRequestDto } from '../models';
|
|
39
|
+
// @ts-ignore
|
|
40
|
+
import { UpdateDocumentResponseClass } from '../models';
|
|
29
41
|
/**
|
|
30
42
|
* DocumentsApi - axios parameter creator
|
|
31
43
|
* @export
|
|
@@ -226,10 +238,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
226
238
|
* @summary Fetches a presigned URL for a S3 key
|
|
227
239
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
228
240
|
* @param {string} [authorization] Bearer Token
|
|
241
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
229
242
|
* @param {*} [options] Override http request option.
|
|
230
243
|
* @throws {RequiredError}
|
|
231
244
|
*/
|
|
232
|
-
getSignedS3keyUrl: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
245
|
+
getSignedS3keyUrl: async (s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
233
246
|
// verify required parameter 's3Key' is not null or undefined
|
|
234
247
|
assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
|
|
235
248
|
const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
|
|
@@ -254,6 +267,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
254
267
|
localVarQueryParameter['s3Key'] = s3Key;
|
|
255
268
|
}
|
|
256
269
|
|
|
270
|
+
if (contentDisposition !== undefined) {
|
|
271
|
+
localVarQueryParameter['contentDisposition'] = contentDisposition;
|
|
272
|
+
}
|
|
273
|
+
|
|
257
274
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
258
275
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
259
276
|
}
|
|
@@ -414,7 +431,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
414
431
|
* @param {*} [options] Override http request option.
|
|
415
432
|
* @throws {RequiredError}
|
|
416
433
|
*/
|
|
417
|
-
async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
434
|
+
async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>> {
|
|
418
435
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocument(createDocumentRequestDto, authorization, options);
|
|
419
436
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
420
437
|
},
|
|
@@ -426,7 +443,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
426
443
|
* @param {*} [options] Override http request option.
|
|
427
444
|
* @throws {RequiredError}
|
|
428
445
|
*/
|
|
429
|
-
async createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
446
|
+
async createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>> {
|
|
430
447
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPresignedPost(createPresignedPostRequestDto, authorization, options);
|
|
431
448
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
432
449
|
},
|
|
@@ -438,7 +455,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
438
455
|
* @param {*} [options] Override http request option.
|
|
439
456
|
* @throws {RequiredError}
|
|
440
457
|
*/
|
|
441
|
-
async deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
458
|
+
async deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
442
459
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocument(code, authorization, options);
|
|
443
460
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
444
461
|
},
|
|
@@ -451,7 +468,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
451
468
|
* @param {*} [options] Override http request option.
|
|
452
469
|
* @throws {RequiredError}
|
|
453
470
|
*/
|
|
454
|
-
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
471
|
+
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>> {
|
|
455
472
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
|
|
456
473
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
457
474
|
},
|
|
@@ -460,11 +477,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
460
477
|
* @summary Fetches a presigned URL for a S3 key
|
|
461
478
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
462
479
|
* @param {string} [authorization] Bearer Token
|
|
480
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
463
481
|
* @param {*} [options] Override http request option.
|
|
464
482
|
* @throws {RequiredError}
|
|
465
483
|
*/
|
|
466
|
-
async getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
467
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
|
|
484
|
+
async getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>> {
|
|
485
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options);
|
|
468
486
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
469
487
|
},
|
|
470
488
|
/**
|
|
@@ -481,7 +499,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
481
499
|
* @param {*} [options] Override http request option.
|
|
482
500
|
* @throws {RequiredError}
|
|
483
501
|
*/
|
|
484
|
-
async listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
502
|
+
async listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
|
|
485
503
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
486
504
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
487
505
|
},
|
|
@@ -494,7 +512,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
494
512
|
* @param {*} [options] Override http request option.
|
|
495
513
|
* @throws {RequiredError}
|
|
496
514
|
*/
|
|
497
|
-
async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
515
|
+
async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>> {
|
|
498
516
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocument(code, updateDocumentRequestDto, authorization, options);
|
|
499
517
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
500
518
|
},
|
|
@@ -516,7 +534,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
516
534
|
* @param {*} [options] Override http request option.
|
|
517
535
|
* @throws {RequiredError}
|
|
518
536
|
*/
|
|
519
|
-
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
537
|
+
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass> {
|
|
520
538
|
return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
521
539
|
},
|
|
522
540
|
/**
|
|
@@ -527,7 +545,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
527
545
|
* @param {*} [options] Override http request option.
|
|
528
546
|
* @throws {RequiredError}
|
|
529
547
|
*/
|
|
530
|
-
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
548
|
+
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass> {
|
|
531
549
|
return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
532
550
|
},
|
|
533
551
|
/**
|
|
@@ -538,7 +556,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
538
556
|
* @param {*} [options] Override http request option.
|
|
539
557
|
* @throws {RequiredError}
|
|
540
558
|
*/
|
|
541
|
-
deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
559
|
+
deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object> {
|
|
542
560
|
return localVarFp.deleteDocument(code, authorization, options).then((request) => request(axios, basePath));
|
|
543
561
|
},
|
|
544
562
|
/**
|
|
@@ -550,7 +568,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
550
568
|
* @param {*} [options] Override http request option.
|
|
551
569
|
* @throws {RequiredError}
|
|
552
570
|
*/
|
|
553
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<
|
|
571
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
|
|
554
572
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
555
573
|
},
|
|
556
574
|
/**
|
|
@@ -558,11 +576,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
558
576
|
* @summary Fetches a presigned URL for a S3 key
|
|
559
577
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
560
578
|
* @param {string} [authorization] Bearer Token
|
|
579
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
561
580
|
* @param {*} [options] Override http request option.
|
|
562
581
|
* @throws {RequiredError}
|
|
563
582
|
*/
|
|
564
|
-
getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<
|
|
565
|
-
return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then((request) => request(axios, basePath));
|
|
583
|
+
getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass> {
|
|
584
|
+
return localVarFp.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
566
585
|
},
|
|
567
586
|
/**
|
|
568
587
|
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
@@ -578,7 +597,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
578
597
|
* @param {*} [options] Override http request option.
|
|
579
598
|
* @throws {RequiredError}
|
|
580
599
|
*/
|
|
581
|
-
listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
600
|
+
listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
|
|
582
601
|
return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
583
602
|
},
|
|
584
603
|
/**
|
|
@@ -590,7 +609,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
590
609
|
* @param {*} [options] Override http request option.
|
|
591
610
|
* @throws {RequiredError}
|
|
592
611
|
*/
|
|
593
|
-
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
612
|
+
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass> {
|
|
594
613
|
return localVarFp.updateDocument(code, updateDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
595
614
|
},
|
|
596
615
|
};
|
|
@@ -706,6 +725,13 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
|
|
|
706
725
|
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
707
726
|
*/
|
|
708
727
|
readonly authorization?: string
|
|
728
|
+
|
|
729
|
+
/**
|
|
730
|
+
* Content disposition override. Default will be depending on the document type.
|
|
731
|
+
* @type {'attachment' | 'inline'}
|
|
732
|
+
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
733
|
+
*/
|
|
734
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
709
735
|
}
|
|
710
736
|
|
|
711
737
|
/**
|
|
@@ -863,7 +889,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
863
889
|
* @memberof DocumentsApi
|
|
864
890
|
*/
|
|
865
891
|
public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
|
|
866
|
-
return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
892
|
+
return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
|
|
867
893
|
}
|
|
868
894
|
|
|
869
895
|
/**
|