@configura/web-api 2.2.0-alpha.1 → 2.2.0-alpha.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.
Files changed (102) hide show
  1. package/.eslintrc.json +5 -5
  2. package/LICENSE +201 -201
  3. package/README.md +1 -1
  4. package/dist/CatalogueAPI.d.ts +633 -633
  5. package/dist/CatalogueAPI.js +312 -312
  6. package/dist/CfgMeasure.d.ts +32 -32
  7. package/dist/CfgMeasure.js +30 -30
  8. package/dist/CfgProduct.d.ts +359 -344
  9. package/dist/CfgProduct.js +1005 -992
  10. package/dist/CfgReferencePathHelper.d.ts +26 -26
  11. package/dist/CfgReferencePathHelper.js +26 -26
  12. package/dist/index.d.ts +24 -24
  13. package/dist/index.js +24 -24
  14. package/dist/io/CfgHistoryManager.d.ts +83 -83
  15. package/dist/io/CfgHistoryManager.js +144 -144
  16. package/dist/io/CfgHistoryToProdConfConnector.d.ts +21 -21
  17. package/dist/io/CfgHistoryToProdConfConnector.js +50 -50
  18. package/dist/io/CfgIOManager.d.ts +53 -53
  19. package/dist/io/CfgIOManager.js +134 -134
  20. package/dist/io/CfgIOProdConfConnector.d.ts +54 -54
  21. package/dist/io/CfgIOProdConfConnector.js +139 -139
  22. package/dist/io/CfgIOWarningSupplier.d.ts +3 -3
  23. package/dist/io/CfgIOWarningSupplier.js +1 -1
  24. package/dist/io/CfgObservableStateManager.d.ts +25 -25
  25. package/dist/io/CfgObservableStateManager.js +69 -69
  26. package/dist/io/CfgObservableStateToProdConfConnector.d.ts +15 -15
  27. package/dist/io/CfgObservableStateToProdConfConnector.js +17 -17
  28. package/dist/io/CfgWindowEventManager.d.ts +21 -21
  29. package/dist/io/CfgWindowEventManager.js +38 -38
  30. package/dist/io/CfgWindowMessageManager.d.ts +40 -40
  31. package/dist/io/CfgWindowMessageManager.js +91 -91
  32. package/dist/io/CfgWindowMessageToProdConfConnector.d.ts +17 -17
  33. package/dist/io/CfgWindowMessageToProdConfConnector.js +19 -19
  34. package/dist/io/index.d.ts +8 -8
  35. package/dist/io/index.js +8 -8
  36. package/dist/material/CfgMaterialMapping.d.ts +7 -7
  37. package/dist/material/CfgMaterialMapping.js +181 -181
  38. package/dist/material/CfgMtrlApplication.d.ts +18 -18
  39. package/dist/material/CfgMtrlApplication.js +43 -43
  40. package/dist/material/CfgMtrlApplicationSource.d.ts +7 -7
  41. package/dist/material/CfgMtrlApplicationSource.js +8 -8
  42. package/dist/material/CfgMtrlSource.d.ts +19 -19
  43. package/dist/material/CfgMtrlSource.js +40 -40
  44. package/dist/material/CfgMtrlSourceWithMetaData.d.ts +7 -7
  45. package/dist/material/CfgMtrlSourceWithMetaData.js +1 -1
  46. package/dist/productConfiguration/CfgFeature.d.ts +199 -199
  47. package/dist/productConfiguration/CfgFeature.js +691 -691
  48. package/dist/productConfiguration/CfgOption.d.ts +160 -160
  49. package/dist/productConfiguration/CfgOption.js +464 -464
  50. package/dist/productConfiguration/CfgProductConfiguration.d.ts +136 -129
  51. package/dist/productConfiguration/CfgProductConfiguration.js +355 -346
  52. package/dist/productConfiguration/filters.d.ts +17 -17
  53. package/dist/productConfiguration/filters.js +141 -141
  54. package/dist/productConfiguration/productParamsGenerator.d.ts +15 -15
  55. package/dist/productConfiguration/productParamsGenerator.js +65 -65
  56. package/dist/productConfiguration/utilitiesProductConfiguration.d.ts +17 -17
  57. package/dist/productConfiguration/utilitiesProductConfiguration.js +89 -87
  58. package/dist/productLoader.d.ts +33 -33
  59. package/dist/productLoader.js +49 -49
  60. package/dist/syncGroups/SyncGroupsApplyMode.d.ts +20 -20
  61. package/dist/syncGroups/SyncGroupsApplyMode.js +21 -21
  62. package/dist/syncGroups/SyncGroupsHandler.d.ts +47 -47
  63. package/dist/syncGroups/SyncGroupsHandler.js +370 -370
  64. package/dist/syncGroups/SyncGroupsPathHelper.d.ts +26 -26
  65. package/dist/syncGroups/SyncGroupsPathHelper.js +90 -90
  66. package/dist/syncGroups/SyncGroupsState.d.ts +39 -39
  67. package/dist/syncGroups/SyncGroupsState.js +167 -167
  68. package/dist/syncGroups/SyncGroupsTransaction.d.ts +154 -154
  69. package/dist/syncGroups/SyncGroupsTransaction.js +589 -589
  70. package/dist/tasks/TaskHandler.d.ts +77 -77
  71. package/dist/tasks/TaskHandler.js +276 -276
  72. package/dist/tasks/formats.d.ts +4 -4
  73. package/dist/tasks/formats.js +7 -7
  74. package/dist/tests/testData/collectorForTest.d.ts +73 -73
  75. package/dist/tests/testData/collectorForTest.js +194 -194
  76. package/dist/tests/testData/dummyProductForTest.d.ts +4 -4
  77. package/dist/tests/testData/dummyProductForTest.js +32 -32
  78. package/dist/tests/testData/testDataAdditionalProductInAdditionalProductInProductForTest.d.ts +11 -11
  79. package/dist/tests/testData/testDataAdditionalProductInAdditionalProductInProductForTest.js +282 -282
  80. package/dist/tests/testData/testDataCachedGetProduct.d.ts +5 -5
  81. package/dist/tests/testData/testDataCachedGetProduct.js +187 -187
  82. package/dist/tests/testData/testDataCachedPostValidate.d.ts +7 -7
  83. package/dist/tests/testData/testDataCachedPostValidate.js +185 -185
  84. package/dist/tests/testData/testDataConstraints.d.ts +3 -3
  85. package/dist/tests/testData/testDataConstraints.js +174 -174
  86. package/dist/tests/testData/testDataNoAdditionalProductNoPropagateForTest.d.ts +3 -3
  87. package/dist/tests/testData/testDataNoAdditionalProductNoPropagateForTest.js +1099 -1099
  88. package/dist/tests/testData/testDataOptions.d.ts +12 -12
  89. package/dist/tests/testData/testDataOptions.js +60 -60
  90. package/dist/tests/testData/testDataProductAggregatedPrice.d.ts +6 -6
  91. package/dist/tests/testData/testDataProductAggregatedPrice.js +189 -189
  92. package/dist/tests/testData/testDataUpcharge.d.ts +8 -8
  93. package/dist/tests/testData/testDataUpcharge.js +121 -121
  94. package/dist/utilitiesCatalogueData.d.ts +47 -47
  95. package/dist/utilitiesCatalogueData.js +180 -180
  96. package/dist/utilitiesCataloguePermission.d.ts +38 -38
  97. package/dist/utilitiesCataloguePermission.js +79 -79
  98. package/dist/utilitiesConfiguration.d.ts +28 -28
  99. package/dist/utilitiesConfiguration.js +200 -200
  100. package/dist/utilitiesNumericValues.d.ts +24 -24
  101. package/dist/utilitiesNumericValues.js +114 -114
  102. package/package.json +3 -3
