@dangl/avacloud-client-node 1.17.0 → 1.19.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.
@@ -1 +1 @@
1
- 2.4.27
1
+ 2.4.28
package/api.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * AVACloud API 1.29.0
2
+ * AVACloud API 1.31.1
3
3
  * AVACloud API specification
4
4
  *
5
- * OpenAPI spec version: 1.29.0
5
+ * OpenAPI spec version: 1.31.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -494,6 +494,8 @@ export declare class IElementDto {
494
494
  * This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
495
495
  */
496
496
  'addendumNumber'?: string;
497
+ 'projectCatalogues'?: Array<CatalogueDto>;
498
+ 'catalogueReferences'?: Array<CatalogueReferenceDto>;
497
499
  'elementTypeDiscriminator': string;
498
500
  static discriminator: string | undefined;
499
501
  static attributeTypeMap: Array<{
@@ -533,6 +535,22 @@ export declare class ExecutionDescriptionDto extends IElementDto {
533
535
  type: string;
534
536
  }[];
535
537
  }
538
+ /**
539
+ * This enum represents the source type for a file based validation operation
540
+ */
541
+ export declare class FileValidationSourceType {
542
+ static discriminator: string | undefined;
543
+ static attributeTypeMap: Array<{
544
+ name: string;
545
+ baseName: string;
546
+ type: string;
547
+ }>;
548
+ static getAttributeTypeMap(): {
549
+ name: string;
550
+ baseName: string;
551
+ type: string;
552
+ }[];
553
+ }
536
554
  export declare class ForgotPasswordPost {
537
555
  'identifier': string;
538
556
  'preferredLanguages'?: Array<string>;
@@ -924,6 +942,26 @@ export declare class NoteTextDto extends IElementDto {
924
942
  }[];
925
943
  }
926
944
  /**
945
+ * Basic information about Object check validation details, commonly used when checking GAEB 2000 files
946
+ */
947
+ export declare class ObjectValidationCheckDetails {
948
+ /**
949
+ * The path under which the element with error was found.
950
+ */
951
+ 'elementPath'?: string;
952
+ static discriminator: string | undefined;
953
+ static attributeTypeMap: Array<{
954
+ name: string;
955
+ baseName: string;
956
+ type: string;
957
+ }>;
958
+ static getAttributeTypeMap(): {
959
+ name: string;
960
+ baseName: string;
961
+ type: string;
962
+ }[];
963
+ }
964
+ /**
927
965
  * This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts.
928
966
  */
929
967
  export declare class OenormNoteTextPropertiesDto {
@@ -1273,14 +1311,6 @@ export declare class PositionDto extends IElementDto {
1273
1311
  * This identifier can be used to point to the Id of a position in the same ServiceSpecification that acts as a base position. It matches \"Bezugsposition\" in GAEB. This can be used for positions that repeat partially or are linked together
1274
1312
  */
1275
1313
  'repetitionTo'?: string;
1276
- /**
1277
- * These are Catalogues that are used within this Position. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection.
1278
- */
1279
- 'projectCatalogues'?: Array<CatalogueDto>;
1280
- /**
1281
- * Referenced catalogues for this Position.
1282
- */
1283
- 'catalogueReferences'?: Array<CatalogueReferenceDto>;
1284
1314
  'type'?: string;
1285
1315
  /**
1286
1316
  * This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding.
@@ -1344,6 +1374,146 @@ export declare class PositionTypeDto {
1344
1374
  }[];
1345
1375
  }
1346
1376
  /**
1377
+ * Options for validating an AVA project
1378
+ */
1379
+ export declare class PostAvaProjectValidationSourceOptions {
1380
+ /**
1381
+ * The project that should be validated
1382
+ */
1383
+ 'avaProject': ProjectDto;
1384
+ /**
1385
+ * The index of the ServiceSpecification that should be validated. If not given, will default to the first one in the project.
1386
+ */
1387
+ 'serviceSpecificationIndex'?: number;
1388
+ /**
1389
+ * This can optionally be specified to simulate a conversion to a specific target.
1390
+ */
1391
+ 'validationType': ValidationType;
1392
+ /**
1393
+ * This can optionally be supplied to test for a specific exchange phase. For example, missing prices will only trigger errors in some specific exchange phases. Please note: If a conversion to a specific format, e.g. GAEB or ÖNorm, is given, this parameter is not applied to the internal conversion. The converter options must be set in the appropriate properties as well.
1394
+ */
1395
+ 'exchangePhase'?: ExchangePhaseDto;
1396
+ /**
1397
+ * Options for importing the AVA project
1398
+ */
1399
+ 'avaSourceOptions'?: PostAvaSourceOptions;
1400
+ /**
1401
+ * Options for conversion to Oenorm. Should be given if ValidationType is set to Oenorm.
1402
+ */
1403
+ 'oenormDestinationOptions'?: PostOenormDestinationOptions;
1404
+ /**
1405
+ * Options for conversion to GAEB. Should be given if ValidationType is set to GAEB.
1406
+ */
1407
+ 'gaebDestinationOptions'?: PostGaebDestinationOptions;
1408
+ static discriminator: string | undefined;
1409
+ static attributeTypeMap: Array<{
1410
+ name: string;
1411
+ baseName: string;
1412
+ type: string;
1413
+ }>;
1414
+ static getAttributeTypeMap(): {
1415
+ name: string;
1416
+ baseName: string;
1417
+ type: string;
1418
+ }[];
1419
+ }
1420
+ /**
1421
+ * Options for conversions from AVA
1422
+ */
1423
+ export declare class PostAvaSourceOptions {
1424
+ /**
1425
+ * If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
1426
+ */
1427
+ 'tryAutoGenerateItemNumbersAndSchema': boolean;
1428
+ static discriminator: string | undefined;
1429
+ static attributeTypeMap: Array<{
1430
+ name: string;
1431
+ baseName: string;
1432
+ type: string;
1433
+ }>;
1434
+ static getAttributeTypeMap(): {
1435
+ name: string;
1436
+ baseName: string;
1437
+ type: string;
1438
+ }[];
1439
+ }
1440
+ /**
1441
+ * Options for conversions to GAEB
1442
+ */
1443
+ export declare class PostGaebDestinationOptions {
1444
+ /**
1445
+ * Defaults to GAEB XML V3.2
1446
+ */
1447
+ 'destinationGaebType': DestinationGaebType;
1448
+ /**
1449
+ * Defaults to none, meaning no transformation will be done
1450
+ */
1451
+ 'targetExchangePhaseTransform': DestinationGaebExchangePhase;
1452
+ /**
1453
+ * Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
1454
+ */
1455
+ 'enforceStrictOfferPhaseLongTextOutput': boolean;
1456
+ /**
1457
+ * Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
1458
+ */
1459
+ 'exportQuantityDetermination': boolean;
1460
+ /**
1461
+ * If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
1462
+ */
1463
+ 'removeUnprintableCharactersFromTexts': boolean;
1464
+ /**
1465
+ * If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
1466
+ */
1467
+ 'forceIncludeDescriptions': boolean;
1468
+ /**
1469
+ * When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
1470
+ */
1471
+ 'treatNullItemNumberSchemaAsInvalid': boolean;
1472
+ static discriminator: string | undefined;
1473
+ static attributeTypeMap: Array<{
1474
+ name: string;
1475
+ baseName: string;
1476
+ type: string;
1477
+ }>;
1478
+ static getAttributeTypeMap(): {
1479
+ name: string;
1480
+ baseName: string;
1481
+ type: string;
1482
+ }[];
1483
+ }
1484
+ /**
1485
+ * Options for conversions to Oenorm
1486
+ */
1487
+ export declare class PostOenormDestinationOptions {
1488
+ /**
1489
+ * Defaults to Lv2015
1490
+ */
1491
+ 'destinationOenormType': DestinationOenormType;
1492
+ /**
1493
+ * Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
1494
+ */
1495
+ 'tryRepairProjectStructure': boolean;
1496
+ /**
1497
+ * If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
1498
+ */
1499
+ 'skipTryEnforceSchemaCompliantXmlOutput': boolean;
1500
+ /**
1501
+ * If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
1502
+ */
1503
+ 'removeUnprintableCharactersFromTexts': boolean;
1504
+ static discriminator: string | undefined;
1505
+ static attributeTypeMap: Array<{
1506
+ name: string;
1507
+ baseName: string;
1508
+ type: string;
1509
+ }>;
1510
+ static getAttributeTypeMap(): {
1511
+ name: string;
1512
+ baseName: string;
1513
+ type: string;
1514
+ }[];
1515
+ }
1516
+ /**
1347
1517
  * This class provides means to store information about a price and it's composition. Note that this is referencing to a single price component, so for example a Position would have a list of PriceComponents, one for Material, one for Labour etc.
1348
1518
  */
1349
1519
  export declare class PriceComponentDto {
@@ -1626,6 +1796,26 @@ export declare class ProjectInformationDto {
1626
1796
  }[];
1627
1797
  }
1628
1798
  /**
1799
+ * Check details specificly for checking ProjectDto objects
1800
+ */
1801
+ export declare class ProjectValidationCheckDetails {
1802
+ /**
1803
+ * The id of the element
1804
+ */
1805
+ 'elementId': string;
1806
+ static discriminator: string | undefined;
1807
+ static attributeTypeMap: Array<{
1808
+ name: string;
1809
+ baseName: string;
1810
+ type: string;
1811
+ }>;
1812
+ static getAttributeTypeMap(): {
1813
+ name: string;
1814
+ baseName: string;
1815
+ type: string;
1816
+ }[];
1817
+ }
1818
+ /**
1629
1819
  * Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes.
1630
1820
  */
1631
1821
  export declare class QuantityAssignmentDto {
@@ -2058,14 +2248,6 @@ export declare class ServiceSpecificationGroupDto extends IElementDto {
2058
2248
  'alternativeTo'?: string;
2059
2249
  'type'?: string;
2060
2250
  /**
2061
- * These are Catalogue that are used within this ElementContainerBase. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves.
2062
- */
2063
- 'projectCatalogues'?: Array<CatalogueDto>;
2064
- /**
2065
- * Referenced catalogues for this ElementContainerBase.
2066
- */
2067
- 'catalogueReferences'?: Array<CatalogueReferenceDto>;
2068
- /**
2069
2251
  * This class models special properties that only apply to some exchange scenarios where ÖNorm is used.
2070
2252
  */
2071
2253
  'oenormProperties'?: OenormPropertiesDto;
@@ -2178,6 +2360,10 @@ export declare class SubDescriptionDto {
2178
2360
  */
2179
2361
  'quantity': number;
2180
2362
  /**
2363
+ * You can use this property to directly set the quantity for this sub description. This will override any given QuantityComponents
2364
+ */
2365
+ 'quantityOverride'?: number;
2366
+ /**
2181
2367
  * Holds quantity information for this sub description. Quantity is listening to changes here and is reporting the total sum of all quantity components.
2182
2368
  */
2183
2369
  'quantityComponents'?: Array<CalculationDto>;
@@ -2198,6 +2384,10 @@ export declare class SubDescriptionDto {
2198
2384
  */
2199
2385
  'longText'?: string;
2200
2386
  /**
2387
+ * If this is given, then the sub description has a different unit tag than the parent position.
2388
+ */
2389
+ 'unitTag'?: string;
2390
+ /**
2201
2391
  * This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out.
2202
2392
  */
2203
2393
  'htmlLongText'?: string;
@@ -2222,6 +2412,8 @@ export declare class SubDescriptionDto {
2222
2412
  */
2223
2413
  'descriptionId'?: string;
2224
2414
  'hasBidderCommentInHtmlLongText': boolean;
2415
+ 'elementType'?: string;
2416
+ 'elementTypeDiscriminator'?: string;
2225
2417
  static discriminator: string | undefined;
2226
2418
  static attributeTypeMap: Array<{
2227
2419
  name: string;
@@ -2316,6 +2508,126 @@ export declare class TradeDiscountDto {
2316
2508
  }[];
2317
2509
  }
2318
2510
  /**
2511
+ * This class models the results of a single check performed during a validation action
2512
+ */
2513
+ export declare class ValidationCheckResult {
2514
+ /**
2515
+ * The severity for this check. Usually, low severity checks do not impact data exchange with third party applications
2516
+ */
2517
+ 'severity': ValidationSeverity;
2518
+ /**
2519
+ * The actual check that is represented by this result. Additional information may be found in other properties of this class, depending on the check.
2520
+ */
2521
+ 'checkType': ValidationCheckType;
2522
+ /**
2523
+ * A human readable message describing the result of the check.
2524
+ */
2525
+ 'message'?: string;
2526
+ /**
2527
+ * For CheckType of types ObjectValidation
2528
+ */
2529
+ 'objectValidationCheckDetails'?: ObjectValidationCheckDetails;
2530
+ /**
2531
+ * For CheckType of types XmlSchemaCheck
2532
+ */
2533
+ 'xmlSchemaValidationCheckDetails'?: XmlSchemaValidationCheckDetails;
2534
+ /**
2535
+ * For CheckType of types ProjectValidation
2536
+ */
2537
+ 'projectValidationCheckDetails'?: ProjectValidationCheckDetails;
2538
+ static discriminator: string | undefined;
2539
+ static attributeTypeMap: Array<{
2540
+ name: string;
2541
+ baseName: string;
2542
+ type: string;
2543
+ }>;
2544
+ static getAttributeTypeMap(): {
2545
+ name: string;
2546
+ baseName: string;
2547
+ type: string;
2548
+ }[];
2549
+ }
2550
+ /**
2551
+ * Enumeration for the different types of checks performed
2552
+ */
2553
+ export declare class ValidationCheckType {
2554
+ static discriminator: string | undefined;
2555
+ static attributeTypeMap: Array<{
2556
+ name: string;
2557
+ baseName: string;
2558
+ type: string;
2559
+ }>;
2560
+ static getAttributeTypeMap(): {
2561
+ name: string;
2562
+ baseName: string;
2563
+ type: string;
2564
+ }[];
2565
+ }
2566
+ /**
2567
+ * This class represents the result of a validation operation
2568
+ */
2569
+ export declare class ValidationResult {
2570
+ /**
2571
+ * Indicates if the validation produced no errors
2572
+ */
2573
+ 'isSchemaCompliant': boolean;
2574
+ /**
2575
+ * List of validation check results, which are usually errors
2576
+ */
2577
+ 'checkResults'?: Array<ValidationCheckResult>;
2578
+ /**
2579
+ * The type of the validation that was performed
2580
+ */
2581
+ 'validationType': ValidationType;
2582
+ /**
2583
+ * Name of the validated file
2584
+ */
2585
+ 'fileName'?: string;
2586
+ static discriminator: string | undefined;
2587
+ static attributeTypeMap: Array<{
2588
+ name: string;
2589
+ baseName: string;
2590
+ type: string;
2591
+ }>;
2592
+ static getAttributeTypeMap(): {
2593
+ name: string;
2594
+ baseName: string;
2595
+ type: string;
2596
+ }[];
2597
+ }
2598
+ /**
2599
+ * Indicates the severity of a check
2600
+ */
2601
+ export declare class ValidationSeverity {
2602
+ static discriminator: string | undefined;
2603
+ static attributeTypeMap: Array<{
2604
+ name: string;
2605
+ baseName: string;
2606
+ type: string;
2607
+ }>;
2608
+ static getAttributeTypeMap(): {
2609
+ name: string;
2610
+ baseName: string;
2611
+ type: string;
2612
+ }[];
2613
+ }
2614
+ /**
2615
+ * This enumeration represents the possible conversion targets when performing a validation
2616
+ */
2617
+ export declare class ValidationType {
2618
+ static discriminator: string | undefined;
2619
+ static attributeTypeMap: Array<{
2620
+ name: string;
2621
+ baseName: string;
2622
+ type: string;
2623
+ }>;
2624
+ static getAttributeTypeMap(): {
2625
+ name: string;
2626
+ baseName: string;
2627
+ type: string;
2628
+ }[];
2629
+ }
2630
+ /**
2319
2631
  * This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months
2320
2632
  */
2321
2633
  export declare class WarrantyDurationDto {
@@ -2339,6 +2651,30 @@ export declare class WarrantyDurationDto {
2339
2651
  type: string;
2340
2652
  }[];
2341
2653
  }
2654
+ /**
2655
+ * Check details for an XML schema validation result
2656
+ */
2657
+ export declare class XmlSchemaValidationCheckDetails {
2658
+ /**
2659
+ * The line number on which the validation happened
2660
+ */
2661
+ 'lineNumber': number;
2662
+ /**
2663
+ * The position in the line
2664
+ */
2665
+ 'linePosition': number;
2666
+ static discriminator: string | undefined;
2667
+ static attributeTypeMap: Array<{
2668
+ name: string;
2669
+ baseName: string;
2670
+ type: string;
2671
+ }>;
2672
+ static getAttributeTypeMap(): {
2673
+ name: string;
2674
+ baseName: string;
2675
+ type: string;
2676
+ }[];
2677
+ }
2342
2678
  export interface Authentication {
2343
2679
  /**
2344
2680
  * Apply authentication settings to header and query params.
@@ -2417,9 +2753,11 @@ export declare class AslvConversionApi {
2417
2753
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2418
2754
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2419
2755
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
2756
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
2757
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2420
2758
  * @param {*} [options] Override http request options.
2421
2759
  */
2422
- aslvConversionConvertToGaeb(aslvFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
2760
+ aslvConversionConvertToGaeb(aslvFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2423
2761
  response: http.IncomingMessage;
2424
2762
  body: Buffer;
2425
2763
  }>;
@@ -2492,9 +2830,11 @@ export declare class AvaConversionApi {
2492
2830
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2493
2831
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2494
2832
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
2833
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
2834
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2495
2835
  * @param {*} [options] Override http request options.
2496
2836
  */
2497
- avaConversionConvertToGaeb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
2837
+ avaConversionConvertToGaeb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2498
2838
  response: http.IncomingMessage;
2499
2839
  body: Buffer;
2500
2840
  }>;
@@ -2666,9 +3006,11 @@ export declare class ExcelConversionApi {
2666
3006
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2667
3007
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2668
3008
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
3009
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
3010
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2669
3011
  * @param {*} [options] Override http request options.
2670
3012
  */
2671
- excelConversionConvertToGaeb(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
3013
+ excelConversionConvertToGaeb(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2672
3014
  response: http.IncomingMessage;
2673
3015
  body: Buffer;
2674
3016
  }>;
@@ -2743,9 +3085,11 @@ export declare class GaebConversionApi {
2743
3085
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2744
3086
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2745
3087
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
3088
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
3089
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2746
3090
  * @param {*} [options] Override http request options.
2747
3091
  */
2748
- gaebConversionConvertToGaeb(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
3092
+ gaebConversionConvertToGaeb(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2749
3093
  response: http.IncomingMessage;
2750
3094
  body: Buffer;
2751
3095
  }>;
@@ -2816,9 +3160,11 @@ export declare class OenormConversionApi {
2816
3160
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2817
3161
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2818
3162
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
3163
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
3164
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2819
3165
  * @param {*} [options] Override http request options.
2820
3166
  */
2821
- oenormConversionConvertToGaeb(oenormFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
3167
+ oenormConversionConvertToGaeb(oenormFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2822
3168
  response: http.IncomingMessage;
2823
3169
  body: Buffer;
2824
3170
  }>;
@@ -2888,9 +3234,11 @@ export declare class RebConversionApi {
2888
3234
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2889
3235
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2890
3236
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
3237
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
3238
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2891
3239
  * @param {*} [options] Override http request options.
2892
3240
  */
2893
- rebConversionConvertToGaeb(rebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
3241
+ rebConversionConvertToGaeb(rebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2894
3242
  response: http.IncomingMessage;
2895
3243
  body: Buffer;
2896
3244
  }>;
@@ -2960,9 +3308,11 @@ export declare class SiaConversionApi {
2960
3308
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
2961
3309
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
2962
3310
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
3311
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
3312
+ * @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
2963
3313
  * @param {*} [options] Override http request options.
2964
3314
  */
2965
- siaConversionConvertToGaeb(siaFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
3315
+ siaConversionConvertToGaeb(siaFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
2966
3316
  response: http.IncomingMessage;
2967
3317
  body: Buffer;
2968
3318
  }>;
@@ -3008,6 +3358,45 @@ export declare class StatusApi {
3008
3358
  body: GetStatus;
3009
3359
  }>;
3010
3360
  }
3361
+ export declare enum ValidationApiApiKeys {
3362
+ }
3363
+ export declare class ValidationApi {
3364
+ protected _basePath: string;
3365
+ protected defaultHeaders: any;
3366
+ protected _useQuerystring: boolean;
3367
+ protected authentications: {
3368
+ default: Authentication;
3369
+ 'Dangl.Identity': OAuth;
3370
+ };
3371
+ constructor(basePath?: string);
3372
+ set useQuerystring(value: boolean);
3373
+ set basePath(basePath: string);
3374
+ get basePath(): string;
3375
+ setDefaultAuthentication(auth: Authentication): void;
3376
+ setApiKey(key: ValidationApiApiKeys, value: string): void;
3377
+ set accessToken(token: string);
3378
+ /**
3379
+ *
3380
+ * @summary This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided as a query parameter, since there is no auto detection of the uploaded file type.
3381
+ * @param avaFile The file to validate
3382
+ * @param fileValidationSourceType You need to indicate which type of file is being provided, there is no auto detection mechanism
3383
+ * @param {*} [options] Override http request options.
3384
+ */
3385
+ validationValidateFile(avaFile: FileParameter, fileValidationSourceType?: 'Gaeb' | 'Oenorm', options?: any): Promise<{
3386
+ response: http.IncomingMessage;
3387
+ body: ValidationResult;
3388
+ }>;
3389
+ /**
3390
+ *
3391
+ * @summary This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase into account and do some general project validation. Optionally, a conversion to a desired target can also be done, in which case the target file will also be validated.
3392
+ * @param avaProjectValidationSourceOptions The options used for the validation operation
3393
+ * @param {*} [options] Override http request options.
3394
+ */
3395
+ validationValidateProject(avaProjectValidationSourceOptions: PostAvaProjectValidationSourceOptions, options?: any): Promise<{
3396
+ response: http.IncomingMessage;
3397
+ body: ValidationResult;
3398
+ }>;
3399
+ }
3011
3400
  export interface FileParameter {
3012
3401
  value: Buffer;
3013
3402
  options: {