@dangl/avacloud-client-node 1.21.1 → 1.22.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.30
1
+ 2.4.31
package/api.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * AVACloud API 1.36.0
2
+ * AVACloud API 1.40.0
3
3
  * AVACloud API specification
4
4
  *
5
- * OpenAPI spec version: 1.36.0
5
+ * OpenAPI spec version: 1.40.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -367,6 +367,10 @@ export declare class CommercePropertiesDto {
367
367
  * This optional property can be used to indicate the basis for prices for a single position. Price basis means that the price is given per unit of the basis, e.g. per a pack of five when this property is set to '5'.
368
368
  */
369
369
  'priceBasis'?: number;
370
+ /**
371
+ * This optional property can be used to indicate a sub position identifier specific for the commerce exchange
372
+ */
373
+ 'subPositionIdentifier'?: string;
370
374
  static discriminator: string | undefined;
371
375
  static attributeTypeMap: Array<{
372
376
  name: string;
@@ -664,6 +668,38 @@ export declare class GrossPriceComponentDto {
664
668
  }[];
665
669
  }
666
670
  /**
671
+ * Duration used in retention positions
672
+ */
673
+ export declare class HoldOutDurationUnitDto {
674
+ static discriminator: string | undefined;
675
+ static attributeTypeMap: Array<{
676
+ name: string;
677
+ baseName: string;
678
+ type: string;
679
+ }>;
680
+ static getAttributeTypeMap(): {
681
+ name: string;
682
+ baseName: string;
683
+ type: string;
684
+ }[];
685
+ }
686
+ /**
687
+ * Types of retentions to be used in positions
688
+ */
689
+ export declare class HoldOutTypeDto {
690
+ static discriminator: string | undefined;
691
+ static attributeTypeMap: Array<{
692
+ name: string;
693
+ baseName: string;
694
+ type: string;
695
+ }>;
696
+ static getAttributeTypeMap(): {
697
+ name: string;
698
+ baseName: string;
699
+ type: string;
700
+ }[];
701
+ }
702
+ /**
667
703
  *
668
704
  */
669
705
  export declare class HttpStatusCode {
@@ -1409,6 +1445,46 @@ export declare class PositionDto extends IElementDto {
1409
1445
  * This property can optionally be used in GAEB exchange scenarios. It is only meaningful if this position itself is a complementing position, meaning if this position is marked in other positions in their ComplementedBy list. Then, it specifies how the complementing should be expressed in GAEB. By default, positions are always explicitly referenced, but other options are possible. Please also note that the Dangl.AVA.Converter package, which is used for GAEB exports, will check if the given type is valid in the current project configuration. If not, directly referenced positions will be used as fallback.
1410
1446
  */
1411
1447
  'gaebComplementingType': PositionComplementingTypeDto;
1448
+ /**
1449
+ * HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site.
1450
+ */
1451
+ 'holdOutProperties'?: PositionHoldOutPropertiesDto;
1452
+ static discriminator: string | undefined;
1453
+ static attributeTypeMap: Array<{
1454
+ name: string;
1455
+ baseName: string;
1456
+ type: string;
1457
+ }>;
1458
+ static getAttributeTypeMap(): {
1459
+ name: string;
1460
+ baseName: string;
1461
+ type: string;
1462
+ }[];
1463
+ }
1464
+ /**
1465
+ * This class holds properties that describe retention types in position. Retention / hold out usually means that a service is provided and kept available for a specific amount of time, e.g. fences on a construction site
1466
+ */
1467
+ export declare class PositionHoldOutPropertiesDto {
1468
+ /**
1469
+ * Elements GUID identifier.
1470
+ */
1471
+ 'id': string;
1472
+ /**
1473
+ * The actual type
1474
+ */
1475
+ 'holdOutType': HoldOutTypeDto;
1476
+ /**
1477
+ * The duration of the period
1478
+ */
1479
+ 'holdOutDuration': number;
1480
+ /**
1481
+ * The time unit of the period
1482
+ */
1483
+ 'holdOutDurationUnit': HoldOutDurationUnitDto;
1484
+ /**
1485
+ * References to base positions
1486
+ */
1487
+ 'basePositionReferences'?: Array<string>;
1412
1488
  static discriminator: string | undefined;
1413
1489
  static attributeTypeMap: Array<{
1414
1490
  name: string;
@@ -1522,7 +1598,7 @@ export declare class PostGaebDestinationOptions {
1522
1598
  */
1523
1599
  'exportQuantityDetermination': boolean;
1524
1600
  /**
1525
- * 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.
1601
+ * 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. Defaults to true.
1526
1602
  */
1527
1603
  'removeUnprintableCharactersFromTexts': boolean;
1528
1604
  /**
@@ -1562,7 +1638,7 @@ export declare class PostOenormDestinationOptions {
1562
1638
  */
1563
1639
  'skipTryEnforceSchemaCompliantXmlOutput': boolean;
1564
1640
  /**
1565
- * 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.
1641
+ * 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. Defaults to true.
1566
1642
  */
1567
1643
  'removeUnprintableCharactersFromTexts': boolean;
1568
1644
  static discriminator: string | undefined;
@@ -1847,6 +1923,14 @@ export declare class ProjectInformationDto {
1847
1923
  * This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary
1848
1924
  */
1849
1925
  'specialAwardKind': SpecialAwardKindDto;
1926
+ /**
1927
+ * Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners.
1928
+ */
1929
+ 'requesters'?: Array<PartyInformationDto>;
1930
+ /**
1931
+ * Notification sites are addresses that are used for delivering messages in the context of construction projects.
1932
+ */
1933
+ 'notificationSites'?: Array<PartyInformationDto>;
1850
1934
  static discriminator: string | undefined;
1851
1935
  static attributeTypeMap: Array<{
1852
1936
  name: string;
@@ -2201,6 +2285,18 @@ export declare class ServiceSpecificationDto {
2201
2285
  */
2202
2286
  'decisionDate'?: Date;
2203
2287
  /**
2288
+ * Date of when the offer / bid was created
2289
+ */
2290
+ 'bidDate'?: Date;
2291
+ /**
2292
+ * If a construction project requires a warranty bond, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as a warranty bond.
2293
+ */
2294
+ 'warrantyBondPercentage': number;
2295
+ /**
2296
+ * If a construction project requires an execution guarantty, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as an execution guarantee. In practice, this percentage is usually deducted from intermediate invoices and only billed in the final invoice.
2297
+ */
2298
+ 'executionGuaranteePercentage': number;
2299
+ /**
2204
2300
  * String indicating where the physical submission of the offer is taking place.
2205
2301
  */
2206
2302
  'submissionLocation'?: string;
@@ -2922,7 +3018,7 @@ export declare class AslvConversionApi {
2922
3018
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
2923
3019
  * @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.
2924
3020
  * @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.
2925
- * @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.
3021
+ * @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. Defaults to true.
2926
3022
  * @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.
2927
3023
  * @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.
2928
3024
  * @param {*} [options] Override http request options.
@@ -2951,7 +3047,7 @@ export declare class AslvConversionApi {
2951
3047
  * @param destinationOenormType Defaults to Lv2015
2952
3048
  * @param tryRepairProjectStructure 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
2953
3049
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
2954
- * @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.
3050
+ * @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. Defaults to true.
2955
3051
  * @param {*} [options] Override http request options.
2956
3052
  */
2957
3053
  aslvConversionConvertToOenorm(aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
@@ -3054,7 +3150,7 @@ export declare class AvaConversionApi {
3054
3150
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3055
3151
  * @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.
3056
3152
  * @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.
3057
- * @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.
3153
+ * @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. Defaults to true.
3058
3154
  * @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.
3059
3155
  * @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.
3060
3156
  * @param {*} [options] Override http request options.
@@ -3085,7 +3181,7 @@ export declare class AvaConversionApi {
3085
3181
  * @param destinationOenormType Defaults to Lv2015
3086
3182
  * @param tryRepairProjectStructure 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
3087
3183
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
3088
- * @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.
3184
+ * @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. Defaults to true.
3089
3185
  * @param {*} [options] Override http request options.
3090
3186
  */
3091
3187
  avaConversionConvertToOenorm(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
@@ -3097,7 +3193,7 @@ export declare class AvaConversionApi {
3097
3193
  */
3098
3194
  avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: {
3099
3195
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3100
- destinationRebType?: 'D11' | 'X31GaebXmlV32';
3196
+ destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33';
3101
3197
  options?: any;
3102
3198
  }): Promise<{
3103
3199
  response: http.IncomingMessage;
@@ -3111,7 +3207,7 @@ export declare class AvaConversionApi {
3111
3207
  * @param destinationRebType Defaults to D11
3112
3208
  * @param {*} [options] Override http request options.
3113
3209
  */
3114
- avaConversionConvertToReb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32', options?: any): Promise<{
3210
+ avaConversionConvertToReb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33', options?: any): Promise<{
3115
3211
  response: http.IncomingMessage;
3116
3212
  body: Buffer;
3117
3213
  }>;
@@ -3320,7 +3416,7 @@ export declare class ExcelConversionApi {
3320
3416
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3321
3417
  * @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.
3322
3418
  * @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.
3323
- * @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.
3419
+ * @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. Defaults to true.
3324
3420
  * @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.
3325
3421
  * @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.
3326
3422
  * @param {*} [options] Override http request options.
@@ -3353,7 +3449,7 @@ export declare class ExcelConversionApi {
3353
3449
  * @param destinationOenormType Defaults to Lv2015
3354
3450
  * @param tryRepairProjectStructure 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
3355
3451
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
3356
- * @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.
3452
+ * @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. Defaults to true.
3357
3453
  * @param {*} [options] Override http request options.
3358
3454
  */
3359
3455
  excelConversionConvertToOenorm(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
@@ -3385,6 +3481,8 @@ export declare class GaebConversionApi {
3385
3481
  supportSkippedItemNumberLevelsInPositions?: boolean;
3386
3482
  removePlainTextLongTexts?: boolean;
3387
3483
  removeHtmlLongTexts?: boolean;
3484
+ outputHtmlAsXml?: boolean;
3485
+ keepEmptyHtmlText?: boolean;
3388
3486
  options?: any;
3389
3487
  }): Promise<{
3390
3488
  response: http.IncomingMessage;
@@ -3394,12 +3492,14 @@ export declare class GaebConversionApi {
3394
3492
  *
3395
3493
  * @summary Converts GAEB files to Dangl.AVA projects
3396
3494
  * @param gaebFile The input file
3397
- * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3495
+ * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3398
3496
  * @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
3399
3497
  * @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
3498
+ * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3499
+ * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3400
3500
  * @param {*} [options] Override http request options.
3401
3501
  */
3402
- gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
3502
+ gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options?: any): Promise<{
3403
3503
  response: http.IncomingMessage;
3404
3504
  body: ProjectDto;
3405
3505
  }>;
@@ -3411,6 +3511,8 @@ export declare class GaebConversionApi {
3411
3511
  writePrices?: boolean;
3412
3512
  writeLongTexts?: boolean;
3413
3513
  conversionCulture?: string;
3514
+ outputHtmlAsXml?: boolean;
3515
+ keepEmptyHtmlText?: boolean;
3414
3516
  options?: any;
3415
3517
  }): Promise<{
3416
3518
  response: http.IncomingMessage;
@@ -3420,13 +3522,15 @@ export declare class GaebConversionApi {
3420
3522
  *
3421
3523
  * @summary Converts GAEB files to Excel
3422
3524
  * @param gaebFile The input file
3423
- * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3525
+ * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3424
3526
  * @param writePrices Defaults to true
3425
3527
  * @param writeLongTexts Defaults to true
3426
3528
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3529
+ * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3530
+ * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3427
3531
  * @param {*} [options] Override http request options.
3428
3532
  */
3429
- gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3533
+ gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options?: any): Promise<{
3430
3534
  response: http.IncomingMessage;
3431
3535
  body: Buffer;
3432
3536
  }>;
@@ -3442,6 +3546,8 @@ export declare class GaebConversionApi {
3442
3546
  removeUnprintableCharactersFromTexts?: boolean;
3443
3547
  forceIncludeDescriptions?: boolean;
3444
3548
  treatNullItemNumberSchemaAsInvalid?: boolean;
3549
+ outputHtmlAsXml?: boolean;
3550
+ keepEmptyHtmlText?: boolean;
3445
3551
  options?: any;
3446
3552
  }): Promise<{
3447
3553
  response: http.IncomingMessage;
@@ -3451,17 +3557,19 @@ export declare class GaebConversionApi {
3451
3557
  *
3452
3558
  * @summary Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
3453
3559
  * @param gaebFile The input file
3454
- * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3560
+ * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3455
3561
  * @param destinationGaebType Defaults to GAEB XML V3.2
3456
3562
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3457
3563
  * @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.
3458
3564
  * @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.
3459
- * @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.
3565
+ * @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. Defaults to true.
3460
3566
  * @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.
3461
3567
  * @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.
3568
+ * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3569
+ * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3462
3570
  * @param {*} [options] Override http request options.
3463
3571
  */
3464
- 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' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
3572
+ 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' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options?: any): Promise<{
3465
3573
  response: http.IncomingMessage;
3466
3574
  body: Buffer;
3467
3575
  }>;
@@ -3474,6 +3582,8 @@ export declare class GaebConversionApi {
3474
3582
  tryRepairProjectStructure?: boolean;
3475
3583
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
3476
3584
  removeUnprintableCharactersFromTexts?: boolean;
3585
+ outputHtmlAsXml?: boolean;
3586
+ keepEmptyHtmlText?: boolean;
3477
3587
  options?: any;
3478
3588
  }): Promise<{
3479
3589
  response: http.IncomingMessage;
@@ -3483,14 +3593,16 @@ export declare class GaebConversionApi {
3483
3593
  *
3484
3594
  * @summary Converts GAEB files to Oenorm files
3485
3595
  * @param gaebFile The input file
3486
- * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position levels - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3596
+ * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3487
3597
  * @param destinationOenormType Defaults to Lv2015
3488
3598
  * @param tryRepairProjectStructure 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
3489
3599
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
3490
- * @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.
3600
+ * @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. Defaults to true.
3601
+ * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3602
+ * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3491
3603
  * @param {*} [options] Override http request options.
3492
3604
  */
3493
- gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
3605
+ gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options?: any): Promise<{
3494
3606
  response: http.IncomingMessage;
3495
3607
  body: Buffer;
3496
3608
  }>;
@@ -3584,7 +3696,7 @@ export declare class OenormConversionApi {
3584
3696
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3585
3697
  * @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.
3586
3698
  * @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.
3587
- * @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.
3699
+ * @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. Defaults to true.
3588
3700
  * @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.
3589
3701
  * @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.
3590
3702
  * @param {*} [options] Override http request options.
@@ -3613,7 +3725,7 @@ export declare class OenormConversionApi {
3613
3725
  * @param destinationOenormType Defaults to Lv2015
3614
3726
  * @param tryRepairProjectStructure 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
3615
3727
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
3616
- * @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.
3728
+ * @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. Defaults to true.
3617
3729
  * @param {*} [options] Override http request options.
3618
3730
  */
3619
3731
  oenormConversionConvertToOenorm(oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
@@ -3710,7 +3822,7 @@ export declare class RebConversionApi {
3710
3822
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3711
3823
  * @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.
3712
3824
  * @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.
3713
- * @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.
3825
+ * @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. Defaults to true.
3714
3826
  * @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.
3715
3827
  * @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.
3716
3828
  * @param {*} [options] Override http request options.
@@ -3739,7 +3851,7 @@ export declare class RebConversionApi {
3739
3851
  * @param destinationOenormType Defaults to Lv2015
3740
3852
  * @param tryRepairProjectStructure 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
3741
3853
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
3742
- * @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.
3854
+ * @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. Defaults to true.
3743
3855
  * @param {*} [options] Override http request options.
3744
3856
  */
3745
3857
  rebConversionConvertToOenorm(rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
@@ -3836,7 +3948,7 @@ export declare class SiaConversionApi {
3836
3948
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3837
3949
  * @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.
3838
3950
  * @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.
3839
- * @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.
3951
+ * @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. Defaults to true.
3840
3952
  * @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.
3841
3953
  * @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.
3842
3954
  * @param {*} [options] Override http request options.
@@ -3865,7 +3977,7 @@ export declare class SiaConversionApi {
3865
3977
  * @param destinationOenormType Defaults to Lv2015
3866
3978
  * @param tryRepairProjectStructure 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
3867
3979
  * @param skipTryEnforceSchemaCompliantXmlOutput 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.
3868
- * @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.
3980
+ * @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. Defaults to true.
3869
3981
  * @param {*} [options] Override http request options.
3870
3982
  */
3871
3983
  siaConversionConvertToOenorm(siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{