@emilgroup/document-sdk-node 1.44.1-beta.2 → 1.44.1-beta.3
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 +1 -2
- package/README.md +2 -2
- package/api/{health-api.ts → default-api.ts} +13 -13
- package/api/documents-api.ts +8 -10
- package/api/product-documents-api.ts +30 -231
- package/api.ts +2 -2
- package/dist/api/{health-api.d.ts → default-api.d.ts} +10 -10
- package/dist/api/{health-api.js → default-api.js} +22 -22
- package/dist/api/documents-api.d.ts +8 -9
- package/dist/api/documents-api.js +3 -3
- package/dist/api/product-documents-api.d.ts +26 -145
- package/dist/api/product-documents-api.js +12 -146
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/models/index.ts +0 -1
- package/package.json +1 -1
- package/dist/models/get-product-document-download-url-request-rest-dto.d.ts +0 -29
- package/dist/models/get-product-document-download-url-request-rest-dto.js +0 -20
- package/models/get-product-document-download-url-request-rest-dto.ts +0 -38
package/.openapi-generator/FILES
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
|
+
api/default-api.ts
|
|
6
7
|
api/document-templates-api.ts
|
|
7
8
|
api/documents-api.ts
|
|
8
9
|
api/docx-templates-api.ts
|
|
9
|
-
api/health-api.ts
|
|
10
10
|
api/layouts-api.ts
|
|
11
11
|
api/product-documents-api.ts
|
|
12
12
|
api/search-keywords-api.ts
|
|
@@ -44,7 +44,6 @@ models/get-docx-template-download-url-response-class.ts
|
|
|
44
44
|
models/get-docx-template-response-class.ts
|
|
45
45
|
models/get-layout-request-dto.ts
|
|
46
46
|
models/get-layout-response-class.ts
|
|
47
|
-
models/get-product-document-download-url-request-rest-dto.ts
|
|
48
47
|
models/get-product-document-download-url-response-class.ts
|
|
49
48
|
models/get-product-document-response-class.ts
|
|
50
49
|
models/get-signed-s3-key-url-response-class.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-node@1.44.1-beta.
|
|
20
|
+
npm install @emilgroup/document-sdk-node@1.44.1-beta.3 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk-node@1.44.1-beta.
|
|
24
|
+
yarn add @emilgroup/document-sdk-node@1.44.1-beta.3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
|
@@ -29,10 +29,10 @@ import { InlineResponse503 } from '../models';
|
|
|
29
29
|
import { URL, URLSearchParams } from 'url';
|
|
30
30
|
const FormData = require('form-data');
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* DefaultApi - axios parameter creator
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export const
|
|
35
|
+
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
38
|
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
@@ -70,11 +70,11 @@ export const HealthApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
70
70
|
};
|
|
71
71
|
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* DefaultApi - functional programming interface
|
|
74
74
|
* @export
|
|
75
75
|
*/
|
|
76
|
-
export const
|
|
77
|
-
const localVarAxiosParamCreator =
|
|
76
|
+
export const DefaultApiFp = function(configuration?: Configuration) {
|
|
77
|
+
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
78
78
|
return {
|
|
79
79
|
/**
|
|
80
80
|
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
@@ -90,11 +90,11 @@ export const HealthApiFp = function(configuration?: Configuration) {
|
|
|
90
90
|
};
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* DefaultApi - factory interface
|
|
94
94
|
* @export
|
|
95
95
|
*/
|
|
96
|
-
export const
|
|
97
|
-
const localVarFp =
|
|
96
|
+
export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
97
|
+
const localVarFp = DefaultApiFp(configuration)
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
100
|
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
@@ -109,20 +109,20 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat
|
|
|
109
109
|
};
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* DefaultApi - object-oriented interface
|
|
113
113
|
* @export
|
|
114
|
-
* @class
|
|
114
|
+
* @class DefaultApi
|
|
115
115
|
* @extends {BaseAPI}
|
|
116
116
|
*/
|
|
117
|
-
export class
|
|
117
|
+
export class DefaultApi extends BaseAPI {
|
|
118
118
|
/**
|
|
119
119
|
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
120
120
|
* @summary Health Check
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
|
-
* @memberof
|
|
123
|
+
* @memberof DefaultApi
|
|
124
124
|
*/
|
|
125
125
|
public check(options?: AxiosRequestConfig) {
|
|
126
|
-
return
|
|
126
|
+
return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
127
127
|
}
|
|
128
128
|
}
|
package/api/documents-api.ts
CHANGED
|
@@ -37,8 +37,6 @@ import { ExportDocumentResponseClass } from '../models';
|
|
|
37
37
|
// @ts-ignore
|
|
38
38
|
import { GetDocumentDownloadUrlResponseClass } from '../models';
|
|
39
39
|
// @ts-ignore
|
|
40
|
-
import { GetProductDocumentDownloadUrlRequestRestDto } from '../models';
|
|
41
|
-
// @ts-ignore
|
|
42
40
|
import { GetSignedS3KeyUrlResponseClass } from '../models';
|
|
43
41
|
// @ts-ignore
|
|
44
42
|
import { ListDocumentsResponseClass } from '../models';
|
|
@@ -304,11 +302,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
304
302
|
* @summary Fetches a document download URL
|
|
305
303
|
* @param {string} code Document code
|
|
306
304
|
* @param {string} [authorization] Bearer Token
|
|
307
|
-
* @param {
|
|
305
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
308
306
|
* @param {*} [options] Override http request option.
|
|
309
307
|
* @throws {RequiredError}
|
|
310
308
|
*/
|
|
311
|
-
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?:
|
|
309
|
+
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
312
310
|
// verify required parameter 'code' is not null or undefined
|
|
313
311
|
assertParamExists('getDocumentDownloadUrl', 'code', code)
|
|
314
312
|
const localVarPath = `/documentservice/v1/documents/{code}/download-url`
|
|
@@ -699,11 +697,11 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
699
697
|
* @summary Fetches a document download URL
|
|
700
698
|
* @param {string} code Document code
|
|
701
699
|
* @param {string} [authorization] Bearer Token
|
|
702
|
-
* @param {
|
|
700
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
703
701
|
* @param {*} [options] Override http request option.
|
|
704
702
|
* @throws {RequiredError}
|
|
705
703
|
*/
|
|
706
|
-
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
704
|
+
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>> {
|
|
707
705
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
|
|
708
706
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
709
707
|
},
|
|
@@ -846,11 +844,11 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
846
844
|
* @summary Fetches a document download URL
|
|
847
845
|
* @param {string} code Document code
|
|
848
846
|
* @param {string} [authorization] Bearer Token
|
|
849
|
-
* @param {
|
|
847
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
850
848
|
* @param {*} [options] Override http request option.
|
|
851
849
|
* @throws {RequiredError}
|
|
852
850
|
*/
|
|
853
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
851
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
|
|
854
852
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
855
853
|
},
|
|
856
854
|
/**
|
|
@@ -1053,10 +1051,10 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
|
|
|
1053
1051
|
|
|
1054
1052
|
/**
|
|
1055
1053
|
* Content disposition override. Default will be depending on the document type.
|
|
1056
|
-
* @type {
|
|
1054
|
+
* @type {'attachment' | 'inline'}
|
|
1057
1055
|
* @memberof DocumentsApiGetDocumentDownloadUrl
|
|
1058
1056
|
*/
|
|
1059
|
-
readonly contentDisposition?:
|
|
1057
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
1060
1058
|
}
|
|
1061
1059
|
|
|
1062
1060
|
/**
|
|
@@ -23,8 +23,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreatePresignedPostResponseClass } from '../models';
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { GetProductDocumentDownloadUrlRequestRestDto } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
26
|
import { GetProductDocumentDownloadUrlResponseClass } from '../models';
|
|
29
27
|
// @ts-ignore
|
|
30
28
|
import { GetProductDocumentResponseClass } from '../models';
|
|
@@ -97,11 +95,11 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
97
95
|
* @param {string} productSlug Product slug
|
|
98
96
|
* @param {string} code Product document code
|
|
99
97
|
* @param {string} [authorization] Bearer Token
|
|
100
|
-
* @param {
|
|
98
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
101
99
|
* @param {*} [options] Override http request option.
|
|
102
100
|
* @throws {RequiredError}
|
|
103
101
|
*/
|
|
104
|
-
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
102
|
+
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
105
103
|
// verify required parameter 'productSlug' is not null or undefined
|
|
106
104
|
assertParamExists('downloadProductDocument', 'productSlug', productSlug)
|
|
107
105
|
// verify required parameter 'code' is not null or undefined
|
|
@@ -209,89 +207,9 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
209
207
|
* @param {*} [options] Override http request option.
|
|
210
208
|
* @throws {RequiredError}
|
|
211
209
|
*/
|
|
212
|
-
|
|
210
|
+
listProductDocuments: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
213
211
|
// verify required parameter 'productSlug' is not null or undefined
|
|
214
|
-
assertParamExists('
|
|
215
|
-
const localVarPath = `/documentservice/v1/product-documents`
|
|
216
|
-
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
217
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
218
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
219
|
-
let baseOptions;
|
|
220
|
-
let baseAccessToken;
|
|
221
|
-
if (configuration) {
|
|
222
|
-
baseOptions = configuration.baseOptions;
|
|
223
|
-
baseAccessToken = configuration.accessToken;
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
227
|
-
const localVarHeaderParameter = {} as any;
|
|
228
|
-
const localVarQueryParameter = {} as any;
|
|
229
|
-
|
|
230
|
-
// authentication bearer required
|
|
231
|
-
// http bearer authentication required
|
|
232
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
233
|
-
|
|
234
|
-
if (pageSize !== undefined) {
|
|
235
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
if (pageToken !== undefined) {
|
|
239
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
if (filter !== undefined) {
|
|
243
|
-
localVarQueryParameter['filter'] = filter;
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
if (search !== undefined) {
|
|
247
|
-
localVarQueryParameter['search'] = search;
|
|
248
|
-
}
|
|
249
|
-
|
|
250
|
-
if (order !== undefined) {
|
|
251
|
-
localVarQueryParameter['order'] = order;
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
if (expand !== undefined) {
|
|
255
|
-
localVarQueryParameter['expand'] = expand;
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
if (filters !== undefined) {
|
|
259
|
-
localVarQueryParameter['filters'] = filters;
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
263
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
264
|
-
}
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
269
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
270
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
271
|
-
|
|
272
|
-
return {
|
|
273
|
-
url: toPathString(localVarUrlObj),
|
|
274
|
-
options: localVarRequestOptions,
|
|
275
|
-
};
|
|
276
|
-
},
|
|
277
|
-
/**
|
|
278
|
-
* 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. **Required Permissions** \"document-management.documents.view\"
|
|
279
|
-
* @summary List product documents
|
|
280
|
-
* @param {string} productSlug
|
|
281
|
-
* @param {string} [authorization] Bearer Token
|
|
282
|
-
* @param {number} [pageSize] Page size
|
|
283
|
-
* @param {string} [pageToken] Page token
|
|
284
|
-
* @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, slug</i>
|
|
285
|
-
* @param {string} [search] Search query
|
|
286
|
-
* @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>
|
|
287
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
288
|
-
* @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, slug</i>
|
|
289
|
-
* @param {*} [options] Override http request option.
|
|
290
|
-
* @throws {RequiredError}
|
|
291
|
-
*/
|
|
292
|
-
listProductDocuments1: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
293
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
294
|
-
assertParamExists('listProductDocuments1', 'productSlug', productSlug)
|
|
212
|
+
assertParamExists('listProductDocuments', 'productSlug', productSlug)
|
|
295
213
|
const localVarPath = `/documentservice/v1/product-documents/{productSlug}`
|
|
296
214
|
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
297
215
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -434,11 +352,11 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
434
352
|
* @param {string} productSlug Product slug
|
|
435
353
|
* @param {string} code Product document code
|
|
436
354
|
* @param {string} [authorization] Bearer Token
|
|
437
|
-
* @param {
|
|
355
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
438
356
|
* @param {*} [options] Override http request option.
|
|
439
357
|
* @throws {RequiredError}
|
|
440
358
|
*/
|
|
441
|
-
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
359
|
+
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
442
360
|
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
|
|
443
361
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
444
362
|
},
|
|
@@ -470,27 +388,8 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
470
388
|
* @param {*} [options] Override http request option.
|
|
471
389
|
* @throws {RequiredError}
|
|
472
390
|
*/
|
|
473
|
-
async
|
|
474
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
475
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
476
|
-
},
|
|
477
|
-
/**
|
|
478
|
-
* 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. **Required Permissions** \"document-management.documents.view\"
|
|
479
|
-
* @summary List product documents
|
|
480
|
-
* @param {string} productSlug
|
|
481
|
-
* @param {string} [authorization] Bearer Token
|
|
482
|
-
* @param {number} [pageSize] Page size
|
|
483
|
-
* @param {string} [pageToken] Page token
|
|
484
|
-
* @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, slug</i>
|
|
485
|
-
* @param {string} [search] Search query
|
|
486
|
-
* @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>
|
|
487
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
488
|
-
* @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, slug</i>
|
|
489
|
-
* @param {*} [options] Override http request option.
|
|
490
|
-
* @throws {RequiredError}
|
|
491
|
-
*/
|
|
492
|
-
async listProductDocuments1(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>> {
|
|
493
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
391
|
+
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>> {
|
|
392
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
494
393
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
495
394
|
},
|
|
496
395
|
/**
|
|
@@ -534,11 +433,11 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
534
433
|
* @param {string} productSlug Product slug
|
|
535
434
|
* @param {string} code Product document code
|
|
536
435
|
* @param {string} [authorization] Bearer Token
|
|
537
|
-
* @param {
|
|
436
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
538
437
|
* @param {*} [options] Override http request option.
|
|
539
438
|
* @throws {RequiredError}
|
|
540
439
|
*/
|
|
541
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
440
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
542
441
|
return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
543
442
|
},
|
|
544
443
|
/**
|
|
@@ -568,26 +467,8 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
568
467
|
* @param {*} [options] Override http request option.
|
|
569
468
|
* @throws {RequiredError}
|
|
570
469
|
*/
|
|
571
|
-
|
|
572
|
-
return localVarFp.
|
|
573
|
-
},
|
|
574
|
-
/**
|
|
575
|
-
* 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. **Required Permissions** \"document-management.documents.view\"
|
|
576
|
-
* @summary List product documents
|
|
577
|
-
* @param {string} productSlug
|
|
578
|
-
* @param {string} [authorization] Bearer Token
|
|
579
|
-
* @param {number} [pageSize] Page size
|
|
580
|
-
* @param {string} [pageToken] Page token
|
|
581
|
-
* @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, slug</i>
|
|
582
|
-
* @param {string} [search] Search query
|
|
583
|
-
* @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>
|
|
584
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
585
|
-
* @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, slug</i>
|
|
586
|
-
* @param {*} [options] Override http request option.
|
|
587
|
-
* @throws {RequiredError}
|
|
588
|
-
*/
|
|
589
|
-
listProductDocuments1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
590
|
-
return localVarFp.listProductDocuments1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
470
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
471
|
+
return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
591
472
|
},
|
|
592
473
|
/**
|
|
593
474
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
@@ -660,11 +541,11 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
|
|
|
660
541
|
readonly authorization?: string
|
|
661
542
|
|
|
662
543
|
/**
|
|
663
|
-
* Content disposition type
|
|
664
|
-
* @type {
|
|
544
|
+
* Content disposition override. Default will be depending on the document type.
|
|
545
|
+
* @type {'attachment' | 'inline'}
|
|
665
546
|
* @memberof ProductDocumentsApiDownloadProductDocument
|
|
666
547
|
*/
|
|
667
|
-
readonly contentDisposition?:
|
|
548
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
668
549
|
}
|
|
669
550
|
|
|
670
551
|
/**
|
|
@@ -696,141 +577,71 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
|
696
577
|
}
|
|
697
578
|
|
|
698
579
|
/**
|
|
699
|
-
* Request parameters for
|
|
580
|
+
* Request parameters for listProductDocuments operation in ProductDocumentsApi.
|
|
700
581
|
* @export
|
|
701
|
-
* @interface
|
|
582
|
+
* @interface ProductDocumentsApiListProductDocumentsRequest
|
|
702
583
|
*/
|
|
703
|
-
export interface
|
|
584
|
+
export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
704
585
|
/**
|
|
705
586
|
*
|
|
706
587
|
* @type {string}
|
|
707
|
-
* @memberof
|
|
588
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
708
589
|
*/
|
|
709
590
|
readonly productSlug: string
|
|
710
591
|
|
|
711
592
|
/**
|
|
712
593
|
* Bearer Token
|
|
713
594
|
* @type {string}
|
|
714
|
-
* @memberof
|
|
595
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
715
596
|
*/
|
|
716
597
|
readonly authorization?: string
|
|
717
598
|
|
|
718
599
|
/**
|
|
719
600
|
* Page size
|
|
720
601
|
* @type {number}
|
|
721
|
-
* @memberof
|
|
602
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
722
603
|
*/
|
|
723
604
|
readonly pageSize?: number
|
|
724
605
|
|
|
725
606
|
/**
|
|
726
607
|
* Page token
|
|
727
608
|
* @type {string}
|
|
728
|
-
* @memberof
|
|
609
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
729
610
|
*/
|
|
730
611
|
readonly pageToken?: string
|
|
731
612
|
|
|
732
613
|
/**
|
|
733
614
|
* 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, slug</i>
|
|
734
615
|
* @type {string}
|
|
735
|
-
* @memberof
|
|
616
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
736
617
|
*/
|
|
737
618
|
readonly filter?: string
|
|
738
619
|
|
|
739
620
|
/**
|
|
740
621
|
* Search query
|
|
741
622
|
* @type {string}
|
|
742
|
-
* @memberof
|
|
623
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
743
624
|
*/
|
|
744
625
|
readonly search?: string
|
|
745
626
|
|
|
746
627
|
/**
|
|
747
628
|
* 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>
|
|
748
629
|
* @type {string}
|
|
749
|
-
* @memberof
|
|
630
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
750
631
|
*/
|
|
751
632
|
readonly order?: string
|
|
752
633
|
|
|
753
634
|
/**
|
|
754
635
|
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
755
636
|
* @type {string}
|
|
756
|
-
* @memberof
|
|
637
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
757
638
|
*/
|
|
758
639
|
readonly expand?: string
|
|
759
640
|
|
|
760
641
|
/**
|
|
761
642
|
* 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, slug</i>
|
|
762
643
|
* @type {string}
|
|
763
|
-
* @memberof
|
|
764
|
-
*/
|
|
765
|
-
readonly filters?: string
|
|
766
|
-
}
|
|
767
|
-
|
|
768
|
-
/**
|
|
769
|
-
* Request parameters for listProductDocuments1 operation in ProductDocumentsApi.
|
|
770
|
-
* @export
|
|
771
|
-
* @interface ProductDocumentsApiListProductDocuments1Request
|
|
772
|
-
*/
|
|
773
|
-
export interface ProductDocumentsApiListProductDocuments1Request {
|
|
774
|
-
/**
|
|
775
|
-
*
|
|
776
|
-
* @type {string}
|
|
777
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
778
|
-
*/
|
|
779
|
-
readonly productSlug: string
|
|
780
|
-
|
|
781
|
-
/**
|
|
782
|
-
* Bearer Token
|
|
783
|
-
* @type {string}
|
|
784
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
785
|
-
*/
|
|
786
|
-
readonly authorization?: string
|
|
787
|
-
|
|
788
|
-
/**
|
|
789
|
-
* Page size
|
|
790
|
-
* @type {number}
|
|
791
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
792
|
-
*/
|
|
793
|
-
readonly pageSize?: number
|
|
794
|
-
|
|
795
|
-
/**
|
|
796
|
-
* Page token
|
|
797
|
-
* @type {string}
|
|
798
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
799
|
-
*/
|
|
800
|
-
readonly pageToken?: string
|
|
801
|
-
|
|
802
|
-
/**
|
|
803
|
-
* 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, slug</i>
|
|
804
|
-
* @type {string}
|
|
805
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
806
|
-
*/
|
|
807
|
-
readonly filter?: string
|
|
808
|
-
|
|
809
|
-
/**
|
|
810
|
-
* Search query
|
|
811
|
-
* @type {string}
|
|
812
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
813
|
-
*/
|
|
814
|
-
readonly search?: string
|
|
815
|
-
|
|
816
|
-
/**
|
|
817
|
-
* 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>
|
|
818
|
-
* @type {string}
|
|
819
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
820
|
-
*/
|
|
821
|
-
readonly order?: string
|
|
822
|
-
|
|
823
|
-
/**
|
|
824
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
825
|
-
* @type {string}
|
|
826
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
827
|
-
*/
|
|
828
|
-
readonly expand?: string
|
|
829
|
-
|
|
830
|
-
/**
|
|
831
|
-
* 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, slug</i>
|
|
832
|
-
* @type {string}
|
|
833
|
-
* @memberof ProductDocumentsApiListProductDocuments1
|
|
644
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
834
645
|
*/
|
|
835
646
|
readonly filters?: string
|
|
836
647
|
}
|
|
@@ -909,25 +720,13 @@ export class ProductDocumentsApi extends BaseAPI {
|
|
|
909
720
|
/**
|
|
910
721
|
* 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. **Required Permissions** \"document-management.documents.view\"
|
|
911
722
|
* @summary List product documents
|
|
912
|
-
* @param {
|
|
913
|
-
* @param {*} [options] Override http request option.
|
|
914
|
-
* @throws {RequiredError}
|
|
915
|
-
* @memberof ProductDocumentsApi
|
|
916
|
-
*/
|
|
917
|
-
public listProductDocuments0(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig) {
|
|
918
|
-
return ProductDocumentsApiFp(this.configuration).listProductDocuments0(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
919
|
-
}
|
|
920
|
-
|
|
921
|
-
/**
|
|
922
|
-
* 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. **Required Permissions** \"document-management.documents.view\"
|
|
923
|
-
* @summary List product documents
|
|
924
|
-
* @param {ProductDocumentsApiListProductDocuments1Request} requestParameters Request parameters.
|
|
723
|
+
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
925
724
|
* @param {*} [options] Override http request option.
|
|
926
725
|
* @throws {RequiredError}
|
|
927
726
|
* @memberof ProductDocumentsApi
|
|
928
727
|
*/
|
|
929
|
-
public
|
|
930
|
-
return ProductDocumentsApiFp(this.configuration).
|
|
728
|
+
public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
|
|
729
|
+
return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
931
730
|
}
|
|
932
731
|
|
|
933
732
|
/**
|
package/api.ts
CHANGED
|
@@ -24,10 +24,10 @@ import FormData from 'form-data'
|
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
27
|
+
import { DefaultApi } from './api';
|
|
27
28
|
import { DocumentTemplatesApi } from './api';
|
|
28
29
|
import { DocumentsApi } from './api';
|
|
29
30
|
import { DocxTemplatesApi } from './api';
|
|
30
|
-
import { HealthApi } from './api';
|
|
31
31
|
import { LayoutsApi } from './api';
|
|
32
32
|
import { ProductDocumentsApi } from './api';
|
|
33
33
|
import { SearchKeywordsApi } from './api';
|
|
@@ -35,10 +35,10 @@ import { SearchableDocumentOwnersApi } from './api';
|
|
|
35
35
|
import { SearchableDocumentsApi } from './api';
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
export * from './api/default-api';
|
|
38
39
|
export * from './api/document-templates-api';
|
|
39
40
|
export * from './api/documents-api';
|
|
40
41
|
export * from './api/docx-templates-api';
|
|
41
|
-
export * from './api/health-api';
|
|
42
42
|
export * from './api/layouts-api';
|
|
43
43
|
export * from './api/product-documents-api';
|
|
44
44
|
export * from './api/search-keywords-api';
|