@configura/web-api 1.5.0-alpha.0 → 1.5.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/LICENSE +201 -201
- package/README.md +1 -1
- package/dist/CatalogueAPI.d.ts +511 -504
- package/dist/CatalogueAPI.js +273 -250
- package/dist/CfgMeasure.d.ts +32 -32
- package/dist/CfgMeasure.js +30 -30
- package/dist/CfgProduct.d.ts +239 -217
- package/dist/CfgProduct.js +668 -636
- package/dist/index.d.ts +18 -18
- package/dist/index.js +18 -18
- package/dist/material/CfgMaterialMapping.d.ts +7 -7
- package/dist/material/CfgMaterialMapping.js +181 -181
- package/dist/material/CfgMtrlApplication.d.ts +18 -18
- package/dist/material/CfgMtrlApplication.js +43 -43
- package/dist/material/CfgMtrlApplicationSource.d.ts +7 -7
- package/dist/material/CfgMtrlApplicationSource.js +8 -8
- package/dist/material/CfgMtrlSource.d.ts +19 -19
- package/dist/material/CfgMtrlSource.js +40 -40
- package/dist/material/CfgMtrlSourceWithMetaData.d.ts +7 -7
- package/dist/material/CfgMtrlSourceWithMetaData.js +1 -1
- package/dist/productConfiguration/CfgFeature.d.ts +178 -164
- package/dist/productConfiguration/CfgFeature.js +611 -597
- package/dist/productConfiguration/CfgOption.d.ts +128 -128
- package/dist/productConfiguration/CfgOption.js +394 -394
- package/dist/productConfiguration/CfgProductConfiguration.d.ts +120 -120
- package/dist/productConfiguration/CfgProductConfiguration.js +307 -307
- package/dist/productConfiguration/filters.d.ts +15 -15
- package/dist/productConfiguration/filters.js +67 -67
- package/dist/productConfiguration/productParamsGenerator.d.ts +15 -15
- package/dist/productConfiguration/productParamsGenerator.js +51 -51
- package/dist/productConfiguration/utilitiesProductConfiguration.d.ts +17 -17
- package/dist/productConfiguration/utilitiesProductConfiguration.js +80 -80
- package/dist/productLoader.d.ts +33 -33
- package/dist/productLoader.js +49 -49
- package/dist/tasks/TaskHandler.d.ts +78 -78
- package/dist/tasks/TaskHandler.js +265 -264
- package/dist/tasks/formats.d.ts +4 -6
- package/dist/tasks/formats.js +7 -8
- package/dist/tests/testData/collectorForTest.d.ts +73 -73
- package/dist/tests/testData/collectorForTest.js +195 -195
- package/dist/tests/testData/dummyProductForTest.d.ts +4 -4
- package/dist/tests/testData/dummyProductForTest.js +36 -36
- package/dist/tests/testData/testDataAdditionalProductInAdditionalProductInProductForTest.d.ts +32 -32
- package/dist/tests/testData/testDataAdditionalProductInAdditionalProductInProductForTest.js +348 -348
- package/dist/tests/testData/testDataCachedGetProduct.d.ts +5 -5
- package/dist/tests/testData/testDataCachedGetProduct.js +196 -196
- package/dist/tests/testData/testDataCachedPostValidate.d.ts +7 -7
- package/dist/tests/testData/testDataCachedPostValidate.js +183 -183
- package/dist/tests/testData/testDataNoAdditionalProductNoPropagateForTest.d.ts +3 -3
- package/dist/tests/testData/testDataNoAdditionalProductNoPropagateForTest.js +1099 -1099
- package/dist/tests/testData/testDataProductAggregatedPrice.d.ts +6 -6
- package/dist/tests/testData/testDataProductAggregatedPrice.js +198 -198
- package/dist/tests/testData/testDataUpcharge.d.ts +29 -29
- package/dist/tests/testData/testDataUpcharge.js +151 -151
- package/dist/utilitiesCatalogueData.d.ts +25 -25
- package/dist/utilitiesCatalogueData.js +64 -64
- package/dist/utilitiesCataloguePermission.d.ts +39 -39
- package/dist/utilitiesCataloguePermission.js +84 -84
- package/dist/utilitiesNumericValues.d.ts +24 -24
- package/dist/utilitiesNumericValues.js +109 -109
- package/package.json +3 -3
package/dist/CatalogueAPI.d.ts
CHANGED
|
@@ -1,505 +1,512 @@
|
|
|
1
|
-
/** AdditionalProductConfiguration */
|
|
2
|
-
export interface AdditionalProductConfiguration {
|
|
3
|
-
refKey?: string;
|
|
4
|
-
selected?: boolean;
|
|
5
|
-
selOptions: Array<SelectedOption>;
|
|
6
|
-
additionalProducts?: Array<AdditionalProductConfiguration>;
|
|
7
|
-
}
|
|
8
|
-
/** AdditionalProductRef */
|
|
9
|
-
export interface AdditionalProductRef {
|
|
10
|
-
refKey: string;
|
|
11
|
-
catId: CatalogueParams;
|
|
12
|
-
partNumber: string;
|
|
13
|
-
refDescription?: string;
|
|
14
|
-
anchor?: MeasureParam;
|
|
15
|
-
transform?: Transform;
|
|
16
|
-
optional?: boolean;
|
|
17
|
-
}
|
|
18
|
-
/** ApplicationArea */
|
|
19
|
-
export interface ApplicationArea {
|
|
20
|
-
areas?: Array<string>;
|
|
21
|
-
cid?: number;
|
|
22
|
-
material?: string;
|
|
23
|
-
preview?: string;
|
|
24
|
-
}
|
|
25
|
-
/** ApplicationAreasResponse */
|
|
26
|
-
export interface ApplicationAreasResponse {
|
|
27
|
-
applicationAreas: Array<ApplicationArea>;
|
|
28
|
-
uuid: string;
|
|
29
|
-
}
|
|
30
|
-
/** AuthorizeResponse */
|
|
31
|
-
export interface AuthorizeResponse {
|
|
32
|
-
endpoint: string;
|
|
33
|
-
secretToken: string;
|
|
34
|
-
apiSession: CatalogueAPISession;
|
|
35
|
-
}
|
|
36
|
-
/** CatalogueAPISession */
|
|
37
|
-
export interface CatalogueAPISession {
|
|
38
|
-
expires: string;
|
|
39
|
-
features?: Array<string>;
|
|
40
|
-
permissions?: Array<CataloguePermission>;
|
|
41
|
-
}
|
|
42
|
-
/** CatalogueParams */
|
|
43
|
-
export interface CatalogueParams {
|
|
44
|
-
enterprise: string;
|
|
45
|
-
prdCat: string;
|
|
46
|
-
prdCatVersion: string;
|
|
47
|
-
vendor: string;
|
|
48
|
-
priceList: string;
|
|
49
|
-
}
|
|
50
|
-
/** CataloguePermission */
|
|
51
|
-
export interface CataloguePermission {
|
|
52
|
-
cid: number;
|
|
53
|
-
enterprise: string;
|
|
54
|
-
prdCat: string;
|
|
55
|
-
prdCatVersion: string;
|
|
56
|
-
priceLists?: Array<string>;
|
|
57
|
-
vendors?: Array<string>;
|
|
58
|
-
}
|
|
59
|
-
/** CategoryMap */
|
|
60
|
-
export interface CategoryMap {
|
|
61
|
-
[index: string]: string;
|
|
62
|
-
}
|
|
63
|
-
/** CodeRange */
|
|
64
|
-
export interface CodeRange {
|
|
65
|
-
minValue: number;
|
|
66
|
-
maxValue: number;
|
|
67
|
-
increment?: number;
|
|
68
|
-
}
|
|
69
|
-
/** ConnectorRef */
|
|
70
|
-
export interface ConnectorRef {
|
|
71
|
-
code: string;
|
|
72
|
-
connectRule: string;
|
|
73
|
-
visible: boolean;
|
|
74
|
-
anchor?: MeasureParam;
|
|
75
|
-
transform: Transform;
|
|
76
|
-
}
|
|
77
|
-
/** ErrorResponse */
|
|
78
|
-
export interface ErrorResponse {
|
|
79
|
-
error: string;
|
|
80
|
-
code: number;
|
|
81
|
-
eventId?: string;
|
|
82
|
-
}
|
|
83
|
-
/** ExportFormat -
|
|
84
|
-
export declare type ExportFormat = "fbx" | "dwg" | "cmdrw" | "cmfav" | "cmsym";
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
export
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
}
|
|
380
|
-
/**
|
|
381
|
-
export
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
}
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
}
|
|
445
|
-
/**
|
|
446
|
-
export interface
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
}
|
|
462
|
-
/**
|
|
463
|
-
export interface
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
}
|
|
480
|
-
export declare
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
1
|
+
/** AdditionalProductConfiguration */
|
|
2
|
+
export interface AdditionalProductConfiguration {
|
|
3
|
+
refKey?: string;
|
|
4
|
+
selected?: boolean;
|
|
5
|
+
selOptions: Array<SelectedOption>;
|
|
6
|
+
additionalProducts?: Array<AdditionalProductConfiguration>;
|
|
7
|
+
}
|
|
8
|
+
/** AdditionalProductRef */
|
|
9
|
+
export interface AdditionalProductRef {
|
|
10
|
+
refKey: string;
|
|
11
|
+
catId: CatalogueParams;
|
|
12
|
+
partNumber: string;
|
|
13
|
+
refDescription?: string;
|
|
14
|
+
anchor?: MeasureParam;
|
|
15
|
+
transform?: Transform;
|
|
16
|
+
optional?: boolean;
|
|
17
|
+
}
|
|
18
|
+
/** ApplicationArea */
|
|
19
|
+
export interface ApplicationArea {
|
|
20
|
+
areas?: Array<string>;
|
|
21
|
+
cid?: number;
|
|
22
|
+
material?: string;
|
|
23
|
+
preview?: string;
|
|
24
|
+
}
|
|
25
|
+
/** ApplicationAreasResponse */
|
|
26
|
+
export interface ApplicationAreasResponse {
|
|
27
|
+
applicationAreas: Array<ApplicationArea>;
|
|
28
|
+
uuid: string;
|
|
29
|
+
}
|
|
30
|
+
/** AuthorizeResponse */
|
|
31
|
+
export interface AuthorizeResponse {
|
|
32
|
+
endpoint: string;
|
|
33
|
+
secretToken: string;
|
|
34
|
+
apiSession: CatalogueAPISession;
|
|
35
|
+
}
|
|
36
|
+
/** CatalogueAPISession */
|
|
37
|
+
export interface CatalogueAPISession {
|
|
38
|
+
expires: string;
|
|
39
|
+
features?: Array<string>;
|
|
40
|
+
permissions?: Array<CataloguePermission>;
|
|
41
|
+
}
|
|
42
|
+
/** CatalogueParams */
|
|
43
|
+
export interface CatalogueParams {
|
|
44
|
+
enterprise: string;
|
|
45
|
+
prdCat: string;
|
|
46
|
+
prdCatVersion: string;
|
|
47
|
+
vendor: string;
|
|
48
|
+
priceList: string;
|
|
49
|
+
}
|
|
50
|
+
/** CataloguePermission */
|
|
51
|
+
export interface CataloguePermission {
|
|
52
|
+
cid: number;
|
|
53
|
+
enterprise: string;
|
|
54
|
+
prdCat: string;
|
|
55
|
+
prdCatVersion: string;
|
|
56
|
+
priceLists?: Array<string>;
|
|
57
|
+
vendors?: Array<string>;
|
|
58
|
+
}
|
|
59
|
+
/** CategoryMap */
|
|
60
|
+
export interface CategoryMap {
|
|
61
|
+
[index: string]: string;
|
|
62
|
+
}
|
|
63
|
+
/** CodeRange */
|
|
64
|
+
export interface CodeRange {
|
|
65
|
+
minValue: number;
|
|
66
|
+
maxValue: number;
|
|
67
|
+
increment?: number;
|
|
68
|
+
}
|
|
69
|
+
/** ConnectorRef */
|
|
70
|
+
export interface ConnectorRef {
|
|
71
|
+
code: string;
|
|
72
|
+
connectRule: string;
|
|
73
|
+
visible: boolean;
|
|
74
|
+
anchor?: MeasureParam;
|
|
75
|
+
transform: Transform;
|
|
76
|
+
}
|
|
77
|
+
/** ErrorResponse */
|
|
78
|
+
export interface ErrorResponse {
|
|
79
|
+
error: string;
|
|
80
|
+
code: number;
|
|
81
|
+
eventId?: string;
|
|
82
|
+
}
|
|
83
|
+
/** ExportFormat - Format of the exported product, identical to the format's file extension. */
|
|
84
|
+
export declare type ExportFormat = "glb" | "gltf" | "fbx" | "dwg" | "cmdrw" | "cmfav" | "cmsym";
|
|
85
|
+
export declare const exportFormatNames: ExportFormat[];
|
|
86
|
+
/** ExportRequest */
|
|
87
|
+
export interface ExportRequest {
|
|
88
|
+
format: ExportFormat;
|
|
89
|
+
selOptions: Array<SelectedOption>;
|
|
90
|
+
additionalProducts?: Array<AdditionalProductConfiguration>;
|
|
91
|
+
}
|
|
92
|
+
/** ExportResponse */
|
|
93
|
+
export interface ExportResponse {
|
|
94
|
+
exportStatus: ExportStatus;
|
|
95
|
+
}
|
|
96
|
+
/** ExportStatus */
|
|
97
|
+
export interface ExportStatus {
|
|
98
|
+
created: string;
|
|
99
|
+
modified: string;
|
|
100
|
+
status: ExportStatusStatus;
|
|
101
|
+
url?: string;
|
|
102
|
+
uuid: string;
|
|
103
|
+
}
|
|
104
|
+
/** ExportStatusStatus - WIP */
|
|
105
|
+
export declare type ExportStatusStatus = "pending" | "running" | "finished" | "failed";
|
|
106
|
+
export declare const exportStatusStatusNames: ExportStatusStatus[];
|
|
107
|
+
/** Feature */
|
|
108
|
+
export interface Feature {
|
|
109
|
+
code: string;
|
|
110
|
+
description: string;
|
|
111
|
+
functional?: boolean;
|
|
112
|
+
groupCode?: string;
|
|
113
|
+
mtrlApplications?: Array<MtrlApplication>;
|
|
114
|
+
multiple?: boolean;
|
|
115
|
+
numericOrder: boolean;
|
|
116
|
+
optional?: boolean;
|
|
117
|
+
options: Array<Option>;
|
|
118
|
+
hideIfMainProduct?: boolean;
|
|
119
|
+
hideIfAdditionalProduct?: boolean;
|
|
120
|
+
measureParams?: Array<MeasureParam>;
|
|
121
|
+
syncGroup?: SyncGroup;
|
|
122
|
+
unit?: string;
|
|
123
|
+
}
|
|
124
|
+
/** FeatureRef */
|
|
125
|
+
export interface FeatureRef {
|
|
126
|
+
code: string;
|
|
127
|
+
defaultOptionRef?: string;
|
|
128
|
+
selectedOptionRef?: string;
|
|
129
|
+
excludedOptionRefs?: Array<string>;
|
|
130
|
+
}
|
|
131
|
+
/** GetApplicationAreasParams represents the URL parameters of getApplicationAreas */
|
|
132
|
+
export interface GetApplicationAreasParams {
|
|
133
|
+
lang: string;
|
|
134
|
+
enterprise: string;
|
|
135
|
+
prdCat: string;
|
|
136
|
+
prdCatVersion: string;
|
|
137
|
+
vendor: string;
|
|
138
|
+
priceList: string;
|
|
139
|
+
}
|
|
140
|
+
/** GetExportByIdParams represents the URL parameters of getExportById */
|
|
141
|
+
export interface GetExportByIdParams {
|
|
142
|
+
uuid: string;
|
|
143
|
+
}
|
|
144
|
+
/** GetPriceListsParams represents the URL parameters of getPriceLists */
|
|
145
|
+
export interface GetPriceListsParams {
|
|
146
|
+
lang: string;
|
|
147
|
+
enterprise: string;
|
|
148
|
+
prdCat: string;
|
|
149
|
+
prdCatVersion: string;
|
|
150
|
+
vendor: string;
|
|
151
|
+
priceList: string;
|
|
152
|
+
}
|
|
153
|
+
/** GetProductParams represents the URL parameters of getProduct */
|
|
154
|
+
export interface GetProductParams {
|
|
155
|
+
lang: string;
|
|
156
|
+
enterprise: string;
|
|
157
|
+
prdCat: string;
|
|
158
|
+
prdCatVersion: string;
|
|
159
|
+
vendor: string;
|
|
160
|
+
priceList: string;
|
|
161
|
+
partNumber: string;
|
|
162
|
+
}
|
|
163
|
+
/** GetRenderByIdParams represents the URL parameters of getRenderById */
|
|
164
|
+
export interface GetRenderByIdParams {
|
|
165
|
+
uuid: string;
|
|
166
|
+
}
|
|
167
|
+
/** GetTocFlatParams represents the URL parameters of getTocFlat */
|
|
168
|
+
export interface GetTocFlatParams {
|
|
169
|
+
lang: string;
|
|
170
|
+
enterprise: string;
|
|
171
|
+
prdCat: string;
|
|
172
|
+
prdCatVersion: string;
|
|
173
|
+
vendor: string;
|
|
174
|
+
priceList: string;
|
|
175
|
+
}
|
|
176
|
+
/** GetTocTreeParams represents the URL parameters of getTocTree */
|
|
177
|
+
export interface GetTocTreeParams {
|
|
178
|
+
lang: string;
|
|
179
|
+
enterprise: string;
|
|
180
|
+
prdCat: string;
|
|
181
|
+
prdCatVersion: string;
|
|
182
|
+
vendor: string;
|
|
183
|
+
priceList: string;
|
|
184
|
+
}
|
|
185
|
+
/** Level */
|
|
186
|
+
export interface Level {
|
|
187
|
+
code: string;
|
|
188
|
+
description: string;
|
|
189
|
+
lvls?: Array<Level>;
|
|
190
|
+
prdRefs?: Array<LevelProductRef>;
|
|
191
|
+
}
|
|
192
|
+
/** LevelProductRef */
|
|
193
|
+
export interface LevelProductRef {
|
|
194
|
+
prdRef: string;
|
|
195
|
+
}
|
|
196
|
+
/** Measurement */
|
|
197
|
+
export interface Measurement {
|
|
198
|
+
code: string;
|
|
199
|
+
numericValue?: ValueWithUnit;
|
|
200
|
+
measureParam?: MeasureParam;
|
|
201
|
+
}
|
|
202
|
+
/** MeasureParam */
|
|
203
|
+
export interface MeasureParam {
|
|
204
|
+
code: string;
|
|
205
|
+
anchorPoint?: string;
|
|
206
|
+
measurePriority?: Array<MeasurePriority>;
|
|
207
|
+
}
|
|
208
|
+
/** MeasurePriority */
|
|
209
|
+
export interface MeasurePriority {
|
|
210
|
+
url: string;
|
|
211
|
+
}
|
|
212
|
+
/** Model */
|
|
213
|
+
export interface Model {
|
|
214
|
+
cid: number;
|
|
215
|
+
anchor?: MeasureParam;
|
|
216
|
+
t?: Transform;
|
|
217
|
+
uri: string;
|
|
218
|
+
}
|
|
219
|
+
/** MtrlApplication */
|
|
220
|
+
export interface MtrlApplication {
|
|
221
|
+
areas?: Array<string>;
|
|
222
|
+
material?: string;
|
|
223
|
+
preview?: string;
|
|
224
|
+
cid?: number;
|
|
225
|
+
}
|
|
226
|
+
/** Option */
|
|
227
|
+
export interface Option {
|
|
228
|
+
additionalProductRefs?: Array<AdditionalProductRef>;
|
|
229
|
+
code: string;
|
|
230
|
+
description: string;
|
|
231
|
+
featureRefs?: Array<FeatureRef>;
|
|
232
|
+
material?: string;
|
|
233
|
+
mtrlApplications?: Array<MtrlApplication>;
|
|
234
|
+
codeRanges?: Array<CodeRange>;
|
|
235
|
+
upcharge?: number;
|
|
236
|
+
priceCodes?: Array<string>;
|
|
237
|
+
}
|
|
238
|
+
/** Orientation */
|
|
239
|
+
export interface Orientation {
|
|
240
|
+
yaw: number;
|
|
241
|
+
pitch: number;
|
|
242
|
+
roll: number;
|
|
243
|
+
}
|
|
244
|
+
/** PartsData */
|
|
245
|
+
export interface PartsData {
|
|
246
|
+
basePrice: number;
|
|
247
|
+
currency: string;
|
|
248
|
+
rounding?: number;
|
|
249
|
+
listPrice: number;
|
|
250
|
+
pkgCount: number;
|
|
251
|
+
selOptions: Array<PartsSelectedOption>;
|
|
252
|
+
styleNr: string;
|
|
253
|
+
prices?: Prices;
|
|
254
|
+
}
|
|
255
|
+
/** PartsSelectedOption */
|
|
256
|
+
export interface PartsSelectedOption {
|
|
257
|
+
code: string;
|
|
258
|
+
numericValue?: ValueWithUnit;
|
|
259
|
+
description?: string;
|
|
260
|
+
feature: string;
|
|
261
|
+
featDesc: string;
|
|
262
|
+
upcharge?: number;
|
|
263
|
+
next?: {
|
|
264
|
+
[index: string]: PartsSelectedOption;
|
|
265
|
+
};
|
|
266
|
+
}
|
|
267
|
+
/** Point */
|
|
268
|
+
export interface Point {
|
|
269
|
+
x: number;
|
|
270
|
+
y: number;
|
|
271
|
+
z: number;
|
|
272
|
+
}
|
|
273
|
+
/** PostExportParams represents the URL parameters of postExport */
|
|
274
|
+
export interface PostExportParams {
|
|
275
|
+
lang: string;
|
|
276
|
+
enterprise: string;
|
|
277
|
+
prdCat: string;
|
|
278
|
+
prdCatVersion: string;
|
|
279
|
+
vendor: string;
|
|
280
|
+
priceList: string;
|
|
281
|
+
partNumber: string;
|
|
282
|
+
}
|
|
283
|
+
/** PostPublicAccessTokenAuthorizeParams represents the URL parameters of postPublicAccessTokenAuthorize */
|
|
284
|
+
export interface PostPublicAccessTokenAuthorizeParams {
|
|
285
|
+
accessTokenId: string;
|
|
286
|
+
}
|
|
287
|
+
/** PostRenderParams represents the URL parameters of postRender */
|
|
288
|
+
export interface PostRenderParams {
|
|
289
|
+
lang: string;
|
|
290
|
+
enterprise: string;
|
|
291
|
+
prdCat: string;
|
|
292
|
+
prdCatVersion: string;
|
|
293
|
+
vendor: string;
|
|
294
|
+
priceList: string;
|
|
295
|
+
partNumber: string;
|
|
296
|
+
}
|
|
297
|
+
/** PostValidateParams represents the URL parameters of postValidate */
|
|
298
|
+
export interface PostValidateParams {
|
|
299
|
+
lang: string;
|
|
300
|
+
enterprise: string;
|
|
301
|
+
prdCat: string;
|
|
302
|
+
prdCatVersion: string;
|
|
303
|
+
vendor: string;
|
|
304
|
+
priceList: string;
|
|
305
|
+
partNumber: string;
|
|
306
|
+
}
|
|
307
|
+
/** PriceList */
|
|
308
|
+
export interface PriceList {
|
|
309
|
+
code: string;
|
|
310
|
+
currency: string;
|
|
311
|
+
desc: string;
|
|
312
|
+
rate: number;
|
|
313
|
+
rounding: number;
|
|
314
|
+
}
|
|
315
|
+
/** PriceListsResponse */
|
|
316
|
+
export interface PriceListsResponse {
|
|
317
|
+
priceLists: Array<PriceList>;
|
|
318
|
+
uuid: string;
|
|
319
|
+
}
|
|
320
|
+
/** Prices */
|
|
321
|
+
export interface Prices {
|
|
322
|
+
values: {
|
|
323
|
+
[index: string]: number;
|
|
324
|
+
};
|
|
325
|
+
parent?: Prices;
|
|
326
|
+
}
|
|
327
|
+
/** ProductCatalogueInfo */
|
|
328
|
+
export interface ProductCatalogueInfo {
|
|
329
|
+
catDesc: string;
|
|
330
|
+
catName: string;
|
|
331
|
+
currency: string;
|
|
332
|
+
currencyRound: number;
|
|
333
|
+
exchangeRate: number;
|
|
334
|
+
lastModified: string;
|
|
335
|
+
}
|
|
336
|
+
/** ProductData */
|
|
337
|
+
export interface ProductData {
|
|
338
|
+
area?: string;
|
|
339
|
+
categories?: Array<CategoryMap>;
|
|
340
|
+
depth?: string;
|
|
341
|
+
description?: string;
|
|
342
|
+
height?: string;
|
|
343
|
+
hideIfMainProduct?: boolean;
|
|
344
|
+
hideIfAdditionalProduct?: boolean;
|
|
345
|
+
length?: string;
|
|
346
|
+
mtrlApplications?: Array<MtrlApplication>;
|
|
347
|
+
additionalProductRefs?: Array<AdditionalProductRef>;
|
|
348
|
+
navImage?: string;
|
|
349
|
+
sku: string;
|
|
350
|
+
measurements?: Array<Measurement>;
|
|
351
|
+
connectorRefs?: Array<ConnectorRef>;
|
|
352
|
+
tags?: Array<{
|
|
353
|
+
[index: string]: string;
|
|
354
|
+
}>;
|
|
355
|
+
volume?: string;
|
|
356
|
+
weight?: string;
|
|
357
|
+
width?: string;
|
|
358
|
+
models?: Array<Model>;
|
|
359
|
+
partsData: PartsData;
|
|
360
|
+
}
|
|
361
|
+
/** ProductRef */
|
|
362
|
+
export interface ProductRef {
|
|
363
|
+
basePrice: number;
|
|
364
|
+
categories?: Array<CategoryMap>;
|
|
365
|
+
descLong: string;
|
|
366
|
+
descShort: string;
|
|
367
|
+
navImage: string;
|
|
368
|
+
omitOnOrder: boolean;
|
|
369
|
+
partNr: string;
|
|
370
|
+
styleNr?: string;
|
|
371
|
+
}
|
|
372
|
+
/** ProductResponse */
|
|
373
|
+
export interface ProductResponse {
|
|
374
|
+
rootFeatureRefs: Array<FeatureRef>;
|
|
375
|
+
features: Array<Feature>;
|
|
376
|
+
productData: ProductData;
|
|
377
|
+
unit: string;
|
|
378
|
+
uuid: string;
|
|
379
|
+
}
|
|
380
|
+
/** RefreshSessionTokenResponse */
|
|
381
|
+
export interface RefreshSessionTokenResponse {
|
|
382
|
+
apiSession: CatalogueAPISession;
|
|
383
|
+
}
|
|
384
|
+
/** RenderFormat */
|
|
385
|
+
export declare type RenderFormat = "jpg" | "png";
|
|
386
|
+
export declare const renderFormatNames: RenderFormat[];
|
|
387
|
+
/** RenderRequest */
|
|
388
|
+
export interface RenderRequest {
|
|
389
|
+
width: number;
|
|
390
|
+
height: number;
|
|
391
|
+
format?: RenderFormat;
|
|
392
|
+
targetCameraArgs?: TargetCameraArgs;
|
|
393
|
+
selOptions: Array<SelectedOption>;
|
|
394
|
+
additionalProducts?: Array<AdditionalProductConfiguration>;
|
|
395
|
+
}
|
|
396
|
+
/** RenderResponse */
|
|
397
|
+
export interface RenderResponse {
|
|
398
|
+
renderStatus: RenderStatus;
|
|
399
|
+
}
|
|
400
|
+
/** RenderStatus */
|
|
401
|
+
export interface RenderStatus {
|
|
402
|
+
created: string;
|
|
403
|
+
modified: string;
|
|
404
|
+
status: RenderStatusStatus;
|
|
405
|
+
url?: string;
|
|
406
|
+
uuid: string;
|
|
407
|
+
}
|
|
408
|
+
/** RenderStatusStatus - WIP */
|
|
409
|
+
export declare type RenderStatusStatus = "pending" | "running" | "finished" | "failed";
|
|
410
|
+
export declare const renderStatusStatusNames: RenderStatusStatus[];
|
|
411
|
+
/** SelectedOption */
|
|
412
|
+
export interface SelectedOption {
|
|
413
|
+
code: string;
|
|
414
|
+
numericValue?: ValueWithUnit;
|
|
415
|
+
next?: {
|
|
416
|
+
[index: string]: SelectedOption;
|
|
417
|
+
};
|
|
418
|
+
}
|
|
419
|
+
/** SuccessResponse */
|
|
420
|
+
export interface SuccessResponse {
|
|
421
|
+
uuid: string;
|
|
422
|
+
success: boolean;
|
|
423
|
+
}
|
|
424
|
+
/** SyncGroup */
|
|
425
|
+
export interface SyncGroup {
|
|
426
|
+
syncGroupCode: string;
|
|
427
|
+
syncMethod: SyncGroupMethods;
|
|
428
|
+
}
|
|
429
|
+
/** SyncGroupMethods */
|
|
430
|
+
export declare type SyncGroupMethods = "pull" | "push" | "twoWay";
|
|
431
|
+
export declare const syncGroupMethodsNames: SyncGroupMethods[];
|
|
432
|
+
/** TargetCameraArgs */
|
|
433
|
+
export interface TargetCameraArgs {
|
|
434
|
+
location?: Point;
|
|
435
|
+
target?: Point;
|
|
436
|
+
direction?: Vector;
|
|
437
|
+
normal?: Vector;
|
|
438
|
+
yaw?: number;
|
|
439
|
+
pitch?: number;
|
|
440
|
+
roll?: number;
|
|
441
|
+
fov?: number;
|
|
442
|
+
nearClip?: number;
|
|
443
|
+
minHeight?: number;
|
|
444
|
+
}
|
|
445
|
+
/** TOCResponse - Table Of Contents */
|
|
446
|
+
export interface TOCResponse {
|
|
447
|
+
uuid: string;
|
|
448
|
+
prdRefs?: Array<ProductRef>;
|
|
449
|
+
prdCatInfo: ProductCatalogueInfo;
|
|
450
|
+
lvls?: Array<Level>;
|
|
451
|
+
}
|
|
452
|
+
/** Transform */
|
|
453
|
+
export interface Transform {
|
|
454
|
+
pos: Vector;
|
|
455
|
+
scale: Vector;
|
|
456
|
+
rot: Orientation;
|
|
457
|
+
}
|
|
458
|
+
/** ValidateRequest */
|
|
459
|
+
export interface ValidateRequest {
|
|
460
|
+
selOptions: Array<SelectedOption>;
|
|
461
|
+
}
|
|
462
|
+
/** ValidateResponse */
|
|
463
|
+
export interface ValidateResponse {
|
|
464
|
+
productData: ProductData;
|
|
465
|
+
uuid: string;
|
|
466
|
+
validated: boolean;
|
|
467
|
+
rootFeatureRefs?: Array<FeatureRef>;
|
|
468
|
+
}
|
|
469
|
+
/** ValueWithUnit */
|
|
470
|
+
export interface ValueWithUnit {
|
|
471
|
+
value: number;
|
|
472
|
+
unit?: string;
|
|
473
|
+
}
|
|
474
|
+
/** Vector */
|
|
475
|
+
export interface Vector {
|
|
476
|
+
x: number;
|
|
477
|
+
y: number;
|
|
478
|
+
z: number;
|
|
479
|
+
}
|
|
480
|
+
export declare type RequestOptions = {
|
|
481
|
+
method: "POST" | "GET" | "DELETE";
|
|
482
|
+
headers: {
|
|
483
|
+
[index: string]: string;
|
|
484
|
+
};
|
|
485
|
+
body?: string;
|
|
486
|
+
};
|
|
487
|
+
export declare class APIError<T> extends Error {
|
|
488
|
+
body?: string;
|
|
489
|
+
error?: Error;
|
|
490
|
+
parsed?: T;
|
|
491
|
+
status?: number;
|
|
492
|
+
}
|
|
493
|
+
export declare class CatalogueAPI {
|
|
494
|
+
auth: AuthorizeResponse | undefined;
|
|
495
|
+
constructor();
|
|
496
|
+
private _alternativeReferer;
|
|
497
|
+
hasFeature(feature: string): boolean;
|
|
498
|
+
fetch<T>(url: string, options: RequestOptions): Promise<T>;
|
|
499
|
+
postPublicAccessTokenAuthorize(params: PostPublicAccessTokenAuthorizeParams, endpoint: string): Promise<AuthorizeResponse>;
|
|
500
|
+
getApplicationAreas(params: GetApplicationAreasParams): Promise<ApplicationAreasResponse>;
|
|
501
|
+
postExport(params: PostExportParams, body: ExportRequest): Promise<ExportResponse>;
|
|
502
|
+
getPriceLists(params: GetPriceListsParams): Promise<PriceListsResponse>;
|
|
503
|
+
getProduct(params: GetProductParams): Promise<ProductResponse>;
|
|
504
|
+
postRender(params: PostRenderParams, body: RenderRequest): Promise<RenderResponse>;
|
|
505
|
+
postValidate(params: PostValidateParams, body: ValidateRequest): Promise<ValidateResponse>;
|
|
506
|
+
getTocTree(params: GetTocTreeParams): Promise<TOCResponse>;
|
|
507
|
+
getTocFlat(params: GetTocFlatParams): Promise<TOCResponse>;
|
|
508
|
+
getExportById(params: GetExportByIdParams): Promise<ExportResponse>;
|
|
509
|
+
getRenderById(params: GetRenderByIdParams): Promise<RenderResponse>;
|
|
510
|
+
postSessionTokenRefresh(): Promise<RefreshSessionTokenResponse>;
|
|
511
|
+
}
|
|
505
512
|
//# sourceMappingURL=CatalogueAPI.d.ts.map
|