@emilgroup/document-sdk 1.24.1-beta.0 → 1.26.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/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.24.1-beta.0 --save
20
+ npm install @emilgroup/document-sdk@1.26.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk@1.24.1-beta.0
24
+ yarn add @emilgroup/document-sdk@1.26.0
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -175,16 +175,14 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
175
175
  * This will return a presigned URL to download the document.
176
176
  * @summary Fetches a document download URL
177
177
  * @param {string} code Document code
178
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
179
178
  * @param {string} [authorization] Bearer Token
179
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
180
180
  * @param {*} [options] Override http request option.
181
181
  * @throws {RequiredError}
182
182
  */
183
- getDocumentDownloadUrl: async (code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
183
+ getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
184
184
  // verify required parameter 'code' is not null or undefined
185
185
  assertParamExists('getDocumentDownloadUrl', 'code', code)
186
- // verify required parameter 'contentDisposition' is not null or undefined
187
- assertParamExists('getDocumentDownloadUrl', 'contentDisposition', contentDisposition)
188
186
  const localVarPath = `/documentservice/v1/documents/{code}/download-url`
189
187
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
190
188
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -227,16 +225,13 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
227
225
  * This will return a presigned URL for a random S3 key
228
226
  * @summary Fetches a presigned URL for a S3 key
229
227
  * @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.
231
228
  * @param {string} [authorization] Bearer Token
232
229
  * @param {*} [options] Override http request option.
233
230
  * @throws {RequiredError}
234
231
  */
235
- getSignedS3keyUrl: async (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
232
+ getSignedS3keyUrl: async (s3Key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
236
233
  // verify required parameter 's3Key' is not null or undefined
237
234
  assertParamExists('getSignedS3keyUrl', 's3Key', s3Key)
238
- // verify required parameter 'contentDisposition' is not null or undefined
239
- assertParamExists('getSignedS3keyUrl', 'contentDisposition', contentDisposition)
240
235
  const localVarPath = `/documentservice/v1/documents/signed-s3-url`;
241
236
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
242
237
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -259,10 +254,6 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
259
254
  localVarQueryParameter['s3Key'] = s3Key;
260
255
  }
261
256
 
262
- if (contentDisposition !== undefined) {
263
- localVarQueryParameter['contentDisposition'] = contentDisposition;
264
- }
265
-
266
257
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
267
258
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
268
259
  }
@@ -455,26 +446,25 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
455
446
  * This will return a presigned URL to download the document.
456
447
  * @summary Fetches a document download URL
457
448
  * @param {string} code Document code
458
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
459
449
  * @param {string} [authorization] Bearer Token
450
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
460
451
  * @param {*} [options] Override http request option.
461
452
  * @throws {RequiredError}
462
453
  */
463
- async getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
464
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options);
454
+ async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
455
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
465
456
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
466
457
  },
467
458
  /**
468
459
  * This will return a presigned URL for a random S3 key
469
460
  * @summary Fetches a presigned URL for a S3 key
470
461
  * @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.
472
462
  * @param {string} [authorization] Bearer Token
473
463
  * @param {*} [options] Override http request option.
474
464
  * @throws {RequiredError}
475
465
  */
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);
466
+ async getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
467
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options);
478
468
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
479
469
  },
480
470
  /**
@@ -555,25 +545,24 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
555
545
  * This will return a presigned URL to download the document.
556
546
  * @summary Fetches a document download URL
557
547
  * @param {string} code Document code
558
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
559
548
  * @param {string} [authorization] Bearer Token
549
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
560
550
  * @param {*} [options] Override http request option.
561
551
  * @throws {RequiredError}
562
552
  */
563
- getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
564
- return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then((request) => request(axios, basePath));
553
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void> {
554
+ return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
565
555
  },
566
556
  /**
567
557
  * This will return a presigned URL for a random S3 key
568
558
  * @summary Fetches a presigned URL for a S3 key
569
559
  * @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.
571
560
  * @param {string} [authorization] Bearer Token
572
561
  * @param {*} [options] Override http request option.
573
562
  * @throws {RequiredError}
574
563
  */
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));
564
+ getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void> {
565
+ return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then((request) => request(axios, basePath));
577
566
  },
