@emilgroup/document-sdk 1.22.1-beta.2 → 1.23.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 +2 -0
- package/README.md +2 -2
- package/api/documents-api.ts +22 -6
- package/api/product-documents-api.ts +20 -18
- package/base.ts +5 -1
- package/dist/api/documents-api.d.ts +12 -3
- package/dist/api/documents-api.js +14 -6
- package/dist/api/product-documents-api.d.ts +20 -19
- package/dist/api/product-documents-api.js +13 -13
- package/dist/base.d.ts +1 -0
- package/dist/base.js +4 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/list-product-documents-response-class.d.ts +31 -0
- package/dist/models/list-product-documents-response-class.js +15 -0
- package/dist/models/product-document-class.d.ts +117 -0
- package/dist/models/product-document-class.js +24 -0
- package/models/index.ts +2 -0
- package/models/list-product-documents-response-class.ts +37 -0
- package/models/product-document-class.ts +126 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -29,10 +29,12 @@ models/get-layout-request-dto.ts
|
|
|
29
29
|
models/index.ts
|
|
30
30
|
models/inline-response200.ts
|
|
31
31
|
models/inline-response503.ts
|
|
32
|
+
models/list-product-documents-response-class.ts
|
|
32
33
|
models/list-request-dto.ts
|
|
33
34
|
models/list-search-keywords-request-dto.ts
|
|
34
35
|
models/list-searchable-document-owners-request-dto.ts
|
|
35
36
|
models/list-searchable-documents-request-dto.ts
|
|
37
|
+
models/product-document-class.ts
|
|
36
38
|
models/shared-update-docx-template-request-dto.ts
|
|
37
39
|
models/update-doc-template-request-dto.ts
|
|
38
40
|
models/update-document-request-dto.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/document-sdk@1.
|
|
20
|
+
npm install @emilgroup/document-sdk@1.23.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk@1.
|
|
24
|
+
yarn add @emilgroup/document-sdk@1.23.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
package/api/documents-api.ts
CHANGED
|
@@ -227,13 +227,16 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
227
227
|
* This will return a presigned URL for a random S3 key
|
|
228
228
|
* @summary Fetches a presigned URL for a S3 key
|
|
229
229
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
230
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
230
231
|
* @param {string} [authorization] Bearer Token
|
|
231
232
|
* @param {*} [options] Override http request option.
|
|
232
233
|
* @throws {RequiredError}
|
|
233
234
|
*/
|
|
234
|
-
getSignedS3keyUrl: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
235
|
+
getSignedS3keyUrl: async (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
235
236
|
// verify required parameter 's3Key' is not null or undefined
|
|
236
237
|
assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
|
|
238
|
+
// verify required parameter 'contentDisposition' is not null or undefined
|
|
239
|
+
assertParamExists('getSignedS3keyUrl', 'contentDisposition', contentDisposition)
|
|
237
240
|
const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
|
|
238
241
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
239
242
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -256,6 +259,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
256
259
|
localVarQueryParameter['s3Key'] = s3Key;
|
|
257
260
|
}
|
|
258
261
|
|
|
262
|
+
if (contentDisposition !== undefined) {
|
|
263
|
+
localVarQueryParameter['contentDisposition'] = contentDisposition;
|
|
264
|
+
}
|
|
265
|
+
|
|
259
266
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
260
267
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
261
268
|
}
|
|
@@ -461,12 +468,13 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
461
468
|
* This will return a presigned URL for a random S3 key
|
|
462
469
|
* @summary Fetches a presigned URL for a S3 key
|
|
463
470
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
471
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
464
472
|
* @param {string} [authorization] Bearer Token
|
|
465
473
|
* @param {*} [options] Override http request option.
|
|
466
474
|
* @throws {RequiredError}
|
|
467
475
|
*/
|
|
468
|
-
async getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
469
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
|
|
476
|
+
async getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
477
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options);
|
|
470
478
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
471
479
|
},
|
|
472
480
|
/**
|
|
@@ -559,12 +567,13 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
559
567
|
* This will return a presigned URL for a random S3 key
|
|
560
568
|
* @summary Fetches a presigned URL for a S3 key
|
|
561
569
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
570
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
562
571
|
* @param {string} [authorization] Bearer Token
|
|
563
572
|
* @param {*} [options] Override http request option.
|
|
564
573
|
* @throws {RequiredError}
|
|
565
574
|
*/
|
|
566
|
-
getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
567
|
-
return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then((request) => request(axios, basePath));
|
|
575
|
+
getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
|
|
576
|
+
return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then((request) => request(axios, basePath));
|
|
568
577
|
},
|
|
569
578
|
/**
|
|
570
579
|
* 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.
|
|
@@ -702,6 +711,13 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
|
|
|
702
711
|
*/
|
|
703
712
|
readonly s3Key: string
|
|
704
713
|
|
|
714
|
+
/**
|
|
715
|
+
* Content disposition override. Default will be depending on the document type.
|
|
716
|
+
* @type {'attachment' | 'inline'}
|
|
717
|
+
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
718
|
+
*/
|
|
719
|
+
readonly contentDisposition: 'attachment' | 'inline'
|
|
720
|
+
|
|
705
721
|
/**
|
|
706
722
|
* Bearer Token
|
|
707
723
|
* @type {string}
|
|
@@ -865,7 +881,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
865
881
|
* @memberof DocumentsApi
|
|
866
882
|
*/
|
|
867
883
|
public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
|
|
868
|
-
return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
884
|
+
return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
869
885
|
}
|
|
870
886
|
|
|
871
887
|
/**
|
|
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { ListProductDocumentsResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
24
26
|
import { UploadProductDocumentRequestDto } from '../models';
|
|
25
27
|
/**
|
|
26
28
|
* ProductDocumentsApi - axios parameter creator
|
|
@@ -183,17 +185,17 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
183
185
|
};
|
|
184
186
|
},
|
|
185
187
|
/**
|
|
186
|
-
* Returns a list of product documents you have previously created.
|
|
188
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
187
189
|
* @summary List product documents
|
|
188
190
|
* @param {string} productSlug
|
|
189
191
|
* @param {string} [authorization] Bearer Token
|
|
190
192
|
* @param {number} [pageSize] Page size
|
|
191
193
|
* @param {string} [pageToken] Page token
|
|
192
|
-
* @param {string} [filter]
|
|
194
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
193
195
|
* @param {string} [search] Search query
|
|
194
|
-
* @param {string} [order]
|
|
196
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
195
197
|
* @param {string} [expand] Extra fields to fetch
|
|
196
|
-
* @param {string} [filters]
|
|
198
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
197
199
|
* @param {*} [options] Override http request option.
|
|
198
200
|
* @throws {RequiredError}
|
|
199
201
|
*/
|
|
@@ -364,21 +366,21 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
364
366
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
365
367
|
},
|
|
366
368
|
/**
|
|
367
|
-
* Returns a list of product documents you have previously created.
|
|
369
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
368
370
|
* @summary List product documents
|
|
369
371
|
* @param {string} productSlug
|
|
370
372
|
* @param {string} [authorization] Bearer Token
|
|
371
373
|
* @param {number} [pageSize] Page size
|
|
372
374
|
* @param {string} [pageToken] Page token
|
|
373
|
-
* @param {string} [filter]
|
|
375
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
374
376
|
* @param {string} [search] Search query
|
|
375
|
-
* @param {string} [order]
|
|
377
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
376
378
|
* @param {string} [expand] Extra fields to fetch
|
|
377
|
-
* @param {string} [filters]
|
|
379
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
378
380
|
* @param {*} [options] Override http request option.
|
|
379
381
|
* @throws {RequiredError}
|
|
380
382
|
*/
|
|
381
|
-
async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
383
|
+
async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
|
|
382
384
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
383
385
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
384
386
|
},
|
|
@@ -443,21 +445,21 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
443
445
|
return localVarFp.getProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
|
|
444
446
|
},
|
|
445
447
|
/**
|
|
446
|
-
* Returns a list of product documents you have previously created.
|
|
448
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
447
449
|
* @summary List product documents
|
|
448
450
|
* @param {string} productSlug
|
|
449
451
|
* @param {string} [authorization] Bearer Token
|
|
450
452
|
* @param {number} [pageSize] Page size
|
|
451
453
|
* @param {string} [pageToken] Page token
|
|
452
|
-
* @param {string} [filter]
|
|
454
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
453
455
|
* @param {string} [search] Search query
|
|
454
|
-
* @param {string} [order]
|
|
456
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
455
457
|
* @param {string} [expand] Extra fields to fetch
|
|
456
|
-
* @param {string} [filters]
|
|
458
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
457
459
|
* @param {*} [options] Override http request option.
|
|
458
460
|
* @throws {RequiredError}
|
|
459
461
|
*/
|
|
460
|
-
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
462
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
461
463
|
return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
462
464
|
},
|
|
463
465
|
/**
|
|
@@ -601,7 +603,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
|
601
603
|
readonly pageToken?: string
|
|
602
604
|
|
|
603
605
|
/**
|
|
604
|
-
*
|
|
606
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
605
607
|
* @type {string}
|
|
606
608
|
* @memberof ProductDocumentsApiListProductDocuments
|
|
607
609
|
*/
|
|
@@ -615,7 +617,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
|
615
617
|
readonly search?: string
|
|
616
618
|
|
|
617
619
|
/**
|
|
618
|
-
*
|
|
620
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
619
621
|
* @type {string}
|
|
620
622
|
* @memberof ProductDocumentsApiListProductDocuments
|
|
621
623
|
*/
|
|
@@ -629,7 +631,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
|
629
631
|
readonly expand?: string
|
|
630
632
|
|
|
631
633
|
/**
|
|
632
|
-
*
|
|
634
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
633
635
|
* @type {string}
|
|
634
636
|
* @memberof ProductDocumentsApiListProductDocuments
|
|
635
637
|
*/
|
|
@@ -708,7 +710,7 @@ export class ProductDocumentsApi extends BaseAPI {
|
|
|
708
710
|
}
|
|
709
711
|
|
|
710
712
|
/**
|
|
711
|
-
* Returns a list of product documents you have previously created.
|
|
713
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
712
714
|
* @summary List product documents
|
|
713
715
|
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
714
716
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -102,7 +102,11 @@ export class BaseAPI {
|
|
|
102
102
|
}
|
|
103
103
|
|
|
104
104
|
selectEnvironment(env: Environment) {
|
|
105
|
-
this.
|
|
105
|
+
this.selectBasePath(env);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
selectBasePath(path: string) {
|
|
109
|
+
this.configuration.basePath = path;
|
|
106
110
|
}
|
|
107
111
|
|
|
108
112
|
async authorize(username: string, password: string): Promise<void> {
|
|
@@ -61,11 +61,12 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
61
61
|
* This will return a presigned URL for a random S3 key
|
|
62
62
|
* @summary Fetches a presigned URL for a S3 key
|
|
63
63
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
64
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
64
65
|
* @param {string} [authorization] Bearer Token
|
|
65
66
|
* @param {*} [options] Override http request option.
|
|
66
67
|
* @throws {RequiredError}
|
|
67
68
|
*/
|
|
68
|
-
getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
getSignedS3keyUrl: (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
70
|
/**
|
|
70
71
|
* 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
72
|
* @summary List documents
|
|
@@ -138,11 +139,12 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
138
139
|
* This will return a presigned URL for a random S3 key
|
|
139
140
|
* @summary Fetches a presigned URL for a S3 key
|
|
140
141
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
142
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
141
143
|
* @param {string} [authorization] Bearer Token
|
|
142
144
|
* @param {*} [options] Override http request option.
|
|
143
145
|
* @throws {RequiredError}
|
|
144
146
|
*/
|
|
145
|
-
getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
147
|
+
getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
146
148
|
/**
|
|
147
149
|
* 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
150
|
* @summary List documents
|
|
@@ -215,11 +217,12 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
215
217
|
* This will return a presigned URL for a random S3 key
|
|
216
218
|
* @summary Fetches a presigned URL for a S3 key
|
|
217
219
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
220
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
218
221
|
* @param {string} [authorization] Bearer Token
|
|
219
222
|
* @param {*} [options] Override http request option.
|
|
220
223
|
* @throws {RequiredError}
|
|
221
224
|
*/
|
|
222
|
-
getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
225
|
+
getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
|
|
223
226
|
/**
|
|
224
227
|
* 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
228
|
* @summary List documents
|
|
@@ -340,6 +343,12 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
|
|
|
340
343
|
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
341
344
|
*/
|
|
342
345
|
readonly s3Key: string;
|
|
346
|
+
/**
|
|
347
|
+
* Content disposition override. Default will be depending on the document type.
|
|
348
|
+
* @type {'attachment' | 'inline'}
|
|
349
|
+
* @memberof DocumentsApiGetSignedS3keyUrl
|
|
350
|
+
*/
|
|
351
|
+
readonly contentDisposition: 'attachment' | 'inline';
|
|
343
352
|
/**
|
|
344
353
|
* Bearer Token
|
|
345
354
|
* @type {string}
|
|
@@ -296,11 +296,12 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
296
296
|
* This will return a presigned URL for a random S3 key
|
|
297
297
|
* @summary Fetches a presigned URL for a S3 key
|
|
298
298
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
299
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
299
300
|
* @param {string} [authorization] Bearer Token
|
|
300
301
|
* @param {*} [options] Override http request option.
|
|
301
302
|
* @throws {RequiredError}
|
|
302
303
|
*/
|
|
303
|
-
getSignedS3keyUrl: function (s3Key, authorization, options) {
|
|
304
|
+
getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
|
|
304
305
|
if (options === void 0) { options = {}; }
|
|
305
306
|
return __awaiter(_this, void 0, void 0, function () {
|
|
306
307
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -309,6 +310,8 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
309
310
|
case 0:
|
|
310
311
|
// verify required parameter 's3Key' is not null or undefined
|
|
311
312
|
(0, common_1.assertParamExists)('getSignedS3keyUrl', 's3Key', s3Key);
|
|
313
|
+
// verify required parameter 'contentDisposition' is not null or undefined
|
|
314
|
+
(0, common_1.assertParamExists)('getSignedS3keyUrl', 'contentDisposition', contentDisposition);
|
|
312
315
|
localVarPath = "/documentservice/v1/documents/signed-s3-url";
|
|
313
316
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
314
317
|
if (configuration) {
|
|
@@ -328,6 +331,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
328
331
|
if (s3Key !== undefined) {
|
|
329
332
|
localVarQueryParameter['s3Key'] = s3Key;
|
|
330
333
|
}
|
|
334
|
+
if (contentDisposition !== undefined) {
|
|
335
|
+
localVarQueryParameter['contentDisposition'] = contentDisposition;
|
|
336
|
+
}
|
|
331
337
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
332
338
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
333
339
|
}
|
|
@@ -566,16 +572,17 @@ var DocumentsApiFp = function (configuration) {
|
|
|
566
572
|
* This will return a presigned URL for a random S3 key
|
|
567
573
|
* @summary Fetches a presigned URL for a S3 key
|
|
568
574
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
575
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
569
576
|
* @param {string} [authorization] Bearer Token
|
|
570
577
|
* @param {*} [options] Override http request option.
|
|
571
578
|
* @throws {RequiredError}
|
|
572
579
|
*/
|
|
573
|
-
getSignedS3keyUrl: function (s3Key, authorization, options) {
|
|
580
|
+
getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
|
|
574
581
|
return __awaiter(this, void 0, void 0, function () {
|
|
575
582
|
var localVarAxiosArgs;
|
|
576
583
|
return __generator(this, function (_a) {
|
|
577
584
|
switch (_a.label) {
|
|
578
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
|
|
585
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options)];
|
|
579
586
|
case 1:
|
|
580
587
|
localVarAxiosArgs = _a.sent();
|
|
581
588
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -691,12 +698,13 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
691
698
|
* This will return a presigned URL for a random S3 key
|
|
692
699
|
* @summary Fetches a presigned URL for a S3 key
|
|
693
700
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
701
|
+
* @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
|
|
694
702
|
* @param {string} [authorization] Bearer Token
|
|
695
703
|
* @param {*} [options] Override http request option.
|
|
696
704
|
* @throws {RequiredError}
|
|
697
705
|
*/
|
|
698
|
-
getSignedS3keyUrl: function (s3Key, authorization, options) {
|
|
699
|
-
return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
706
|
+
getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
|
|
707
|
+
return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
700
708
|
},
|
|
701
709
|
/**
|
|
702
710
|
* 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.
|
|
@@ -799,7 +807,7 @@ var DocumentsApi = /** @class */ (function (_super) {
|
|
|
799
807
|
*/
|
|
800
808
|
DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
|
|
801
809
|
var _this = this;
|
|
802
|
-
return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
810
|
+
return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
803
811
|
};
|
|
804
812
|
/**
|
|
805
813
|
* 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,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { ListProductDocumentsResponseClass } from '../models';
|
|
15
16
|
import { UploadProductDocumentRequestDto } from '../models';
|
|
16
17
|
/**
|
|
17
18
|
* ProductDocumentsApi - axios parameter creator
|
|
@@ -50,17 +51,17 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
50
51
|
*/
|
|
51
52
|
getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
53
|
/**
|
|
53
|
-
* Returns a list of product documents you have previously created.
|
|
54
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
54
55
|
* @summary List product documents
|
|
55
56
|
* @param {string} productSlug
|
|
56
57
|
* @param {string} [authorization] Bearer Token
|
|
57
58
|
* @param {number} [pageSize] Page size
|
|
58
59
|
* @param {string} [pageToken] Page token
|
|
59
|
-
* @param {string} [filter]
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
60
61
|
* @param {string} [search] Search query
|
|
61
|
-
* @param {string} [order]
|
|
62
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
62
63
|
* @param {string} [expand] Extra fields to fetch
|
|
63
|
-
* @param {string} [filters]
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
64
65
|
* @param {*} [options] Override http request option.
|
|
65
66
|
* @throws {RequiredError}
|
|
66
67
|
*/
|
|
@@ -113,21 +114,21 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
113
114
|
*/
|
|
114
115
|
getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
115
116
|
/**
|
|
116
|
-
* Returns a list of product documents you have previously created.
|
|
117
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
117
118
|
* @summary List product documents
|
|
118
119
|
* @param {string} productSlug
|
|
119
120
|
* @param {string} [authorization] Bearer Token
|
|
120
121
|
* @param {number} [pageSize] Page size
|
|
121
122
|
* @param {string} [pageToken] Page token
|
|
122
|
-
* @param {string} [filter]
|
|
123
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
123
124
|
* @param {string} [search] Search query
|
|
124
|
-
* @param {string} [order]
|
|
125
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
125
126
|
* @param {string} [expand] Extra fields to fetch
|
|
126
|
-
* @param {string} [filters]
|
|
127
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
127
128
|
* @param {*} [options] Override http request option.
|
|
128
129
|
* @throws {RequiredError}
|
|
129
130
|
*/
|
|
130
|
-
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
131
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
|
|
131
132
|
/**
|
|
132
133
|
* Upload a product document.
|
|
133
134
|
* @summary Create the product document
|
|
@@ -176,21 +177,21 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
|
|
|
176
177
|
*/
|
|
177
178
|
getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
178
179
|
/**
|
|
179
|
-
* Returns a list of product documents you have previously created.
|
|
180
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
180
181
|
* @summary List product documents
|
|
181
182
|
* @param {string} productSlug
|
|
182
183
|
* @param {string} [authorization] Bearer Token
|
|
183
184
|
* @param {number} [pageSize] Page size
|
|
184
185
|
* @param {string} [pageToken] Page token
|
|
185
|
-
* @param {string} [filter]
|
|
186
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
186
187
|
* @param {string} [search] Search query
|
|
187
|
-
* @param {string} [order]
|
|
188
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
188
189
|
* @param {string} [expand] Extra fields to fetch
|
|
189
|
-
* @param {string} [filters]
|
|
190
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
190
191
|
* @param {*} [options] Override http request option.
|
|
191
192
|
* @throws {RequiredError}
|
|
192
193
|
*/
|
|
193
|
-
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<
|
|
194
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
|
|
194
195
|
/**
|
|
195
196
|
* Upload a product document.
|
|
196
197
|
* @summary Create the product document
|
|
@@ -314,7 +315,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
|
314
315
|
*/
|
|
315
316
|
readonly pageToken?: string;
|
|
316
317
|
/**
|
|
317
|
-
*
|
|
318
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
318
319
|
* @type {string}
|
|
319
320
|
* @memberof ProductDocumentsApiListProductDocuments
|
|
320
321
|
*/
|
|
@@ -326,7 +327,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
|
326
327
|
*/
|
|
327
328
|
readonly search?: string;
|
|
328
329
|
/**
|
|
329
|
-
*
|
|
330
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
330
331
|
* @type {string}
|
|
331
332
|
* @memberof ProductDocumentsApiListProductDocuments
|
|
332
333
|
*/
|
|
@@ -338,7 +339,7 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
|
338
339
|
*/
|
|
339
340
|
readonly expand?: string;
|
|
340
341
|
/**
|
|
341
|
-
*
|
|
342
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
342
343
|
* @type {string}
|
|
343
344
|
* @memberof ProductDocumentsApiListProductDocuments
|
|
344
345
|
*/
|
|
@@ -404,14 +405,14 @@ export declare class ProductDocumentsApi extends BaseAPI {
|
|
|
404
405
|
*/
|
|
405
406
|
getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
406
407
|
/**
|
|
407
|
-
* Returns a list of product documents you have previously created.
|
|
408
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
408
409
|
* @summary List product documents
|
|
409
410
|
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
410
411
|
* @param {*} [options] Override http request option.
|
|
411
412
|
* @throws {RequiredError}
|
|
412
413
|
* @memberof ProductDocumentsApi
|
|
413
414
|
*/
|
|
414
|
-
listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
415
|
+
listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
|
|
415
416
|
/**
|
|
416
417
|
* Upload a product document.
|
|
417
418
|
* @summary Create the product document
|
|
@@ -255,17 +255,17 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
});
|
|
256
256
|
},
|
|
257
257
|
/**
|
|
258
|
-
* Returns a list of product documents you have previously created.
|
|
258
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
259
259
|
* @summary List product documents
|
|
260
260
|
* @param {string} productSlug
|
|
261
261
|
* @param {string} [authorization] Bearer Token
|
|
262
262
|
* @param {number} [pageSize] Page size
|
|
263
263
|
* @param {string} [pageToken] Page token
|
|
264
|
-
* @param {string} [filter]
|
|
264
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
265
265
|
* @param {string} [search] Search query
|
|
266
|
-
* @param {string} [order]
|
|
266
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
267
267
|
* @param {string} [expand] Extra fields to fetch
|
|
268
|
-
* @param {string} [filters]
|
|
268
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
269
269
|
* @param {*} [options] Override http request option.
|
|
270
270
|
* @throws {RequiredError}
|
|
271
271
|
*/
|
|
@@ -461,17 +461,17 @@ var ProductDocumentsApiFp = function (configuration) {
|
|
|
461
461
|
});
|
|
462
462
|
},
|
|
463
463
|
/**
|
|
464
|
-
* Returns a list of product documents you have previously created.
|
|
464
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
465
465
|
* @summary List product documents
|
|
466
466
|
* @param {string} productSlug
|
|
467
467
|
* @param {string} [authorization] Bearer Token
|
|
468
468
|
* @param {number} [pageSize] Page size
|
|
469
469
|
* @param {string} [pageToken] Page token
|
|
470
|
-
* @param {string} [filter]
|
|
470
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
471
471
|
* @param {string} [search] Search query
|
|
472
|
-
* @param {string} [order]
|
|
472
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
473
473
|
* @param {string} [expand] Extra fields to fetch
|
|
474
|
-
* @param {string} [filters]
|
|
474
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
475
475
|
* @param {*} [options] Override http request option.
|
|
476
476
|
* @throws {RequiredError}
|
|
477
477
|
*/
|
|
@@ -558,17 +558,17 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
558
558
|
return localVarFp.getProductDocument(productSlug, code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
559
559
|
},
|
|
560
560
|
/**
|
|
561
|
-
* Returns a list of product documents you have previously created.
|
|
561
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
562
562
|
* @summary List product documents
|
|
563
563
|
* @param {string} productSlug
|
|
564
564
|
* @param {string} [authorization] Bearer Token
|
|
565
565
|
* @param {number} [pageSize] Page size
|
|
566
566
|
* @param {string} [pageToken] Page token
|
|
567
|
-
* @param {string} [filter]
|
|
567
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
568
568
|
* @param {string} [search] Search query
|
|
569
|
-
* @param {string} [order]
|
|
569
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, filename</i>
|
|
570
570
|
* @param {string} [expand] Extra fields to fetch
|
|
571
|
-
* @param {string} [filters]
|
|
571
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productSlug, productCode, type, createdAt</i>
|
|
572
572
|
* @param {*} [options] Override http request option.
|
|
573
573
|
* @throws {RequiredError}
|
|
574
574
|
*/
|
|
@@ -638,7 +638,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
|
|
|
638
638
|
return (0, exports.ProductDocumentsApiFp)(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
639
639
|
};
|
|
640
640
|
/**
|
|
641
|
-
* Returns a list of product documents you have previously created.
|
|
641
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
642
642
|
* @summary List product documents
|
|
643
643
|
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
644
644
|
* @param {*} [options] Override http request option.
|
package/dist/base.d.ts
CHANGED
|
@@ -54,6 +54,7 @@ export declare class BaseAPI {
|
|
|
54
54
|
private tokenData?;
|
|
55
55
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
56
56
|
selectEnvironment(env: Environment): void;
|
|
57
|
+
selectBasePath(path: string): void;
|
|
57
58
|
authorize(username: string, password: string): Promise<void>;
|
|
58
59
|
refreshTokenInternal(): Promise<string>;
|
|
59
60
|
private storeTokenData;
|
package/dist/base.js
CHANGED
|
@@ -138,7 +138,10 @@ var BaseAPI = /** @class */ (function () {
|
|
|
138
138
|
this.attachInterceptor(axios);
|
|
139
139
|
}
|
|
140
140
|
BaseAPI.prototype.selectEnvironment = function (env) {
|
|
141
|
-
this.
|
|
141
|
+
this.selectBasePath(env);
|
|
142
|
+
};
|
|
143
|
+
BaseAPI.prototype.selectBasePath = function (path) {
|
|
144
|
+
this.configuration.basePath = path;
|
|
142
145
|
};
|
|
143
146
|
BaseAPI.prototype.authorize = function (username, password) {
|
|
144
147
|
return __awaiter(this, void 0, void 0, function () {
|
package/dist/models/index.d.ts
CHANGED
|
@@ -9,10 +9,12 @@ export * from './delete-request-dto';
|
|
|
9
9
|
export * from './get-layout-request-dto';
|
|
10
10
|
export * from './inline-response200';
|
|
11
11
|
export * from './inline-response503';
|
|
12
|
+
export * from './list-product-documents-response-class';
|
|
12
13
|
export * from './list-request-dto';
|
|
13
14
|
export * from './list-search-keywords-request-dto';
|
|
14
15
|
export * from './list-searchable-document-owners-request-dto';
|
|
15
16
|
export * from './list-searchable-documents-request-dto';
|
|
17
|
+
export * from './product-document-class';
|
|
16
18
|
export * from './shared-update-docx-template-request-dto';
|
|
17
19
|
export * from './update-doc-template-request-dto';
|
|
18
20
|
export * from './update-document-request-dto';
|
package/dist/models/index.js
CHANGED
|
@@ -25,10 +25,12 @@ __exportStar(require("./delete-request-dto"), exports);
|
|
|
25
25
|
__exportStar(require("./get-layout-request-dto"), exports);
|
|
26
26
|
__exportStar(require("./inline-response200"), exports);
|
|
27
27
|
__exportStar(require("./inline-response503"), exports);
|
|
28
|
+
__exportStar(require("./list-product-documents-response-class"), exports);
|
|
28
29
|
__exportStar(require("./list-request-dto"), exports);
|
|
29
30
|
__exportStar(require("./list-search-keywords-request-dto"), exports);
|
|
30
31
|
__exportStar(require("./list-searchable-document-owners-request-dto"), exports);
|
|
31
32
|
__exportStar(require("./list-searchable-documents-request-dto"), exports);
|
|
33
|
+
__exportStar(require("./product-document-class"), exports);
|
|
32
34
|
__exportStar(require("./shared-update-docx-template-request-dto"), exports);
|
|
33
35
|
__exportStar(require("./update-doc-template-request-dto"), exports);
|
|
34
36
|
__exportStar(require("./update-document-request-dto"), exports);
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL DocumentService
|
|
3
|
+
* The EMIL DocumentService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { ProductDocumentClass } from './product-document-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ListProductDocumentsResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface ListProductDocumentsResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* The list of documents.
|
|
21
|
+
* @type {Array<ProductDocumentClass>}
|
|
22
|
+
* @memberof ListProductDocumentsResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'items': Array<ProductDocumentClass>;
|
|
25
|
+
/**
|
|
26
|
+
* Next page token.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ListProductDocumentsResponseClass
|
|
29
|
+
*/
|
|
30
|
+
'nextPageToken': string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL DocumentService
|
|
6
|
+
* The EMIL DocumentService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL DocumentService
|
|
3
|
+
* The EMIL DocumentService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ProductDocumentClass
|
|
16
|
+
*/
|
|
17
|
+
export interface ProductDocumentClass {
|
|
18
|
+
/**
|
|
19
|
+
* Internal unique identifier for the object. You should not have to use this, use code instead.
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof ProductDocumentClass
|
|
22
|
+
*/
|
|
23
|
+
'id': number;
|
|
24
|
+
/**
|
|
25
|
+
* Unique identifier for the object.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ProductDocumentClass
|
|
28
|
+
*/
|
|
29
|
+
'code': string;
|
|
30
|
+
/**
|
|
31
|
+
* Unique identifier of the product that this object belongs to.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ProductDocumentClass
|
|
34
|
+
*/
|
|
35
|
+
'productCode': string;
|
|
36
|
+
/**
|
|
37
|
+
* Unique identifier referencing the product.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof ProductDocumentClass
|
|
40
|
+
*/
|
|
41
|
+
'productVersionId': number;
|
|
42
|
+
/**
|
|
43
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ProductDocumentClass
|
|
46
|
+
*/
|
|
47
|
+
'slug': string;
|
|
48
|
+
/**
|
|
49
|
+
* Type of the product document.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ProductDocumentClass
|
|
52
|
+
*/
|
|
53
|
+
'type': string;
|
|
54
|
+
/**
|
|
55
|
+
* Description of the document. Usually a short summary about the context in which the document is being used.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof ProductDocumentClass
|
|
58
|
+
*/
|
|
59
|
+
'description': string;
|
|
60
|
+
/**
|
|
61
|
+
* The unique key used by Amazon Simple Storage Service (S3).
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof ProductDocumentClass
|
|
64
|
+
*/
|
|
65
|
+
's3Key': string;
|
|
66
|
+
/**
|
|
67
|
+
* Extension of the file.
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof ProductDocumentClass
|
|
70
|
+
*/
|
|
71
|
+
'contentType': ProductDocumentClassContentTypeEnum;
|
|
72
|
+
/**
|
|
73
|
+
* Product Document entity type.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof ProductDocumentClass
|
|
76
|
+
*/
|
|
77
|
+
'entityType': string;
|
|
78
|
+
/**
|
|
79
|
+
* The file name the end user will see when downloading it.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof ProductDocumentClass
|
|
82
|
+
*/
|
|
83
|
+
'filename': string;
|
|
84
|
+
/**
|
|
85
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof ProductDocumentClass
|
|
88
|
+
*/
|
|
89
|
+
'productSlug': string;
|
|
90
|
+
/**
|
|
91
|
+
* The current version number of the product document.
|
|
92
|
+
* @type {number}
|
|
93
|
+
* @memberof ProductDocumentClass
|
|
94
|
+
*/
|
|
95
|
+
'versionNumber': number;
|
|
96
|
+
/**
|
|
97
|
+
* Time at which the object was created.
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof ProductDocumentClass
|
|
100
|
+
*/
|
|
101
|
+
'createdAt': string;
|
|
102
|
+
/**
|
|
103
|
+
* Time at which the object was created.
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof ProductDocumentClass
|
|
106
|
+
*/
|
|
107
|
+
'updated': string;
|
|
108
|
+
}
|
|
109
|
+
export declare const ProductDocumentClassContentTypeEnum: {
|
|
110
|
+
readonly Pdf: "pdf";
|
|
111
|
+
readonly Jpg: "jpg";
|
|
112
|
+
readonly Png: "png";
|
|
113
|
+
readonly Csv: "csv";
|
|
114
|
+
readonly Doc: "doc";
|
|
115
|
+
readonly Docx: "docx";
|
|
116
|
+
};
|
|
117
|
+
export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL DocumentService
|
|
6
|
+
* The EMIL DocumentService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ProductDocumentClassContentTypeEnum = void 0;
|
|
17
|
+
exports.ProductDocumentClassContentTypeEnum = {
|
|
18
|
+
Pdf: 'pdf',
|
|
19
|
+
Jpg: 'jpg',
|
|
20
|
+
Png: 'png',
|
|
21
|
+
Csv: 'csv',
|
|
22
|
+
Doc: 'doc',
|
|
23
|
+
Docx: 'docx'
|
|
24
|
+
};
|
package/models/index.ts
CHANGED
|
@@ -9,10 +9,12 @@ export * from './delete-request-dto';
|
|
|
9
9
|
export * from './get-layout-request-dto';
|
|
10
10
|
export * from './inline-response200';
|
|
11
11
|
export * from './inline-response503';
|
|
12
|
+
export * from './list-product-documents-response-class';
|
|
12
13
|
export * from './list-request-dto';
|
|
13
14
|
export * from './list-search-keywords-request-dto';
|
|
14
15
|
export * from './list-searchable-document-owners-request-dto';
|
|
15
16
|
export * from './list-searchable-documents-request-dto';
|
|
17
|
+
export * from './product-document-class';
|
|
16
18
|
export * from './shared-update-docx-template-request-dto';
|
|
17
19
|
export * from './update-doc-template-request-dto';
|
|
18
20
|
export * from './update-document-request-dto';
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL DocumentService
|
|
5
|
+
* The EMIL DocumentService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import { ProductDocumentClass } from './product-document-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface ListProductDocumentsResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface ListProductDocumentsResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* The list of documents.
|
|
26
|
+
* @type {Array<ProductDocumentClass>}
|
|
27
|
+
* @memberof ListProductDocumentsResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'items': Array<ProductDocumentClass>;
|
|
30
|
+
/**
|
|
31
|
+
* Next page token.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ListProductDocumentsResponseClass
|
|
34
|
+
*/
|
|
35
|
+
'nextPageToken': string;
|
|
36
|
+
}
|
|
37
|
+
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL DocumentService
|
|
5
|
+
* The EMIL DocumentService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface ProductDocumentClass
|
|
21
|
+
*/
|
|
22
|
+
export interface ProductDocumentClass {
|
|
23
|
+
/**
|
|
24
|
+
* Internal unique identifier for the object. You should not have to use this, use code instead.
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof ProductDocumentClass
|
|
27
|
+
*/
|
|
28
|
+
'id': number;
|
|
29
|
+
/**
|
|
30
|
+
* Unique identifier for the object.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof ProductDocumentClass
|
|
33
|
+
*/
|
|
34
|
+
'code': string;
|
|
35
|
+
/**
|
|
36
|
+
* Unique identifier of the product that this object belongs to.
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof ProductDocumentClass
|
|
39
|
+
*/
|
|
40
|
+
'productCode': string;
|
|
41
|
+
/**
|
|
42
|
+
* Unique identifier referencing the product.
|
|
43
|
+
* @type {number}
|
|
44
|
+
* @memberof ProductDocumentClass
|
|
45
|
+
*/
|
|
46
|
+
'productVersionId': number;
|
|
47
|
+
/**
|
|
48
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof ProductDocumentClass
|
|
51
|
+
*/
|
|
52
|
+
'slug': string;
|
|
53
|
+
/**
|
|
54
|
+
* Type of the product document.
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof ProductDocumentClass
|
|
57
|
+
*/
|
|
58
|
+
'type': string;
|
|
59
|
+
/**
|
|
60
|
+
* Description of the document. Usually a short summary about the context in which the document is being used.
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof ProductDocumentClass
|
|
63
|
+
*/
|
|
64
|
+
'description': string;
|
|
65
|
+
/**
|
|
66
|
+
* The unique key used by Amazon Simple Storage Service (S3).
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof ProductDocumentClass
|
|
69
|
+
*/
|
|
70
|
+
's3Key': string;
|
|
71
|
+
/**
|
|
72
|
+
* Extension of the file.
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof ProductDocumentClass
|
|
75
|
+
*/
|
|
76
|
+
'contentType': ProductDocumentClassContentTypeEnum;
|
|
77
|
+
/**
|
|
78
|
+
* Product Document entity type.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof ProductDocumentClass
|
|
81
|
+
*/
|
|
82
|
+
'entityType': string;
|
|
83
|
+
/**
|
|
84
|
+
* The file name the end user will see when downloading it.
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof ProductDocumentClass
|
|
87
|
+
*/
|
|
88
|
+
'filename': string;
|
|
89
|
+
/**
|
|
90
|
+
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof ProductDocumentClass
|
|
93
|
+
*/
|
|
94
|
+
'productSlug': string;
|
|
95
|
+
/**
|
|
96
|
+
* The current version number of the product document.
|
|
97
|
+
* @type {number}
|
|
98
|
+
* @memberof ProductDocumentClass
|
|
99
|
+
*/
|
|
100
|
+
'versionNumber': number;
|
|
101
|
+
/**
|
|
102
|
+
* Time at which the object was created.
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof ProductDocumentClass
|
|
105
|
+
*/
|
|
106
|
+
'createdAt': string;
|
|
107
|
+
/**
|
|
108
|
+
* Time at which the object was created.
|
|
109
|
+
* @type {string}
|
|
110
|
+
* @memberof ProductDocumentClass
|
|
111
|
+
*/
|
|
112
|
+
'updated': string;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export const ProductDocumentClassContentTypeEnum = {
|
|
116
|
+
Pdf: 'pdf',
|
|
117
|
+
Jpg: 'jpg',
|
|
118
|
+
Png: 'png',
|
|
119
|
+
Csv: 'csv',
|
|
120
|
+
Doc: 'doc',
|
|
121
|
+
Docx: 'docx'
|
|
122
|
+
} as const;
|
|
123
|
+
|
|
124
|
+
export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
|
|
125
|
+
|
|
126
|
+
|