@emilgroup/document-sdk 1.45.0 → 1.46.1-beta.2
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/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/models/create-document-request-dto.d.ts +6 -0
- package/dist/models/create-presigned-post-request-dto.d.ts +6 -0
- package/dist/models/document-class.d.ts +6 -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/create-document-request-dto.ts +6 -0
- package/models/create-presigned-post-request-dto.ts +6 -0
- package/models/document-class.ts +6 -0
- package/models/get-product-document-download-url-request-rest-dto.ts +38 -0
- package/models/index.ts +1 -0
- package/package.json +2 -2
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@1.
|
|
20
|
+
npm install @emilgroup/document-sdk@1.46.1-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk@1.
|
|
24
|
+
yarn add @emilgroup/document-sdk@1.46.1-beta.2
|
|
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';
|
|
@@ -298,11 +300,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
298
300
|
* @summary Fetches a document download URL
|
|
299
301
|
* @param {string} code Document code
|
|
300
302
|
* @param {string} [authorization] Bearer Token
|
|
301
|
-
* @param {
|
|
303
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
302
304
|
* @param {*} [options] Override http request option.
|
|
303
305
|
* @throws {RequiredError}
|
|
304
306
|
*/
|
|
305
|
-
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?:
|
|
307
|
+
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
306
308
|
// verify required parameter 'code' is not null or undefined
|
|
307
309
|
assertParamExists('getDocumentDownloadUrl', 'code', code)
|
|
308
310
|
const localVarPath = `/documentservice/v1/documents/{code}/download-url`
|
|
@@ -693,11 +695,11 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
693
695
|
* @summary Fetches a document download URL
|
|
694
696
|
* @param {string} code Document code
|
|
695
697
|
* @param {string} [authorization] Bearer Token
|
|
696
|
-
* @param {
|
|
698
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
697
699
|
* @param {*} [options] Override http request option.
|
|
698
700
|
* @throws {RequiredError}
|
|
699
701
|
*/
|
|
700
|
-
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
702
|
+
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>> {
|
|
701
703
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
|
|
702
704
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
703
705
|
},
|
|
@@ -840,11 +842,11 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
840
842
|
* @summary Fetches a document download URL
|
|
841
843
|
* @param {string} code Document code
|
|
842
844
|
* @param {string} [authorization] Bearer Token
|
|
843
|
-
* @param {
|
|
845
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
844
846
|
* @param {*} [options] Override http request option.
|
|
845
847
|
* @throws {RequiredError}
|
|
846
848
|
*/
|
|
847
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
849
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
|
|
848
850
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
849
851
|
},
|
|
850
852
|
/**
|
|
@@ -1047,10 +1049,10 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
|
|
|
1047
1049
|
|
|
1048
1050
|
/**
|
|
1049
1051
|
* Content disposition override. Default will be depending on the document type.
|
|
1050
|
-
* @type {
|
|
1052
|
+
* @type {GetProductDocumentDownloadUrlRequestRestDto}
|
|
1051
1053
|
* @memberof DocumentsApiGetDocumentDownloadUrl
|
|
1052
1054
|
*/
|
|
1053
|
-
readonly contentDisposition?:
|
|
1055
|
+
readonly contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto
|
|
1054
1056
|
}
|
|
1055
1057
|
|
|
1056
1058
|
/**
|
|
@@ -25,10 +25,10 @@ import { InlineResponse200 } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { InlineResponse503 } from '../models';
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* HealthApi - axios parameter creator
|
|
29
29
|
* @export
|
|
30
30
|
*/
|
|
31
|
-
export const
|
|
31
|
+
export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
34
|
* 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.
|
|
@@ -66,11 +66,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
66
66
|
};
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* HealthApi - functional programming interface
|
|
70
70
|
* @export
|
|
71
71
|
*/
|
|
72
|
-
export const
|
|
73
|
-
const localVarAxiosParamCreator =
|
|
72
|
+
export const HealthApiFp = function(configuration?: Configuration) {
|
|
73
|
+
const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
|
|
74
74
|
return {
|
|
75
75
|
/**
|
|
76
76
|
* 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.
|
|
@@ -86,11 +86,11 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
86
86
|
};
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* HealthApi - factory interface
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
export const
|
|
93
|
-
const localVarFp =
|
|
92
|
+
export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
93
|
+
const localVarFp = HealthApiFp(configuration)
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
96
|
* 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.
|
|
@@ -105,20 +105,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
105
105
|
};
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* HealthApi - object-oriented interface
|
|
109
109
|
* @export
|
|
110
|
-
* @class
|
|
110
|
+
* @class HealthApi
|
|
111
111
|
* @extends {BaseAPI}
|
|
112
112
|
*/
|
|
113
|
-
export class
|
|
113
|
+
export class HealthApi extends BaseAPI {
|
|
114
114
|
/**
|
|
115
115
|
* 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.
|
|
116
116
|
* @summary Health Check
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
|
-
* @memberof
|
|
119
|
+
* @memberof HealthApi
|
|
120
120
|
*/
|
|
121
121
|
public check(options?: AxiosRequestConfig) {
|
|
122
|
-
return
|
|
122
|
+
return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
123
123
|
}
|
|
124
124
|
}
|
|
@@ -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';
|
|
@@ -91,11 +93,11 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
91
93
|
* @param {string} productSlug Product slug
|
|
92
94
|
* @param {string} code Product document code
|
|
93
95
|
* @param {string} [authorization] Bearer Token
|
|
94
|
-
* @param {
|
|
96
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
95
97
|
* @param {*} [options] Override http request option.
|
|
96
98
|
* @throws {RequiredError}
|
|
97
99
|
*/
|
|
98
|
-
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
100
|
+
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
99
101
|
// verify required parameter 'productSlug' is not null or undefined
|
|
100
102
|
assertParamExists('downloadProductDocument', 'productSlug', productSlug)
|
|
101
103
|
// verify required parameter 'code' is not null or undefined
|
|
@@ -203,9 +205,89 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
203
205
|
* @param {*} [options] Override http request option.
|
|
204
206
|
* @throws {RequiredError}
|
|
205
207
|
*/
|
|
206
|
-
|
|
208
|
+
listProductDocuments0: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
207
209
|
// verify required parameter 'productSlug' is not null or undefined
|
|
208
|
-
assertParamExists('
|
|
210
|
+
assertParamExists('listProductDocuments0', 'productSlug', productSlug)
|
|
211
|
+
const localVarPath = `/documentservice/v1/product-documents`
|
|
212
|
+
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
213
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
214
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
215
|
+
let baseOptions;
|
|
216
|
+
let baseAccessToken;
|
|
217
|
+
if (configuration) {
|
|
218
|
+
baseOptions = configuration.baseOptions;
|
|
219
|
+
baseAccessToken = configuration.accessToken;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
223
|
+
const localVarHeaderParameter = {} as any;
|
|
224
|
+
const localVarQueryParameter = {} as any;
|
|
225
|
+
|
|
226
|
+
// authentication bearer required
|
|
227
|
+
// http bearer authentication required
|
|
228
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
229
|
+
|
|
230
|
+
if (pageSize !== undefined) {
|
|
231
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
if (pageToken !== undefined) {
|
|
235
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
if (filter !== undefined) {
|
|
239
|
+
localVarQueryParameter['filter'] = filter;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
if (search !== undefined) {
|
|
243
|
+
localVarQueryParameter['search'] = search;
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
if (order !== undefined) {
|
|
247
|
+
localVarQueryParameter['order'] = order;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
if (expand !== undefined) {
|
|
251
|
+
localVarQueryParameter['expand'] = expand;
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
if (filters !== undefined) {
|
|
255
|
+
localVarQueryParameter['filters'] = filters;
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
259
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
265
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
266
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
267
|
+
|
|
268
|
+
return {
|
|
269
|
+
url: toPathString(localVarUrlObj),
|
|
270
|
+
options: localVarRequestOptions,
|
|
271
|
+
};
|
|
272
|
+
},
|
|
273
|
+
/**
|
|
274
|
+
* 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\"
|
|
275
|
+
* @summary List product documents
|
|
276
|
+
* @param {string} productSlug
|
|
277
|
+
* @param {string} [authorization] Bearer Token
|
|
278
|
+
* @param {number} [pageSize] Page size
|
|
279
|
+
* @param {string} [pageToken] Page token
|
|
280
|
+
* @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>
|
|
281
|
+
* @param {string} [search] Search query
|
|
282
|
+
* @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>
|
|
283
|
+
* @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/>
|
|
284
|
+
* @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>
|
|
285
|
+
* @param {*} [options] Override http request option.
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
listProductDocuments1: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
289
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
290
|
+
assertParamExists('listProductDocuments1', 'productSlug', productSlug)
|
|
209
291
|
const localVarPath = `/documentservice/v1/product-documents/{productSlug}`
|
|
210
292
|
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
211
293
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -348,11 +430,11 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
348
430
|
* @param {string} productSlug Product slug
|
|
349
431
|
* @param {string} code Product document code
|
|
350
432
|
* @param {string} [authorization] Bearer Token
|
|
351
|
-
* @param {
|
|
433
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
352
434
|
* @param {*} [options] Override http request option.
|
|
353
435
|
* @throws {RequiredError}
|
|
354
436
|
*/
|
|
355
|
-
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
437
|
+
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
356
438
|
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
|
|
357
439
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
440
|
},
|
|
@@ -384,8 +466,27 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
384
466
|
* @param {*} [options] Override http request option.
|
|
385
467
|
* @throws {RequiredError}
|
|
386
468
|
*/
|
|
387
|
-
async
|
|
388
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
469
|
+
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>> {
|
|
470
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments0(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
471
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
472
|
+
},
|
|
473
|
+
/**
|
|
474
|
+
* 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\"
|
|
475
|
+
* @summary List product documents
|
|
476
|
+
* @param {string} productSlug
|
|
477
|
+
* @param {string} [authorization] Bearer Token
|
|
478
|
+
* @param {number} [pageSize] Page size
|
|
479
|
+
* @param {string} [pageToken] Page token
|
|
480
|
+
* @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>
|
|
481
|
+
* @param {string} [search] Search query
|
|
482
|
+
* @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>
|
|
483
|
+
* @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/>
|
|
484
|
+
* @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>
|
|
485
|
+
* @param {*} [options] Override http request option.
|
|
486
|
+
* @throws {RequiredError}
|
|
487
|
+
*/
|
|
488
|
+
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>> {
|
|
489
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
389
490
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
390
491
|
},
|
|
391
492
|
/**
|
|
@@ -429,11 +530,11 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
429
530
|
* @param {string} productSlug Product slug
|
|
430
531
|
* @param {string} code Product document code
|
|
431
532
|
* @param {string} [authorization] Bearer Token
|
|
432
|
-
* @param {
|
|
533
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
433
534
|
* @param {*} [options] Override http request option.
|
|
434
535
|
* @throws {RequiredError}
|
|
435
536
|
*/
|
|
436
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
537
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
437
538
|
return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
438
539
|
},
|
|
439
540
|
/**
|
|
@@ -463,8 +564,26 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
463
564
|
* @param {*} [options] Override http request option.
|
|
464
565
|
* @throws {RequiredError}
|
|
465
566
|
*/
|
|
466
|
-
|
|
467
|
-
return localVarFp.
|
|
567
|
+
listProductDocuments0(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
568
|
+
return localVarFp.listProductDocuments0(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
569
|
+
},
|
|
570
|
+
/**
|
|
571
|
+
* 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\"
|
|
572
|
+
* @summary List product documents
|
|
573
|
+
* @param {string} productSlug
|
|
574
|
+
* @param {string} [authorization] Bearer Token
|
|
575
|
+
* @param {number} [pageSize] Page size
|
|
576
|
+
* @param {string} [pageToken] Page token
|
|
577
|
+
* @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>
|
|
578
|
+
* @param {string} [search] Search query
|
|
579
|
+
* @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>
|
|
580
|
+
* @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/>
|
|
581
|
+
* @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>
|
|
582
|
+
* @param {*} [options] Override http request option.
|
|
583
|
+
* @throws {RequiredError}
|
|
584
|
+
*/
|
|
585
|
+
listProductDocuments1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
586
|
+
return localVarFp.listProductDocuments1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
468
587
|
},
|
|
469
588
|
/**
|
|
470
589
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
@@ -537,11 +656,11 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
|
|
|
537
656
|
readonly authorization?: string
|
|
538
657
|
|
|
539
658
|
/**
|
|
540
|
-
* Content disposition
|
|
541
|
-
* @type {
|
|
659
|
+
* Content disposition type
|
|
660
|
+
* @type {GetProductDocumentDownloadUrlRequestRestDto}
|
|
542
661
|
* @memberof ProductDocumentsApiDownloadProductDocument
|
|
543
662
|
*/
|
|
544
|
-
readonly contentDisposition?:
|
|
663
|
+
readonly contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto
|
|
545
664
|
}
|
|
546
665
|
|
|
547
666
|
/**
|
|
@@ -573,71 +692,141 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
|
573
692
|
}
|
|
574
693
|
|
|
575
694
|
/**
|
|
576
|
-
* Request parameters for
|
|
695
|
+
* Request parameters for listProductDocuments0 operation in ProductDocumentsApi.
|
|
577
696
|
* @export
|
|
578
|
-
* @interface
|
|
697
|
+
* @interface ProductDocumentsApiListProductDocuments0Request
|
|
579
698
|
*/
|
|
580
|
-
export interface
|
|
699
|
+
export interface ProductDocumentsApiListProductDocuments0Request {
|
|
581
700
|
/**
|
|
582
701
|
*
|
|
583
702
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
703
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
585
704
|
*/
|
|
586
705
|
readonly productSlug: string
|
|
587
706
|
|
|
588
707
|
/**
|
|
589
708
|
* Bearer Token
|
|
590
709
|
* @type {string}
|
|
591
|
-
* @memberof
|
|
710
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
592
711
|
*/
|
|
593
712
|
readonly authorization?: string
|
|
594
713
|
|
|
595
714
|
/**
|
|
596
715
|
* Page size
|
|
597
716
|
* @type {number}
|
|
598
|
-
* @memberof
|
|
717
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
599
718
|
*/
|
|
600
719
|
readonly pageSize?: number
|
|
601
720
|
|
|
602
721
|
/**
|
|
603
722
|
* Page token
|
|
604
723
|
* @type {string}
|
|
605
|
-
* @memberof
|
|
724
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
606
725
|
*/
|
|
607
726
|
readonly pageToken?: string
|
|
608
727
|
|
|
609
728
|
/**
|
|
610
729
|
* 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>
|
|
611
730
|
* @type {string}
|
|
612
|
-
* @memberof
|
|
731
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
613
732
|
*/
|
|
614
733
|
readonly filter?: string
|
|
615
734
|
|
|
616
735
|
/**
|
|
617
736
|
* Search query
|
|
618
737
|
* @type {string}
|
|
619
|
-
* @memberof
|
|
738
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
620
739
|
*/
|
|
621
740
|
readonly search?: string
|
|
622
741
|
|
|
623
742
|
/**
|
|
624
743
|
* 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>
|
|
625
744
|
* @type {string}
|
|
626
|
-
* @memberof
|
|
745
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
627
746
|
*/
|
|
628
747
|
readonly order?: string
|
|
629
748
|
|
|
630
749
|
/**
|
|
631
750
|
* 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/>
|
|
632
751
|
* @type {string}
|
|
633
|
-
* @memberof
|
|
752
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
634
753
|
*/
|
|
635
754
|
readonly expand?: string
|
|
636
755
|
|
|
637
756
|
/**
|
|
638
757
|
* 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>
|
|
639
758
|
* @type {string}
|
|
640
|
-
* @memberof
|
|
759
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
760
|
+
*/
|
|
761
|
+
readonly filters?: string
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
/**
|
|
765
|
+
* Request parameters for listProductDocuments1 operation in ProductDocumentsApi.
|
|
766
|
+
* @export
|
|
767
|
+
* @interface ProductDocumentsApiListProductDocuments1Request
|
|
768
|
+
*/
|
|
769
|
+
export interface ProductDocumentsApiListProductDocuments1Request {
|
|
770
|
+
/**
|
|
771
|
+
*
|
|
772
|
+
* @type {string}
|
|
773
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
774
|
+
*/
|
|
775
|
+
readonly productSlug: string
|
|
776
|
+
|
|
777
|
+
/**
|
|
778
|
+
* Bearer Token
|
|
779
|
+
* @type {string}
|
|
780
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
781
|
+
*/
|
|
782
|
+
readonly authorization?: string
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* Page size
|
|
786
|
+
* @type {number}
|
|
787
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
788
|
+
*/
|
|
789
|
+
readonly pageSize?: number
|
|
790
|
+
|
|
791
|
+
/**
|
|
792
|
+
* Page token
|
|
793
|
+
* @type {string}
|
|
794
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
795
|
+
*/
|
|
796
|
+
readonly pageToken?: string
|
|
797
|
+
|
|
798
|
+
/**
|
|
799
|
+
* 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>
|
|
800
|
+
* @type {string}
|
|
801
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
802
|
+
*/
|
|
803
|
+
readonly filter?: string
|
|
804
|
+
|
|
805
|
+
/**
|
|
806
|
+
* Search query
|
|
807
|
+
* @type {string}
|
|
808
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
809
|
+
*/
|
|
810
|
+
readonly search?: string
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* 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>
|
|
814
|
+
* @type {string}
|
|
815
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
816
|
+
*/
|
|
817
|
+
readonly order?: string
|
|
818
|
+
|
|
819
|
+
/**
|
|
820
|
+
* 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/>
|
|
821
|
+
* @type {string}
|
|
822
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
823
|
+
*/
|
|
824
|
+
readonly expand?: string
|
|
825
|
+
|
|
826
|
+
/**
|
|
827
|
+
* 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>
|
|
828
|
+
* @type {string}
|
|
829
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
641
830
|
*/
|
|
642
831
|
readonly filters?: string
|
|
643
832
|
}
|
|
@@ -716,13 +905,25 @@ export class ProductDocumentsApi extends BaseAPI {
|
|
|
716
905
|
/**
|
|
717
906
|
* 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\"
|
|
718
907
|
* @summary List product documents
|
|
719
|
-
* @param {
|
|
908
|
+
* @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
|
|
909
|
+
* @param {*} [options] Override http request option.
|
|
910
|
+
* @throws {RequiredError}
|
|
911
|
+
* @memberof ProductDocumentsApi
|
|
912
|
+
*/
|
|
913
|
+
public listProductDocuments0(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig) {
|
|
914
|
+
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));
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
/**
|
|
918
|
+
* 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\"
|
|
919
|
+
* @summary List product documents
|
|
920
|
+
* @param {ProductDocumentsApiListProductDocuments1Request} requestParameters Request parameters.
|
|
720
921
|
* @param {*} [options] Override http request option.
|
|
721
922
|
* @throws {RequiredError}
|
|
722
923
|
* @memberof ProductDocumentsApi
|
|
723
924
|
*/
|
|
724
|
-
public
|
|
725
|
-
return ProductDocumentsApiFp(this.configuration).
|
|
925
|
+
public listProductDocuments1(requestParameters: ProductDocumentsApiListProductDocuments1Request, options?: AxiosRequestConfig) {
|
|
926
|
+
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));
|
|
726
927
|
}
|
|
727
928
|
|
|
728
929
|
/**
|
package/api.ts
CHANGED
|
@@ -20,10 +20,10 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
|
|
|
20
20
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
23
|
-
import { DefaultApi } from './api';
|
|
24
23
|
import { DocumentTemplatesApi } from './api';
|
|
25
24
|
import { DocumentsApi } from './api';
|
|
26
25
|
import { DocxTemplatesApi } from './api';
|
|
26
|
+
import { HealthApi } from './api';
|
|
27
27
|
import { LayoutsApi } from './api';
|
|
28
28
|
import { ProductDocumentsApi } from './api';
|
|
29
29
|
import { SearchKeywordsApi } from './api';
|
|
@@ -31,10 +31,10 @@ import { SearchableDocumentOwnersApi } from './api';
|
|
|
31
31
|
import { SearchableDocumentsApi } from './api';
|
|
32
32
|
|
|
33
33
|
|
|
34
|
-
export * from './api/default-api';
|
|
35
34
|
export * from './api/document-templates-api';
|
|
36
35
|
export * from './api/documents-api';
|
|
37
36
|
export * from './api/docx-templates-api';
|
|
37
|
+
export * from './api/health-api';
|
|
38
38
|
export * from './api/layouts-api';
|
|
39
39
|
export * from './api/product-documents-api';
|
|
40
40
|
export * from './api/search-keywords-api';
|