578
567
  /**
579
568
  * 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.
@@ -684,18 +673,18 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
684
673
  readonly code: string
685
674
 
686
675
  /**
687
- * Content disposition override. Default will be depending on the document type.
688
- * @type {'attachment' | 'inline'}
676
+ * Bearer Token
677
+ * @type {string}
689
678
  * @memberof DocumentsApiGetDocumentDownloadUrl
690
679
  */
691
- readonly contentDisposition: 'attachment' | 'inline'
680
+ readonly authorization?: string
692
681
 
693
682
  /**
694
- * Bearer Token
695
- * @type {string}
683
+ * Content disposition override. Default will be depending on the document type.
684
+ * @type {'attachment' | 'inline'}
696
685
  * @memberof DocumentsApiGetDocumentDownloadUrl
697
686
  */
698
- readonly authorization?: string
687
+ readonly contentDisposition?: 'attachment' | 'inline'
699
688
  }
700
689
 
701
690
  /**
@@ -711,13 +700,6 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
711
700
  */
712
701
  readonly s3Key: string
713
702
 
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
-
721
703
  /**
722
704
  * Bearer Token
723
705
  * @type {string}
@@ -869,7 +851,7 @@ export class DocumentsApi extends BaseAPI {
869
851
  * @memberof DocumentsApi
870
852
  */
871
853
  public getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig) {
872
- return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
854
+ return DocumentsApiFp(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
873
855
  }
874
856
 
875
857
  /**
@@ -881,7 +863,7 @@ export class DocumentsApi extends BaseAPI {
881
863
  * @memberof DocumentsApi
882
864
  */
883
865
  public getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig) {
884
- return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
866
+ return DocumentsApiFp(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
885
867
  }
886
868
 
887
869
  /**
@@ -84,18 +84,16 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
84
84
  * @summary Get pre-signed url for downloading product document
85
85
  * @param {string} productSlug Product slug
86
86
  * @param {string} code Product document code
87
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
88
87
  * @param {string} [authorization] Bearer Token
88
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
89
89
  * @param {*} [options] Override http request option.
90
90
  * @throws {RequiredError}
91
91
  */
92
- downloadProductDocument: async (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
92
+ downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
93
93
  // verify required parameter 'productSlug' is not null or undefined
94
94
  assertParamExists('downloadProductDocument', 'productSlug', productSlug)
95
95
  // verify required parameter 'code' is not null or undefined
96
96
  assertParamExists('downloadProductDocument', 'code', code)
97
- // verify required parameter 'contentDisposition' is not null or undefined
98
- assertParamExists('downloadProductDocument', 'contentDisposition', contentDisposition)
99
97
  const localVarPath = `/documentservice/v1/product-documents/{productSlug}/{code}/download-url`
100
98
  .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)))
101
99
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
@@ -343,13 +341,13 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
343
341
  * @summary Get pre-signed url for downloading product document
344
342
  * @param {string} productSlug Product slug
345
343
  * @param {string} code Product document code
346
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
347
344
  * @param {string} [authorization] Bearer Token
345
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
348
346
  * @param {*} [options] Override http request option.
349
347
  * @throws {RequiredError}
350
348
  */
351
- async downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
352
- const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options);
349
+ async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
350
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
353
351
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
352
  },
355
353
  /**
@@ -424,13 +422,13 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
424
422
  * @summary Get pre-signed url for downloading product document
425
423
  * @param {string} productSlug Product slug
426
424
  * @param {string} code Product document code
427
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
428
425
  * @param {string} [authorization] Bearer Token
426
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
429
427
  * @param {*} [options] Override http request option.
430
428
  * @throws {RequiredError}
431
429
  */
432
- downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void> {
433
- return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then((request) => request(axios, basePath));
430
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void> {
431
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
434
432
  },
435
433
  /**
436
434
  * Get a product document.
@@ -526,18 +524,18 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
526
524
  readonly code: string
527
525
 
528
526
  /**
529
- * Content disposition override. Default will be depending on the document type.
530
- * @type {'attachment' | 'inline'}
527
+ * Bearer Token
528
+ * @type {string}
531
529
  * @memberof ProductDocumentsApiDownloadProductDocument
532
530
  */
533
- readonly contentDisposition: 'attachment' | 'inline'
531
+ readonly authorization?: string
534
532
 
535
533
  /**
536
- * Bearer Token
537
- * @type {string}
534
+ * Content disposition override. Default will be depending on the document type.
535
+ * @type {'attachment' | 'inline'}
538
536
  * @memberof ProductDocumentsApiDownloadProductDocument
539
537
  */
540
- readonly authorization?: string
538
+ readonly contentDisposition?: 'attachment' | 'inline'
541
539
  }
