@emilgroup/document-sdk 1.46.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/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 +2 -2
|
@@ -20,6 +20,7 @@ import { CreateQrBillDocumentRequestDto } from '../models';
|
|
|
20
20
|
import { ExportDocumentRequestDto } from '../models';
|
|
21
21
|
import { ExportDocumentResponseClass } from '../models';
|
|
22
22
|
import { GetDocumentDownloadUrlResponseClass } from '../models';
|
|
23
|
+
import { GetProductDocumentDownloadUrlRequestRestDto } from '../models';
|
|
23
24
|
import { GetSignedS3KeyUrlResponseClass } from '../models';
|
|
24
25
|
import { ListDocumentsResponseClass } from '../models';
|
|
25
26
|
import { MergeDocumentsRequestDto } from '../models';
|
|
@@ -83,11 +84,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
83
84
|
* @summary Fetches a document download URL
|
|
84
85
|
* @param {string} code Document code
|
|
85
86
|
* @param {string} [authorization] Bearer Token
|
|
86
|
-
* @param {
|
|
87
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
87
88
|
* @param {*} [options] Override http request option.
|
|
88
89
|
* @throws {RequiredError}
|
|
89
90
|
*/
|
|
90
|
-
getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?:
|
|
91
|
+
getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
91
92
|
/**
|
|
92
93
|
* This will return a presigned URL for a random S3 key
|
|
93
94
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -198,11 +199,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
198
199
|
* @summary Fetches a document download URL
|
|
199
200
|
* @param {string} code Document code
|
|
200
201
|
* @param {string} [authorization] Bearer Token
|
|
201
|
-
* @param {
|
|
202
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
202
203
|
* @param {*} [options] Override http request option.
|
|
203
204
|
* @throws {RequiredError}
|
|
204
205
|
*/
|
|
205
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
206
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
|
|
206
207
|
/**
|
|
207
208
|
* This will return a presigned URL for a random S3 key
|
|
208
209
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -313,11 +314,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
313
314
|
* @summary Fetches a document download URL
|
|
314
315
|
* @param {string} code Document code
|
|
315
316
|
* @param {string} [authorization] Bearer Token
|
|
316
|
-
* @param {
|
|
317
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
317
318
|
* @param {*} [options] Override http request option.
|
|
318
319
|
* @throws {RequiredError}
|
|
319
320
|
*/
|
|
320
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
321
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
|
|
321
322
|
/**
|
|
322
323
|
* This will return a presigned URL for a random S3 key
|
|
323
324
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -493,10 +494,10 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
|
|
|
493
494
|
readonly authorization?: string;
|
|
494
495
|
/**
|
|
495
496
|
* Content disposition override. Default will be depending on the document type.
|
|
496
|
-
* @type {
|
|
497
|
+
* @type {GetProductDocumentDownloadUrlRequestRestDto}
|
|
497
498
|
* @memberof DocumentsApiGetDocumentDownloadUrl
|
|
498
499
|
*/
|
|
499
|
-
readonly contentDisposition?:
|
|
500
|
+
readonly contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto;
|
|
500
501
|
}
|
|
501
502
|
/**
|
|
502
503
|
* Request parameters for getSignedS3keyUrl operation in DocumentsApi.
|
|
@@ -345,7 +345,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
345
345
|
* @summary Fetches a document download URL
|
|
346
346
|
* @param {string} code Document code
|
|
347
347
|
* @param {string} [authorization] Bearer Token
|
|
348
|
-
* @param {
|
|
348
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
349
349
|
* @param {*} [options] Override http request option.
|
|
350
350
|
* @throws {RequiredError}
|
|
351
351
|
*/
|
|
@@ -790,7 +790,7 @@ var DocumentsApiFp = function (configuration) {
|
|
|
790
790
|
* @summary Fetches a document download URL
|
|
791
791
|
* @param {string} code Document code
|
|
792
792
|
* @param {string} [authorization] Bearer Token
|
|
793
|
-
* @param {
|
|
793
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
794
794
|
* @param {*} [options] Override http request option.
|
|
795
795
|
* @throws {RequiredError}
|
|
796
796
|
*/
|
|
@@ -991,7 +991,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
991
991
|
* @summary Fetches a document download URL
|
|
992
992
|
* @param {string} code Document code
|
|
993
993
|
* @param {string} [authorization] Bearer Token
|
|
994
|
-
* @param {
|
|
994
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
995
995
|
* @param {*} [options] Override http request option.
|
|
996
996
|
* @throws {RequiredError}
|
|
997
997
|
*/
|
|
@@ -14,10 +14,10 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { InlineResponse200 } from '../models';
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* HealthApi - axios parameter creator
|
|
18
18
|
* @export
|
|
19
19
|
*/
|
|
20
|
-
export declare const
|
|
20
|
+
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
22
|
* 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.
|
|
23
23
|
* @summary Health Check
|
|
@@ -27,10 +27,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
27
27
|
check: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* HealthApi - functional programming interface
|
|
31
31
|
* @export
|
|
32
32
|
*/
|
|
33
|
-
export declare const
|
|
33
|
+
export declare const HealthApiFp: (configuration?: Configuration) => {
|
|
34
34
|
/**
|
|
35
35
|
* 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.
|
|
36
36
|
* @summary Health Check
|
|
@@ -40,10 +40,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
40
40
|
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* HealthApi - factory interface
|
|
44
44
|
* @export
|
|
45
45
|
*/
|
|
46
|
-
export declare const
|
|
46
|
+
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
47
47
|
/**
|
|
48
48
|
* 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.
|
|
49
49
|
* @summary Health Check
|
|
@@ -53,18 +53,18 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
53
53
|
check(options?: any): AxiosPromise<InlineResponse200>;
|
|
54
54
|
};
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* HealthApi - object-oriented interface
|
|
57
57
|
* @export
|
|
58
|
-
* @class
|
|
58
|
+
* @class HealthApi
|
|
59
59
|
* @extends {BaseAPI}
|
|
60
60
|
*/
|
|
61
|
-
export declare class
|
|
61
|
+
export declare class HealthApi extends BaseAPI {
|
|
62
62
|
/**
|
|
63
63
|
* 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.
|
|
64
64
|
* @summary Health Check
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
|
-
* @memberof
|
|
67
|
+
* @memberof HealthApi
|
|
68
68
|
*/
|
|
69
69
|
check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}>>;
|
|
70
70
|
}
|
|
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
78
78
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
79
|
};
|
|
80
80
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
-
exports.
|
|
81
|
+
exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = void 0;
|
|
82
82
|
var axios_1 = __importDefault(require("axios"));
|
|
83
83
|
// Some imports not used depending on template conditions
|
|
84
84
|
// @ts-ignore
|
|
@@ -86,10 +86,10 @@ var common_1 = require("../common");
|
|
|
86
86
|
// @ts-ignore
|
|
87
87
|
var base_1 = require("../base");
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* HealthApi - axios parameter creator
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
var
|
|
92
|
+
var HealthApiAxiosParamCreator = function (configuration) {
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
@@ -124,13 +124,13 @@ var DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
124
124
|
},
|
|
125
125
|
};
|
|
126
126
|
};
|
|
127
|
-
exports.
|
|
127
|
+
exports.HealthApiAxiosParamCreator = HealthApiAxiosParamCreator;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* HealthApi - functional programming interface
|
|
130
130
|
* @export
|
|
131
131
|
*/
|
|
132
|
-
var
|
|
133
|
-
var localVarAxiosParamCreator = (0, exports.
|
|
132
|
+
var HealthApiFp = function (configuration) {
|
|
133
|
+
var localVarAxiosParamCreator = (0, exports.HealthApiAxiosParamCreator)(configuration);
|
|
134
134
|
return {
|
|
135
135
|
/**
|
|
136
136
|
* 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.
|
|
@@ -153,13 +153,13 @@ var DefaultApiFp = function (configuration) {
|
|
|
153
153
|
},
|
|
154
154
|
};
|
|
155
155
|
};
|
|
156
|
-
exports.
|
|
156
|
+
exports.HealthApiFp = HealthApiFp;
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* HealthApi - factory interface
|
|
159
159
|
* @export
|
|
160
160
|
*/
|
|
161
|
-
var
|
|
162
|
-
var localVarFp = (0, exports.
|
|
161
|
+
var HealthApiFactory = function (configuration, basePath, axios) {
|
|
162
|
+
var localVarFp = (0, exports.HealthApiFp)(configuration);
|
|
163
163
|
return {
|
|
164
164
|
/**
|
|
165
165
|
* 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.
|
|
@@ -172,16 +172,16 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
172
172
|
},
|
|
173
173
|
};
|
|
174
174
|
};
|
|
175
|
-
exports.
|
|
175
|
+
exports.HealthApiFactory = HealthApiFactory;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* HealthApi - object-oriented interface
|
|
178
178
|
* @export
|
|
179
|
-
* @class
|
|
179
|
+
* @class HealthApi
|
|
180
180
|
* @extends {BaseAPI}
|
|
181
181
|
*/
|
|
182
|
-
var
|
|
183
|
-
__extends(
|
|
184
|
-
function
|
|
182
|
+
var HealthApi = /** @class */ (function (_super) {
|
|
183
|
+
__extends(HealthApi, _super);
|
|
184
|
+
function HealthApi() {
|
|
185
185
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
@@ -189,12 +189,12 @@ var DefaultApi = /** @class */ (function (_super) {
|
|
|
189
189
|
* @summary Health Check
|
|
190
190
|
* @param {*} [options] Override http request option.
|
|
191
191
|
* @throws {RequiredError}
|
|
192
|
-
* @memberof
|
|
192
|
+
* @memberof HealthApi
|
|
193
193
|
*/
|
|
194
|
-
|
|
194
|
+
HealthApi.prototype.check = function (options) {
|
|
195
195
|
var _this = this;
|
|
196
|
-
return (0, exports.
|
|
196
|
+
return (0, exports.HealthApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
197
197
|
};
|
|
198
|
-
return
|
|
198
|
+
return HealthApi;
|
|
199
199
|
}(base_1.BaseAPI));
|
|
200
|
-
exports.
|
|
200
|
+
exports.HealthApi = HealthApi;
|
|
@@ -13,6 +13,7 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreatePresignedPostResponseClass } from '../models';
|
|
16
|
+
import { GetProductDocumentDownloadUrlRequestRestDto } from '../models';
|
|
16
17
|
import { GetProductDocumentDownloadUrlResponseClass } from '../models';
|
|
17
18
|
import { GetProductDocumentResponseClass } from '../models';
|
|
18
19
|
import { ListProductDocumentsResponseClass } from '../models';
|
|
@@ -38,11 +39,11 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
38
39
|
* @param {string} productSlug Product slug
|
|
39
40
|
* @param {string} code Product document code
|
|
40
41
|
* @param {string} [authorization] Bearer Token
|
|
41
|
-
* @param {
|
|
42
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
42
43
|
* @param {*} [options] Override http request option.
|
|
43
44
|
* @throws {RequiredError}
|
|
44
45
|
*/
|
|
45
|
-
downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
46
|
+
downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
47
|
/**
|
|
47
48
|
* Get a product document. **Required Permissions** \"document-management.documents.view\"
|
|
48
49
|
* @summary Retrieve the product document
|
|
@@ -68,7 +69,23 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
68
69
|
* @param {*} [options] Override http request option.
|
|
69
70
|
* @throws {RequiredError}
|
|
70
71
|
*/
|
|
71
|
-
|
|
72
|
+
listProductDocuments0: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
|
+
/**
|
|
74
|
+
* 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\"
|
|
75
|
+
* @summary List product documents
|
|
76
|
+
* @param {string} productSlug
|
|
77
|
+
* @param {string} [authorization] Bearer Token
|
|
78
|
+
* @param {number} [pageSize] Page size
|
|
79
|
+
* @param {string} [pageToken] Page token
|
|
80
|
+
* @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>
|
|
81
|
+
* @param {string} [search] Search query
|
|
82
|
+
* @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>
|
|
83
|
+
* @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/>
|
|
84
|
+
* @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>
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
*/
|
|
88
|
+
listProductDocuments1: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
89
|
/**
|
|
73
90
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
74
91
|
* @summary Create the product document
|
|
@@ -101,11 +118,11 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
101
118
|
* @param {string} productSlug Product slug
|
|
102
119
|
* @param {string} code Product document code
|
|
103
120
|
* @param {string} [authorization] Bearer Token
|
|
104
|
-
* @param {
|
|
121
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
105
122
|
* @param {*} [options] Override http request option.
|
|
106
123
|
* @throws {RequiredError}
|
|
107
124
|
*/
|
|
108
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
125
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
|
|
109
126
|
/**
|
|
110
127
|
* Get a product document. **Required Permissions** \"document-management.documents.view\"
|
|
111
128
|
* @summary Retrieve the product document
|
|
@@ -131,7 +148,23 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
131
148
|
* @param {*} [options] Override http request option.
|
|
132
149
|
* @throws {RequiredError}
|
|
133
150
|
*/
|
|
134
|
-
|
|
151
|
+
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>>;
|
|
152
|
+
/**
|
|
153
|
+
* 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\"
|
|
154
|
+
* @summary List product documents
|
|
155
|
+
* @param {string} productSlug
|
|
156
|
+
* @param {string} [authorization] Bearer Token
|
|
157
|
+
* @param {number} [pageSize] Page size
|
|
158
|
+
* @param {string} [pageToken] Page token
|
|
159
|
+
* @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>
|
|
160
|
+
* @param {string} [search] Search query
|
|
161
|
+
* @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>
|
|
162
|
+
* @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/>
|
|
163
|
+
* @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>
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
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>>;
|
|
135
168
|
/**
|
|
136
169
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
137
170
|
* @summary Create the product document
|
|
@@ -164,11 +197,11 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
|
|
|
164
197
|
* @param {string} productSlug Product slug
|
|
165
198
|
* @param {string} code Product document code
|
|
166
199
|
* @param {string} [authorization] Bearer Token
|
|
167
|
-
* @param {
|
|
200
|
+
* @param {GetProductDocumentDownloadUrlRequestRestDto} [contentDisposition] Content disposition type
|
|
168
201
|
* @param {*} [options] Override http request option.
|
|
169
202
|
* @throws {RequiredError}
|
|
170
203
|
*/
|
|
171
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
204
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
|
|
172
205
|
/**
|
|
173
206
|
* Get a product document. **Required Permissions** \"document-management.documents.view\"
|
|
174
207
|
* @summary Retrieve the product document
|
|
@@ -194,7 +227,23 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
|
|
|
194
227
|
* @param {*} [options] Override http request option.
|
|
195
228
|
* @throws {RequiredError}
|
|
196
229
|
*/
|
|
197
|
-
|
|
230
|
+
listProductDocuments0(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
|
|
231
|
+
/**
|
|
232
|
+
* 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\"
|
|
233
|
+
* @summary List product documents
|
|
234
|
+
* @param {string} productSlug
|
|
235
|
+
* @param {string} [authorization] Bearer Token
|
|
236
|
+
* @param {number} [pageSize] Page size
|
|
237
|
+
* @param {string} [pageToken] Page token
|
|
238
|
+
* @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>
|
|
239
|
+
* @param {string} [search] Search query
|
|
240
|
+
* @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>
|
|
241
|
+
* @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/>
|
|
242
|
+
* @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>
|
|
243
|
+
* @param {*} [options] Override http request option.
|
|
244
|
+
* @throws {RequiredError}
|
|
245
|
+
*/
|
|
246
|
+
listProductDocuments1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
|
|
198
247
|
/**
|
|
199
248
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
200
249
|
* @summary Create the product document
|
|
@@ -256,11 +305,11 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
|
|
|
256
305
|
*/
|
|
257
306
|
readonly authorization?: string;
|
|
258
307
|
/**
|
|
259
|
-
* Content disposition
|
|
260
|
-
* @type {
|
|
308
|
+
* Content disposition type
|
|
309
|
+
* @type {GetProductDocumentDownloadUrlRequestRestDto}
|
|
261
310
|
* @memberof ProductDocumentsApiDownloadProductDocument
|
|
262
311
|
*/
|
|
263
|
-
readonly contentDisposition?:
|
|
312
|
+
readonly contentDisposition?: GetProductDocumentDownloadUrlRequestRestDto;
|
|
264
313
|
}
|
|
265
314
|
/**
|
|
266
315
|
* Request parameters for getProductDocument operation in ProductDocumentsApi.
|
|
@@ -288,63 +337,124 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
|
288
337
|
readonly authorization?: string;
|
|
289
338
|
}
|
|
290
339
|
/**
|
|
291
|
-
* Request parameters for
|
|
340
|
+
* Request parameters for listProductDocuments0 operation in ProductDocumentsApi.
|
|
292
341
|
* @export
|
|
293
|
-
* @interface
|
|
342
|
+
* @interface ProductDocumentsApiListProductDocuments0Request
|
|
294
343
|
*/
|
|
295
|
-
export interface
|
|
344
|
+
export interface ProductDocumentsApiListProductDocuments0Request {
|
|
296
345
|
/**
|
|
297
346
|
*
|
|
298
347
|
* @type {string}
|
|
299
|
-
* @memberof
|
|
348
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
300
349
|
*/
|
|
301
350
|
readonly productSlug: string;
|
|
302
351
|
/**
|
|
303
352
|
* Bearer Token
|
|
304
353
|
* @type {string}
|
|
305
|
-
* @memberof
|
|
354
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
306
355
|
*/
|
|
307
356
|
readonly authorization?: string;
|
|
308
357
|
/**
|
|
309
358
|
* Page size
|
|
310
359
|
* @type {number}
|
|
311
|
-
* @memberof
|
|
360
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
312
361
|
*/
|
|
313
362
|
readonly pageSize?: number;
|
|
314
363
|
/**
|
|
315
364
|
* Page token
|
|
316
365
|
* @type {string}
|
|
317
|
-
* @memberof
|
|
366
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
318
367
|
*/
|
|
319
368
|
readonly pageToken?: string;
|
|
320
369
|
/**
|
|
321
370
|
* 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>
|
|
322
371
|
* @type {string}
|
|
323
|
-
* @memberof
|
|
372
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
324
373
|
*/
|
|
325
374
|
readonly filter?: string;
|
|
326
375
|
/**
|
|
327
376
|
* Search query
|
|
328
377
|
* @type {string}
|
|
329
|
-
* @memberof
|
|
378
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
330
379
|
*/
|
|
331
380
|
readonly search?: string;
|
|
332
381
|
/**
|
|
333
382
|
* 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>
|
|
334
383
|
* @type {string}
|
|
335
|
-
* @memberof
|
|
384
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
336
385
|
*/
|
|
337
386
|
readonly order?: string;
|
|
338
387
|
/**
|
|
339
388
|
* 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/>
|
|
340
389
|
* @type {string}
|
|
341
|
-
* @memberof
|
|
390
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
342
391
|
*/
|
|
343
392
|
readonly expand?: string;
|
|
344
393
|
/**
|
|
345
394
|
* 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>
|
|
346
395
|
* @type {string}
|
|
347
|
-
* @memberof
|
|
396
|
+
* @memberof ProductDocumentsApiListProductDocuments0
|
|
397
|
+
*/
|
|
398
|
+
readonly filters?: string;
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* Request parameters for listProductDocuments1 operation in ProductDocumentsApi.
|
|
402
|
+
* @export
|
|
403
|
+
* @interface ProductDocumentsApiListProductDocuments1Request
|
|
404
|
+
*/
|
|
405
|
+
export interface ProductDocumentsApiListProductDocuments1Request {
|
|
406
|
+
/**
|
|
407
|
+
*
|
|
408
|
+
* @type {string}
|
|
409
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
410
|
+
*/
|
|
411
|
+
readonly productSlug: string;
|
|
412
|
+
/**
|
|
413
|
+
* Bearer Token
|
|
414
|
+
* @type {string}
|
|
415
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
416
|
+
*/
|
|
417
|
+
readonly authorization?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Page size
|
|
420
|
+
* @type {number}
|
|
421
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
422
|
+
*/
|
|
423
|
+
readonly pageSize?: number;
|
|
424
|
+
/**
|
|
425
|
+
* Page token
|
|
426
|
+
* @type {string}
|
|
427
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
428
|
+
*/
|
|
429
|
+
readonly pageToken?: string;
|
|
430
|
+
/**
|
|
431
|
+
* 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>
|
|
432
|
+
* @type {string}
|
|
433
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
434
|
+
*/
|
|
435
|
+
readonly filter?: string;
|
|
436
|
+
/**
|
|
437
|
+
* Search query
|
|
438
|
+
* @type {string}
|
|
439
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
440
|
+
*/
|
|
441
|
+
readonly search?: string;
|
|
442
|
+
/**
|
|
443
|
+
* 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>
|
|
444
|
+
* @type {string}
|
|
445
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
446
|
+
*/
|
|
447
|
+
readonly order?: string;
|
|
448
|
+
/**
|
|
449
|
+
* 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/>
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
452
|
+
*/
|
|
453
|
+
readonly expand?: string;
|
|
454
|
+
/**
|
|
455
|
+
* 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>
|
|
456
|
+
* @type {string}
|
|
457
|
+
* @memberof ProductDocumentsApiListProductDocuments1
|
|
348
458
|
*/
|
|
349
459
|
readonly filters?: string;
|
|
350
460
|
}
|
|
@@ -410,12 +520,21 @@ export declare class ProductDocumentsApi extends BaseAPI {
|
|
|
410
520
|
/**
|
|
411
521
|
* 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\"
|
|
412
522
|
* @summary List product documents
|
|
413
|
-
* @param {
|
|
523
|
+
* @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
|
|
524
|
+
* @param {*} [options] Override http request option.
|
|
525
|
+
* @throws {RequiredError}
|
|
526
|
+
* @memberof ProductDocumentsApi
|
|
527
|
+
*/
|
|
528
|
+
listProductDocuments0(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any, {}>>;
|
|
529
|
+
/**
|
|
530
|
+
* 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\"
|
|
531
|
+
* @summary List product documents
|
|
532
|
+
* @param {ProductDocumentsApiListProductDocuments1Request} requestParameters Request parameters.
|
|
414
533
|
* @param {*} [options] Override http request option.
|
|
415
534
|
* @throws {RequiredError}
|
|
416
535
|
* @memberof ProductDocumentsApi
|
|
417
536
|
*/
|
|
418
|
-
|
|
537
|
+
listProductDocuments1(requestParameters: ProductDocumentsApiListProductDocuments1Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any, {}>>;
|
|
419
538
|
/**
|
|
420
539
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
421
540
|
* @summary Create the product document
|