@@ -1,634 +1,634 @@
1
- /** AdditionalProductConf */
2
- export interface DtoAdditionalProductConf extends DtoProductConf {
3
- refKey: string;
4
- selected: boolean;
5
- }
6
- /** AdditionalProductConfiguration */
7
- export interface DtoAdditionalProductConfiguration {
8
- refKey?: string;
9
- selected?: boolean;
10
- selOptions: Array<DtoSelectedOption>;
11
- additionalProducts?: Array<DtoAdditionalProductConfiguration>;
12
- }
13
- /** AdditionalProductRef */
14
- export interface DtoAdditionalProductRef {
15
- refKey: string;
16
- catId: DtoCatalogueParams;
17
- partNumber: string;
18
- refDescription?: string;
19
- anchor?: DtoMeasureParam;
20
- transform?: DtoTransform;
21
- optional?: boolean;
22
- }
23
- /** ApplicationArea */
24
- export interface DtoApplicationArea {
25
- areas?: Array<string>;
26
- cid?: number;
27
- material?: string;
28
- preview?: string;
29
- }
30
- /** ApplicationAreasResponse */
31
- export interface DtoApplicationAreasResponse {
32
- applicationAreas: Array<DtoApplicationArea>;
33
- uuid: string;
34
- }
35
- /** AuthorizeResponse - The response to an authorize request. It contains an endpoint, a session token and an API session. The endpoint is the URL to access the API. The secret token is used to validate each request to the API. The API session contains information about the user's catalogue access. */
36
- export interface DtoAuthorizeResponse {
37
- endpoint: string;
38
- secretToken: string;
39
- apiSession: DtoCatalogueAPISession;
40
- }
41
- /** CatalogueAPISession */
42
- export interface DtoCatalogueAPISession {
43
- expires: string;
44
- features?: Array<string>;
45
- permissions?: Array<DtoCataloguePermission>;
46
- }
47
- /** CatalogueParams - To identify one catalogue the Portfolio ID CID is needed in addition to the parameters in this object. However as of now CID is not used in API calls and therefore this version without CID is needed. */
48
- export interface DtoCatalogueParams {
49
- enterprise: string;
50
- prdCat: string;
51
- prdCatVersion: string;
52
- vendor: string;
53
- priceList: string;
54
- }
55
- /** CatalogueParamsWithCid */
56
- export interface DtoCatalogueParamsWithCid extends DtoCatalogueParams {
57
- cid: number;
58
- }
59
- /** CatalogueParamsWithCidAndLang */
60
- export interface DtoCatalogueParamsWithCidAndLang extends DtoCatalogueParamsWithCid {
61
- lang: string;
62
- }
63
- /** CataloguePermission */
64
- export interface DtoCataloguePermission {
65
- cid: number;
66
- enterprise: string;
67
- prdCat: string;
68
- prdCatVersion: string;
69
- priceLists?: Array<string>;
70
- vendors?: Array<string>;
71
- }
72
- /** CategoryMap */
73
- export interface DtoCategoryMap {
74
- [index: string]: string;
75
- }
76
- /** CodeRange */
77
- export interface DtoCodeRange {
78
- minValue: number;
79
- maxValue: number;
80
- increment?: number;
81
- }
82
- /** ErrorResponse */
83
- export interface DtoErrorResponse {
84
- error: string;
85
- code: number;
86
- eventId?: string;
87
- }
88
- /** ExportFormat - Format of the exported product, identical to the format's file extension. */
89
- export declare type DtoExportFormat = "glb" | "gltf" | "fbx" | "dwg" | "cmdrw" | "cmfav" | "cmsym";
90
- export declare const dtoExportFormatNames: DtoExportFormat[];
91
- /** ExportRequest */
92
- export interface DtoExportRequest {
93
- format: DtoExportFormat;
94
- selOptions: Array<DtoSelectedOption>;
95
- additionalProducts?: Array<DtoAdditionalProductConfiguration>;
96
- preferUnzipped?: boolean;
97
- }
98
- /** ExportResponse */
99
- export interface DtoExportResponse {
100
- exportStatus: DtoExportStatus;
101
- }
102
- /** ExportStatus */
103
- export interface DtoExportStatus {
104
- created: string;
105
- modified: string;
106
- status: DtoExportStatusStatus;
107
- url?: string;
108
- uuid: string;
109
- }
110
- /** ExportStatusStatus - WIP */
111
- export declare type DtoExportStatusStatus = "pending" | "running" | "finished" | "failed";
112
- export declare const dtoExportStatusStatusNames: DtoExportStatusStatus[];
113
- /** Feature */
114
- export interface DtoFeature {
115
- code: string;
116
- description: string;
117
- functional?: boolean;
118
- groupCode?: string;
119
- mtrlApplications?: Array<DtoMtrlApplication>;
120
- multiple?: boolean;
121
- numericOrder: boolean;
122
- omitOnOrder?: boolean;
123
- optional?: boolean;
124
- options: Array<DtoOption>;
125
- hideIfMainProduct?: boolean;
126
- hideIfAdditionalProduct?: boolean;
127
- measureParams?: Array<DtoMeasureParam>;
128
- syncGroup?: DtoSyncGroup;
129
- unit?: string;
130
- noteRefs?: Array<string>;
131
- }
132
- /** FeatureConf */
133
- export interface DtoFeatureConf {
134
- code: string;
135
- groupCode?: string;
136
- unit?: string;
137
- options?: Array<DtoOptionConf>;
138
- }
139
- /** FeatureRef */
140
- export interface DtoFeatureRef {
141
- code: string;
142
- defaultOptionRef?: string;
143
- selectedOptionRef?: string;
144
- excludedOptionRefs?: Array<string>;
145
- }
146
- /** GetApplicationAreasParams represents the URL parameters of getApplicationAreas */
147
- export interface DtoGetApplicationAreasParams {
148
- lang: string;
149
- enterprise: string;
150
- prdCat: string;
151
- prdCatVersion: string;
152
- vendor: string;
153
- priceList: string;
154
- }
155
- /** GetExportByIdParams represents the URL parameters of getExportById */
156
- export interface DtoGetExportByIdParams {
157
- uuid: string;
158
- }
159
- /** GetPriceListsParams represents the URL parameters of getPriceLists */
160
- export interface DtoGetPriceListsParams {
161
- lang: string;
162
- enterprise: string;
163
- prdCat: string;
164
- prdCatVersion: string;
165
- vendor: string;
166
- priceList: string;
167
- }
168
- /** GetProductLegacyV2Params represents the URL parameters of getProductLegacyV2 */
169
- export interface DtoGetProductLegacyV2Params {
170
- lang: string;
171
- enterprise: string;
172
- prdCat: string;
173
- prdCatVersion: string;
174
- vendor: string;
175
- priceList: string;
176
- partNumber: string;
177
- }
178
- /** GetProductParams represents the URL parameters of getProduct */
179
- export interface DtoGetProductParams {
180
- lang: string;
181
- enterprise: string;
182
- prdCat: string;
183
- prdCatVersion: string;
184
- vendor: string;
185
- priceList: string;
186
- partNumber: string;
187
- }
188
- /** GetRenderByIdParams represents the URL parameters of getRenderById */
189
- export interface DtoGetRenderByIdParams {
190
- uuid: string;
191
- }
192
- /** GetTocFlatParams represents the URL parameters of getTocFlat */
193
- export interface DtoGetTocFlatParams {
194
- lang: string;
195
- enterprise: string;
196
- prdCat: string;
197
- prdCatVersion: string;
198
- vendor: string;
199
- priceList: string;
200
- }
201
- /** GetTocTreeParams represents the URL parameters of getTocTree */
202
- export interface DtoGetTocTreeParams {
203
- lang: string;
204
- enterprise: string;
205
- prdCat: string;
206
- prdCatVersion: string;
207
- vendor: string;
208
- priceList: string;
209
- }
210
- /** Level */
211
- export interface DtoLevel {
212
- code: string;
213
- description: string;
214
- lvls?: Array<DtoLevel>;
215
- prdRefs?: Array<DtoLevelProductRef>;
216
- }
217
- /** LevelProductRef */
218
- export interface DtoLevelProductRef {
219
- prdRef: string;
220
- }
221
- /** Measurement */
222
- export interface DtoMeasurement {
223
- code: string;
224
- numericValue?: DtoValueWithUnit;
225
- measureParam?: DtoMeasureParam;
226
- }
227
- /** MeasureParam */
228
- export interface DtoMeasureParam {
229
- code: string;
230
- anchorPoint?: string;
231
- measurePriority?: Array<DtoMeasurePriority>;
232
- }
233
- /** MeasurePriority */
234
- export interface DtoMeasurePriority {
235
- url: string;
236
- }
237
- /** MiscFile */
238
- export interface DtoMiscFile {
239
- key: string;
240
- url: string;
241
- preview?: string;
242
- }
243
- /** Model */
244
- export interface DtoModel {
245
- cid: number;
246
- anchor?: DtoMeasureParam;
247
- t?: DtoTransform;
248
- uri: string;
249
- }
250
- /** MtrlApplication */
251
- export interface DtoMtrlApplication {
252
- areas?: Array<string>;
253
- material?: string;
254
- preview?: string;
255
- cid?: number;
256
- }
257
- /** Note */
258
- export interface DtoNote {
259
- code: string;
260
- severity?: DtoNoteSeverity;
261
- key?: string;
262
- title?: string;
263
- body: string;
264
- }
265
- /** NoteSeverity - WIP */
266
- export declare type DtoNoteSeverity = "Information" | "Critical" | "Warning";
267
- export declare const dtoNoteSeverityNames: DtoNoteSeverity[];
268
- /** Option */
269
- export interface DtoOption {
270
- additionalProductRefs?: Array<DtoAdditionalProductRef>;
271
- code: string;
272
- description: string;
273
- featureRefs?: Array<DtoFeatureRef>;
274
- material?: string;
275
- mtrlApplications?: Array<DtoMtrlApplication>;
276
- codeRanges?: Array<DtoCodeRange>;
277
- upcharge?: number;
278
- priceCodes?: Array<string>;
279
- noteRefs?: Array<string>;
280
- miscFiles?: Array<DtoMiscFile>;
281
- omitOnOrder?: boolean;
282
- }
283
- /** OptionConf */
284
- export interface DtoOptionConf {
285
- code: string;
286
- selected: boolean;
287
- numericValue?: DtoValueWithUnit;
288
- features?: Array<DtoFeatureConf>;
289
- }
290
- /** Orientation */
291
- export interface DtoOrientation {
292
- yaw: number;
293
- pitch: number;
294
- roll: number;
295
- }
296
- /** PartsConstrainedOption */
297
- export interface DtoPartsConstrainedOption {
298
- code: string;
299
- feature: string;
300
- constrOptions?: Array<string>;
301
- next?: {
302
- [index: string]: DtoPartsConstrainedOption;
303
- };
304
- }
305
- /** PartsData */
306
- export interface DtoPartsData {
307
- basePrice: number;
308
- currency: string;
309
- rounding?: number;
310
- listPrice: number;
311
- pkgCount: number;
312
- selOptions: Array<DtoPartsSelectedOption>;
313
- constrOptions?: Array<DtoPartsConstrainedOption>;
314
- styleNr: string;
315
- prices?: DtoPrices;
316
- }
317
- /** PartsSelectedOption */
318
- export interface DtoPartsSelectedOption {
319
- code: string;
320
- numericValue?: DtoValueWithUnit;
321
- description?: string;
322
- feature: string;
323
- featDesc: string;
324
- upcharge?: number;
325
- next?: {
326
- [index: string]: DtoPartsSelectedOption;
327
- };
328
- }
329
- /** Point */
330
- export interface DtoPoint {
331
- x: number;
332
- y: number;
333
- z: number;
334
- }
335
- /** PostExportParams represents the URL parameters of postExport */
336
- export interface DtoPostExportParams {
337
- lang: string;
338
- enterprise: string;
339
- prdCat: string;
340
- prdCatVersion: string;
341
- vendor: string;
342
- priceList: string;
343
- partNumber: string;
344
- }
345
- /** PostPublicAccessTokenAuthorizeParams represents the URL parameters of postPublicAccessTokenAuthorize */
346
- export interface DtoPostPublicAccessTokenAuthorizeParams {
347
- accessTokenId: string;
348
- }
349
- /** PostRenderParams represents the URL parameters of postRender */
350
- export interface DtoPostRenderParams {
351
- lang: string;
352
- enterprise: string;
353
- prdCat: string;
354
- prdCatVersion: string;
355
- vendor: string;
356
- priceList: string;
357
- partNumber: string;
358
- }
359
- /** PostValidateLegacyV1Params represents the URL parameters of postValidateLegacyV1 */
360
- export interface DtoPostValidateLegacyV1Params {
361
- lang: string;
362
- enterprise: string;
363
- prdCat: string;
364
- prdCatVersion: string;
365
- vendor: string;
366
- priceList: string;
367
- partNumber: string;
368
- }
369
- /** PostValidateParams represents the URL parameters of postValidate */
370
- export interface DtoPostValidateParams {
371
- lang: string;
372
- enterprise: string;
373
- prdCat: string;
374
- prdCatVersion: string;
375
- vendor: string;
376
- priceList: string;
377
- partNumber: string;
378
- }
379
- /** PriceList */
380
- export interface DtoPriceList {
381
- code: string;
382
- currency: string;
383
- desc: string;
384
- rate: number;
385
- rounding: number;
386
- }
387
- /** PriceListsResponse */
388
- export interface DtoPriceListsResponse {
389
- priceLists: Array<DtoPriceList>;
390
- uuid: string;
391
- }
392
- /** Prices */
393
- export interface DtoPrices {
394
- values: {
395
- [index: string]: number;
396
- };
397
- parent?: DtoPrices;
398
- }
399
- /** ProductCatalogueInfo */
400
- export interface DtoProductCatalogueInfo {
401
- catDesc: string;
402
- catName: string;
403
- currency: string;
404
- currencyRound: number;
405
- exchangeRate: number;
406
- lastModified: string;
407
- }
408
- /** ProductConf - This is intended to eventually supersede AdditionalProductConfiguration as the format for sending/receiving how a Product is configured. */
409
- export interface DtoProductConf {
410
- features?: Array<DtoFeatureConf>;
411
- additionalProducts?: Array<DtoAdditionalProductConf>;
412
- prodParams?: DtoProductParamsWithCidAndLang;
413
- syncGroupState?: DtoSyncGroupState;
414
- }
415
- /** ProductData */
416
- export interface DtoProductData {
417
- area?: string;
418
- categories?: Array<DtoCategoryMap>;
419
- depth?: string;
420
- description?: string;
421
- height?: string;
422
- hideIfMainProduct?: boolean;
423
- hideIfAdditionalProduct?: boolean;
424
- length?: string;
425
- mtrlApplications?: Array<DtoMtrlApplication>;
426
- additionalProductRefs?: Array<DtoAdditionalProductRef>;
427
- navImage?: string;
428
- sku: string;
429
- measurements?: Array<DtoMeasurement>;
430
- tags?: Array<{
431
- [index: string]: string;
432
- }>;
433
- volume?: string;
434
- weight?: string;
435
- width?: string;
436
- models?: Array<DtoModel>;
437
- partsData: DtoPartsData;
438
- noteRefs?: Array<string>;
439
- miscFiles?: Array<DtoMiscFile>;
440
- }
441
- /** ProductParamsWithCid */
442
- export interface DtoProductParamsWithCid extends DtoCatalogueParamsWithCid {
443
- partNumber: string;
444
- }
445
- /** ProductParamsWithCidAndLang */
446
- export interface DtoProductParamsWithCidAndLang extends DtoProductParamsWithCid {
447
- lang: string;
448
- }
449
- /** ProductRef */
450
- export interface DtoProductRef {
451
- basePrice: number;
452
- categories?: Array<DtoCategoryMap>;
453
- descLong: string;
454
- descShort: string;
455
- navImage: string;
456
- omitOnOrder: boolean;
457
- partNr: string;
458
- styleNr?: string;
459
- }
460
- /** ProductResponse */
461
- export interface DtoProductResponse {
462
- rootFeatureRefs: Array<DtoFeatureRef>;
463
- features: Array<DtoFeature>;
464
- productData: DtoProductData;
465
- unit: string;
466
- uuid: string;
467
- notes?: Array<DtoNote>;
468
- }
469
- /** RefreshSessionTokenResponse - The response to a refresh session token request. It contains a new API session. */
470
- export interface DtoRefreshSessionTokenResponse {
471
- apiSession: DtoCatalogueAPISession;
472
- }
473
- /** RenderFormat */
474
- export declare type DtoRenderFormat = "jpg" | "png";
475
- export declare const dtoRenderFormatNames: DtoRenderFormat[];
476
- /** RenderRequest */
477
- export interface DtoRenderRequest {
478
- width: number;
479
- height: number;
480
- format?: DtoRenderFormat;
481
- targetCameraArgs?: DtoTargetCameraArgs;
482
- selOptions: Array<DtoSelectedOption>;
483
- additionalProducts?: Array<DtoAdditionalProductConfiguration>;
484
- }
485
- /** RenderResponse */
486
- export interface DtoRenderResponse {
487
- renderStatus: DtoRenderStatus;
488
- }
489
- /** RenderStatus */
490
- export interface DtoRenderStatus {
491
- created: string;
492
- modified: string;
493
- status: DtoRenderStatusStatus;
494
- url?: string;
495
- uuid: string;
496
- }
497
- /** RenderStatusStatus - WIP */
498
- export declare type DtoRenderStatusStatus = "pending" | "running" | "finished" | "failed";
499
- export declare const dtoRenderStatusStatusNames: DtoRenderStatusStatus[];
500
- /** SelectedOption */
501
- export interface DtoSelectedOption {
502
- code: string;
503
- numericValue?: DtoValueWithUnit;
504
- next?: {
505
- [index: string]: DtoSelectedOption;
506
- };
507
- }
508
- /** SuccessResponse */
509
- export interface DtoSuccessResponse {
510
- uuid: string;
511
- success: boolean;
512
- }
513
- /** SyncGroup */
514
- export interface DtoSyncGroup {
515
- syncGroupCode: string;
516
- syncMethod: DtoSyncGroupMethods;
517
- }
518
- /** SyncGroupMethods */
519
- export declare type DtoSyncGroupMethods = "pull" | "push" | "twoWay";
520
- export declare const dtoSyncGroupMethodsNames: DtoSyncGroupMethods[];
521
- /** SyncGroupState */
522
- export interface DtoSyncGroupState {
523
- selectOne?: Array<DtoSyncToOptionCode>;
524
- selectMany?: Array<DtoSyncToOptionCodeToSelected>;
525
- }
526
- /** SyncToOptionCode */
527
- export interface DtoSyncToOptionCode {
528
- syncCode: string;
529
- optionCode: string;
530
- }
531
- /** SyncToOptionCodeToSelected */
532
- export interface DtoSyncToOptionCodeToSelected extends DtoSyncToOptionCode {
533
- selected: boolean;
534
- }
535
- /** TargetCameraArgs */
536
- export interface DtoTargetCameraArgs {
537
- location?: DtoPoint;
538
- target?: DtoPoint;
539
- direction?: DtoVector;
540
- normal?: DtoVector;
541
- yaw?: number;
542
- pitch?: number;
543
- roll?: number;
544
- fov?: number;
545
- nearClip?: number;
546
- minHeight?: number;
547
- }
548
- /** TOCResponse - Table Of Contents */
549
- export interface DtoTOCResponse {
550
- uuid: string;
551
- prdRefs?: Array<DtoProductRef>;
552
- prdCatInfo: DtoProductCatalogueInfo;
553
- lvls?: Array<DtoLevel>;
554
- }
555
- /** Transform */
556
- export interface DtoTransform {
557
- pos: DtoVector;
558
- scale: DtoVector;
559
- rot: DtoOrientation;
560
- }
561
- /** ValidateRequest */
562
- export interface DtoValidateRequest extends DtoValidateRequestLegacyV1 {
563
- knownFeatureCodes: Array<string>;
564
- }
565
- /** ValidateRequestLegacyV1 */
566
- export interface DtoValidateRequestLegacyV1 {
567
- selOptions: Array<DtoSelectedOption>;
568
- }
569
- /** ValidateResponse */
570
- export interface DtoValidateResponse extends DtoValidateResponseLegacyV1 {
571
- features: Array<DtoFeature>;
572
- unit: string;
573
- notes?: Array<DtoNote>;
574
- }
575
- /** ValidateResponseLegacyV1 */
576
- export interface DtoValidateResponseLegacyV1 {
577
- productData: DtoProductData;
578
- uuid: string;
579
- validated: boolean;
580
- rootFeatureRefs?: Array<DtoFeatureRef>;
581
- }
582
- /** ValueWithUnit */
583
- export interface DtoValueWithUnit {
584
- value: number;
585
- unit?: string;
586
- }
587
- /** Vector */
588
- export interface DtoVector {
589
- x: number;
590
- y: number;
591
- z: number;
592
- }
593
- export declare type DtoRequestOptions = {
594
- method: "POST" | "GET" | "DELETE";
595
- headers: {
596
- [index: string]: string;
597
- };
598
- body?: string;
599
- };
600
- export declare class DtoAPIError<T> extends Error {
601
- body?: string;
602
- error?: Error;
603
- parsed?: T;
604
- status?: number;
605
- }
606
- declare type FetchFunc = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
607
- export declare class CatalogueAPI {
608
- private readonly _fetch;
609
- auth: DtoAuthorizeResponse | undefined;
610
- constructor(_fetch?: FetchFunc);
611
- private _alternativeReferer;
612
- _saveAlternativeReferer(): void;
613
- hasFeature(feature: string): boolean;
614
- fetch<T>(url: string, options: DtoRequestOptions): Promise<T>;
615
- postPublicAccessTokenAuthorize(params: DtoPostPublicAccessTokenAuthorizeParams, endpoint: string): Promise<DtoAuthorizeResponse>;
616
- getApplicationAreas(params: DtoGetApplicationAreasParams): Promise<DtoApplicationAreasResponse>;
617
- postExport(params: DtoPostExportParams, body: DtoExportRequest): Promise<DtoExportResponse>;
618
- getPriceLists(params: DtoGetPriceListsParams): Promise<DtoPriceListsResponse>;
619
- getProductLegacyV2(params: DtoGetProductLegacyV2Params): Promise<DtoProductResponse>;
620
- getProduct(params: DtoGetProductParams): Promise<DtoProductResponse>;
621
- postRender(params: DtoPostRenderParams, body: DtoRenderRequest): Promise<DtoRenderResponse>;
622
- postValidateLegacyV1(params: DtoPostValidateLegacyV1Params, body: DtoValidateRequestLegacyV1): Promise<DtoValidateResponseLegacyV1>;
623
- postValidate(params: DtoPostValidateParams, body: DtoValidateRequest): Promise<DtoValidateResponse>;
624
- getTocTree(params: DtoGetTocTreeParams): Promise<DtoTOCResponse>;
625
- getTocFlat(params: DtoGetTocFlatParams): Promise<DtoTOCResponse>;
626
- getExportById(params: DtoGetExportByIdParams): Promise<DtoExportResponse>;
627
- getRenderById(params: DtoGetRenderByIdParams): Promise<DtoRenderResponse>;
628
- postSessionTokenRefresh(): Promise<DtoRefreshSessionTokenResponse>;
629
- }
630
- export declare const DTO_OPERATION_ID_TO_DEBIT_GROUP: {
631
- [operation_id: string]: string;
632
- };
633
- export {};
1
+ /** AdditionalProductConf */
2
+ export interface DtoAdditionalProductConf extends DtoProductConf {
3
+ refKey: string;
4
+ selected: boolean;
5
+ }
6
+ /** AdditionalProductConfiguration */
7
+ export interface DtoAdditionalProductConfiguration {
8
+ refKey?: string;
9
+ selected?: boolean;
10
+ selOptions: Array<DtoSelectedOption>;
11
+ additionalProducts?: Array<DtoAdditionalProductConfiguration>;
12
+ }
13
+ /** AdditionalProductRef */
14
+ export interface DtoAdditionalProductRef {
15
+ refKey: string;
16
+ catId: DtoCatalogueParams;
17
+ partNumber: string;
18
+ refDescription?: string;
19
+ anchor?: DtoMeasureParam;
20
+ transform?: DtoTransform;
21
+ optional?: boolean;
22
+ }
23
+ /** ApplicationArea */
24
+ export interface DtoApplicationArea {
25
+ areas?: Array<string>;
26
+ cid?: number;
27
+ material?: string;
28
+ preview?: string;
29
+ }
30
+ /** ApplicationAreasResponse */
31
+ export interface DtoApplicationAreasResponse {
32
+ applicationAreas: Array<DtoApplicationArea>;
33
+ uuid: string;
34
+ }
35
+ /** AuthorizeResponse - The response to an authorize request. It contains an endpoint, a session token and an API session. The endpoint is the URL to access the API. The secret token is used to validate each request to the API. The API session contains information about the user's catalogue access. */
36
+ export interface DtoAuthorizeResponse {
37
+ endpoint: string;
38
+ secretToken: string;
39
+ apiSession: DtoCatalogueAPISession;
40
+ }
41
+ /** CatalogueAPISession */
42
+ export interface DtoCatalogueAPISession {
43
+ expires: string;
44
+ features?: Array<string>;
45
+ permissions?: Array<DtoCataloguePermission>;
46
+ }
47
+ /** CatalogueParams - To identify one catalogue the Portfolio ID CID is needed in addition to the parameters in this object. However as of now CID is not used in API calls and therefore this version without CID is needed. */
48
+ export interface DtoCatalogueParams {
49
+ enterprise: string;
50
+ prdCat: string;
51
+ prdCatVersion: string;
52
+ vendor: string;
53
+ priceList: string;
54
+ }
55
+ /** CatalogueParamsWithCid */
56
+ export interface DtoCatalogueParamsWithCid extends DtoCatalogueParams {
57
+ cid: number;
58
+ }
59
+ /** CatalogueParamsWithCidAndLang */
60
+ export interface DtoCatalogueParamsWithCidAndLang extends DtoCatalogueParamsWithCid {
61
+ lang: string;
62
+ }
63
+ /** CataloguePermission */
64
+ export interface DtoCataloguePermission {
65
+ cid: number;
66
+ enterprise: string;
67
+ prdCat: string;
68
+ prdCatVersion: string;
69
+ priceLists?: Array<string>;
70
+ vendors?: Array<string>;
71
+ }
72
+ /** CategoryMap */
73
+ export interface DtoCategoryMap {
74
+ [index: string]: string;
75
+ }
76
+ /** CodeRange */
77
+ export interface DtoCodeRange {
78
+ minValue: number;
79
+ maxValue: number;
80
+ increment?: number;
81
+ }
82
+ /** ErrorResponse */
83
+ export interface DtoErrorResponse {
84
+ error: string;
85
+ code: number;
86
+ eventId?: string;
87
+ }
88
+ /** ExportFormat - Format of the exported product, identical to the format's file extension. */
89
+ export declare type DtoExportFormat = "glb" | "gltf" | "fbx" | "dwg" | "cmdrw" | "cmfav" | "cmsym";
90
+ export declare const dtoExportFormatNames: DtoExportFormat[];
91
+ /** ExportRequest */
92
+ export interface DtoExportRequest {
93
+ format: DtoExportFormat;
94
+ selOptions: Array<DtoSelectedOption>;
95
+ additionalProducts?: Array<DtoAdditionalProductConfiguration>;
96
+ preferUnzipped?: boolean;
97
+ }
98
+ /** ExportResponse */
99
+ export interface DtoExportResponse {
100
+ exportStatus: DtoExportStatus;
101
+ }
102
+ /** ExportStatus */
103
+ export interface DtoExportStatus {
104
+ created: string;
105
+ modified: string;
106
+ status: DtoExportStatusStatus;
107
+ url?: string;
108
+ uuid: string;
109
+ }
110
+ /** ExportStatusStatus - WIP */
111
+ export declare type DtoExportStatusStatus = "pending" | "running" | "finished" | "failed";
112
+ export declare const dtoExportStatusStatusNames: DtoExportStatusStatus[];
113
+ /** Feature */
114
+ export interface DtoFeature {
115
+ code: string;
116
+ description: string;
117
+ functional?: boolean;
118
+ groupCode?: string;
119
+ mtrlApplications?: Array<DtoMtrlApplication>;
120
+ multiple?: boolean;
121
+ numericOrder: boolean;
122
+ omitOnOrder?: boolean;
123
+ optional?: boolean;
124
+ options: Array<DtoOption>;
125
+ hideIfMainProduct?: boolean;
126
+ hideIfAdditionalProduct?: boolean;
127
+ measureParams?: Array<DtoMeasureParam>;
128
+ syncGroup?: DtoSyncGroup;
129
+ unit?: string;
130
+ noteRefs?: Array<string>;
131
+ }
132
+ /** FeatureConf */
133
+ export interface DtoFeatureConf {
134
+ code: string;
135
+ groupCode?: string;
136
+ unit?: string;
137
+ options?: Array<DtoOptionConf>;
138
+ }
139
+ /** FeatureRef */
140
+ export interface DtoFeatureRef {
141
+ code: string;
142
+ defaultOptionRef?: string;
143
+ selectedOptionRef?: string;
144
+ excludedOptionRefs?: Array<string>;
145
+ }
146
+ /** GetApplicationAreasParams represents the URL parameters of getApplicationAreas */
147
+ export interface DtoGetApplicationAreasParams {
148
+ lang: string;
149
+ enterprise: string;
150
+ prdCat: string;
151
+ prdCatVersion: string;
152
+ vendor: string;
153
+ priceList: string;
154
+ }
155
+ /** GetExportByIdParams represents the URL parameters of getExportById */
156
+ export interface DtoGetExportByIdParams {
157
+ uuid: string;
158
+ }
159
+ /** GetPriceListsParams represents the URL parameters of getPriceLists */
160
+ export interface DtoGetPriceListsParams {
161
+ lang: string;
162
+ enterprise: string;
163
+ prdCat: string;
164
+ prdCatVersion: string;
165
+ vendor: string;
166
+ priceList: string;
167
+ }
168
+ /** GetProductLegacyV2Params represents the URL parameters of getProductLegacyV2 */
169
+ export interface DtoGetProductLegacyV2Params {
170
+ lang: string;
171
+ enterprise: string;
172
+ prdCat: string;
173
+ prdCatVersion: string;
174
+ vendor: string;
175
+ priceList: string;
176
+ partNumber: string;
177
+ }
178
+ /** GetProductParams represents the URL parameters of getProduct */
179
+ export interface DtoGetProductParams {
180
+ lang: string;
181
+ enterprise: string;
182
+ prdCat: string;
183
+ prdCatVersion: string;
184
+ vendor: string;
185
+ priceList: string;
186
+ partNumber: string;
187
+ }
188
+ /** GetRenderByIdParams represents the URL parameters of getRenderById */
189
+ export interface DtoGetRenderByIdParams {
190
+ uuid: string;
191
+ }
192
+ /** GetTocFlatParams represents the URL parameters of getTocFlat */
193
+ export interface DtoGetTocFlatParams {
194
+ lang: string;
195
+ enterprise: string;
196
+ prdCat: string;
197
+ prdCatVersion: string;
198
+ vendor: string;
199
+ priceList: string;
200
+ }
201
+ /** GetTocTreeParams represents the URL parameters of getTocTree */
202
+ export interface DtoGetTocTreeParams {
203
+ lang: string;
204
+ enterprise: string;
205
+ prdCat: string;
206
+ prdCatVersion: string;
207
+ vendor: string;
208
+ priceList: string;
209
+ }
210
+ /** Level */
211
+ export interface DtoLevel {
212
+ code: string;
213
+ description: string;
214
+ lvls?: Array<DtoLevel>;
215
+ prdRefs?: Array<DtoLevelProductRef>;
216
+ }
217
+ /** LevelProductRef */
218
+ export interface DtoLevelProductRef {
219
+ prdRef: string;
220
+ }
221
+ /** Measurement */
222
+ export interface DtoMeasurement {
223
+ code: string;
224
+ numericValue?: DtoValueWithUnit;
225
+ measureParam?: DtoMeasureParam;
226
+ }
227
+ /** MeasureParam */
228
+ export interface DtoMeasureParam {
229
+ code: string;
230
+ anchorPoint?: string;
231
+ measurePriority?: Array<DtoMeasurePriority>;
232
+ }
233
+ /** MeasurePriority */
234
+ export interface DtoMeasurePriority {
235
+ url: string;
236
+ }
237
+ /** MiscFile */
238
+ export interface DtoMiscFile {
239
+ key: string;
240
+ url: string;
241
+ preview?: string;
242
+ }
243
+ /** Model */
244
+ export interface DtoModel {
245
+ cid: number;
246
+ anchor?: DtoMeasureParam;
247
+ t?: DtoTransform;
248
+ uri: string;
249
+ }
250
+ /** MtrlApplication */
251
+ export interface DtoMtrlApplication {
252
+ areas?: Array<string>;
253
+ material?: string;
254
+ preview?: string;
255
+ cid?: number;
256
+ }
257
+ /** Note */
258
+ export interface DtoNote {
259
+ code: string;
260
+ severity?: DtoNoteSeverity;
261
+ key?: string;
262
+ title?: string;
263
+ body: string;
264
+ }
265
+ /** NoteSeverity - WIP */
266
+ export declare type DtoNoteSeverity = "Information" | "Critical" | "Warning";
267
+ export declare const dtoNoteSeverityNames: DtoNoteSeverity[];
268
+ /** Option */
269
+ export interface DtoOption {
270
+ additionalProductRefs?: Array<DtoAdditionalProductRef>;
271
+ code: string;
272
+ description: string;
273
+ featureRefs?: Array<DtoFeatureRef>;
274
+ material?: string;
275
+ mtrlApplications?: Array<DtoMtrlApplication>;
276
+ codeRanges?: Array<DtoCodeRange>;
277
+ upcharge?: number;
278
+ priceCodes?: Array<string>;
279
+ noteRefs?: Array<string>;
280
+ miscFiles?: Array<DtoMiscFile>;
281
+ omitOnOrder?: boolean;
282
+ }
283
+ /** OptionConf */
284
+ export interface DtoOptionConf {
285
+ code: string;
286
+ selected: boolean;
287
+ numericValue?: DtoValueWithUnit;
288
+ features?: Array<DtoFeatureConf>;
289
+ }
290
+ /** Orientation */
291
+ export interface DtoOrientation {
292
+ yaw: number;
293
+ pitch: number;
294
+ roll: number;
295
+ }
296
+ /** PartsConstrainedOption */
297
+ export interface DtoPartsConstrainedOption {
298
+ code: string;
299
+ feature: string;
300
+ constrOptions?: Array<string>;
301
+ next?: {
302
+ [index: string]: DtoPartsConstrainedOption;
303
+ };
304
+ }
305
+ /** PartsData */
306
+ export interface DtoPartsData {
307
+ basePrice: number;
308
+ currency: string;
309
+ rounding?: number;
310
+ listPrice: number;
311
+ pkgCount: number;
312
+ selOptions: Array<DtoPartsSelectedOption>;
313
+ constrOptions?: Array<DtoPartsConstrainedOption>;
314
+ styleNr: string;
315
+ prices?: DtoPrices;
316
+ }
317
+ /** PartsSelectedOption */
318
+ export interface DtoPartsSelectedOption {
319
+ code: string;
320
+ numericValue?: DtoValueWithUnit;
321
+ description?: string;
322
+ feature: string;
323
+ featDesc: string;
324
+ upcharge?: number;
325
+ next?: {
326
+ [index: string]: DtoPartsSelectedOption;
327
+ };
328
+ }
329
+ /** Point */
330
+ export interface DtoPoint {
331
+ x: number;
332
+ y: number;
333
+ z: number;
334
+ }
335
+ /** PostExportParams represents the URL parameters of postExport */
336
+ export interface DtoPostExportParams {
337
+ lang: string;
338
+ enterprise: string;
339
+ prdCat: string;
340
+ prdCatVersion: string;
341
+ vendor: string;
342
+ priceList: string;
343
+ partNumber: string;
344
+ }
345
+ /** PostPublicAccessTokenAuthorizeParams represents the URL parameters of postPublicAccessTokenAuthorize */
346
+ export interface DtoPostPublicAccessTokenAuthorizeParams {
347
+ accessTokenId: string;
348
+ }
349
+ /** PostRenderParams represents the URL parameters of postRender */
350
+ export interface DtoPostRenderParams {
351
+ lang: string;
352
+ enterprise: string;
353
+ prdCat: string;
354
+ prdCatVersion: string;
355
+ vendor: string;
356
+ priceList: string;
357
+ partNumber: string;
358
+ }
359
+ /** PostValidateLegacyV1Params represents the URL parameters of postValidateLegacyV1 */
360
+ export interface DtoPostValidateLegacyV1Params {
361
+ lang: string;
362
+ enterprise: string;
363
+ prdCat: string;
364
+ prdCatVersion: string;
365
+ vendor: string;
366
+ priceList: string;
367
+ partNumber: string;
368
+ }
369
+ /** PostValidateParams represents the URL parameters of postValidate */
370
+ export interface DtoPostValidateParams {
371
+ lang: string;
372
+ enterprise: string;
373
+ prdCat: string;
374
+ prdCatVersion: string;
375
+ vendor: string;
376
+ priceList: string;
377
+ partNumber: string;
378
+ }
379
+ /** PriceList */
380
+ export interface DtoPriceList {
381
+ code: string;
382
+ currency: string;
383
+ desc: string;
384
+ rate: number;
385
+ rounding: number;
386
+ }
387
+ /** PriceListsResponse */
388
+ export interface DtoPriceListsResponse {
389
+ priceLists: Array<DtoPriceList>;
390
+ uuid: string;
391
+ }
392
+ /** Prices */
393
+ export interface DtoPrices {
394
+ values: {
395
+ [index: string]: number;
396
+ };
397
+ parent?: DtoPrices;
398
+ }
399
+ /** ProductCatalogueInfo */
400
+ export interface DtoProductCatalogueInfo {
401
+ catDesc: string;
402
+ catName: string;
403
+ currency: string;
404
+ currencyRound: number;
405
+ exchangeRate: number;
406
+ lastModified: string;
407
+ }
408
+ /** ProductConf - This is intended to eventually supersede AdditionalProductConfiguration as the format for sending/receiving how a Product is configured. */
409
+ export interface DtoProductConf {
410
+ features?: Array<DtoFeatureConf>;
411
+ additionalProducts?: Array<DtoAdditionalProductConf>;
412
+ prodParams?: DtoProductParamsWithCidAndLang;
413
+ syncGroupState?: DtoSyncGroupState;
414
+ }
415
+ /** ProductData */
416
+ export interface DtoProductData {
417
+ area?: string;
418
+ categories?: Array<DtoCategoryMap>;
419
+ depth?: string;
420
+ description?: string;
421
+ height?: string;
422
+ hideIfMainProduct?: boolean;
423
+ hideIfAdditionalProduct?: boolean;
424
+ length?: string;
425
+ mtrlApplications?: Array<DtoMtrlApplication>;
426
+ additionalProductRefs?: Array<DtoAdditionalProductRef>;
427
+ navImage?: string;
428
+ sku: string;
429
+ measurements?: Array<DtoMeasurement>;
430
+ tags?: Array<{
431
+ [index: string]: string;
432
+ }>;
433
+ volume?: string;
434
+ weight?: string;
435
+ width?: string;
436
+ models?: Array<DtoModel>;
437
+ partsData: DtoPartsData;
438
+ noteRefs?: Array<string>;
439
+ miscFiles?: Array<DtoMiscFile>;
440
+ }
441
+ /** ProductParamsWithCid */
442
+ export interface DtoProductParamsWithCid extends DtoCatalogueParamsWithCid {
443
+ partNumber: string;
444
+ }
445
+ /** ProductParamsWithCidAndLang */
446
+ export interface DtoProductParamsWithCidAndLang extends DtoProductParamsWithCid {
447
+ lang: string;
448
+ }
449
+ /** ProductRef */
450
+ export interface DtoProductRef {
451
+ basePrice: number;
452
+ categories?: Array<DtoCategoryMap>;
453
+ descLong: string;
454
+ descShort: string;
455
+ navImage: string;
456
+ omitOnOrder: boolean;
457
+ partNr: string;
458
+ styleNr?: string;
459
+ }
460
+ /** ProductResponse */
461
+ export interface DtoProductResponse {
462
+ rootFeatureRefs: Array<DtoFeatureRef>;
463
+ features: Array<DtoFeature>;
464
+ productData: DtoProductData;
465
+ unit: string;
466
+ uuid: string;
467
+ notes?: Array<DtoNote>;
468
+ }
469
+ /** RefreshSessionTokenResponse - The response to a refresh session token request. It contains a new API session. */
470
+ export interface DtoRefreshSessionTokenResponse {
471
+ apiSession: DtoCatalogueAPISession;
472
+ }
473
+ /** RenderFormat */
474
+ export declare type DtoRenderFormat = "jpg" | "png";
475
+ export declare const dtoRenderFormatNames: DtoRenderFormat[];
476
+ /** RenderRequest */
477
+ export interface DtoRenderRequest {
478
+ width: number;
479
+ height: number;
480
+ format?: DtoRenderFormat;
481
+ targetCameraArgs?: DtoTargetCameraArgs;
482
+ selOptions: Array<DtoSelectedOption>;
483
+ additionalProducts?: Array<DtoAdditionalProductConfiguration>;
484
+ }
485
+ /** RenderResponse */
486
+ export interface DtoRenderResponse {
487
+ renderStatus: DtoRenderStatus;
488
+ }
489
+ /** RenderStatus */
490
+ export interface DtoRenderStatus {
491
+ created: string;
492
+ modified: string;
493
+ status: DtoRenderStatusStatus;
494
+ url?: string;
495
+ uuid: string;
496
+ }
497
+ /** RenderStatusStatus - WIP */
498
+ export declare type DtoRenderStatusStatus = "pending" | "running" | "finished" | "failed";
499
+ export declare const dtoRenderStatusStatusNames: DtoRenderStatusStatus[];
500
+ /** SelectedOption */
501
+ export interface DtoSelectedOption {
502
+ code: string;
503
+ numericValue?: DtoValueWithUnit;
504
+ next?: {
505
+ [index: string]: DtoSelectedOption;
506
+ };
507
+ }
508
+ /** SuccessResponse */
509
+ export interface DtoSuccessResponse {
510
+ uuid: string;
511
+ success: boolean;
512
+ }
513
+ /** SyncGroup */
514
+ export interface DtoSyncGroup {
515
+ syncGroupCode: string;
516
+ syncMethod: DtoSyncGroupMethods;
517
+ }
518
+ /** SyncGroupMethods */
519
+ export declare type DtoSyncGroupMethods = "pull" | "push" | "twoWay";
520
+ export declare const dtoSyncGroupMethodsNames: DtoSyncGroupMethods[];
521
+ /** SyncGroupState */
522
+ export interface DtoSyncGroupState {
523
+ selectOne?: Array<DtoSyncToOptionCode>;
524
+ selectMany?: Array<DtoSyncToOptionCodeToSelected>;
525
+ }
526
+ /** SyncToOptionCode */
527
+ export interface DtoSyncToOptionCode {
528
+ syncCode: string;
529
+ optionCode: string;
530
+ }
531
+ /** SyncToOptionCodeToSelected */
532
+ export interface DtoSyncToOptionCodeToSelected extends DtoSyncToOptionCode {
533
+ selected: boolean;
534
+ }
535
+ /** TargetCameraArgs */
536
+ export interface DtoTargetCameraArgs {
537
+ location?: DtoPoint;
538
+ target?: DtoPoint;
539
+ direction?: DtoVector;
540
+ normal?: DtoVector;
541
+ yaw?: number;
542
+ pitch?: number;
543
+ roll?: number;
544
+ fov?: number;
545
+ nearClip?: number;
546
+ minHeight?: number;
547
+ }
548
+ /** TOCResponse - Table Of Contents */
549
+ export interface DtoTOCResponse {
550
+ uuid: string;
551
+ prdRefs?: Array<DtoProductRef>;
552
+ prdCatInfo: DtoProductCatalogueInfo;
553
+ lvls?: Array<DtoLevel>;
554
+ }
555
+ /** Transform */
556
+ export interface DtoTransform {
557
+ pos: DtoVector;
558
+ scale: DtoVector;
559
+ rot: DtoOrientation;
560
+ }
561
+ /** ValidateRequest */
562
+ export interface DtoValidateRequest extends DtoValidateRequestLegacyV1 {
563
+ knownFeatureCodes: Array<string>;
564
+ }
565
+ /** ValidateRequestLegacyV1 */
566
+ export interface DtoValidateRequestLegacyV1 {
567
+ selOptions: Array<DtoSelectedOption>;
568
+ }
569
+ /** ValidateResponse */
570
+ export interface DtoValidateResponse extends DtoValidateResponseLegacyV1 {
571
+ features: Array<DtoFeature>;
572
+ unit: string;
573
+ notes?: Array<DtoNote>;
574
+ }
575
+ /** ValidateResponseLegacyV1 */
576
+ export interface DtoValidateResponseLegacyV1 {
577
+ productData: DtoProductData;
578
+ uuid: string;
579
+ validated: boolean;
580
+ rootFeatureRefs?: Array<DtoFeatureRef>;
581
+ }
582
+ /** ValueWithUnit */
583
+ export interface DtoValueWithUnit {
584
+ value: number;
585
+ unit?: string;
586
+ }
587
+ /** Vector */
588
+ export interface DtoVector {
589
+ x: number;
590
+ y: number;
591
+ z: number;
592
+ }
593
+ export declare type DtoRequestOptions = {
594
+ method: "POST" | "GET" | "DELETE";
595
+ headers: {
596
+ [index: string]: string;
597
+ };
598
+ body?: string;
599
+ };
600
+ export declare class DtoAPIError<T> extends Error {
601
+ body?: string;
602
+ error?: Error;
603
+ parsed?: T;
604
+ status?: number;
605
+ }
606
+ declare type FetchFunc = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
607
+ export declare class CatalogueAPI {
608
+ private readonly _fetch;
609
+ auth: DtoAuthorizeResponse | undefined;
610
+ constructor(_fetch?: FetchFunc);
611
+ private _alternativeReferer;
612
+ _saveAlternativeReferer(): void;
613
+ hasFeature(feature: string): boolean;
614
+ fetch<T>(url: string, options: DtoRequestOptions): Promise<T>;
615
+ postPublicAccessTokenAuthorize(params: DtoPostPublicAccessTokenAuthorizeParams, endpoint: string): Promise<DtoAuthorizeResponse>;
616
+ getApplicationAreas(params: DtoGetApplicationAreasParams): Promise<DtoApplicationAreasResponse>;
617
+ postExport(params: DtoPostExportParams, body: DtoExportRequest): Promise<DtoExportResponse>;
618
+ getPriceLists(params: DtoGetPriceListsParams): Promise<DtoPriceListsResponse>;
619
+ getProductLegacyV2(params: DtoGetProductLegacyV2Params): Promise<DtoProductResponse>;
620
+ getProduct(params: DtoGetProductParams): Promise<DtoProductResponse>;
621
+ postRender(params: DtoPostRenderParams, body: DtoRenderRequest): Promise<DtoRenderResponse>;
622
+ postValidateLegacyV1(params: DtoPostValidateLegacyV1Params, body: DtoValidateRequestLegacyV1): Promise<DtoValidateResponseLegacyV1>;
623
+ postValidate(params: DtoPostValidateParams, body: DtoValidateRequest): Promise<DtoValidateResponse>;
624
+ getTocTree(params: DtoGetTocTreeParams): Promise<DtoTOCResponse>;
625
+ getTocFlat(params: DtoGetTocFlatParams): Promise<DtoTOCResponse>;
626
+ getExportById(params: DtoGetExportByIdParams): Promise<DtoExportResponse>;
627
+ getRenderById(params: DtoGetRenderByIdParams): Promise<DtoRenderResponse>;
628
+ postSessionTokenRefresh(): Promise<DtoRefreshSessionTokenResponse>;
629
+ }
630
+ export declare const DTO_OPERATION_ID_TO_DEBIT_GROUP: {
631
+ [operation_id: string]: string;
632
+ };
633
+ export {};
634
634
  //# sourceMappingURL=CatalogueAPI.d.ts.map