542
540
 
543
541
  /**
@@ -694,7 +692,7 @@ export class ProductDocumentsApi extends BaseAPI {
694
692
  * @memberof ProductDocumentsApi
695
693
  */
696
694
  public downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig) {
697
- return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
695
+ return ProductDocumentsApiFp(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then((request) => request(this.axios, this.basePath));
698
696
  }
699
697
 
700
698
  /**
@@ -51,22 +51,21 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
51
51
  * This will return a presigned URL to download the document.
52
52
  * @summary Fetches a document download URL
53
53
  * @param {string} code Document code
54
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
55
54
  * @param {string} [authorization] Bearer Token
55
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
56
56
  * @param {*} [options] Override http request option.
57
57
  * @throws {RequiredError}
58
58
  */
59
- getDocumentDownloadUrl: (code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
59
+ getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
60
60
  /**
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.
65
64
  * @param {string} [authorization] Bearer Token
66
65
  * @param {*} [options] Override http request option.
67
66
  * @throws {RequiredError}
68
67
  */
69
- getSignedS3keyUrl: (s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
69
  /**
71
70
  * 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.
72
71
  * @summary List documents
@@ -129,22 +128,21 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
129
128
  * This will return a presigned URL to download the document.
130
129
  * @summary Fetches a document download URL
131
130
  * @param {string} code Document code
132
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
133
131
  * @param {string} [authorization] Bearer Token
132
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
134
133
  * @param {*} [options] Override http request option.
135
134
  * @throws {RequiredError}
136
135
  */
137
- getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
136
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
138
137
  /**
139
138
  * This will return a presigned URL for a random S3 key
140
139
  * @summary Fetches a presigned URL for a S3 key
141
140
  * @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.
143
141
  * @param {string} [authorization] Bearer Token
144
142
  * @param {*} [options] Override http request option.
145
143
  * @throws {RequiredError}
146
144
  */
147
- getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
145
+ getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
148
146
  /**
149
147
  * 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.
150
148
  * @summary List documents
@@ -207,22 +205,21 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
207
205
  * This will return a presigned URL to download the document.
208
206
  * @summary Fetches a document download URL
209
207
  * @param {string} code Document code
210
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
211
208
  * @param {string} [authorization] Bearer Token
209
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
212
210
  * @param {*} [options] Override http request option.
213
211
  * @throws {RequiredError}
214
212
  */
215
- getDocumentDownloadUrl(code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
213
+ getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void>;
216
214
  /**
217
215
  * This will return a presigned URL for a random S3 key
218
216
  * @summary Fetches a presigned URL for a S3 key
219
217
  * @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.
221
218
  * @param {string} [authorization] Bearer Token
222
219
  * @param {*} [options] Override http request option.
223
220
  * @throws {RequiredError}
224
221
  */
225
- getSignedS3keyUrl(s3Key: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
222
+ getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<void>;
226
223
  /**
227
224
  * 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.
228
225
  * @summary List documents
@@ -318,18 +315,18 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
318
315
  * @memberof DocumentsApiGetDocumentDownloadUrl
319
316
  */
320
317
  readonly code: string;
321
- /**
322
- * Content disposition override. Default will be depending on the document type.
323
- * @type {'attachment' | 'inline'}
324
- * @memberof DocumentsApiGetDocumentDownloadUrl
325
- */
326
- readonly contentDisposition: 'attachment' | 'inline';
327
318
  /**
328
319
  * Bearer Token
329
320
  * @type {string}
330
321
  * @memberof DocumentsApiGetDocumentDownloadUrl
331
322
  */
332
323
  readonly authorization?: string;
324
+ /**
325
+ * Content disposition override. Default will be depending on the document type.
326
+ * @type {'attachment' | 'inline'}
327
+ * @memberof DocumentsApiGetDocumentDownloadUrl
328
+ */
329
+ readonly contentDisposition?: 'attachment' | 'inline';
333
330
  }
334
331
  /**
335
332
  * Request parameters for getSignedS3keyUrl operation in DocumentsApi.
@@ -343,12 +340,6 @@ export interface DocumentsApiGetSignedS3keyUrlRequest {
343
340
  * @memberof DocumentsApiGetSignedS3keyUrl
344
341
  */
345
342
  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';
352
343
  /**
353
344
  * Bearer Token
354
345
  * @type {string}
@@ -242,12 +242,12 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
242
242
  * This will return a presigned URL to download the document.
243
243
  * @summary Fetches a document download URL
244
244
  * @param {string} code Document code
245
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
246
245
  * @param {string} [authorization] Bearer Token
246
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
247
247
  * @param {*} [options] Override http request option.
248
248
  * @throws {RequiredError}
249
249
  */
250
- getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
250
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
251
251
  if (options === void 0) { options = {}; }
252
252
  return __awaiter(_this, void 0, void 0, function () {
253
253
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -256,8 +256,6 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
256
256
  case 0:
257
257
  // verify required parameter 'code' is not null or undefined
258
258
  (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'code', code);
259
- // verify required parameter 'contentDisposition' is not null or undefined
260
- (0, common_1.assertParamExists)('getDocumentDownloadUrl', 'contentDisposition', contentDisposition);
261
259
  localVarPath = "/documentservice/v1/documents/{code}/download-url"
262
260
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
263
261
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -296,12 +294,11 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
296
294
  * This will return a presigned URL for a random S3 key
297
295
  * @summary Fetches a presigned URL for a S3 key
298
296
  * @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.
300
297
  * @param {string} [authorization] Bearer Token
301
298
  * @param {*} [options] Override http request option.
302
299
  * @throws {RequiredError}
303
300
  */
304
- getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
301
+ getSignedS3keyUrl: function (s3Key, authorization, options) {
305
302
  if (options === void 0) { options = {}; }
306
303
  return __awaiter(_this, void 0, void 0, function () {
307
304
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -310,8 +307,6 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
310
307
  case 0:
311
308
  // verify required parameter 's3Key' is not null or undefined
312
309
  (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);
315
310
  localVarPath = "/documentservice/v1/documents/signed-s3-url";
316
311
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
317
312
  if (configuration) {
@@ -331,9 +326,6 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
331
326
  if (s3Key !== undefined) {
332
327
  localVarQueryParameter['s3Key'] = s3Key;
333
328
  }
334
- if (contentDisposition !== undefined) {
335
- localVarQueryParameter['contentDisposition'] = contentDisposition;
336
- }
337
329
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
338
330
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
339
331
  }
@@ -550,17 +542,17 @@ var DocumentsApiFp = function (configuration) {
550
542
  * This will return a presigned URL to download the document.
551
543
  * @summary Fetches a document download URL
552
544
  * @param {string} code Document code
553
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
554
545
  * @param {string} [authorization] Bearer Token
546
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
555
547
  * @param {*} [options] Override http request option.
556
548
  * @throws {RequiredError}
557
549
  */
558
- getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
550
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
559
551
  return __awaiter(this, void 0, void 0, function () {
560
552
  var localVarAxiosArgs;
561
553
  return __generator(this, function (_a) {
562
554
  switch (_a.label) {
563
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, contentDisposition, authorization, options)];
555
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options)];
564
556
  case 1:
565
557
  localVarAxiosArgs = _a.sent();
566
558
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -572,17 +564,16 @@ var DocumentsApiFp = function (configuration) {
572
564
  * This will return a presigned URL for a random S3 key
573
565
  * @summary Fetches a presigned URL for a S3 key
574
566
  * @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.
576
567
  * @param {string} [authorization] Bearer Token
577
568
  * @param {*} [options] Override http request option.
578
569
  * @throws {RequiredError}
579
570
  */
580
- getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
571
+ getSignedS3keyUrl: function (s3Key, authorization, options) {
581
572
  return __awaiter(this, void 0, void 0, function () {
582
573
  var localVarAxiosArgs;
583
574
  return __generator(this, function (_a) {
584
575
  switch (_a.label) {
585
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options)];
576
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSignedS3keyUrl(s3Key, authorization, options)];
586
577
  case 1:
587
578
  localVarAxiosArgs = _a.sent();
588
579
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -686,25 +677,24 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
686
677
  * This will return a presigned URL to download the document.
687
678
  * @summary Fetches a document download URL
688
679
  * @param {string} code Document code
689
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
690
680
  * @param {string} [authorization] Bearer Token
681
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
691
682
  * @param {*} [options] Override http request option.
692
683
  * @throws {RequiredError}
693
684
  */
694
- getDocumentDownloadUrl: function (code, contentDisposition, authorization, options) {
695
- return localVarFp.getDocumentDownloadUrl(code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
685
+ getDocumentDownloadUrl: function (code, authorization, contentDisposition, options) {
686
+ return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
696
687
  },
697
688
  /**
698
689
  * This will return a presigned URL for a random S3 key
699
690
  * @summary Fetches a presigned URL for a S3 key
700
691
  * @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.
702
692
  * @param {string} [authorization] Bearer Token
703
693
  * @param {*} [options] Override http request option.
704
694
  * @throws {RequiredError}
705
695
  */
706
- getSignedS3keyUrl: function (s3Key, contentDisposition, authorization, options) {
707
- return localVarFp.getSignedS3keyUrl(s3Key, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
696
+ getSignedS3keyUrl: function (s3Key, authorization, options) {
697
+ return localVarFp.getSignedS3keyUrl(s3Key, authorization, options).then(function (request) { return request(axios, basePath); });
708
698
  },
709
699
  /**
710
700
  * 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.
@@ -795,7 +785,7 @@ var DocumentsApi = /** @class */ (function (_super) {
795
785
  */
796
786
  DocumentsApi.prototype.getDocumentDownloadUrl = function (requestParameters, options) {
797
787
  var _this = this;
798
- return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
788
+ return (0, exports.DocumentsApiFp)(this.configuration).getDocumentDownloadUrl(requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
799
789
  };
800
790
  /**
801
791
  * This will return a presigned URL for a random S3 key
@@ -807,7 +797,7 @@ var DocumentsApi = /** @class */ (function (_super) {
807
797
  */
808
798
  DocumentsApi.prototype.getSignedS3keyUrl = function (requestParameters, options) {
809
799
  var _this = this;
810
- return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
800
+ return (0, exports.DocumentsApiFp)(this.configuration).getSignedS3keyUrl(requestParameters.s3Key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
811
801
  };
812
802
  /**
813
803
  * 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.
@@ -34,12 +34,12 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
34
34
  * @summary Get pre-signed url for downloading product document
35
35
  * @param {string} productSlug Product slug
36
36
  * @param {string} code Product document code
37
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
38
37
  * @param {string} [authorization] Bearer Token
38
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
39
39
  * @param {*} [options] Override http request option.
40
40
  * @throws {RequiredError}
41
41
  */
42
- downloadProductDocument: (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
43
  /**
44
44
  * Get a product document.
45
45
  * @summary Retrieve the product document
@@ -97,12 +97,12 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
97
97
  * @summary Get pre-signed url for downloading product document
98
98
  * @param {string} productSlug Product slug
99
99
  * @param {string} code Product document code
100
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
101
100
  * @param {string} [authorization] Bearer Token
101
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
102
102
  * @param {*} [options] Override http request option.
103
103
  * @throws {RequiredError}
104
104
  */
105
- downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
105
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
106
106
  /**
107
107
  * Get a product document.
108
108
  * @summary Retrieve the product document
@@ -160,12 +160,12 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
160
160
  * @summary Get pre-signed url for downloading product document
161
161
  * @param {string} productSlug Product slug
162
162
  * @param {string} code Product document code
163
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
164
163
  * @param {string} [authorization] Bearer Token
164
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
165
165
  * @param {*} [options] Override http request option.
166
166
  * @throws {RequiredError}
167
167
  */
168
- downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
168
+ downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<void>;
169
169
  /**
170
170
  * Get a product document.
171
171
  * @summary Retrieve the product document
@@ -246,18 +246,18 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
246
246
  * @memberof ProductDocumentsApiDownloadProductDocument
247
247
  */
248
248
  readonly code: string;
249
- /**
250
- * Content disposition override. Default will be depending on the document type.
251
- * @type {'attachment' | 'inline'}
252
- * @memberof ProductDocumentsApiDownloadProductDocument
253
- */
254
- readonly contentDisposition: 'attachment' | 'inline';
255
249
  /**
256
250
  * Bearer Token
257
251
  * @type {string}
258
252
  * @memberof ProductDocumentsApiDownloadProductDocument
259
253
  */
260
254
  readonly authorization?: string;
255
+ /**
256
+ * Content disposition override. Default will be depending on the document type.
257
+ * @type {'attachment' | 'inline'}
258
+ * @memberof ProductDocumentsApiDownloadProductDocument
259
+ */
260
+ readonly contentDisposition?: 'attachment' | 'inline';
261
261
  }
262
262
  /**
263
263
  * Request parameters for getProductDocument operation in ProductDocumentsApi.
@@ -149,12 +149,12 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
149
149
  * @summary Get pre-signed url for downloading product document
150
150
  * @param {string} productSlug Product slug
151
151
  * @param {string} code Product document code
152
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
153
152
  * @param {string} [authorization] Bearer Token
153
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
154
154
  * @param {*} [options] Override http request option.
155
155
  * @throws {RequiredError}
156
156
  */
157
- downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
157
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
158
158
  if (options === void 0) { options = {}; }
159
159
  return __awaiter(_this, void 0, void 0, function () {
160
160
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -165,8 +165,6 @@ var ProductDocumentsApiAxiosParamCreator = function (configuration) {
165
165
  (0, common_1.assertParamExists)('downloadProductDocument', 'productSlug', productSlug);
166
166
  // verify required parameter 'code' is not null or undefined
167
167
  (0, common_1.assertParamExists)('downloadProductDocument', 'code', code);
168
- // verify required parameter 'contentDisposition' is not null or undefined
169
- (0, common_1.assertParamExists)('downloadProductDocument', 'contentDisposition', contentDisposition);
170
168
  localVarPath = "/documentservice/v1/product-documents/{productSlug}/{code}/download-url"
171
169
  .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)))
172
170
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
@@ -420,17 +418,17 @@ var ProductDocumentsApiFp = function (configuration) {
420
418
  * @summary Get pre-signed url for downloading product document
421
419
  * @param {string} productSlug Product slug
422
420
  * @param {string} code Product document code
423
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
424
421
  * @param {string} [authorization] Bearer Token
422
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
425
423
  * @param {*} [options] Override http request option.
426
424
  * @throws {RequiredError}
427
425
  */
428
- downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
426
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
429
427
  return __awaiter(this, void 0, void 0, function () {
430
428
  var localVarAxiosArgs;
431
429
  return __generator(this, function (_a) {
432
430
  switch (_a.label) {
433
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, contentDisposition, authorization, options)];
431
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options)];
434
432
  case 1:
435
433
  localVarAxiosArgs = _a.sent();
436
434
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -537,13 +535,13 @@ var ProductDocumentsApiFactory = function (configuration, basePath, axios) {
537
535
  * @summary Get pre-signed url for downloading product document
538
536
  * @param {string} productSlug Product slug
539
537
  * @param {string} code Product document code
540
- * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
541
538
  * @param {string} [authorization] Bearer Token
539
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
542
540
  * @param {*} [options] Override http request option.
543
541
  * @throws {RequiredError}
544
542
  */
545
- downloadProductDocument: function (productSlug, code, contentDisposition, authorization, options) {
546
- return localVarFp.downloadProductDocument(productSlug, code, contentDisposition, authorization, options).then(function (request) { return request(axios, basePath); });
543
+ downloadProductDocument: function (productSlug, code, authorization, contentDisposition, options) {
544
+ return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then(function (request) { return request(axios, basePath); });
547
545
  },
548
546
  /**
549
547
  * Get a product document.
@@ -623,7 +621,7 @@ var ProductDocumentsApi = /** @class */ (function (_super) {
623
621
  */
624
622
  ProductDocumentsApi.prototype.downloadProductDocument = function (requestParameters, options) {
625
623
  var _this = this;
626
- return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.contentDisposition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
624
+ return (0, exports.ProductDocumentsApiFp)(this.configuration).downloadProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, requestParameters.contentDisposition, options).then(function (request) { return request(_this.axios, _this.basePath); });
627
625
  };
628
626
  /**
629
627
  * Get a product document.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk",
3
- "version": "1.24.1-beta.0",
3
+ "version": "1.26.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [