@emilgroup/document-sdk 1.46.1-beta.2 → 1.46.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@1.46.1-beta.
|
|
20
|
+
npm install @emilgroup/document-sdk@1.46.1-beta.3 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk@1.46.1-beta.
|
|
24
|
+
yarn add @emilgroup/document-sdk@1.46.1-beta.3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
|
@@ -25,10 +25,10 @@ import { InlineResponse200 } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { InlineResponse503 } from '../models';
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* DefaultApi - axios parameter creator
|
|
29
29
|
* @export
|
|
30
30
|
*/
|
|
31
|
-
export const
|
|
31
|
+
export const DefaultApiAxiosParamCreator = 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 HealthApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
66
66
|
};
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* DefaultApi - functional programming interface
|
|
70
70
|
* @export
|
|
71
71
|
*/
|
|
72
|
-
export const
|
|
73
|
-
const localVarAxiosParamCreator =
|
|
72
|
+
export const DefaultApiFp = function(configuration?: Configuration) {
|
|
73
|
+
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(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 HealthApiFp = function(configuration?: Configuration) {
|
|
|
86
86
|
};
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* DefaultApi - factory interface
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
export const
|
|
93
|
-
const localVarFp =
|
|
92
|
+
export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
93
|
+
const localVarFp = DefaultApiFp(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 HealthApiFactory = function (configuration?: Configuration, basePat
|
|
|
105
105
|
};
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* DefaultApi - object-oriented interface
|
|
109
109
|
* @export
|
|
110
|
-
* @class
|
|
110
|
+
* @class DefaultApi
|
|
111
111
|
* @extends {BaseAPI}
|
|
112
112
|
*/
|
|
113
|
-
export class
|
|
113
|
+
export class DefaultApi 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 DefaultApi
|
|
120
120
|
*/
|
|
121
121
|
public check(options?: AxiosRequestConfig) {
|
|
122
|
-
return
|
|
122
|
+
return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
123
123
|
}
|
|
124
124
|
}
|
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';
|
|
@@ -300,11 +298,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
300
298
|
* @summary Fetches a document download URL
|
|
301
299
|
* @param {string} code Document code
|
|
302
300
|
* @param {string} [authorization] Bearer Token
|
|
303
|
-
* @param {
|
|
301
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
304
302
|
* @param {*} [options] Override http request option.
|
|
305
303
|
* @throws {RequiredError}
|
|
306
304
|
*/
|
|
307
|
-
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?:
|
|
305
|
+
getDocumentDownloadUrl: async (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
308
306
|
// verify required parameter 'code' is not null or undefined
|
|
309
307
|
assertParamExists('getDocumentDownloadUrl', 'code', code)
|
|
310
308
|
const localVarPath = `/documentservice/v1/documents/{code}/download-url`
|
|
@@ -695,11 +693,11 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
695
693
|
* @summary Fetches a document download URL
|
|
696
694
|
* @param {string} code Document code
|
|
697
695
|
* @param {string} [authorization] Bearer Token
|
|
698
|
-
* @param {
|
|
696
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
699
697
|
* @param {*} [options] Override http request option.
|
|
700
698
|
* @throws {RequiredError}
|
|
701
699
|
*/
|
|
702
|
-
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
700
|
+
async getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>> {
|
|
703
701
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentDownloadUrl(code, authorization, contentDisposition, options);
|
|
704
702
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
705
703
|
},
|
|
@@ -842,11 +840,11 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
842
840
|
* @summary Fetches a document download URL
|
|
843
841
|
* @param {string} code Document code
|
|
844
842
|
* @param {string} [authorization] Bearer Token
|
|
845
|
-
* @param {
|
|
843
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
846
844
|
* @param {*} [options] Override http request option.
|
|
847
845
|
* @throws {RequiredError}
|
|
848
846
|
*/
|
|
849
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
847
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass> {
|
|
850
848
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
851
849
|
},
|
|
852
850
|
/**
|
|
@@ -1049,10 +1047,10 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
|
|
|
1049
1047
|
|
|
1050
1048
|
/**
|
|
1051
1049
|
* Content disposition override. Default will be depending on the document type.
|
|
1052
|
-
* @type {
|
|
1050
|
+
* @type {'attachment' | 'inline'}
|
|
1053
1051
|
* @memberof DocumentsApiGetDocumentDownloadUrl
|
|
1054
1052
|
*/
|
|
1055
|
-
readonly contentDisposition?:
|
|
1053
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
1056
1054
|
}
|
|
1057
1055
|
|
|
1058
1056
|
/**
|
|
@@ -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';
|
|
@@ -93,11 +91,11 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
93
91
|
* @param {string} productSlug Product slug
|
|
94
92
|
* @param {string} code Product document code
|
|
95
93
|
* @param {string} [authorization] Bearer Token
|
|
96
|
-
* @param {
|
|
94
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
97
95
|
* @param {*} [options] Override http request option.
|
|
98
96
|
* @throws {RequiredError}
|
|
99
97
|
*/
|
|
100
|
-
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
98
|
+
downloadProductDocument: async (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
99
|
// verify required parameter 'productSlug' is not null or undefined
|
|
102
100
|
assertParamExists('downloadProductDocument', 'productSlug', productSlug)
|
|
103
101
|
// verify required parameter 'code' is not null or undefined
|
|
@@ -205,89 +203,9 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
|
|
|
205
203
|
* @param {*} [options] Override http request option.
|
|
206
204
|
* @throws {RequiredError}
|
|
207
205
|
*/
|
|
208
|
-
|
|
206
|
+
listProductDocuments: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
209
207
|
// verify required parameter 'productSlug' is not null or undefined
|
|
210
|
-
assertParamExists('
|
|
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)
|
|
208
|
+
assertParamExists('listProductDocuments', 'productSlug', productSlug)
|
|
291
209
|
const localVarPath = `/documentservice/v1/product-documents/{productSlug}`
|
|
292
210
|
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
293
211
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -430,11 +348,11 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
430
348
|
* @param {string} productSlug Product slug
|
|
431
349
|
* @param {string} code Product document code
|
|
432
350
|
* @param {string} [authorization] Bearer Token
|
|
433
|
-
* @param {
|
|
351
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
434
352
|
* @param {*} [options] Override http request option.
|
|
435
353
|
* @throws {RequiredError}
|
|
436
354
|
*/
|
|
437
|
-
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
355
|
+
async downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>> {
|
|
438
356
|
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadProductDocument(productSlug, code, authorization, contentDisposition, options);
|
|
439
357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
440
358
|
},
|
|
@@ -466,27 +384,8 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
|
466
384
|
* @param {*} [options] Override http request option.
|
|
467
385
|
* @throws {RequiredError}
|
|
468
386
|
*/
|
|
469
|
-
async
|
|
470
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
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);
|
|
387
|
+
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>> {
|
|
388
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
490
389
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
491
390
|
},
|
|
492
391
|
/**
|
|
@@ -530,11 +429,11 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
530
429
|
* @param {string} productSlug Product slug
|
|
531
430
|
* @param {string} code Product document code
|
|
532
431
|
* @param {string} [authorization] Bearer Token
|
|
533
|
-
* @param {
|
|
432
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
534
433
|
* @param {*} [options] Override http request option.
|
|
535
434
|
* @throws {RequiredError}
|
|
536
435
|
*/
|
|
537
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
436
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass> {
|
|
538
437
|
return localVarFp.downloadProductDocument(productSlug, code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
539
438
|
},
|
|
540
439
|
/**
|
|
@@ -564,26 +463,8 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
|
|
|
564
463
|
* @param {*} [options] Override http request option.
|
|
565
464
|
* @throws {RequiredError}
|
|
566
465
|
*/
|
|
567
|
-
|
|
568
|
-
return localVarFp.
|
|
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));
|
|
466
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
467
|
+
return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
587
468
|
},
|
|
588
469
|
/**
|
|
589
470
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
@@ -656,11 +537,11 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
|
|
|
656
537
|
readonly authorization?: string
|
|
657
538
|
|
|
658
539
|
/**
|
|
659
|
-
* Content disposition type
|
|
660
|
-
* @type {
|
|
540
|
+
* Content disposition override. Default will be depending on the document type.
|
|
541
|
+
* @type {'attachment' | 'inline'}
|
|
661
542
|
* @memberof ProductDocumentsApiDownloadProductDocument
|
|
662
543
|
*/
|
|
663
|
-
readonly contentDisposition?:
|
|
544
|
+
readonly contentDisposition?: 'attachment' | 'inline'
|
|
664
545
|
}
|
|
665
546
|
|
|
666
547
|
/**
|
|
@@ -692,141 +573,71 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
|
692
573
|
}
|
|
693
574
|
|
|
694
575
|
/**
|
|
695
|
-
* Request parameters for
|
|
576
|
+
* Request parameters for listProductDocuments operation in ProductDocumentsApi.
|
|
696
577
|
* @export
|
|
697
|
-
* @interface
|
|
578
|
+
* @interface ProductDocumentsApiListProductDocumentsRequest
|
|
698
579
|
*/
|
|
699
|
-
export interface
|
|
580
|
+
export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
700
581
|
/**
|
|
701
582
|
*
|
|
702
583
|
* @type {string}
|
|
703
|
-
* @memberof
|
|
584
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
704
585
|
*/
|
|
705
586
|
readonly productSlug: string
|
|
706
587
|
|
|
707
588
|
/**
|
|
708
589
|
* Bearer Token
|
|
709
590
|
* @type {string}
|
|
710
|
-
* @memberof
|
|
591
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
711
592
|
*/
|
|
712
593
|
readonly authorization?: string
|
|
713
594
|
|
|
714
595
|
/**
|
|
715
596
|
* Page size
|
|
716
597
|
* @type {number}
|
|
717
|
-
* @memberof
|
|
598
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
718
599
|
*/
|
|
719
600
|
readonly pageSize?: number
|
|
720
601
|
|
|
721
602
|
/**
|
|
722
603
|
* Page token
|
|
723
604
|
* @type {string}
|
|
724
|
-
* @memberof
|
|
605
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
725
606
|
*/
|
|
726
607
|
readonly pageToken?: string
|
|
727
608
|
|
|
728
609
|
/**
|
|
729
610
|
* 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>
|
|
730
611
|
* @type {string}
|
|
731
|
-
* @memberof
|
|
612
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
732
613
|
*/
|
|
733
614
|
readonly filter?: string
|
|
734
615
|
|
|
735
616
|
/**
|
|
736
617
|
* Search query
|
|
737
618
|
* @type {string}
|
|
738
|
-
* @memberof
|
|
619
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
739
620
|
*/
|
|
740
621
|
readonly search?: string
|
|
741
622
|
|
|
742
623
|
/**
|
|
743
624
|
* 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>
|
|
744
625
|
* @type {string}
|
|
745
|
-
* @memberof
|
|
626
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
746
627
|
*/
|
|
747
628
|
readonly order?: string
|
|
748
629
|
|
|
749
630
|
/**
|
|
750
631
|
* 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/>
|
|
751
632
|
* @type {string}
|
|
752
|
-
* @memberof
|
|
633
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
753
634
|
*/
|
|
754
635
|
readonly expand?: string
|
|
755
636
|
|
|
756
637
|
/**
|
|
757
638
|
* 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>
|
|
758
639
|
* @type {string}
|
|
759
|
-
* @memberof
|
|
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
|
|
640
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
830
641
|
*/
|
|
831
642
|
readonly filters?: string
|
|
832
643
|
}
|
|
@@ -905,25 +716,13 @@ export class ProductDocumentsApi extends BaseAPI {
|
|
|
905
716
|
/**
|
|
906
717
|
* 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\"
|
|
907
718
|
* @summary List product documents
|
|
908
|
-
* @param {
|
|
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.
|
|
719
|
+
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
921
720
|
* @param {*} [options] Override http request option.
|
|
922
721
|
* @throws {RequiredError}
|
|
923
722
|
* @memberof ProductDocumentsApi
|
|
924
723
|
*/
|
|
925
|
-
public
|
|
926
|
-
return ProductDocumentsApiFp(this.configuration).
|
|
724
|
+
public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
|
|
725
|
+
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));
|
|
927
726
|
}
|
|
928
727
|
|
|
929
728
|
/**
|
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';
|
|
23
24
|
import { DocumentTemplatesApi } from './api';
|
|
24
25
|
import { DocumentsApi } from './api';
|
|
25
26
|
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';
|
|
34
35
|
export * from './api/document-templates-api';
|
|
35
36
|
export * from './api/documents-api';
|
|
36
37
|
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';
|