@emilgroup/document-sdk-node 1.2.1 → 1.3.0
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 +6 -0
- package/README.md +2 -2
- package/api/documents-api.ts +8 -8
- package/api/product-documents-api.ts +599 -0
- package/api.ts +2 -0
- package/base.ts +1 -1
- package/dist/api/documents-api.d.ts +8 -8
- package/dist/api/documents-api.js +8 -8
- package/dist/api/product-documents-api.d.ts +345 -0
- package/dist/api/product-documents-api.js +558 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +1 -1
- package/dist/models/create-document-request-dto.d.ts +1 -0
- package/dist/models/create-document-request-dto.js +2 -1
- package/dist/models/create-presigned-post-request-dto.d.ts +1 -0
- package/dist/models/create-presigned-post-request-dto.js +2 -1
- package/dist/models/delete-product-document-request-dto.d.ts +30 -0
- package/dist/models/delete-product-document-request-dto.js +15 -0
- package/dist/models/document-class.d.ts +1 -0
- package/dist/models/document-class.js +2 -1
- package/dist/models/get-product-document-response-class.d.ts +25 -0
- package/dist/models/get-product-document-response-class.js +15 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/list-product-documents-response-class.d.ts +31 -0
- package/dist/models/list-product-documents-response-class.js +15 -0
- package/dist/models/product-document-class.d.ts +99 -0
- package/dist/models/product-document-class.js +36 -0
- package/dist/models/upload-product-document-request-dto.d.ts +63 -0
- package/dist/models/upload-product-document-request-dto.js +24 -0
- package/models/create-document-request-dto.ts +2 -1
- package/models/create-presigned-post-request-dto.ts +2 -1
- package/models/delete-product-document-request-dto.ts +36 -0
- package/models/document-class.ts +2 -1
- package/models/get-product-document-response-class.ts +31 -0
- package/models/index.ts +5 -0
- package/models/list-product-documents-response-class.ts +37 -0
- package/models/product-document-class.ts +108 -0
- package/models/upload-product-document-request-dto.ts +72 -0
- package/package.json +2 -2
|
@@ -0,0 +1,599 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL DocumentService
|
|
5
|
+
* The EMIL DocumentService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { GetProductDocumentResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ListProductDocumentsResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { ProductDocumentClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { UploadProductDocumentRequestDto } from '../models';
|
|
31
|
+
// URLSearchParams not necessarily used
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import { URL, URLSearchParams } from 'url';
|
|
34
|
+
const FormData = require('form-data');
|
|
35
|
+
/**
|
|
36
|
+
* ProductDocumentsApi - axios parameter creator
|
|
37
|
+
* @export
|
|
38
|
+
*/
|
|
39
|
+
export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
|
+
return {
|
|
41
|
+
/**
|
|
42
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
43
|
+
* @summary Delete the product document
|
|
44
|
+
* @param {string} code
|
|
45
|
+
* @param {string} productSlug
|
|
46
|
+
* @param {string} [authorization] Bearer Token
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
deleteProductDocument: async (code: string, productSlug: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51
|
+
// verify required parameter 'code' is not null or undefined
|
|
52
|
+
assertParamExists('deleteProductDocument', 'code', code)
|
|
53
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
54
|
+
assertParamExists('deleteProductDocument', 'productSlug', productSlug)
|
|
55
|
+
const localVarPath = `/documentservice/v1/documents/product/{productSlug}/{code}`
|
|
56
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
57
|
+
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
58
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60
|
+
let baseOptions;
|
|
61
|
+
let baseAccessToken;
|
|
62
|
+
if (configuration) {
|
|
63
|
+
baseOptions = configuration.baseOptions;
|
|
64
|
+
baseAccessToken = configuration.accessToken;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
68
|
+
const localVarHeaderParameter = {} as any;
|
|
69
|
+
const localVarQueryParameter = {} as any;
|
|
70
|
+
|
|
71
|
+
// authentication bearer required
|
|
72
|
+
// http bearer authentication required
|
|
73
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
74
|
+
|
|
75
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
76
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
83
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
url: toPathString(localVarUrlObj),
|
|
87
|
+
options: localVarRequestOptions,
|
|
88
|
+
};
|
|
89
|
+
},
|
|
90
|
+
/**
|
|
91
|
+
* Get a product document.
|
|
92
|
+
* @summary Retrieve the product document
|
|
93
|
+
* @param {string} productSlug
|
|
94
|
+
* @param {string} code
|
|
95
|
+
* @param {string} [authorization] Bearer Token
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
getProductDocument: async (productSlug: string, code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
100
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
101
|
+
assertParamExists('getProductDocument', 'productSlug', productSlug)
|
|
102
|
+
// verify required parameter 'code' is not null or undefined
|
|
103
|
+
assertParamExists('getProductDocument', 'code', code)
|
|
104
|
+
const localVarPath = `/documentservice/v1/documents/product/{productSlug}/{code}`
|
|
105
|
+
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)))
|
|
106
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
107
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
108
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
109
|
+
let baseOptions;
|
|
110
|
+
let baseAccessToken;
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
baseAccessToken = configuration.accessToken;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
117
|
+
const localVarHeaderParameter = {} as any;
|
|
118
|
+
const localVarQueryParameter = {} as any;
|
|
119
|
+
|
|
120
|
+
// authentication bearer required
|
|
121
|
+
// http bearer authentication required
|
|
122
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
123
|
+
|
|
124
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
125
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
132
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
133
|
+
|
|
134
|
+
return {
|
|
135
|
+
url: toPathString(localVarUrlObj),
|
|
136
|
+
options: localVarRequestOptions,
|
|
137
|
+
};
|
|
138
|
+
},
|
|
139
|
+
/**
|
|
140
|
+
* 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.
|
|
141
|
+
* @summary List product documents
|
|
142
|
+
* @param {string} productSlug
|
|
143
|
+
* @param {string} [authorization] Bearer Token
|
|
144
|
+
* @param {number} [pageSize] Page size
|
|
145
|
+
* @param {string} [pageToken] Page token
|
|
146
|
+
* @param {string} [filter] List filter
|
|
147
|
+
* @param {string} [search] Search query
|
|
148
|
+
* @param {string} [order] Ordering criteria
|
|
149
|
+
* @param {string} [expand] Extra fields to fetch
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
listProductDocuments: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
154
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
155
|
+
assertParamExists('listProductDocuments', 'productSlug', productSlug)
|
|
156
|
+
const localVarPath = `/documentservice/v1/documents/product/{productSlug}`
|
|
157
|
+
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
158
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
159
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
160
|
+
let baseOptions;
|
|
161
|
+
let baseAccessToken;
|
|
162
|
+
if (configuration) {
|
|
163
|
+
baseOptions = configuration.baseOptions;
|
|
164
|
+
baseAccessToken = configuration.accessToken;
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
168
|
+
const localVarHeaderParameter = {} as any;
|
|
169
|
+
const localVarQueryParameter = {} as any;
|
|
170
|
+
|
|
171
|
+
// authentication bearer required
|
|
172
|
+
// http bearer authentication required
|
|
173
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
174
|
+
|
|
175
|
+
if (pageSize !== undefined) {
|
|
176
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
if (pageToken !== undefined) {
|
|
180
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
if (filter !== undefined) {
|
|
184
|
+
localVarQueryParameter['filter'] = filter;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
if (search !== undefined) {
|
|
188
|
+
localVarQueryParameter['search'] = search;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
if (order !== undefined) {
|
|
192
|
+
localVarQueryParameter['order'] = order;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
if (expand !== undefined) {
|
|
196
|
+
localVarQueryParameter['expand'] = expand;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
200
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
206
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
207
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
208
|
+
|
|
209
|
+
return {
|
|
210
|
+
url: toPathString(localVarUrlObj),
|
|
211
|
+
options: localVarRequestOptions,
|
|
212
|
+
};
|
|
213
|
+
},
|
|
214
|
+
/**
|
|
215
|
+
* Upload a product document.
|
|
216
|
+
* @summary Create the product document
|
|
217
|
+
* @param {string} productSlug
|
|
218
|
+
* @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
|
|
219
|
+
* @param {string} [authorization] Bearer Token
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
uploadProductDocument: async (productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
224
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
225
|
+
assertParamExists('uploadProductDocument', 'productSlug', productSlug)
|
|
226
|
+
// verify required parameter 'uploadProductDocumentRequestDto' is not null or undefined
|
|
227
|
+
assertParamExists('uploadProductDocument', 'uploadProductDocumentRequestDto', uploadProductDocumentRequestDto)
|
|
228
|
+
const localVarPath = `/documentservice/v1/documents/product/{productSlug}`
|
|
229
|
+
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
230
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
231
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
232
|
+
let baseOptions;
|
|
233
|
+
let baseAccessToken;
|
|
234
|
+
if (configuration) {
|
|
235
|
+
baseOptions = configuration.baseOptions;
|
|
236
|
+
baseAccessToken = configuration.accessToken;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
240
|
+
const localVarHeaderParameter = {} as any;
|
|
241
|
+
const localVarQueryParameter = {} as any;
|
|
242
|
+
|
|
243
|
+
// authentication bearer required
|
|
244
|
+
// http bearer authentication required
|
|
245
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
246
|
+
|
|
247
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
248
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
254
|
+
|
|
255
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
256
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
257
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
258
|
+
localVarRequestOptions.data = serializeDataIfNeeded(uploadProductDocumentRequestDto, localVarRequestOptions, configuration)
|
|
259
|
+
|
|
260
|
+
return {
|
|
261
|
+
url: toPathString(localVarUrlObj),
|
|
262
|
+
options: localVarRequestOptions,
|
|
263
|
+
};
|
|
264
|
+
},
|
|
265
|
+
}
|
|
266
|
+
};
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* ProductDocumentsApi - functional programming interface
|
|
270
|
+
* @export
|
|
271
|
+
*/
|
|
272
|
+
export const ProductDocumentsApiFp = function(configuration?: Configuration) {
|
|
273
|
+
const localVarAxiosParamCreator = ProductDocumentsApiAxiosParamCreator(configuration)
|
|
274
|
+
return {
|
|
275
|
+
/**
|
|
276
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
277
|
+
* @summary Delete the product document
|
|
278
|
+
* @param {string} code
|
|
279
|
+
* @param {string} productSlug
|
|
280
|
+
* @param {string} [authorization] Bearer Token
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
async deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
285
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProductDocument(code, productSlug, authorization, options);
|
|
286
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
287
|
+
},
|
|
288
|
+
/**
|
|
289
|
+
* Get a product document.
|
|
290
|
+
* @summary Retrieve the product document
|
|
291
|
+
* @param {string} productSlug
|
|
292
|
+
* @param {string} code
|
|
293
|
+
* @param {string} [authorization] Bearer Token
|
|
294
|
+
* @param {*} [options] Override http request option.
|
|
295
|
+
* @throws {RequiredError}
|
|
296
|
+
*/
|
|
297
|
+
async getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentResponseClass>> {
|
|
298
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductDocument(productSlug, code, authorization, options);
|
|
299
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
300
|
+
},
|
|
301
|
+
/**
|
|
302
|
+
* 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.
|
|
303
|
+
* @summary List product documents
|
|
304
|
+
* @param {string} productSlug
|
|
305
|
+
* @param {string} [authorization] Bearer Token
|
|
306
|
+
* @param {number} [pageSize] Page size
|
|
307
|
+
* @param {string} [pageToken] Page token
|
|
308
|
+
* @param {string} [filter] List filter
|
|
309
|
+
* @param {string} [search] Search query
|
|
310
|
+
* @param {string} [order] Ordering criteria
|
|
311
|
+
* @param {string} [expand] Extra fields to fetch
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
|
|
316
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
317
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
318
|
+
},
|
|
319
|
+
/**
|
|
320
|
+
* Upload a product document.
|
|
321
|
+
* @summary Create the product document
|
|
322
|
+
* @param {string} productSlug
|
|
323
|
+
* @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
|
|
324
|
+
* @param {string} [authorization] Bearer Token
|
|
325
|
+
* @param {*} [options] Override http request option.
|
|
326
|
+
* @throws {RequiredError}
|
|
327
|
+
*/
|
|
328
|
+
async uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDocumentClass>> {
|
|
329
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadProductDocument(productSlug, uploadProductDocumentRequestDto, authorization, options);
|
|
330
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
331
|
+
},
|
|
332
|
+
}
|
|
333
|
+
};
|
|
334
|
+
|
|
335
|
+
/**
|
|
336
|
+
* ProductDocumentsApi - factory interface
|
|
337
|
+
* @export
|
|
338
|
+
*/
|
|
339
|
+
export const ProductDocumentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
340
|
+
const localVarFp = ProductDocumentsApiFp(configuration)
|
|
341
|
+
return {
|
|
342
|
+
/**
|
|
343
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
344
|
+
* @summary Delete the product document
|
|
345
|
+
* @param {string} code
|
|
346
|
+
* @param {string} productSlug
|
|
347
|
+
* @param {string} [authorization] Bearer Token
|
|
348
|
+
* @param {*} [options] Override http request option.
|
|
349
|
+
* @throws {RequiredError}
|
|
350
|
+
*/
|
|
351
|
+
deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object> {
|
|
352
|
+
return localVarFp.deleteProductDocument(code, productSlug, authorization, options).then((request) => request(axios, basePath));
|
|
353
|
+
},
|
|
354
|
+
/**
|
|
355
|
+
* Get a product document.
|
|
356
|
+
* @summary Retrieve the product document
|
|
357
|
+
* @param {string} productSlug
|
|
358
|
+
* @param {string} code
|
|
359
|
+
* @param {string} [authorization] Bearer Token
|
|
360
|
+
* @param {*} [options] Override http request option.
|
|
361
|
+
* @throws {RequiredError}
|
|
362
|
+
*/
|
|
363
|
+
getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentResponseClass> {
|
|
364
|
+
return localVarFp.getProductDocument(productSlug, code, authorization, options).then((request) => request(axios, basePath));
|
|
365
|
+
},
|
|
366
|
+
/**
|
|
367
|
+
* 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.
|
|
368
|
+
* @summary List product documents
|
|
369
|
+
* @param {string} productSlug
|
|
370
|
+
* @param {string} [authorization] Bearer Token
|
|
371
|
+
* @param {number} [pageSize] Page size
|
|
372
|
+
* @param {string} [pageToken] Page token
|
|
373
|
+
* @param {string} [filter] List filter
|
|
374
|
+
* @param {string} [search] Search query
|
|
375
|
+
* @param {string} [order] Ordering criteria
|
|
376
|
+
* @param {string} [expand] Extra fields to fetch
|
|
377
|
+
* @param {*} [options] Override http request option.
|
|
378
|
+
* @throws {RequiredError}
|
|
379
|
+
*/
|
|
380
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
|
|
381
|
+
return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
382
|
+
},
|
|
383
|
+
/**
|
|
384
|
+
* Upload a product document.
|
|
385
|
+
* @summary Create the product document
|
|
386
|
+
* @param {string} productSlug
|
|
387
|
+
* @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
|
|
388
|
+
* @param {string} [authorization] Bearer Token
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<ProductDocumentClass> {
|
|
393
|
+
return localVarFp.uploadProductDocument(productSlug, uploadProductDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
394
|
+
},
|
|
395
|
+
};
|
|
396
|
+
};
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* Request parameters for deleteProductDocument operation in ProductDocumentsApi.
|
|
400
|
+
* @export
|
|
401
|
+
* @interface ProductDocumentsApiDeleteProductDocumentRequest
|
|
402
|
+
*/
|
|
403
|
+
export interface ProductDocumentsApiDeleteProductDocumentRequest {
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof ProductDocumentsApiDeleteProductDocument
|
|
408
|
+
*/
|
|
409
|
+
readonly code: string
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
*
|
|
413
|
+
* @type {string}
|
|
414
|
+
* @memberof ProductDocumentsApiDeleteProductDocument
|
|
415
|
+
*/
|
|
416
|
+
readonly productSlug: string
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Bearer Token
|
|
420
|
+
* @type {string}
|
|
421
|
+
* @memberof ProductDocumentsApiDeleteProductDocument
|
|
422
|
+
*/
|
|
423
|
+
readonly authorization?: string
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
/**
|
|
427
|
+
* Request parameters for getProductDocument operation in ProductDocumentsApi.
|
|
428
|
+
* @export
|
|
429
|
+
* @interface ProductDocumentsApiGetProductDocumentRequest
|
|
430
|
+
*/
|
|
431
|
+
export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof ProductDocumentsApiGetProductDocument
|
|
436
|
+
*/
|
|
437
|
+
readonly productSlug: string
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof ProductDocumentsApiGetProductDocument
|
|
443
|
+
*/
|
|
444
|
+
readonly code: string
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Bearer Token
|
|
448
|
+
* @type {string}
|
|
449
|
+
* @memberof ProductDocumentsApiGetProductDocument
|
|
450
|
+
*/
|
|
451
|
+
readonly authorization?: string
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* Request parameters for listProductDocuments operation in ProductDocumentsApi.
|
|
456
|
+
* @export
|
|
457
|
+
* @interface ProductDocumentsApiListProductDocumentsRequest
|
|
458
|
+
*/
|
|
459
|
+
export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
460
|
+
/**
|
|
461
|
+
*
|
|
462
|
+
* @type {string}
|
|
463
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
464
|
+
*/
|
|
465
|
+
readonly productSlug: string
|
|
466
|
+
|
|
467
|
+
/**
|
|
468
|
+
* Bearer Token
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
471
|
+
*/
|
|
472
|
+
readonly authorization?: string
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* Page size
|
|
476
|
+
* @type {number}
|
|
477
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
478
|
+
*/
|
|
479
|
+
readonly pageSize?: number
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Page token
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
485
|
+
*/
|
|
486
|
+
readonly pageToken?: string
|
|
487
|
+
|
|
488
|
+
/**
|
|
489
|
+
* List filter
|
|
490
|
+
* @type {string}
|
|
491
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
492
|
+
*/
|
|
493
|
+
readonly filter?: string
|
|
494
|
+
|
|
495
|
+
/**
|
|
496
|
+
* Search query
|
|
497
|
+
* @type {string}
|
|
498
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
499
|
+
*/
|
|
500
|
+
readonly search?: string
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* Ordering criteria
|
|
504
|
+
* @type {string}
|
|
505
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
506
|
+
*/
|
|
507
|
+
readonly order?: string
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Extra fields to fetch
|
|
511
|
+
* @type {string}
|
|
512
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
513
|
+
*/
|
|
514
|
+
readonly expand?: string
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Request parameters for uploadProductDocument operation in ProductDocumentsApi.
|
|
519
|
+
* @export
|
|
520
|
+
* @interface ProductDocumentsApiUploadProductDocumentRequest
|
|
521
|
+
*/
|
|
522
|
+
export interface ProductDocumentsApiUploadProductDocumentRequest {
|
|
523
|
+
/**
|
|
524
|
+
*
|
|
525
|
+
* @type {string}
|
|
526
|
+
* @memberof ProductDocumentsApiUploadProductDocument
|
|
527
|
+
*/
|
|
528
|
+
readonly productSlug: string
|
|
529
|
+
|
|
530
|
+
/**
|
|
531
|
+
*
|
|
532
|
+
* @type {UploadProductDocumentRequestDto}
|
|
533
|
+
* @memberof ProductDocumentsApiUploadProductDocument
|
|
534
|
+
*/
|
|
535
|
+
readonly uploadProductDocumentRequestDto: UploadProductDocumentRequestDto
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* Bearer Token
|
|
539
|
+
* @type {string}
|
|
540
|
+
* @memberof ProductDocumentsApiUploadProductDocument
|
|
541
|
+
*/
|
|
542
|
+
readonly authorization?: string
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* ProductDocumentsApi - object-oriented interface
|
|
547
|
+
* @export
|
|
548
|
+
* @class ProductDocumentsApi
|
|
549
|
+
* @extends {BaseAPI}
|
|
550
|
+
*/
|
|
551
|
+
export class ProductDocumentsApi extends BaseAPI {
|
|
552
|
+
/**
|
|
553
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
554
|
+
* @summary Delete the product document
|
|
555
|
+
* @param {ProductDocumentsApiDeleteProductDocumentRequest} requestParameters Request parameters.
|
|
556
|
+
* @param {*} [options] Override http request option.
|
|
557
|
+
* @throws {RequiredError}
|
|
558
|
+
* @memberof ProductDocumentsApi
|
|
559
|
+
*/
|
|
560
|
+
public deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig) {
|
|
561
|
+
return ProductDocumentsApiFp(this.configuration).deleteProductDocument(requestParameters.code, requestParameters.productSlug, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
/**
|
|
565
|
+
* Get a product document.
|
|
566
|
+
* @summary Retrieve the product document
|
|
567
|
+
* @param {ProductDocumentsApiGetProductDocumentRequest} requestParameters Request parameters.
|
|
568
|
+
* @param {*} [options] Override http request option.
|
|
569
|
+
* @throws {RequiredError}
|
|
570
|
+
* @memberof ProductDocumentsApi
|
|
571
|
+
*/
|
|
572
|
+
public getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig) {
|
|
573
|
+
return ProductDocumentsApiFp(this.configuration).getProductDocument(requestParameters.productSlug, requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
574
|
+
}
|
|
575
|
+
|
|
576
|
+
/**
|
|
577
|
+
* 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.
|
|
578
|
+
* @summary List product documents
|
|
579
|
+
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
580
|
+
* @param {*} [options] Override http request option.
|
|
581
|
+
* @throws {RequiredError}
|
|
582
|
+
* @memberof ProductDocumentsApi
|
|
583
|
+
*/
|
|
584
|
+
public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
|
|
585
|
+
return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* Upload a product document.
|
|
590
|
+
* @summary Create the product document
|
|
591
|
+
* @param {ProductDocumentsApiUploadProductDocumentRequest} requestParameters Request parameters.
|
|
592
|
+
* @param {*} [options] Override http request option.
|
|
593
|
+
* @throws {RequiredError}
|
|
594
|
+
* @memberof ProductDocumentsApi
|
|
595
|
+
*/
|
|
596
|
+
public uploadProductDocument(requestParameters: ProductDocumentsApiUploadProductDocumentRequest, options?: AxiosRequestConfig) {
|
|
597
|
+
return ProductDocumentsApiFp(this.configuration).uploadProductDocument(requestParameters.productSlug, requestParameters.uploadProductDocumentRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
598
|
+
}
|
|
599
|
+
}
|
package/api.ts
CHANGED
|
@@ -27,6 +27,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
27
27
|
import { DocumentTemplatesApi } from './api';
|
|
28
28
|
import { DocumentsApi } from './api';
|
|
29
29
|
import { LayoutsApi } from './api';
|
|
30
|
+
import { ProductDocumentsApi } from './api';
|
|
30
31
|
import { SearchKeywordsApi } from './api';
|
|
31
32
|
import { SearchableDocumentOwnersApi } from './api';
|
|
32
33
|
import { SearchableDocumentsApi } from './api';
|
|
@@ -35,6 +36,7 @@ import { SearchableDocumentsApi } from './api';
|
|
|
35
36
|
export * from './api/document-templates-api';
|
|
36
37
|
export * from './api/documents-api';
|
|
37
38
|
export * from './api/layouts-api';
|
|
39
|
+
export * from './api/product-documents-api';
|
|
38
40
|
export * from './api/search-keywords-api';
|
|
39
41
|
export * from './api/searchable-document-owners-api';
|
|
40
42
|
export * from './api/searchable-documents-api';
|
package/base.ts
CHANGED
|
@@ -21,7 +21,7 @@ import * as fs from 'fs';
|
|
|
21
21
|
import * as path from 'path';
|
|
22
22
|
import * as os from 'os';
|
|
23
23
|
|
|
24
|
-
export const BASE_PATH = "
|
|
24
|
+
export const BASE_PATH = "https://apiv2.emil.de".replace(/\/+$/, "");
|
|
25
25
|
const CONFIG_DIRECTORY = '.emil';
|
|
26
26
|
const CONFIG_FILENAME = 'credentials';
|
|
27
27
|
const KEY_USERNAME = 'emil_username';
|