@emilgroup/document-sdk-node 1.44.1-beta.3 → 1.44.1-beta.8
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 -1
- package/README.md +2 -2
- package/api/documents-api.ts +10 -8
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api/product-documents-api.ts +231 -30
- package/api.ts +2 -2
- package/base.ts +1 -0
- package/dist/api/documents-api.d.ts +9 -8
- package/dist/api/documents-api.js +3 -3
- package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
- package/dist/api/{default-api.js → health-api.js} +22 -22
- package/dist/api/product-documents-api.d.ts +145 -26
- package/dist/api/product-documents-api.js +146 -12
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/get-product-document-download-url-request-rest-dto.d.ts +29 -0
- package/dist/models/get-product-document-download-url-request-rest-dto.js +20 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/models/get-product-document-download-url-request-rest-dto.ts +38 -0
- package/models/index.ts +1 -0
- package/package.json +1 -1
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
|
|
7
6
|
api/document-templates-api.ts
|
|
8
7
|
api/documents-api.ts
|
|
9
8
|
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,6 +44,7 @@ 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
|
|
47
48
|
models/get-product-document-download-url-response-class.ts
|
|
48
49
|
models/get-product-document-response-class.ts
|
|
49
50
|
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.8 --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.8
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
package/api/documents-api.ts
CHANGED
|
@@ -37,6 +37,8 @@ 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
|
|
40
42
|
import { GetSignedS3KeyUrlResponseClass } from '../models';
|
|
41
43
|
// @ts-ignore
|
|
42
44
|
import { ListDocumentsResponseClass } from '../models';
|
|
@@ -302,11 +304,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
302
304
|
* @summary Fetches a document download URL
|
|
303
305
|
* @param {string} code Document code
|
|
304
306
|
* @param {string} [authorization] Bearer Token
|
|
305
|
-
* @param {
|
|
307
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
306
308
|
* @param {*} [options] Override http request option.
|
|
307
309
|
* @throws {RequiredError}
|
|
308
310
|
*/
|
|
309
|
-
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?:
|
|
311
|
+
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
310
312
|
// verify required parameter 'code' is not null or undefined
|
|
311
313
|
assertParamExists('getDocumentDownloadUrl', 'code', code)
|
|
312
314
|
const localVarPath = `/documentservice/v1/documents/{code}/download-url`
|
|
@@ -697,11 +699,11 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
697
699
|
* @summary Fetches a document download URL
|
|
698
700
|
* @param {string} code Document code
|
|
699
701
|
* @param {string} [authorization] Bearer Token
|
|
700
|
-
* @param {
|
|
702
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
701
703
|
* @param {*} [options] Override http request option.
|
|
702
704
|
* @throws {RequiredError}
|
|
703
705
|
*/
|
|
704
|
-
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
706
|
+
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>> {
|
|
705
707
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
|
|
706
708
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
707
709
|
},
|
|
@@ -844,11 +846,11 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
844
846
|
* @summary Fetches a document download URL
|
|
845
847
|
* @param {string} code Document code
|
|
846
848
|
* @param {string} [authorization] Bearer Token
|
|
847
|
-
* @param {
|
|
849
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
848
850
|
* @param {*} [options] Override http request option.
|
|
849
851
|
* @throws {RequiredError}
|
|
850
852
|
*/
|
|
851
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
853
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
|
|
852
854
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
853
855
|
},
|
|
854
856
|
/**
|
|
@@ -1051,10 +1053,10 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
|
|
|
1051
1053
|
|
|
1052
1054
|
/**
|
|
1053
1055
|
* Content disposition override. Default will be depending on the document type.
|
|
1054
|
-
* @type {
|
|
1056
|
+
* @type {GetProductDocumentDownloadUrlRequestRestDto}
|
|
1055
1057
|
* @memberof DocumentsApiGetDocumentDownloadUrl
|
|
1056
1058
|
*/
|
|
1057
|
-
readonly contentDisposition?:
|
|
1059
|
+
readonly contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto
|
|
1058
1060
|
}
|
|
1059
1061
|
|
|
1060
1062
|
/**
|
|
@@ -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
|
+
* HealthApi - axios parameter creator
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export const
|
|
35
|
+
export const HealthApiAxiosParamCreator = 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 DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
70
70
|
};
|
|
71
71
|
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* HealthApi - functional programming interface
|
|
74
74
|
* @export
|
|
75
75
|
*/
|
|
76
|
-
export const
|
|
77
|
-
const localVarAxiosParamCreator =
|
|
76
|
+
export const HealthApiFp = function(configuration?: Configuration) {
|
|
77
|
+
const localVarAxiosParamCreator = HealthApiAxiosParamCreator(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 DefaultApiFp = function(configuration?: Configuration) {
|
|
|
90
90
|
};
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* HealthApi - factory interface
|
|
94
94
|
* @export
|
|
95
95
|
*/
|
|
96
|
-
export const
|
|
97
|
-
const localVarFp =
|
|
96
|
+
export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
97
|
+
const localVarFp = HealthApiFp(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 DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
109
109
|
};
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* HealthApi - object-oriented interface
|
|
113
113
|
* @export
|
|
114
|
-
* @class
|
|
114
|
+
* @class HealthApi
|
|
115
115
|
* @extends {BaseAPI}
|
|
116
116
|
*/
|
|
117
|
-
export class
|
|
117
|
+
export class HealthApi 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 HealthApi
|
|
124
124
|
*/
|
|
125
125
|
public check(options?: AxiosRequestConfig) {
|
|
126
|
-
return
|
|
126
|
+
return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
127
127
|
}
|
|
128
128
|
}
|
|
@@ -23,6 +23,8 @@ 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
|
|
26
28
|
import { GetProductDocumentDownloadUrlResponseClass } from '../models';
|
|
27
29
|
// @ts-ignore
|
|
28
30
|
import { GetProductDocumentResponseClass } from '../models';
|
|
@@ -95,11 +97,11 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
95
97
|
* @param {string} productSlug Product slug
|
|
96
98
|
* @param {string} code Product document code
|
|
97
99
|
* @param {string} [authorization] Bearer Token
|
|
98
|
-
* @param {
|
|
100
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
99
101
|
* @param {*} [options] Override http request option.
|
|
100
102
|
* @throws {RequiredError}
|
|
101
103
|
*/
|
|
102
|
-
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
104
|
+
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
103
105
|
// verify required parameter 'productSlug' is not null or undefined
|
|
104
106
|
assertParamExists('downloadProductDocument', 'productSlug', productSlug)
|
|
105
107
|
// verify required parameter 'code' is not null or undefined
|
|
@@ -207,9 +209,89 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
207
209
|
* @param {*} [options] Override http request option.
|
|
208
210
|
* @throws {RequiredError}
|
|
209
211
|
*/
|
|
210
|
-
|
|
212
|
+
listProductDocuments0: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
211
213
|
// verify required parameter 'productSlug' is not null or undefined
|
|
212
|
-
assertParamExists('
|
|
214
|
+
assertParamExists('listProductDocuments0', 'productSlug', productSlug)
|
|
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)
|
|
213
295
|
const localVarPath = `/documentservice/v1/product-documents/{productSlug}`
|
|
214
296
|
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
215
297
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -352,11 +434,11 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
352
434
|
* @param {string} productSlug Product slug
|
|
353
435
|
* @param {string} code Product document code
|
|
354
436
|
* @param {string} [authorization] Bearer Token
|
|
355
|
-
* @param {
|
|
437
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
356
438
|
* @param {*} [options] Override http request option.
|
|
357
439
|
* @throws {RequiredError}
|
|
358
440
|
*/
|
|
359
|
-
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
441
|
+
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
360
442
|
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
|
|
361
443
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
444
|
},
|
|
@@ -388,8 +470,27 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
388
470
|
* @param {*} [options] Override http request option.
|
|
389
471
|
* @throws {RequiredError}
|
|
390
472
|
*/
|
|
391
|
-
async
|
|
392
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
473
|
+
async listProductDocuments0(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>> {
|
|
474
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments0(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
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);
|
|
393
494
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
394
495
|
},
|
|
395
496
|
/**
|
|
@@ -433,11 +534,11 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
433
534
|
* @param {string} productSlug Product slug
|
|
434
535
|
* @param {string} code Product document code
|
|
435
536
|
* @param {string} [authorization] Bearer Token
|
|
436
|
-
* @param {
|
|
537
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
437
538
|
* @param {*} [options] Override http request option.
|
|
438
539
|
* @throws {RequiredError}
|
|
439
540
|
*/
|
|
440
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
541
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
441
542
|
return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
442
543
|
},
|
|
443
544
|
/**
|
|
@@ -467,8 +568,26 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
467
568
|
* @param {*} [options] Override http request option.
|
|
468
569
|
* @throws {RequiredError}
|
|
469
570
|
*/
|
|
470
|
-
|
|
471
|
-
return localVarFp.
|
|
571
|
+
listProductDocuments0(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
572
|
+
return localVarFp.listProductDocuments0(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
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));
|
|
472
591
|
},
|
|
473
592
|
/**
|
|
474
593
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
@@ -541,11 +660,11 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
|
|
|
541
660
|
readonly authorization?: string
|
|
542
661
|
|
|
543
662
|
/**
|
|
544
|
-
* Content disposition
|
|
545
|
-
* @type {
|
|
663
|
+
* Content disposition type
|
|
664
|
+
* @type {GetProductDocumentDownloadUrlRequestRestDto}
|
|
546
665
|
* @memberof ProductDocumentsApiDownloadProductDocument
|
|
547
666
|
*/
|
|
548
|
-
readonly contentDisposition?:
|
|
667
|
+
readonly contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto
|
|
549
668
|
}
|
|
550
669
|
|
|
551
670
|
/**
|
|
@@ -577,71 +696,141 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
|
577
696
|
}
|
|
578
697
|
|
|
579
698
|
/**
|
|
580
|
-
* Request parameters for
|
|
699
|
+
* Request parameters for listProductDocuments0 operation in ProductDocumentsApi.
|
|
581
700
|
* @export
|
|
582
|
-
* @interface
|
|
701
|
+
* @interface ProductDocumentsApiListProductDocuments0Request
|
|
583
702
|
*/
|
|
584
|
-
export interface
|
|
703
|
+
export interface ProductDocumentsApiListProductDocuments0Request {
|
|
585
704
|
/**
|
|
586
705
|
*
|
|
587
706
|
* @type {string}
|
|
588
|
-
* @memberof
|
|
707
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
589
708
|
*/
|
|
590
709
|
readonly productSlug: string
|
|
591
710
|
|
|
592
711
|
/**
|
|
593
712
|
* Bearer Token
|
|
594
713
|
* @type {string}
|
|
595
|
-
* @memberof
|
|
714
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
596
715
|
*/
|
|
597
716
|
readonly authorization?: string
|
|
598
717
|
|
|
599
718
|
/**
|
|
600
719
|
* Page size
|
|
601
720
|
* @type {number}
|
|
602
|
-
* @memberof
|
|
721
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
603
722
|
*/
|
|
604
723
|
readonly pageSize?: number
|
|
605
724
|
|
|
606
725
|
/**
|
|
607
726
|
* Page token
|
|
608
727
|
* @type {string}
|
|
609
|
-
* @memberof
|
|
728
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
610
729
|
*/
|
|
611
730
|
readonly pageToken?: string
|
|
612
731
|
|
|
613
732
|
/**
|
|
614
733
|
* 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>
|
|
615
734
|
* @type {string}
|
|
616
|
-
* @memberof
|
|
735
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
617
736
|
*/
|
|
618
737
|
readonly filter?: string
|
|
619
738
|
|
|
620
739
|
/**
|
|
621
740
|
* Search query
|
|
622
741
|
* @type {string}
|
|
623
|
-
* @memberof
|
|
742
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
624
743
|
*/
|
|
625
744
|
readonly search?: string
|
|
626
745
|
|
|
627
746
|
/**
|
|
628
747
|
* 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>
|
|
629
748
|
* @type {string}
|
|
630
|
-
* @memberof
|
|
749
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
631
750
|
*/
|
|
632
751
|
readonly order?: string
|
|
633
752
|
|
|
634
753
|
/**
|
|
635
754
|
* 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/>
|
|
636
755
|
* @type {string}
|
|
637
|
-
* @memberof
|
|
756
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
638
757
|
*/
|
|
639
758
|
readonly expand?: string
|
|
640
759
|
|
|
641
760
|
/**
|
|
642
761
|
* 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>
|
|
643
762
|
* @type {string}
|
|
644
|
-
* @memberof
|
|
763
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
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
|
|
645
834
|
*/
|
|
646
835
|
readonly filters?: string
|
|
647
836
|
}
|
|
@@ -720,13 +909,25 @@ export class ProductDocumentsApi extends BaseAPI {
|
|
|
720
909
|
/**
|
|
721
910
|
* 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\"
|
|
722
911
|
* @summary List product documents
|
|
723
|
-
* @param {
|
|
912
|
+
* @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
|
|
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.
|
|
724
925
|
* @param {*} [options] Override http request option.
|
|
725
926
|
* @throws {RequiredError}
|
|
726
927
|
* @memberof ProductDocumentsApi
|
|
727
928
|
*/
|
|
728
|
-
public
|
|
729
|
-
return ProductDocumentsApiFp(this.configuration).
|
|
929
|
+
public listProductDocuments1(requestParameters: ProductDocumentsApiListProductDocuments1Request, options?: AxiosRequestConfig) {
|
|
930
|
+
return ProductDocumentsApiFp(this.configuration).listProductDocuments1(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));
|
|
730
931
|
}
|
|
731
932
|
|
|
732
933
|
/**
|
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';
|
|
28
27
|
import { DocumentTemplatesApi } from './api';
|
|
29
28
|
import { DocumentsApi } from './api';
|
|
30
29
|
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';
|
|
39
38
|
export * from './api/document-templates-api';
|
|
40
39
|
export * from './api/documents-api';
|
|
41
40
|
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';
|
package/base.ts
CHANGED
|
@@ -60,6 +60,7 @@ export enum Environment {
|
|
|
60
60
|
Staging = 'https://apiv2-staging.emil.de',
|
|
61
61
|
Development = 'https://apiv2-dev.emil.de',
|
|
62
62
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
63
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
63
64
|
}
|
|
64
65
|
|
|
65
66
|
let _retry_count = 0
|