@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
|
@@ -13,8 +13,14 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateDocumentRequestDto } from '../models';
|
|
16
|
+
import { CreateDocumentSyncResponseClass } from '../models';
|
|
16
17
|
import { CreatePresignedPostRequestDto } from '../models';
|
|
18
|
+
import { CreatePresignedPostResponseClass } from '../models';
|
|
19
|
+
import { GetDocumentDownloadUrlResponseClass } from '../models';
|
|
20
|
+
import { GetSignedS3KeyUrlResponseClass } from '../models';
|
|
21
|
+
import { ListDocumentsResponseClass } from '../models';
|
|
17
22
|
import { UpdateDocumentRequestDto } from '../models';
|
|
23
|
+
import { UpdateDocumentResponseClass } from '../models';
|
|
18
24
|
/**
|
|
19
25
|
* DocumentsApi - axios parameter creator
|
|
20
26
|
* @export
|
|
@@ -62,10 +68,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
62
68
|
* @summary Fetches a presigned URL for a S3 key
|
|
63
69
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
64
70
|
* @param {string} [authorization] Bearer Token
|
|
71
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
65
72
|
* @param {*} [options] Override http request option.
|
|
66
73
|
* @throws {RequiredError}
|
|
67
74
|
*/
|
|
68
|
-
getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
|
+
getSignedS3keyUrl: (s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
76
|
/**
|
|
70
77
|
* 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.
|
|
71
78
|
* @summary List documents
|
|
@@ -105,7 +112,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
105
112
|
* @param {*} [options] Override http request option.
|
|
106
113
|
* @throws {RequiredError}
|
|
107
114
|
*/
|
|
108
|
-
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
115
|
+
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>>;
|
|
109
116
|
/**
|
|
110
117
|
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
111
118
|
* @summary Upload documents using pre-signed URL
|
|
@@ -114,7 +121,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
114
121
|
* @param {*} [options] Override http request option.
|
|
115
122
|
* @throws {RequiredError}
|
|
116
123
|
*/
|
|
117
|
-
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
124
|
+
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
|
|
118
125
|
/**
|
|
119
126
|
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
120
127
|
* @summary Delete the document
|
|
@@ -123,7 +130,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
123
130
|
* @param {*} [options] Override http request option.
|
|
124
131
|
* @throws {RequiredError}
|
|
125
132
|
*/
|
|
126
|
-
deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
133
|
+
deleteDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
127
134
|
/**
|
|
128
135
|
* This will return a presigned URL to download the document.
|
|
129
136
|
* @summary Fetches a document download URL
|
|
@@ -133,16 +140,17 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
133
140
|
* @param {*} [options] Override http request option.
|
|
134
141
|
* @throws {RequiredError}
|
|
135
142
|
*/
|
|
136
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
143
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
|
|
137
144
|
/**
|
|
138
145
|
* This will return a presigned URL for a random S3 key
|
|
139
146
|
* @summary Fetches a presigned URL for a S3 key
|
|
140
147
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
141
148
|
* @param {string} [authorization] Bearer Token
|
|
149
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
142
150
|
* @param {*} [options] Override http request option.
|
|
143
151
|
* @throws {RequiredError}
|
|
144
152
|
*/
|
|
145
|
-
getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
153
|
+
getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
|
|
146
154
|
/**
|
|
147
155
|
* 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.
|
|
148
156
|
* @summary List documents
|
|
@@ -157,7 +165,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
157
165
|
* @param {*} [options] Override http request option.
|
|
158
166
|
* @throws {RequiredError}
|
|
159
167
|
*/
|
|
160
|
-
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<
|
|
168
|
+
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>>;
|
|
161
169
|
/**
|
|
162
170
|
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
163
171
|
* @summary Update the document
|
|
@@ -167,7 +175,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
167
175
|
* @param {*} [options] Override http request option.
|
|
168
176
|
* @throws {RequiredError}
|
|
169
177
|
*/
|
|
170
|
-
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
178
|
+
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>>;
|
|
171
179
|
};
|
|
172
180
|
/**
|
|
173
181
|
* DocumentsApi - factory interface
|
|
@@ -182,7 +190,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
182
190
|
* @param {*} [options] Override http request option.
|
|
183
191
|
* @throws {RequiredError}
|
|
184
192
|
*/
|
|
185
|
-
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
193
|
+
createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass>;
|
|
186
194
|
/**
|
|
187
195
|
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
188
196
|
* @summary Upload documents using pre-signed URL
|
|
@@ -191,7 +199,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
191
199
|
* @param {*} [options] Override http request option.
|
|
192
200
|
* @throws {RequiredError}
|
|
193
201
|
*/
|
|
194
|
-
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
202
|
+
createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
|
|
195
203
|
/**
|
|
196
204
|
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
197
205
|
* @summary Delete the document
|
|
@@ -200,7 +208,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
200
208
|
* @param {*} [options] Override http request option.
|
|
201
209
|
* @throws {RequiredError}
|
|
202
210
|
*/
|
|
203
|
-
deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
211
|
+
deleteDocument(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
204
212
|
/**
|
|
205
213
|
* This will return a presigned URL to download the document.
|
|
206
214
|
* @summary Fetches a document download URL
|
|
@@ -210,16 +218,17 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
210
218
|
* @param {*} [options] Override http request option.
|
|
211
219
|
* @throws {RequiredError}
|
|
212
220
|
*/
|
|
213
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<
|
|
221
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
|
|
214
222
|
/**
|
|
215
223
|
* This will return a presigned URL for a random S3 key
|
|
216
224
|
* @summary Fetches a presigned URL for a S3 key
|
|
217
225
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
218
226
|
* @param {string} [authorization] Bearer Token
|
|
227
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
219
228
|
* @param {*} [options] Override http request option.
|
|
220
229
|
* @throws {RequiredError}
|
|
221
230
|
*/
|
|
222
|
-
getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<
|
|
231
|
+
getSignedS3keyUrl(s3Key: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
|
|
223
232
|
/**
|
|
224
233
|
* 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.
|
|
225
234
|
* @summary List documents
|
|
@@ -234,7 +243,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
234
243
|
* @param {*} [options] Override http request option.
|
|
235
244
|
* @throws {RequiredError}
|
|
236
245
|
*/
|
|
237
|
-
listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
246
|
+
listDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
|
|
238
247
|
/**
|
|
239
248
|
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
240
249
|
* @summary Update the document
|
|
@@ -244,7 +253,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
244
253
|
* @param {*} [options] Override http request option.
|
|
245
254
|
* @throws {RequiredError}
|
|
246
255
|
*/
|
|
247
|
-
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
256
|
+
updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass>;
|
|
248
257
|
};
|
|
249
258
|
/**
|
|
250
259
|
* Request parameters for createDocument operation in DocumentsApi.
|
|
@@ -346,6 +355,12 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
|
|
|
346
355
|
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
347
356
|
*/
|
|
348
357
|
readonly authorization?: string;
|
|
358
|
+
/**
|
|
359
|
+
* Content disposition override. Default will be depending on the document type.
|
|
360
|
+
* @type {'attachment' | 'inline'}
|
|
361
|
+
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
362
|
+
*/
|
|
363
|
+
readonly contentDisposition?: 'attachment' | 'inline';
|
|
349
364
|
}
|
|
350
365
|
/**
|
|
351
366
|
* Request parameters for listDocuments operation in DocumentsApi.
|
|
@@ -442,7 +457,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
442
457
|
* @throws {RequiredError}
|
|
443
458
|
* @memberof DocumentsApi
|
|
444
459
|
*/
|
|
445
|
-
createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
460
|
+
createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocumentSyncResponseClass, any>>;
|
|
446
461
|
/**
|
|
447
462
|
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
448
463
|
* @summary Upload documents using pre-signed URL
|
|
@@ -451,7 +466,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
451
466
|
* @throws {RequiredError}
|
|
452
467
|
* @memberof DocumentsApi
|
|
453
468
|
*/
|
|
454
|
-
createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
469
|
+
createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
|
|
455
470
|
/**
|
|
456
471
|
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
457
472
|
* @summary Delete the document
|
|
@@ -460,7 +475,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
460
475
|
* @throws {RequiredError}
|
|
461
476
|
* @memberof DocumentsApi
|
|
462
477
|
*/
|
|
463
|
-
deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
478
|
+
deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
464
479
|
/**
|
|
465
480
|
* This will return a presigned URL to download the document.
|
|
466
481
|
* @summary Fetches a document download URL
|
|
@@ -469,7 +484,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
469
484
|
* @throws {RequiredError}
|
|
470
485
|
* @memberof DocumentsApi
|
|
471
486
|
*/
|
|
472
|
-
getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
487
|
+
getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentDownloadUrlResponseClass, any>>;
|
|
473
488
|
/**
|
|
474
489
|
* This will return a presigned URL for a random S3 key
|
|
475
490
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -478,7 +493,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
478
493
|
* @throws {RequiredError}
|
|
479
494
|
* @memberof DocumentsApi
|
|
480
495
|
*/
|
|
481
|
-
getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
496
|
+
getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignedS3KeyUrlResponseClass, any>>;
|
|
482
497
|
/**
|
|
483
498
|
* 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.
|
|
484
499
|
* @summary List documents
|
|
@@ -487,7 +502,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
487
502
|
* @throws {RequiredError}
|
|
488
503
|
* @memberof DocumentsApi
|
|
489
504
|
*/
|
|
490
|
-
listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
505
|
+
listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
|
|
491
506
|
/**
|
|
492
507
|
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
493
508
|
* @summary Update the document
|
|
@@ -496,5 +511,5 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
496
511
|
* @throws {RequiredError}
|
|
497
512
|
* @memberof DocumentsApi
|
|
498
513
|
*/
|
|
499
|
-
updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
514
|
+
updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocumentResponseClass, any>>;
|
|
500
515
|
}
|
|
@@ -295,10 +295,11 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
295
295
|
* @summary Fetches a presigned URL for a S3 key
|
|
296
296
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
297
297
|
* @param {string} [authorization] Bearer Token
|
|
298
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
298
299
|
* @param {*} [options] Override http request option.
|
|
299
300
|
* @throws {RequiredError}
|
|
300
301
|
*/
|
|
301
|
-
getSignedS3keyUrl: function (s3Key, authorization, options) {
|
|
302
|
+
getSignedS3keyUrl: function (s3Key, authorization, contentDisposition, options) {
|
|
302
303
|
if (options === void 0) { options = {}; }
|
|
303
304
|
return __awaiter(_this, void 0, void 0, function () {
|
|
304
305
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -326,6 +327,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
326
327
|
if (s3Key !== undefined) {
|
|
327
328
|
localVarQueryParameter['s3Key'] = s3Key;
|
|
328
329
|
}
|
|
330
|
+
if (contentDisposition !== undefined) {
|
|
331
|
+
localVarQueryParameter['contentDisposition'] = contentDisposition;
|
|
332
|
+
}
|
|
329
333
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
330
334
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
331
335
|
}
|
|
@@ -565,15 +569,16 @@ var DocumentsApiFp = function (configuration) {
|
|
|
565
569
|
* @summary Fetches a presigned URL for a S3 key
|
|
566
570
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
567
571
|
* @param {string} [authorization] Bearer Token
|
|
572
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
568
573
|
* @param {*} [options] Override http request option.
|
|
569
574
|
* @throws {RequiredError}
|
|
570
575
|
*/
|
|
571
|
-
getSignedS3keyUrl: function (s3Key, authorization, options) {
|
|
576
|
+
getSignedS3keyUrl: function (s3Key, authorization, contentDisposition, options) {
|
|
572
577
|
return __awaiter(this, void 0, void 0, function () {
|
|
573
578
|
var localVarAxiosArgs;
|
|
574
579
|
return __generator(this, function (_a) {
|
|
575
580
|
switch (_a.label) {
|
|
576
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
|
|
581
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options)];
|
|
577
582
|
case 1:
|
|
578
583
|
localVarAxiosArgs = _a.sent();
|
|
579
584
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -690,11 +695,12 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
690
695
|
* @summary Fetches a presigned URL for a S3 key
|
|
691
696
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
692
697
|
* @param {string} [authorization] Bearer Token
|
|
698
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
693
699
|
* @param {*} [options] Override http request option.
|
|
694
700
|
* @throws {RequiredError}
|
|
695
701
|
*/
|
|
696
|
-
getSignedS3keyUrl: function (s3Key, authorization, options) {
|
|
697
|
-
return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
702
|
+
getSignedS3keyUrl: function (s3Key, authorization, contentDisposition, options) {
|
|
703
|
+
return localVarFp.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
|
|
698
704
|
},
|
|
699
705
|
/**
|
|
700
706
|
* 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.
|
|
@@ -797,7 +803,7 @@ var DocumentsApi = /** @class */ (function (_super) {
|
|
|
797
803
|
*/
|
|
798
804
|
DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
|
|
799
805
|
var _this = this;
|
|
800
|
-
return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
806
|
+
return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
801
807
|
};
|
|
802
808
|
/**
|
|
803
809
|
* 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.
|
|
@@ -12,7 +12,13 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePresignedPostResponseClass } from '../models';
|
|
16
|
+
import { DeleteResponseClass } from '../models';
|
|
17
|
+
import { GetDocxTemplateDownloadUrlResponseClass } from '../models';
|
|
18
|
+
import { GetDocxTemplateResponseClass } from '../models';
|
|
19
|
+
import { ListDocxTemplatesResponseClass } from '../models';
|
|
15
20
|
import { SharedUpdateDocxTemplateRequestDto } from '../models';
|
|
21
|
+
import { UpdateDocxTemplateResponseClass } from '../models';
|
|
16
22
|
import { UploadDocxTemplateRequestDto } from '../models';
|
|
17
23
|
/**
|
|
18
24
|
* DocxTemplatesApi - axios parameter creator
|
|
@@ -94,7 +100,7 @@ export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
94
100
|
* @param {*} [options] Override http request option.
|
|
95
101
|
* @throws {RequiredError}
|
|
96
102
|
*/
|
|
97
|
-
deleteDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
103
|
+
deleteDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
98
104
|
/**
|
|
99
105
|
* Get a pre-signed download url for the given docx template.
|
|
100
106
|
* @summary Get pre-signed url for downloading docx template
|
|
@@ -103,7 +109,7 @@ export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
103
109
|
* @param {*} [options] Override http request option.
|
|
104
110
|
* @throws {RequiredError}
|
|
105
111
|
*/
|
|
106
|
-
downloadDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
112
|
+
downloadDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocxTemplateDownloadUrlResponseClass>>;
|
|
107
113
|
/**
|
|
108
114
|
* Get a docx template.
|
|
109
115
|
* @summary Retrieve the docx template
|
|
@@ -112,7 +118,7 @@ export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
112
118
|
* @param {*} [options] Override http request option.
|
|
113
119
|
* @throws {RequiredError}
|
|
114
120
|
*/
|
|
115
|
-
getDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
121
|
+
getDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocxTemplateResponseClass>>;
|
|
116
122
|
/**
|
|
117
123
|
* Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
118
124
|
* @summary List docx templates
|
|
@@ -127,7 +133,7 @@ export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
127
133
|
* @param {*} [options] Override http request option.
|
|
128
134
|
* @throws {RequiredError}
|
|
129
135
|
*/
|
|
130
|
-
listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
136
|
+
listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocxTemplatesResponseClass>>;
|
|
131
137
|
/**
|
|
132
138
|
* Updates a docx template metadata.
|
|
133
139
|
* @summary Update the docx template
|
|
@@ -137,7 +143,7 @@ export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
137
143
|
* @param {*} [options] Override http request option.
|
|
138
144
|
* @throws {RequiredError}
|
|
139
145
|
*/
|
|
140
|
-
updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
146
|
+
updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocxTemplateResponseClass>>;
|
|
141
147
|
/**
|
|
142
148
|
* Upload a docx template via a presigned Url.
|
|
143
149
|
* @summary Upload a docx template.
|
|
@@ -146,7 +152,7 @@ export declare const DocxTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
146
152
|
* @param {*} [options] Override http request option.
|
|
147
153
|
* @throws {RequiredError}
|
|
148
154
|
*/
|
|
149
|
-
uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
155
|
+
uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
|
|
150
156
|
};
|
|
151
157
|
/**
|
|
152
158
|
* DocxTemplatesApi - factory interface
|
|
@@ -161,7 +167,7 @@ export declare const DocxTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
161
167
|
* @param {*} [options] Override http request option.
|
|
162
168
|
* @throws {RequiredError}
|
|
163
169
|
*/
|
|
164
|
-
deleteDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
170
|
+
deleteDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
165
171
|
/**
|
|
166
172
|
* Get a pre-signed download url for the given docx template.
|
|
167
173
|
* @summary Get pre-signed url for downloading docx template
|
|
@@ -170,7 +176,7 @@ export declare const DocxTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
170
176
|
* @param {*} [options] Override http request option.
|
|
171
177
|
* @throws {RequiredError}
|
|
172
178
|
*/
|
|
173
|
-
downloadDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
179
|
+
downloadDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<GetDocxTemplateDownloadUrlResponseClass>;
|
|
174
180
|
/**
|
|
175
181
|
* Get a docx template.
|
|
176
182
|
* @summary Retrieve the docx template
|
|
@@ -179,7 +185,7 @@ export declare const DocxTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
179
185
|
* @param {*} [options] Override http request option.
|
|
180
186
|
* @throws {RequiredError}
|
|
181
187
|
*/
|
|
182
|
-
getDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
188
|
+
getDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<GetDocxTemplateResponseClass>;
|
|
183
189
|
/**
|
|
184
190
|
* Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
185
191
|
* @summary List docx templates
|
|
@@ -194,7 +200,7 @@ export declare const DocxTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
194
200
|
* @param {*} [options] Override http request option.
|
|
195
201
|
* @throws {RequiredError}
|
|
196
202
|
*/
|
|
197
|
-
listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
203
|
+
listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDocxTemplatesResponseClass>;
|
|
198
204
|
/**
|
|
199
205
|
* Updates a docx template metadata.
|
|
200
206
|
* @summary Update the docx template
|
|
@@ -204,7 +210,7 @@ export declare const DocxTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
204
210
|
* @param {*} [options] Override http request option.
|
|
205
211
|
* @throws {RequiredError}
|
|
206
212
|
*/
|
|
207
|
-
updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
213
|
+
updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocxTemplateResponseClass>;
|
|
208
214
|
/**
|
|
209
215
|
* Upload a docx template via a presigned Url.
|
|
210
216
|
* @summary Upload a docx template.
|
|
@@ -213,7 +219,7 @@ export declare const DocxTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
213
219
|
* @param {*} [options] Override http request option.
|
|
214
220
|
* @throws {RequiredError}
|
|
215
221
|
*/
|
|
216
|
-
uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
222
|
+
uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
|
|
217
223
|
};
|
|
218
224
|
/**
|
|
219
225
|
* Request parameters for deleteDocxTemplate operation in DocxTemplatesApi.
|
|
@@ -386,7 +392,7 @@ export declare class DocxTemplatesApi extends BaseAPI {
|
|
|
386
392
|
* @throws {RequiredError}
|
|
387
393
|
* @memberof DocxTemplatesApi
|
|
388
394
|
*/
|
|
389
|
-
deleteDocxTemplate(requestParameters: DocxTemplatesApiDeleteDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
395
|
+
deleteDocxTemplate(requestParameters: DocxTemplatesApiDeleteDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
390
396
|
/**
|
|
391
397
|
* Get a pre-signed download url for the given docx template.
|
|
392
398
|
* @summary Get pre-signed url for downloading docx template
|
|
@@ -395,7 +401,7 @@ export declare class DocxTemplatesApi extends BaseAPI {
|
|
|
395
401
|
* @throws {RequiredError}
|
|
396
402
|
* @memberof DocxTemplatesApi
|
|
397
403
|
*/
|
|
398
|
-
downloadDocxTemplate(requestParameters: DocxTemplatesApiDownloadDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
404
|
+
downloadDocxTemplate(requestParameters: DocxTemplatesApiDownloadDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocxTemplateDownloadUrlResponseClass, any>>;
|
|
399
405
|
/**
|
|
400
406
|
* Get a docx template.
|
|
401
407
|
* @summary Retrieve the docx template
|
|
@@ -404,7 +410,7 @@ export declare class DocxTemplatesApi extends BaseAPI {
|
|
|
404
410
|
* @throws {RequiredError}
|
|
405
411
|
* @memberof DocxTemplatesApi
|
|
406
412
|
*/
|
|
407
|
-
getDocxTemplate(requestParameters: DocxTemplatesApiGetDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
413
|
+
getDocxTemplate(requestParameters: DocxTemplatesApiGetDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocxTemplateResponseClass, any>>;
|
|
408
414
|
/**
|
|
409
415
|
* Returns a list of docx templates you have previously created. The docx templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
410
416
|
* @summary List docx templates
|
|
@@ -413,7 +419,7 @@ export declare class DocxTemplatesApi extends BaseAPI {
|
|
|
413
419
|
* @throws {RequiredError}
|
|
414
420
|
* @memberof DocxTemplatesApi
|
|
415
421
|
*/
|
|
416
|
-
listDocxTemplates(requestParameters?: DocxTemplatesApiListDocxTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
422
|
+
listDocxTemplates(requestParameters?: DocxTemplatesApiListDocxTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocxTemplatesResponseClass, any>>;
|
|
417
423
|
/**
|
|
418
424
|
* Updates a docx template metadata.
|
|
419
425
|
* @summary Update the docx template
|
|
@@ -422,7 +428,7 @@ export declare class DocxTemplatesApi extends BaseAPI {
|
|
|
422
428
|
* @throws {RequiredError}
|
|
423
429
|
* @memberof DocxTemplatesApi
|
|
424
430
|
*/
|
|
425
|
-
updateDocxTemplate(requestParameters: DocxTemplatesApiUpdateDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
431
|
+
updateDocxTemplate(requestParameters: DocxTemplatesApiUpdateDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocxTemplateResponseClass, any>>;
|
|
426
432
|
/**
|
|
427
433
|
* Upload a docx template via a presigned Url.
|
|
428
434
|
* @summary Upload a docx template.
|
|
@@ -431,5 +437,5 @@ export declare class DocxTemplatesApi extends BaseAPI {
|
|
|
431
437
|
* @throws {RequiredError}
|
|
432
438
|
* @memberof DocxTemplatesApi
|
|
433
439
|
*/
|
|
434
|
-
uploadDocxTemplate(requestParameters: DocxTemplatesApiUploadDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
440
|
+
uploadDocxTemplate(requestParameters: DocxTemplatesApiUploadDocxTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
|
|
435
441
|
}
|
|
@@ -13,7 +13,12 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateLayoutRequestDto } from '../models';
|
|
16
|
+
import { CreateLayoutResponseClass } from '../models';
|
|
17
|
+
import { DeleteResponseClass } from '../models';
|
|
18
|
+
import { GetLayoutResponseClass } from '../models';
|
|
19
|
+
import { ListLayoutsResponseClass } from '../models';
|
|
16
20
|
import { UpdateLayoutRequestDto } from '../models';
|
|
21
|
+
import { UpdateLayoutResponseClass } from '../models';
|
|
17
22
|
/**
|
|
18
23
|
* LayoutsApi - axios parameter creator
|
|
19
24
|
* @export
|
|
@@ -86,7 +91,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
86
91
|
* @param {*} [options] Override http request option.
|
|
87
92
|
* @throws {RequiredError}
|
|
88
93
|
*/
|
|
89
|
-
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
94
|
+
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLayoutResponseClass>>;
|
|
90
95
|
/**
|
|
91
96
|
* Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
|
|
92
97
|
* @summary Delete the layout
|
|
@@ -95,7 +100,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
95
100
|
* @param {*} [options] Override http request option.
|
|
96
101
|
* @throws {RequiredError}
|
|
97
102
|
*/
|
|
98
|
-
deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
103
|
+
deleteLayout(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
99
104
|
/**
|
|
100
105
|
* Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
|
|
101
106
|
* @summary Retrieve the layout
|
|
@@ -105,7 +110,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
105
110
|
* @param {*} [options] Override http request option.
|
|
106
111
|
* @throws {RequiredError}
|
|
107
112
|
*/
|
|
108
|
-
getLayout(id: string, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
113
|
+
getLayout(id: string, id2: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLayoutResponseClass>>;
|
|
109
114
|
/**
|
|
110
115
|
* Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
111
116
|
* @summary List layouts
|
|
@@ -120,7 +125,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
120
125
|
* @param {*} [options] Override http request option.
|
|
121
126
|
* @throws {RequiredError}
|
|
122
127
|
*/
|
|
123
|
-
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
128
|
+
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLayoutsResponseClass>>;
|
|
124
129
|
/**
|
|
125
130
|
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
126
131
|
* @summary Update the layout
|
|
@@ -130,7 +135,7 @@ export declare const LayoutsApiFp: (configuration?: Configuration) => {
|
|
|
130
135
|
* @param {*} [options] Override http request option.
|
|
131
136
|
* @throws {RequiredError}
|
|
132
137
|
*/
|
|
133
|
-
updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
138
|
+
updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLayoutResponseClass>>;
|
|
134
139
|
};
|
|
135
140
|
/**
|
|
136
141
|
* LayoutsApi - factory interface
|
|
@@ -145,7 +150,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
145
150
|
* @param {*} [options] Override http request option.
|
|
146
151
|
* @throws {RequiredError}
|
|
147
152
|
*/
|
|
148
|
-
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
153
|
+
createLayout(createLayoutRequestDto: CreateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLayoutResponseClass>;
|
|
149
154
|
/**
|
|
150
155
|
* Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
|
|
151
156
|
* @summary Delete the layout
|
|
@@ -154,7 +159,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
154
159
|
* @param {*} [options] Override http request option.
|
|
155
160
|
* @throws {RequiredError}
|
|
156
161
|
*/
|
|
157
|
-
deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<
|
|
162
|
+
deleteLayout(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
158
163
|
/**
|
|
159
164
|
* Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
|
|
160
165
|
* @summary Retrieve the layout
|
|
@@ -164,7 +169,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
164
169
|
* @param {*} [options] Override http request option.
|
|
165
170
|
* @throws {RequiredError}
|
|
166
171
|
*/
|
|
167
|
-
getLayout(id: string, id2: number, authorization?: string, options?: any): AxiosPromise<
|
|
172
|
+
getLayout(id: string, id2: number, authorization?: string, options?: any): AxiosPromise<GetLayoutResponseClass>;
|
|
168
173
|
/**
|
|
169
174
|
* Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
170
175
|
* @summary List layouts
|
|
@@ -179,7 +184,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
179
184
|
* @param {*} [options] Override http request option.
|
|
180
185
|
* @throws {RequiredError}
|
|
181
186
|
*/
|
|
182
|
-
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
187
|
+
listLayouts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListLayoutsResponseClass>;
|
|
183
188
|
/**
|
|
184
189
|
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
185
190
|
* @summary Update the layout
|
|
@@ -189,7 +194,7 @@ export declare const LayoutsApiFactory: (configuration?: Configuration, basePath
|
|
|
189
194
|
* @param {*} [options] Override http request option.
|
|
190
195
|
* @throws {RequiredError}
|
|
191
196
|
*/
|
|
192
|
-
updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
197
|
+
updateLayout(id: number, updateLayoutRequestDto: UpdateLayoutRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLayoutResponseClass>;
|
|
193
198
|
};
|
|
194
199
|
/**
|
|
195
200
|
* Request parameters for createLayout operation in LayoutsApi.
|
|
@@ -349,7 +354,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
349
354
|
* @throws {RequiredError}
|
|
350
355
|
* @memberof LayoutsApi
|
|
351
356
|
*/
|
|
352
|
-
createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
357
|
+
createLayout(requestParameters: LayoutsApiCreateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLayoutResponseClass, any>>;
|
|
353
358
|
/**
|
|
354
359
|
* Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
|
|
355
360
|
* @summary Delete the layout
|
|
@@ -358,7 +363,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
358
363
|
* @throws {RequiredError}
|
|
359
364
|
* @memberof LayoutsApi
|
|
360
365
|
*/
|
|
361
|
-
deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
366
|
+
deleteLayout(requestParameters: LayoutsApiDeleteLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
362
367
|
/**
|
|
363
368
|
* Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
|
|
364
369
|
* @summary Retrieve the layout
|
|
@@ -367,7 +372,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
367
372
|
* @throws {RequiredError}
|
|
368
373
|
* @memberof LayoutsApi
|
|
369
374
|
*/
|
|
370
|
-
getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
375
|
+
getLayout(requestParameters: LayoutsApiGetLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLayoutResponseClass, any>>;
|
|
371
376
|
/**
|
|
372
377
|
* Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
373
378
|
* @summary List layouts
|
|
@@ -376,7 +381,7 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
376
381
|
* @throws {RequiredError}
|
|
377
382
|
* @memberof LayoutsApi
|
|
378
383
|
*/
|
|
379
|
-
listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
384
|
+
listLayouts(requestParameters?: LayoutsApiListLayoutsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLayoutsResponseClass, any>>;
|
|
380
385
|
/**
|
|
381
386
|
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
382
387
|
* @summary Update the layout
|
|
@@ -385,5 +390,5 @@ export declare class LayoutsApi extends BaseAPI {
|
|
|
385
390
|
* @throws {RequiredError}
|
|
386
391
|
* @memberof LayoutsApi
|
|
387
392
|
*/
|
|
388
|
-
updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
393
|
+
updateLayout(requestParameters: LayoutsApiUpdateLayoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLayoutResponseClass, any>>;
|
|
389
394
|
}
|