@emilgroup/document-sdk-node 1.28.0 → 1.28.2-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 +39 -29
- 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/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 -31
- package/dist/api/documents-api.js +9 -11
- 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/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 +104 -0
- package/dist/models/doc-template-class.js +15 -0
- package/dist/models/document-class.d.ts +171 -0
- package/dist/models/document-class.js +53 -0
- package/dist/models/docx-template-class.d.ts +102 -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 +78 -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 +91 -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 +78 -0
- package/dist/models/searchable-document-class.js +15 -0
- package/dist/models/searchable-document-owner-class.d.ts +42 -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 +110 -0
- package/models/document-class.ts +181 -0
- package/models/docx-template-class.ts +108 -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 +87 -0
- package/models/index.ts +36 -0
- package/models/layout-class.ts +97 -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 +84 -0
- package/models/searchable-document-owner-class.ts +48 -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-node@1.28.0 --save
|
|
20
|
+
npm install @emilgroup/document-sdk-node@1.28.2-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk-node@1.28.0
|
|
24
|
+
yarn add @emilgroup/document-sdk-node@1.28.2-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
|
// URLSearchParams not necessarily used
|
|
28
38
|
// @ts-ignore
|
|
29
39
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -130,16 +140,14 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
130
140
|
* 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.
|
|
131
141
|
* @summary Retrieve the document template
|
|
132
142
|
* @param {number} id
|
|
133
|
-
* @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.
|
|
134
143
|
* @param {string} [authorization] Bearer Token
|
|
144
|
+
* @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.
|
|
135
145
|
* @param {*} [options] Override http request option.
|
|
136
146
|
* @throws {RequiredError}
|
|
137
147
|
*/
|
|
138
|
-
getDocTemplate: async (id: number,
|
|
148
|
+
getDocTemplate: async (id: number, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
139
149
|
// verify required parameter 'id' is not null or undefined
|
|
140
150
|
assertParamExists('getDocTemplate', 'id', id)
|
|
141
|
-
// verify required parameter 'expand' is not null or undefined
|
|
142
|
-
assertParamExists('getDocTemplate', 'expand', expand)
|
|
143
151
|
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
144
152
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
145
153
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -181,29 +189,17 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
181
189
|
/**
|
|
182
190
|
* 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.
|
|
183
191
|
* @summary List document templates
|
|
184
|
-
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
185
|
-
* @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.
|
|
186
|
-
* @param {string} filter Filter response by productSlug, slug and name.
|
|
187
|
-
* @param {string} search Search document templates by name | slug
|
|
188
|
-
* @param {string} order Order response by createdAt.
|
|
189
|
-
* @param {string} expand Expand response by bodyTemplate.
|
|
190
192
|
* @param {string} [authorization] Bearer Token
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
194
|
+
* @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.
|
|
195
|
+
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
196
|
+
* @param {string} [search] Search document templates by name | slug
|
|
197
|
+
* @param {string} [order] Order response by createdAt.
|
|
198
|
+
* @param {string} [expand] Expand response by bodyTemplate.
|
|
191
199
|
* @param {*} [options] Override http request option.
|
|
192
200
|
* @throws {RequiredError}
|
|
193
201
|
*/
|
|
194
|
-
listDocTemplates: async (pageSize
|
|
195
|
-
// verify required parameter 'pageSize' is not null or undefined
|
|
196
|
-
assertParamExists('listDocTemplates', 'pageSize', pageSize)
|
|
197
|
-
// verify required parameter 'pageToken' is not null or undefined
|
|
198
|
-
assertParamExists('listDocTemplates', 'pageToken', pageToken)
|
|
199
|
-
// verify required parameter 'filter' is not null or undefined
|
|
200
|
-
assertParamExists('listDocTemplates', 'filter', filter)
|
|
201
|
-
// verify required parameter 'search' is not null or undefined
|
|
202
|
-
assertParamExists('listDocTemplates', 'search', search)
|
|
203
|
-
// verify required parameter 'order' is not null or undefined
|
|
204
|
-
assertParamExists('listDocTemplates', 'order', order)
|
|
205
|
-
// verify required parameter 'expand' is not null or undefined
|
|
206
|
-
assertParamExists('listDocTemplates', 'expand', expand)
|
|
202
|
+
listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
207
203
|
const localVarPath = `/documentservice/v1/doc-templates`;
|
|
208
204
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
209
205
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -330,7 +326,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
330
326
|
* @param {*} [options] Override http request option.
|
|
331
327
|
* @throws {RequiredError}
|
|
332
328
|
*/
|
|
333
|
-
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
329
|
+
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocTemplateResponseClass>> {
|
|
334
330
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocTemplate(createDocTemplateRequestDto, authorization, options);
|
|
335
331
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
336
332
|
},
|
|
@@ -342,7 +338,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
342
338
|
* @param {*} [options] Override http request option.
|
|
343
339
|
* @throws {RequiredError}
|
|
344
340
|
*/
|
|
345
|
-
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
341
|
+
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
|
|
346
342
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
|
|
347
343
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
348
344
|
},
|
|
@@ -350,30 +346,30 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
350
346
|
* 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.
|
|
351
347
|
* @summary Retrieve the document template
|
|
352
348
|
* @param {number} id
|
|
353
|
-
* @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.
|
|
354
349
|
* @param {string} [authorization] Bearer Token
|
|
350
|
+
* @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.
|
|
355
351
|
* @param {*} [options] Override http request option.
|
|
356
352
|
* @throws {RequiredError}
|
|
357
353
|
*/
|
|
358
|
-
async getDocTemplate(id: number,
|
|
359
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id,
|
|
354
|
+
async getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>> {
|
|
355
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, authorization, expand, options);
|
|
360
356
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
361
357
|
},
|
|
362
358
|
/**
|
|
363
359
|
* 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.
|
|
364
360
|
* @summary List document templates
|
|
365
|
-
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
366
|
-
* @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.
|
|
367
|
-
* @param {string} filter Filter response by productSlug, slug and name.
|
|
368
|
-
* @param {string} search Search document templates by name | slug
|
|
369
|
-
* @param {string} order Order response by createdAt.
|
|
370
|
-
* @param {string} expand Expand response by bodyTemplate.
|
|
371
361
|
* @param {string} [authorization] Bearer Token
|
|
362
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
363
|
+
* @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.
|
|
364
|
+
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
365
|
+
* @param {string} [search] Search document templates by name | slug
|
|
366
|
+
* @param {string} [order] Order response by createdAt.
|
|
367
|
+
* @param {string} [expand] Expand response by bodyTemplate.
|
|
372
368
|
* @param {*} [options] Override http request option.
|
|
373
369
|
* @throws {RequiredError}
|
|
374
370
|
*/
|
|
375
|
-
async listDocTemplates(pageSize
|
|
376
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand,
|
|
371
|
+
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>> {
|
|
372
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
377
373
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
378
374
|
},
|
|
379
375
|
/**
|
|
@@ -385,7 +381,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
385
381
|
* @param {*} [options] Override http request option.
|
|
386
382
|
* @throws {RequiredError}
|
|
387
383
|
*/
|
|
388
|
-
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
384
|
+
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocTemplateResponseClass>> {
|
|
389
385
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options);
|
|
390
386
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
391
387
|
},
|
|
@@ -407,7 +403,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
407
403
|
* @param {*} [options] Override http request option.
|
|
408
404
|
* @throws {RequiredError}
|
|
409
405
|
*/
|
|
410
|
-
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
406
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass> {
|
|
411
407
|
return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
412
408
|
},
|
|
413
409
|
/**
|
|
@@ -418,36 +414,36 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
418
414
|
* @param {*} [options] Override http request option.
|
|
419
415
|
* @throws {RequiredError}
|
|
420
416
|
*/
|
|
421
|
-
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<
|
|
417
|
+
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
|
|
422
418
|
return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
423
419
|
},
|
|
424
420
|
/**
|
|
425
421
|
* 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.
|
|
426
422
|
* @summary Retrieve the document template
|
|
427
423
|
* @param {number} id
|
|
428
|
-
* @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.
|
|
429
424
|
* @param {string} [authorization] Bearer Token
|
|
425
|
+
* @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.
|
|
430
426
|
* @param {*} [options] Override http request option.
|
|
431
427
|
* @throws {RequiredError}
|
|
432
428
|
*/
|
|
433
|
-
getDocTemplate(id: number,
|
|
434
|
-
return localVarFp.getDocTemplate(id,
|
|
429
|
+
getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass> {
|
|
430
|
+
return localVarFp.getDocTemplate(id, authorization, expand, options).then((request) => request(axios, basePath));
|
|
435
431
|
},
|
|
436
432
|
/**
|
|
437
433
|
* 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.
|
|
438
434
|
* @summary List document templates
|
|
439
|
-
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
440
|
-
* @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.
|
|
441
|
-
* @param {string} filter Filter response by productSlug, slug and name.
|
|
442
|
-
* @param {string} search Search document templates by name | slug
|
|
443
|
-
* @param {string} order Order response by createdAt.
|
|
444
|
-
* @param {string} expand Expand response by bodyTemplate.
|
|
445
435
|
* @param {string} [authorization] Bearer Token
|
|
436
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
437
|
+
* @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.
|
|
438
|
+
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
439
|
+
* @param {string} [search] Search document templates by name | slug
|
|
440
|
+
* @param {string} [order] Order response by createdAt.
|
|
441
|
+
* @param {string} [expand] Expand response by bodyTemplate.
|
|
446
442
|
* @param {*} [options] Override http request option.
|
|
447
443
|
* @throws {RequiredError}
|
|
448
444
|
*/
|
|
449
|
-
listDocTemplates(pageSize
|
|
450
|
-
return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand,
|
|
445
|
+
listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
|
|
446
|
+
return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
451
447
|
},
|
|
452
448
|
/**
|
|
453
449
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -458,7 +454,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
458
454
|
* @param {*} [options] Override http request option.
|
|
459
455
|
* @throws {RequiredError}
|
|
460
456
|
*/
|
|
461
|
-
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
457
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocTemplateResponseClass> {
|
|
462
458
|
return localVarFp.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
463
459
|
},
|
|
464
460
|
};
|
|
@@ -520,18 +516,18 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
520
516
|
readonly id: number
|
|
521
517
|
|
|
522
518
|
/**
|
|
523
|
-
*
|
|
519
|
+
* Bearer Token
|
|
524
520
|
* @type {string}
|
|
525
521
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
526
522
|
*/
|
|
527
|
-
readonly
|
|
523
|
+
readonly authorization?: string
|
|
528
524
|
|
|
529
525
|
/**
|
|
530
|
-
*
|
|
526
|
+
* 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.
|
|
531
527
|
* @type {string}
|
|
532
528
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
533
529
|
*/
|
|
534
|
-
readonly
|
|
530
|
+
readonly expand?: string
|
|
535
531
|
}
|
|
536
532
|
|
|
537
533
|
/**
|
|
@@ -540,54 +536,54 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
540
536
|
* @interface DocumentTemplatesApiListDocTemplatesRequest
|
|
541
537
|
*/
|
|
542
538
|
export interface DocumentTemplatesApiListDocTemplatesRequest {
|
|
539
|
+
/**
|
|
540
|
+
* Bearer Token
|
|
541
|
+
* @type {string}
|
|
542
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
543
|
+
*/
|
|
544
|
+
readonly authorization?: string
|
|
545
|
+
|
|
543
546
|
/**
|
|
544
547
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
545
548
|
* @type {number}
|
|
546
549
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
547
550
|
*/
|
|
548
|
-
readonly pageSize
|
|
551
|
+
readonly pageSize?: number
|
|
549
552
|
|
|
550
553
|
/**
|
|
551
554
|
* 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.
|
|
552
555
|
* @type {string}
|
|
553
556
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
554
557
|
*/
|
|
555
|
-
readonly pageToken
|
|
558
|
+
readonly pageToken?: string
|
|
556
559
|
|
|
557
560
|
/**
|
|
558
561
|
* Filter response by productSlug, slug and name.
|
|
559
562
|
* @type {string}
|
|
560
563
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
561
564
|
*/
|
|
562
|
-
readonly filter
|
|
565
|
+
readonly filter?: string
|
|
563
566
|
|
|
564
567
|
/**
|
|
565
568
|
* Search document templates by name | slug
|
|
566
569
|
* @type {string}
|
|
567
570
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
568
571
|
*/
|
|
569
|
-
readonly search
|
|
572
|
+
readonly search?: string
|
|
570
573
|
|
|
571
574
|
/**
|
|
572
575
|
* Order response by createdAt.
|
|
573
576
|
* @type {string}
|
|
574
577
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
575
578
|
*/
|
|
576
|
-
readonly order
|
|
579
|
+
readonly order?: string
|
|
577
580
|
|
|
578
581
|
/**
|
|
579
582
|
* Expand response by bodyTemplate.
|
|
580
583
|
* @type {string}
|
|
581
584
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
582
585
|
*/
|
|
583
|
-
readonly expand
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
* Bearer Token
|
|
587
|
-
* @type {string}
|
|
588
|
-
* @memberof DocumentTemplatesApiListDocTemplates
|
|
589
|
-
*/
|
|
590
|
-
readonly authorization?: string
|
|
586
|
+
readonly expand?: string
|
|
591
587
|
}
|
|
592
588
|
|
|
593
589
|
/**
|
|
@@ -658,7 +654,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
658
654
|
* @memberof DocumentTemplatesApi
|
|
659
655
|
*/
|
|
660
656
|
public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
661
|
-
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.
|
|
657
|
+
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
662
658
|
}
|
|
663
659
|
|
|
664
660
|
/**
|
|
@@ -669,8 +665,8 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
669
665
|
* @throws {RequiredError}
|
|
670
666
|
* @memberof DocumentTemplatesApi
|
|
671
667
|
*/
|
|
672
|
-
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig) {
|
|
673
|
-
return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand,
|
|
668
|
+
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest = {}, options?: AxiosRequestConfig) {
|
|
669
|
+
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));
|
|
674
670
|
}
|
|
675
671
|
|
|
676
672
|
/**
|
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
|
// URLSearchParams not necessarily used
|
|
30
42
|
// @ts-ignore
|
|
31
43
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -229,16 +241,14 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
229
241
|
* This will return a presigned URL for a random S3 key
|
|
230
242
|
* @summary Fetches a presigned URL for a S3 key
|
|
231
243
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
232
|
-
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
233
244
|
* @param {string} [authorization] Bearer Token
|
|
245
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
234
246
|
* @param {*} [options] Override http request option.
|
|
235
247
|
* @throws {RequiredError}
|
|
236
248
|
*/
|
|
237
|
-
getSignedS3keyUrl: async (s3Key: string, contentDisposition
|
|
249
|
+
getSignedS3keyUrl: async (s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
238
250
|
// verify required parameter 's3Key' is not null or undefined
|
|
239
251
|
assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
|
|
240
|
-
// verify required parameter 'contentDisposition' is not null or undefined
|
|
241
|
-
assertParamExists('getSignedS3keyUrl', 'contentDisposition', contentDisposition)
|
|
242
252
|
const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
|
|
243
253
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
244
254
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -425,7 +435,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
425
435
|
* @param {*} [options] Override http request option.
|
|
426
436
|
* @throws {RequiredError}
|
|
427
437
|
*/
|
|
428
|
-
async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
438
|
+
async createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>> {
|
|
429
439
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocument(createDocumentRequestDto, authorization, options);
|
|
430
440
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
431
441
|
},
|
|
@@ -437,7 +447,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
437
447
|
* @param {*} [options] Override http request option.
|
|
438
448
|
* @throws {RequiredError}
|
|
439
449
|
*/
|
|
440
|
-
async createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
450
|
+
async createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>> {
|
|
441
451
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPresignedPost(createPresignedPostRequestDto, authorization, options);
|
|
442
452
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
443
453
|
},
|
|
@@ -449,7 +459,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
449
459
|
* @param {*} [options] Override http request option.
|
|
450
460
|
* @throws {RequiredError}
|
|
451
461
|
*/
|
|
452
|
-
async deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
462
|
+
async deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
453
463
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocument(code, authorization, options);
|
|
454
464
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
455
465
|
},
|
|
@@ -462,7 +472,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
462
472
|
* @param {*} [options] Override http request option.
|
|
463
473
|
* @throws {RequiredError}
|
|
464
474
|
*/
|
|
465
|
-
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
475
|
+
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>> {
|
|
466
476
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
|
|
467
477
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
468
478
|
},
|
|
@@ -470,13 +480,13 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
470
480
|
* This will return a presigned URL for a random S3 key
|
|
471
481
|
* @summary Fetches a presigned URL for a S3 key
|
|
472
482
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
473
|
-
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
474
483
|
* @param {string} [authorization] Bearer Token
|
|
484
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
475
485
|
* @param {*} [options] Override http request option.
|
|
476
486
|
* @throws {RequiredError}
|
|
477
487
|
*/
|
|
478
|
-
async getSignedS3keyUrl(s3Key: string, contentDisposition
|
|
479
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key,
|
|
488
|
+
async getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>> {
|
|
489
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options);
|
|
480
490
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
481
491
|
},
|
|
482
492
|
/**
|
|
@@ -493,7 +503,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
493
503
|
* @param {*} [options] Override http request option.
|
|
494
504
|
* @throws {RequiredError}
|
|
495
505
|
*/
|
|
496
|
-
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<
|
|
506
|
+
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>> {
|
|
497
507
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
498
508
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
499
509
|
},
|
|
@@ -506,7 +516,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
506
516
|
* @param {*} [options] Override http request option.
|
|
507
517
|
* @throws {RequiredError}
|
|
508
518
|
*/
|
|
509
|
-
async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
519
|
+
async updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>> {
|
|
510
520
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocument(code, updateDocumentRequestDto, authorization, options);
|
|
511
521
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
512
522
|
},
|
|
@@ -528,7 +538,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
528
538
|
* @param {*} [options] Override http request option.
|
|
529
539
|
* @throws {RequiredError}
|
|
530
540
|
*/
|
|
531
|
-
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
541
|
+
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass> {
|
|
532
542
|
return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
533
543
|
},
|
|
534
544
|
/**
|
|
@@ -539,7 +549,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
539
549
|
* @param {*} [options] Override http request option.
|
|
540
550
|
* @throws {RequiredError}
|
|
541
551
|
*/
|
|
542
|
-
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
552
|
+
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass> {
|
|
543
553
|
return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
544
554
|
},
|
|
545
555
|
/**
|
|
@@ -550,7 +560,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
550
560
|
* @param {*} [options] Override http request option.
|
|
551
561
|
* @throws {RequiredError}
|
|
552
562
|
*/
|
|
553
|
-
deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
563
|
+
deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object> {
|
|
554
564
|
return localVarFp.deleteDocument(code, authorization, options).then((request) => request(axios, basePath));
|
|
555
565
|
},
|
|
556
566
|
/**
|
|
@@ -562,20 +572,20 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
562
572
|
* @param {*} [options] Override http request option.
|
|
563
573
|
* @throws {RequiredError}
|
|
564
574
|
*/
|
|
565
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<
|
|
575
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
|
|
566
576
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
567
577
|
},
|
|
568
578
|
/**
|
|
569
579
|
* This will return a presigned URL for a random S3 key
|
|
570
580
|
* @summary Fetches a presigned URL for a S3 key
|
|
571
581
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
572
|
-
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
573
582
|
* @param {string} [authorization] Bearer Token
|
|
583
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
574
584
|
* @param {*} [options] Override http request option.
|
|
575
585
|
* @throws {RequiredError}
|
|
576
586
|
*/
|
|
577
|
-
getSignedS3keyUrl(s3Key: string, contentDisposition
|
|
578
|
-
return localVarFp.getSignedS3keyUrl(s3Key,
|
|
587
|
+
getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass> {
|
|
588
|
+
return localVarFp.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
579
589
|
},
|
|
580
590
|
/**
|
|
581
591
|
* 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.
|
|
@@ -591,7 +601,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
591
601
|
* @param {*} [options] Override http request option.
|
|
592
602
|
* @throws {RequiredError}
|
|
593
603
|
*/
|
|
594
|
-
listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
604
|
+
listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
|
|
595
605
|
return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
596
606
|
},
|
|
597
607
|
/**
|
|
@@ -603,7 +613,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
603
613
|
* @param {*} [options] Override http request option.
|
|
604
614
|
* @throws {RequiredError}
|
|
605
615
|
*/
|
|
606
|
-
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
616
|
+
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass> {
|
|
607
617
|
return localVarFp.updateDocument(code, updateDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
608
618
|
},
|
|
609
619
|
};
|
|
@@ -714,18 +724,18 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
|
|
|
714
724
|
readonly s3Key: string
|
|
715
725
|
|
|
716
726
|
/**
|
|
717
|
-
*
|
|
718
|
-
* @type {
|
|
727
|
+
* Bearer Token
|
|
728
|
+
* @type {string}
|
|
719
729
|
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
720
730
|
*/
|
|
721
|
-
readonly
|
|
731
|
+
readonly authorization?: string
|
|
722
732
|
|
|
723
733
|
/**
|
|
724
|
-
*
|
|
725
|
-
* @type {
|
|
734
|
+
* Content disposition override. Default will be depending on the document type.
|
|
735
|
+
* @type {'attachment' | 'inline'}
|
|
726
736
|
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
727
737
|
*/
|
|
728
|
-
readonly
|
|
738
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
729
739
|
}
|
|
730
740
|
|
|
731
741
|
/**
|
|
@@ -883,7 +893,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
883
893
|
* @memberof DocumentsApi
|
|
884
894
|
*/
|
|
885
895
|
public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
|
|
886
|
-
return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.
|
|
896
|
+
return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
|
|
887
897
|
}
|
|
888
898
|
|
|
889
899
|
/**
|