@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
|
@@ -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
|
+
* DefaultApi - axios parameter creator
|
|
18
18
|
* @export
|
|
19
19
|
*/
|
|
20
|
-
export declare const
|
|
20
|
+
export declare const DefaultApiAxiosParamCreator: (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 HealthApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27
27
|
check: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* DefaultApi - functional programming interface
|
|
31
31
|
* @export
|
|
32
32
|
*/
|
|
33
|
-
export declare const
|
|
33
|
+
export declare const DefaultApiFp: (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 HealthApiFp: (configuration?: Configuration) => {
|
|
|
40
40
|
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* DefaultApi - factory interface
|
|
44
44
|
* @export
|
|
45
45
|
*/
|
|
46
|
-
export declare const
|
|
46
|
+
export declare const DefaultApiFactory: (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 HealthApiFactory: (configuration?: Configuration, basePath?
|
|
|
53
53
|
check(options?: any): AxiosPromise<InlineResponse200>;
|
|
54
54
|
};
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* DefaultApi - object-oriented interface
|
|
57
57
|
* @export
|
|
58
|
-
* @class
|
|
58
|
+
* @class DefaultApi
|
|
59
59
|
* @extends {BaseAPI}
|
|
60
60
|
*/
|
|
61
|
-
export declare class
|
|
61
|
+
export declare class DefaultApi 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 DefaultApi
|
|
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.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = 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
|
+
* DefaultApi - axios parameter creator
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
var
|
|
92
|
+
var DefaultApiAxiosParamCreator = function (configuration) {
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
@@ -124,13 +124,13 @@ var HealthApiAxiosParamCreator = function (configuration) {
|
|
|
124
124
|
},
|
|
125
125
|
};
|
|
126
126
|
};
|
|
127
|
-
exports.
|
|
127
|
+
exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* DefaultApi - functional programming interface
|
|
130
130
|
* @export
|
|
131
131
|
*/
|
|
132
|
-
var
|
|
133
|
-
var localVarAxiosParamCreator = (0, exports.
|
|
132
|
+
var DefaultApiFp = function (configuration) {
|
|
133
|
+
var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(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 HealthApiFp = function (configuration) {
|
|
|
153
153
|
},
|
|
154
154
|
};
|
|
155
155
|
};
|
|
156
|
-
exports.
|
|
156
|
+
exports.DefaultApiFp = DefaultApiFp;
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* DefaultApi - factory interface
|
|
159
159
|
* @export
|
|
160
160
|
*/
|
|
161
|
-
var
|
|
162
|
-
var localVarFp = (0, exports.
|
|
161
|
+
var DefaultApiFactory = function (configuration, basePath, axios) {
|
|
162
|
+
var localVarFp = (0, exports.DefaultApiFp)(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 HealthApiFactory = function (configuration, basePath, axios) {
|
|
|
172
172
|
},
|
|
173
173
|
};
|
|
174
174
|
};
|
|
175
|
-
exports.
|
|
175
|
+
exports.DefaultApiFactory = DefaultApiFactory;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* DefaultApi - object-oriented interface
|
|
178
178
|
* @export
|
|
179
|
-
* @class
|
|
179
|
+
* @class DefaultApi
|
|
180
180
|
* @extends {BaseAPI}
|
|
181
181
|
*/
|
|
182
|
-
var
|
|
183
|
-
__extends(
|
|
184
|
-
function
|
|
182
|
+
var DefaultApi = /** @class */ (function (_super) {
|
|
183
|
+
__extends(DefaultApi, _super);
|
|
184
|
+
function DefaultApi() {
|
|
185
185
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
@@ -189,12 +189,12 @@ var HealthApi = /** @class */ (function (_super) {
|
|
|
189
189
|
* @summary Health Check
|
|
190
190
|
* @param {*} [options] Override http request option.
|
|
191
191
|
* @throws {RequiredError}
|
|
192
|
-
* @memberof
|
|
192
|
+
* @memberof DefaultApi
|
|
193
193
|
*/
|
|
194
|
-
|
|
194
|
+
DefaultApi.prototype.check = function (options) {
|
|
195
195
|
var _this = this;
|
|
196
|
-
return (0, exports.
|
|
196
|
+
return (0, exports.DefaultApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
197
197
|
};
|
|
198
|
-
return
|
|
198
|
+
return DefaultApi;
|
|
199
199
|
}(base_1.BaseAPI));
|
|
200
|
-
exports.
|
|
200
|
+
exports.DefaultApi = DefaultApi;
|
|
@@ -20,7 +20,6 @@ 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';
|
|
24
23
|
import { GetSignedS3KeyUrlResponseClass } from '../models';
|
|
25
24
|
import { ListDocumentsResponseClass } from '../models';
|
|
26
25
|
import { MergeDocumentsRequestDto } from '../models';
|
|
@@ -84,11 +83,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
84
83
|
* @summary Fetches a document download URL
|
|
85
84
|
* @param {string} code Document code
|
|
86
85
|
* @param {string} [authorization] Bearer Token
|
|
87
|
-
* @param {
|
|
86
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
88
87
|
* @param {*} [options] Override http request option.
|
|
89
88
|
* @throws {RequiredError}
|
|
90
89
|
*/
|
|
91
|
-
getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?:
|
|
90
|
+
getDocumentDownloadUrl: (code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
91
|
/**
|
|
93
92
|
* This will return a presigned URL for a random S3 key
|
|
94
93
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -199,11 +198,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
|
199
198
|
* @summary Fetches a document download URL
|
|
200
199
|
* @param {string} code Document code
|
|
201
200
|
* @param {string} [authorization] Bearer Token
|
|
202
|
-
* @param {
|
|
201
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
203
202
|
* @param {*} [options] Override http request option.
|
|
204
203
|
* @throws {RequiredError}
|
|
205
204
|
*/
|
|
206
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
205
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
|
|
207
206
|
/**
|
|
208
207
|
* This will return a presigned URL for a random S3 key
|
|
209
208
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -314,11 +313,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
|
|
|
314
313
|
* @summary Fetches a document download URL
|
|
315
314
|
* @param {string} code Document code
|
|
316
315
|
* @param {string} [authorization] Bearer Token
|
|
317
|
-
* @param {
|
|
316
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
318
317
|
* @param {*} [options] Override http request option.
|
|
319
318
|
* @throws {RequiredError}
|
|
320
319
|
*/
|
|
321
|
-
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?:
|
|
320
|
+
getDocumentDownloadUrl(code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
|
|
322
321
|
/**
|
|
323
322
|
* This will return a presigned URL for a random S3 key
|
|
324
323
|
* @summary Fetches a presigned URL for a S3 key
|
|
@@ -494,10 +493,10 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
|
|
|
494
493
|
readonly authorization?: string;
|
|
495
494
|
/**
|
|
496
495
|
* Content disposition override. Default will be depending on the document type.
|
|
497
|
-
* @type {
|
|
496
|
+
* @type {'attachment' | 'inline'}
|
|
498
497
|
* @memberof DocumentsApiGetDocumentDownloadUrl
|
|
499
498
|
*/
|
|
500
|
-
readonly contentDisposition?:
|
|
499
|
+
readonly contentDisposition?: 'attachment' | 'inline';
|
|
501
500
|
}
|
|
502
501
|
/**
|
|
503
502
|
* 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 {'attachment' | 'inline'} [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 {'attachment' | 'inline'} [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 {'attachment' | 'inline'} [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
|
*/
|
|
@@ -13,7 +13,6 @@ 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';
|
|
17
16
|
import { GetProductDocumentDownloadUrlResponseClass } from '../models';
|
|
18
17
|
import { GetProductDocumentResponseClass } from '../models';
|
|
19
18
|
import { ListProductDocumentsResponseClass } from '../models';
|
|
@@ -39,11 +38,11 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
39
38
|
* @param {string} productSlug Product slug
|
|
40
39
|
* @param {string} code Product document code
|
|
41
40
|
* @param {string} [authorization] Bearer Token
|
|
42
|
-
* @param {
|
|
41
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
43
42
|
* @param {*} [options] Override http request option.
|
|
44
43
|
* @throws {RequiredError}
|
|
45
44
|
*/
|
|
46
|
-
downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
45
|
+
downloadProductDocument: (productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
46
|
/**
|
|
48
47
|
* Get a product document. **Required Permissions** \"document-management.documents.view\"
|
|
49
48
|
* @summary Retrieve the product document
|
|
@@ -69,23 +68,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
|
|
|
69
68
|
* @param {*} [options] Override http request option.
|
|
70
69
|
* @throws {RequiredError}
|
|
71
70
|
*/
|
|
72
|
-
|
|
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>;
|
|
71
|
+
listProductDocuments: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
72
|
/**
|
|
90
73
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
91
74
|
* @summary Create the product document
|
|
@@ -118,11 +101,11 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
118
101
|
* @param {string} productSlug Product slug
|
|
119
102
|
* @param {string} code Product document code
|
|
120
103
|
* @param {string} [authorization] Bearer Token
|
|
121
|
-
* @param {
|
|
104
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
122
105
|
* @param {*} [options] Override http request option.
|
|
123
106
|
* @throws {RequiredError}
|
|
124
107
|
*/
|
|
125
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
108
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
|
|
126
109
|
/**
|
|
127
110
|
* Get a product document. **Required Permissions** \"document-management.documents.view\"
|
|
128
111
|
* @summary Retrieve the product document
|
|
@@ -148,23 +131,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
148
131
|
* @param {*} [options] Override http request option.
|
|
149
132
|
* @throws {RequiredError}
|
|
150
133
|
*/
|
|
151
|
-
|
|
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>>;
|
|
134
|
+
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>>;
|
|
168
135
|
/**
|
|
169
136
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
170
137
|
* @summary Create the product document
|
|
@@ -197,11 +164,11 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
|
|
|
197
164
|
* @param {string} productSlug Product slug
|
|
198
165
|
* @param {string} code Product document code
|
|
199
166
|
* @param {string} [authorization] Bearer Token
|
|
200
|
-
* @param {
|
|
167
|
+
* @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
|
|
201
168
|
* @param {*} [options] Override http request option.
|
|
202
169
|
* @throws {RequiredError}
|
|
203
170
|
*/
|
|
204
|
-
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?:
|
|
171
|
+
downloadProductDocument(productSlug: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
|
|
205
172
|
/**
|
|
206
173
|
* Get a product document. **Required Permissions** \"document-management.documents.view\"
|
|
207
174
|
* @summary Retrieve the product document
|
|
@@ -227,23 +194,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
|
|
|
227
194
|
* @param {*} [options] Override http request option.
|
|
228
195
|
* @throws {RequiredError}
|
|
229
196
|
*/
|
|
230
|
-
|
|
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>;
|
|
197
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
|
|
247
198
|
/**
|
|
248
199
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
249
200
|
* @summary Create the product document
|
|
@@ -305,11 +256,11 @@ export interface ProductDocumentsApiDownloadProductDocumentRequest {
|
|
|
305
256
|
*/
|
|
306
257
|
readonly authorization?: string;
|
|
307
258
|
/**
|
|
308
|
-
* Content disposition type
|
|
309
|
-
* @type {
|
|
259
|
+
* Content disposition override. Default will be depending on the document type.
|
|
260
|
+
* @type {'attachment' | 'inline'}
|
|
310
261
|
* @memberof ProductDocumentsApiDownloadProductDocument
|
|
311
262
|
*/
|
|
312
|
-
readonly contentDisposition?:
|
|
263
|
+
readonly contentDisposition?: 'attachment' | 'inline';
|
|
313
264
|
}
|
|
314
265
|
/**
|
|
315
266
|
* Request parameters for getProductDocument operation in ProductDocumentsApi.
|
|
@@ -337,124 +288,63 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
|
337
288
|
readonly authorization?: string;
|
|
338
289
|
}
|
|
339
290
|
/**
|
|
340
|
-
* Request parameters for
|
|
291
|
+
* Request parameters for listProductDocuments operation in ProductDocumentsApi.
|
|
341
292
|
* @export
|
|
342
|
-
* @interface
|
|
293
|
+
* @interface ProductDocumentsApiListProductDocumentsRequest
|
|
343
294
|
*/
|
|
344
|
-
export interface
|
|
295
|
+
export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
345
296
|
/**
|
|
346
297
|
*
|
|
347
298
|
* @type {string}
|
|
348
|
-
* @memberof
|
|
299
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
349
300
|
*/
|
|
350
301
|
readonly productSlug: string;
|
|
351
302
|
/**
|
|
352
303
|
* Bearer Token
|
|
353
304
|
* @type {string}
|
|
354
|
-
* @memberof
|
|
305
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
355
306
|
*/
|
|
356
307
|
readonly authorization?: string;
|
|
357
308
|
/**
|
|
358
309
|
* Page size
|
|
359
310
|
* @type {number}
|
|
360
|
-
* @memberof
|
|
311
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
361
312
|
*/
|
|
362
313
|
readonly pageSize?: number;
|
|
363
314
|
/**
|
|
364
315
|
* Page token
|
|
365
316
|
* @type {string}
|
|
366
|
-
* @memberof
|
|
317
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
367
318
|
*/
|
|
368
319
|
readonly pageToken?: string;
|
|
369
320
|
/**
|
|
370
321
|
* 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>
|
|
371
322
|
* @type {string}
|
|
372
|
-
* @memberof
|
|
323
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
373
324
|
*/
|
|
374
325
|
readonly filter?: string;
|
|
375
326
|
/**
|
|
376
327
|
* Search query
|
|
377
328
|
* @type {string}
|
|
378
|
-
* @memberof
|
|
329
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
379
330
|
*/
|
|
380
331
|
readonly search?: string;
|
|
381
332
|
/**
|
|
382
333
|
* 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>
|
|
383
334
|
* @type {string}
|
|
384
|
-
* @memberof
|
|
335
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
385
336
|
*/
|
|
386
337
|
readonly order?: string;
|
|
387
338
|
/**
|
|
388
339
|
* 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/>
|
|
389
340
|
* @type {string}
|
|
390
|
-
* @memberof
|
|
341
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
391
342
|
*/
|
|
392
343
|
readonly expand?: string;
|
|
393
344
|
/**
|
|
394
345
|
* 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>
|
|
395
346
|
* @type {string}
|
|
396
|
-
* @memberof
|
|
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
|
|
347
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
458
348
|
*/
|
|
459
349
|
readonly filters?: string;
|
|
460
350
|
}
|
|
@@ -520,21 +410,12 @@ export declare class ProductDocumentsApi extends BaseAPI {
|
|
|
520
410
|
/**
|
|
521
411
|
* 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\"
|
|
522
412
|
* @summary List product documents
|
|
523
|
-
* @param {
|
|
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.
|
|
413
|
+
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
533
414
|
* @param {*} [options] Override http request option.
|
|
534
415
|
* @throws {RequiredError}
|
|
535
416
|
* @memberof ProductDocumentsApi
|
|
536
417
|
*/
|
|
537
|
-
|
|
418
|
+
listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any, {}>>;
|
|
538
419
|
/**
|
|
539
420
|
* Upload a product document. **Required Permissions** \"document-management.documents.update\"
|
|
540
421
|
* @summary Create the product document
|