@dangl/avacloud-client-node 1.21.1 → 1.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * AVACloud API 1.36.0
2
+ * AVACloud API 1.41.0
3
3
  * AVACloud API specification
4
4
  *
5
- * OpenAPI spec version: 1.36.0
5
+ * OpenAPI spec version: 1.41.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -637,6 +637,10 @@ export class CommercePropertiesDto {
637
637
  * 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'.
638
638
  */
639
639
  'priceBasis'?: number;
640
+ /**
641
+ * This optional property can be used to indicate a sub position identifier specific for the commerce exchange
642
+ */
643
+ 'subPositionIdentifier'?: string;
640
644
 
641
645
  static discriminator: string | undefined = undefined;
642
646
 
@@ -670,6 +674,11 @@ export class CommercePropertiesDto {
670
674
  "name": "priceBasis",
671
675
  "baseName": "priceBasis",
672
676
  "type": "number"
677
+ },
678
+ {
679
+ "name": "subPositionIdentifier",
680
+ "baseName": "subPositionIdentifier",
681
+ "type": "string"
673
682
  } ];
674
683
 
675
684
  static getAttributeTypeMap() {
@@ -709,6 +718,21 @@ export class ComplementedByQuantityDto {
709
718
  }
710
719
  }
711
720
 
721
+ /**
722
+ * Represents valid Datanorm versions for export
723
+ */
724
+ export class DatanormDestinationVersion {
725
+
726
+ static discriminator: string | undefined = undefined;
727
+
728
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
729
+ ];
730
+
731
+ static getAttributeTypeMap() {
732
+ return DatanormDestinationVersion.attributeTypeMap;
733
+ }
734
+ }
735
+
712
736
  /**
713
737
  * The GAEB exchange phase to transform to
714
738
  */
@@ -1067,6 +1091,36 @@ export class GrossPriceComponentDto {
1067
1091
  }
1068
1092
  }
1069
1093
 
1094
+ /**
1095
+ * Duration used in retention positions
1096
+ */
1097
+ export class HoldOutDurationUnitDto {
1098
+
1099
+ static discriminator: string | undefined = undefined;
1100
+
1101
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
1102
+ ];
1103
+
1104
+ static getAttributeTypeMap() {
1105
+ return HoldOutDurationUnitDto.attributeTypeMap;
1106
+ }
1107
+ }
1108
+
1109
+ /**
1110
+ * Types of retentions to be used in positions
1111
+ */
1112
+ export class HoldOutTypeDto {
1113
+
1114
+ static discriminator: string | undefined = undefined;
1115
+
1116
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
1117
+ ];
1118
+
1119
+ static getAttributeTypeMap() {
1120
+ return HoldOutTypeDto.attributeTypeMap;
1121
+ }
1122
+ }
1123
+
1070
1124
  /**
1071
1125
  *
1072
1126
  */
@@ -1091,7 +1145,7 @@ export class ItemNumberDto {
1091
1145
  */
1092
1146
  'id': string;
1093
1147
  /**
1094
- * Will return this ItemNumber as point delimited string. Will not distinguish between upper- and lowercase and return an all-lowercase representation. Will consider first numbers, then characters, e.g. 1a is considered preceding aa.
1148
+ * Will return this ItemNumber as point delimited string. Will not distinguish between upper- and lowercase and return an all-lowercase representation. Will consider first numbers, then characters, e.g. 1a is considered preceding aa. Transformation to all lowercase can be configured in the ItemNumberSchema property.
1095
1149
  */
1096
1150
  'stringRepresentation'?: string;
1097
1151
  /**
@@ -1204,6 +1258,10 @@ export class ItemNumberSchemaDto {
1204
1258
  * This is a read-only property that indicates if this schema has a valid structure. It internally just returns the result from IsCorrectlyDefined. This will return if the ItemNumberSchema is correctly defined. For it to be correctly defined, the following conditions must be true: There may only be one lot group, if there is one, it must be at the top. Following lot levels, there may be at least one group level. After the group levels, there must be one position level. After the position level, there may be one index level. If no tiers are defined at all, this will also return false.
1205
1259
  */
1206
1260
  'schemaIsCorrectlyDefined': boolean;
1261
+ /**
1262
+ * Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation.
1263
+ */
1264
+ 'allowUpperCaseLettering': boolean;
1207
1265
 
1208
1266
  static discriminator: string | undefined = undefined;
1209
1267
 
@@ -1247,6 +1305,11 @@ export class ItemNumberSchemaDto {
1247
1305
  "name": "schemaIsCorrectlyDefined",
1248
1306
  "baseName": "schemaIsCorrectlyDefined",
1249
1307
  "type": "boolean"
1308
+ },
1309
+ {
1310
+ "name": "allowUpperCaseLettering",
1311
+ "baseName": "allowUpperCaseLettering",
1312
+ "type": "boolean"
1250
1313
  } ];
1251
1314
 
1252
1315
  static getAttributeTypeMap() {
@@ -2150,6 +2213,10 @@ export class PositionDto extends IElementDto {
2150
2213
  * 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.
2151
2214
  */
2152
2215
  'gaebComplementingType': PositionComplementingTypeDto;
2216
+ /**
2217
+ * HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site.
2218
+ */
2219
+ 'holdOutProperties'?: PositionHoldOutPropertiesDto;
2153
2220
 
2154
2221
  static discriminator: string | undefined = undefined;
2155
2222
 
@@ -2413,6 +2480,11 @@ export class PositionDto extends IElementDto {
2413
2480
  "name": "gaebComplementingType",
2414
2481
  "baseName": "gaebComplementingType",
2415
2482
  "type": "PositionComplementingTypeDto"
2483
+ },
2484
+ {
2485
+ "name": "holdOutProperties",
2486
+ "baseName": "holdOutProperties",
2487
+ "type": "PositionHoldOutPropertiesDto"
2416
2488
  } ];
2417
2489
 
2418
2490
  static getAttributeTypeMap() {
@@ -2420,6 +2492,65 @@ export class PositionDto extends IElementDto {
2420
2492
  }
2421
2493
  }
2422
2494
 
2495
+ /**
2496
+ * 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
2497
+ */
2498
+ export class PositionHoldOutPropertiesDto {
2499
+ /**
2500
+ * Elements GUID identifier.
2501
+ */
2502
+ 'id': string;
2503
+ /**
2504
+ * The actual type
2505
+ */
2506
+ 'holdOutType': HoldOutTypeDto;
2507
+ /**
2508
+ * The duration of the period
2509
+ */
2510
+ 'holdOutDuration': number;
2511
+ /**
2512
+ * The time unit of the period
2513
+ */
2514
+ 'holdOutDurationUnit': HoldOutDurationUnitDto;
2515
+ /**
2516
+ * References to base positions
2517
+ */
2518
+ 'basePositionReferences'?: Array<string>;
2519
+
2520
+ static discriminator: string | undefined = undefined;
2521
+
2522
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
2523
+ {
2524
+ "name": "id",
2525
+ "baseName": "id",
2526
+ "type": "string"
2527
+ },
2528
+ {
2529
+ "name": "holdOutType",
2530
+ "baseName": "holdOutType",
2531
+ "type": "HoldOutTypeDto"
2532
+ },
2533
+ {
2534
+ "name": "holdOutDuration",
2535
+ "baseName": "holdOutDuration",
2536
+ "type": "number"
2537
+ },
2538
+ {
2539
+ "name": "holdOutDurationUnit",
2540
+ "baseName": "holdOutDurationUnit",
2541
+ "type": "HoldOutDurationUnitDto"
2542
+ },
2543
+ {
2544
+ "name": "basePositionReferences",
2545
+ "baseName": "basePositionReferences",
2546
+ "type": "Array<string>"
2547
+ } ];
2548
+
2549
+ static getAttributeTypeMap() {
2550
+ return PositionHoldOutPropertiesDto.attributeTypeMap;
2551
+ }
2552
+ }
2553
+
2423
2554
  /**
2424
2555
  * This is a classification for Position elements.
2425
2556
  */
@@ -2556,7 +2687,7 @@ export class PostGaebDestinationOptions {
2556
2687
  */
2557
2688
  'exportQuantityDetermination': boolean;
2558
2689
  /**
2559
- * 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.
2690
+ * 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.
2560
2691
  */
2561
2692
  'removeUnprintableCharactersFromTexts': boolean;
2562
2693
  /**
@@ -2629,7 +2760,7 @@ export class PostOenormDestinationOptions {
2629
2760
  */
2630
2761
  'skipTryEnforceSchemaCompliantXmlOutput': boolean;
2631
2762
  /**
2632
- * 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.
2763
+ * 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.
2633
2764
  */
2634
2765
  'removeUnprintableCharactersFromTexts': boolean;
2635
2766
 
@@ -3034,6 +3165,14 @@ export class ProjectInformationDto {
3034
3165
  * 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
3035
3166
  */
3036
3167
  'specialAwardKind': SpecialAwardKindDto;
3168
+ /**
3169
+ * Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners.
3170
+ */
3171
+ 'requesters'?: Array<PartyInformationDto>;
3172
+ /**
3173
+ * Notification sites are addresses that are used for delivering messages in the context of construction projects.
3174
+ */
3175
+ 'notificationSites'?: Array<PartyInformationDto>;
3037
3176
 
3038
3177
  static discriminator: string | undefined = undefined;
3039
3178
 
@@ -3112,6 +3251,16 @@ export class ProjectInformationDto {
3112
3251
  "name": "specialAwardKind",
3113
3252
  "baseName": "specialAwardKind",
3114
3253
  "type": "SpecialAwardKindDto"
3254
+ },
3255
+ {
3256
+ "name": "requesters",
3257
+ "baseName": "requesters",
3258
+ "type": "Array<PartyInformationDto>"
3259
+ },
3260
+ {
3261
+ "name": "notificationSites",
3262
+ "baseName": "notificationSites",
3263
+ "type": "Array<PartyInformationDto>"
3115
3264
  } ];
3116
3265
 
3117
3266
  static getAttributeTypeMap() {
@@ -3598,6 +3747,18 @@ export class ServiceSpecificationDto {
3598
3747
  */
3599
3748
  'decisionDate'?: Date;
3600
3749
  /**
3750
+ * Date of when the offer / bid was created
3751
+ */
3752
+ 'bidDate'?: Date;
3753
+ /**
3754
+ * 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.
3755
+ */
3756
+ 'warrantyBondPercentage': number;
3757
+ /**
3758
+ * 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.
3759
+ */
3760
+ 'executionGuaranteePercentage': number;
3761
+ /**
3601
3762
  * String indicating where the physical submission of the offer is taking place.
3602
3763
  */
3603
3764
  'submissionLocation'?: string;
@@ -3819,6 +3980,21 @@ export class ServiceSpecificationDto {
3819
3980
  "baseName": "decisionDate",
3820
3981
  "type": "Date"
3821
3982
  },
3983
+ {
3984
+ "name": "bidDate",
3985
+ "baseName": "bidDate",
3986
+ "type": "Date"
3987
+ },
3988
+ {
3989
+ "name": "warrantyBondPercentage",
3990
+ "baseName": "warrantyBondPercentage",
3991
+ "type": "number"
3992
+ },
3993
+ {
3994
+ "name": "executionGuaranteePercentage",
3995
+ "baseName": "executionGuaranteePercentage",
3996
+ "type": "number"
3997
+ },
3822
3998
  {
3823
3999
  "name": "submissionLocation",
3824
4000
  "baseName": "submissionLocation",
@@ -4020,6 +4196,14 @@ export class ServiceSpecificationGroupDto extends IElementDto {
4020
4196
  * This indicates, if this element is part of an addendum an, if yes, with what status.
4021
4197
  */
4022
4198
  'addendumStatus'?: AddendumStatusDto;
4199
+ /**
4200
+ * This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific group is assigned to. That way, if you specifiy multiple alternative ServiceSpecificationGroups with the same AlternativeIdentifier, you can indicate that to replace a single base ServiceSpecificationGroup, multiple alternative ServiceSpecificationGroups should be used. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo.
4201
+ */
4202
+ 'alternativeIdentifier'?: number;
4203
+ /**
4204
+ * This is an optional property that can be used together with AlternativeTo and AlternativeGroupIdentifier. If this is set, you can indicate which alternative group a specific group is assigned to. That way, you can specify the id (in integer format) for the alternative group this group belongs to. It's different to AlternativeIdentifier in that the other property describes the id of the group, while this property here describes the group itself. If a group only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base group for a specific group. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo.
4205
+ */
4206
+ 'alternativeGroupIdentifier'?: number;
4023
4207
 
4024
4208
  static discriminator: string | undefined = undefined;
4025
4209
 
@@ -4163,6 +4347,16 @@ export class ServiceSpecificationGroupDto extends IElementDto {
4163
4347
  "name": "addendumStatus",
4164
4348
  "baseName": "addendumStatus",
4165
4349
  "type": "AddendumStatusDto"
4350
+ },
4351
+ {
4352
+ "name": "alternativeIdentifier",
4353
+ "baseName": "alternativeIdentifier",
4354
+ "type": "number"
4355
+ },
4356
+ {
4357
+ "name": "alternativeGroupIdentifier",
4358
+ "baseName": "alternativeGroupIdentifier",
4359
+ "type": "number"
4166
4360
  } ];
4167
4361
 
4168
4362
  static getAttributeTypeMap() {
@@ -4581,6 +4775,21 @@ export class TradeDiscountDto {
4581
4775
  }
4582
4776
  }
4583
4777
 
4778
+ /**
4779
+ * Represents valid UGL versions for export
4780
+ */
4781
+ export class UglDestinationVersion {
4782
+
4783
+ static discriminator: string | undefined = undefined;
4784
+
4785
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4786
+ ];
4787
+
4788
+ static getAttributeTypeMap() {
4789
+ return UglDestinationVersion.attributeTypeMap;
4790
+ }
4791
+ }
4792
+
4584
4793
  /**
4585
4794
  * This class models the results of a single check performed during a validation action
4586
4795
  */
@@ -4827,6 +5036,7 @@ let typeMap: {[index: string]: any} = {
4827
5036
  "CommerceInquiryTypeDto": CommerceInquiryTypeDto,
4828
5037
  "CommercePropertiesDto": CommercePropertiesDto,
4829
5038
  "ComplementedByQuantityDto": ComplementedByQuantityDto,
5039
+ "DatanormDestinationVersion": DatanormDestinationVersion,
4830
5040
  "DestinationGaebExchangePhase": DestinationGaebExchangePhase,
4831
5041
  "DestinationGaebType": DestinationGaebType,
4832
5042
  "DestinationOenormType": DestinationOenormType,
@@ -4838,6 +5048,8 @@ let typeMap: {[index: string]: any} = {
4838
5048
  "ForgotPasswordPost": ForgotPasswordPost,
4839
5049
  "GetStatus": GetStatus,
4840
5050
  "GrossPriceComponentDto": GrossPriceComponentDto,
5051
+ "HoldOutDurationUnitDto": HoldOutDurationUnitDto,
5052
+ "HoldOutTypeDto": HoldOutTypeDto,
4841
5053
  "HttpStatusCode": HttpStatusCode,
4842
5054
  "IElementDto": IElementDto,
4843
5055
  "ItemNumberDto": ItemNumberDto,
@@ -4857,6 +5069,7 @@ let typeMap: {[index: string]: any} = {
4857
5069
  "PartyInformationDto": PartyInformationDto,
4858
5070
  "PositionComplementingTypeDto": PositionComplementingTypeDto,
4859
5071
  "PositionDto": PositionDto,
5072
+ "PositionHoldOutPropertiesDto": PositionHoldOutPropertiesDto,
4860
5073
  "PositionTypeDto": PositionTypeDto,
4861
5074
  "PostAvaProjectValidationSourceOptions": PostAvaProjectValidationSourceOptions,
4862
5075
  "PostAvaSourceOptions": PostAvaSourceOptions,
@@ -4888,6 +5101,7 @@ let typeMap: {[index: string]: any} = {
4888
5101
  "TokenRefreshPost": TokenRefreshPost,
4889
5102
  "TokenResponseGet": TokenResponseGet,
4890
5103
  "TradeDiscountDto": TradeDiscountDto,
5104
+ "UglDestinationVersion": UglDestinationVersion,
4891
5105
  "ValidationCheckResult": ValidationCheckResult,
4892
5106
  "ValidationCheckType": ValidationCheckType,
4893
5107
  "ValidationResult": ValidationResult,
@@ -5162,7 +5376,7 @@ export class AslvConversionApi {
5162
5376
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
5163
5377
  * @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.
5164
5378
  * @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.
5165
- * @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.
5379
+ * @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.
5166
5380
  * @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.
5167
5381
  * @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.
5168
5382
  * @param {*} [options] Override http request options.
@@ -5258,7 +5472,7 @@ export class AslvConversionApi {
5258
5472
  * @param destinationOenormType Defaults to Lv2015
5259
5473
  * @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
5260
5474
  * @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.
5261
- * @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.
5475
+ * @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.
5262
5476
  * @param {*} [options] Override http request options.
5263
5477
  */
5264
5478
  public aslvConversionConvertToOenorm (aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/aslv/oenorm';
@@ -5457,6 +5671,80 @@ export class AvaConversionApi {
5457
5671
  /**
5458
5672
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
5459
5673
  */
5674
+ public avaConversionConvertToDatanormWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, datanormDestinationVersion?: 'V4' | 'V5', options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
5675
+ return this.avaConversionConvertToDatanorm(avaProject, options.tryAutoGenerateItemNumbersAndSchema, options.datanormDestinationVersion, options.options || {});
5676
+ }
5677
+
5678
+ /**
5679
+ *
5680
+ * @summary Converts Dangl.AVA projects to Datanorm
5681
+ * @param avaProject The Dangl.AVA project
5682
+ * @param tryAutoGenerateItemNumbersAndSchema 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.
5683
+ * @param datanormDestinationVersion The Datanorm version to convert to. Defaults to V4.
5684
+ * @param {*} [options] Override http request options.
5685
+ */
5686
+ public avaConversionConvertToDatanorm (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, datanormDestinationVersion?: 'V4' | 'V5', options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/ava/datanorm';
5687
+ let localVarQueryParameters: any = {};
5688
+ let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
5689
+ let localVarFormParams: any = {};
5690
+
5691
+ // verify required parameter 'avaProject' is not null or undefined
5692
+ if (avaProject === null || avaProject === undefined) {
5693
+ throw new Error('Required parameter avaProject was null or undefined when calling avaConversionConvertToDatanorm.');
5694
+ }
5695
+
5696
+ if (tryAutoGenerateItemNumbersAndSchema !== undefined) {
5697
+ localVarQueryParameters['TryAutoGenerateItemNumbersAndSchema'] = ObjectSerializer.serialize(tryAutoGenerateItemNumbersAndSchema, "boolean");
5698
+ }
5699
+
5700
+ if (datanormDestinationVersion !== undefined) {
5701
+ localVarQueryParameters['DatanormDestinationVersion'] = ObjectSerializer.serialize(datanormDestinationVersion, "'V4' | 'V5'");
5702
+ }
5703
+
5704
+ (<any>Object).assign(localVarHeaderParams, options.headers);
5705
+
5706
+ let localVarUseFormData = false;
5707
+
5708
+ let localVarRequestOptions: localVarRequest.Options = {
5709
+ method: 'POST',
5710
+ qs: localVarQueryParameters,
5711
+ headers: localVarHeaderParams,
5712
+ uri: localVarPath,
5713
+ useQuerystring: this._useQuerystring,
5714
+ encoding: null,
5715
+ body: avaProject,
5716
+ json: true
5717
+ };
5718
+
5719
+ this.authentications['Dangl.Identity'].applyToRequest(localVarRequestOptions);
5720
+
5721
+ this.authentications.default.applyToRequest(localVarRequestOptions);
5722
+
5723
+ if (Object.keys(localVarFormParams).length) {
5724
+ if (localVarUseFormData) {
5725
+ (<any>localVarRequestOptions).formData = localVarFormParams;
5726
+ } else {
5727
+ localVarRequestOptions.form = localVarFormParams;
5728
+ }
5729
+ }
5730
+ return new Promise<{ response: http.IncomingMessage; body: Buffer; }>((resolve, reject) => {
5731
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
5732
+ if (error) {
5733
+ reject(error);
5734
+ } else {
5735
+ body = ObjectSerializer.deserialize(body, "Buffer");
5736
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
5737
+ resolve({ response: response, body: body });
5738
+ } else {
5739
+ reject({ response: response, body: body });
5740
+ }
5741
+ }
5742
+ });
5743
+ });
5744
+ }
5745
+ /**
5746
+ * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
5747
+ */
5460
5748
  public avaConversionConvertToExcelWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
5461
5749
  return this.avaConversionConvertToExcel(avaProject, options.tryAutoGenerateItemNumbersAndSchema, options.writePrices, options.writeLongTexts, options.conversionCulture, options.options || {});
5462
5750
  }
@@ -5554,7 +5842,7 @@ export class AvaConversionApi {
5554
5842
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
5555
5843
  * @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.
5556
5844
  * @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.
5557
- * @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.
5845
+ * @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.
5558
5846
  * @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.
5559
5847
  * @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.
5560
5848
  * @param {*} [options] Override http request options.
@@ -5657,7 +5945,7 @@ export class AvaConversionApi {
5657
5945
  * @param destinationOenormType Defaults to Lv2015
5658
5946
  * @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
5659
5947
  * @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.
5660
- * @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.
5948
+ * @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.
5661
5949
  * @param {*} [options] Override http request options.
5662
5950
  */
5663
5951
  public avaConversionConvertToOenorm (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/ava/oenorm';
@@ -5734,7 +6022,7 @@ export class AvaConversionApi {
5734
6022
  /**
5735
6023
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
5736
6024
  */
5737
- public avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32', options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6025
+ public avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33', options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
5738
6026
  return this.avaConversionConvertToReb(avaProject, options.tryAutoGenerateItemNumbersAndSchema, options.destinationRebType, options.options || {});
5739
6027
  }
5740
6028
 
@@ -5746,7 +6034,7 @@ export class AvaConversionApi {
5746
6034
  * @param destinationRebType Defaults to D11
5747
6035
  * @param {*} [options] Override http request options.
5748
6036
  */
5749
- public avaConversionConvertToReb (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32', options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/ava/reb';
6037
+ public avaConversionConvertToReb (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33', options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/ava/reb';
5750
6038
  let localVarQueryParameters: any = {};
5751
6039
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
5752
6040
  let localVarFormParams: any = {};
@@ -5761,7 +6049,7 @@ export class AvaConversionApi {
5761
6049
  }
5762
6050
 
5763
6051
  if (destinationRebType !== undefined) {
5764
- localVarQueryParameters['DestinationRebType'] = ObjectSerializer.serialize(destinationRebType, "'D11' | 'X31GaebXmlV32'");
6052
+ localVarQueryParameters['DestinationRebType'] = ObjectSerializer.serialize(destinationRebType, "'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33'");
5765
6053
  }
5766
6054
 
5767
6055
  (<any>Object).assign(localVarHeaderParams, options.headers);
@@ -5874,44 +6162,118 @@ export class AvaConversionApi {
5874
6162
  });
5875
6163
  });
5876
6164
  }
5877
- }
5878
- export enum DanglIdentityApiApiKeys {
5879
- }
6165
+ /**
6166
+ * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
6167
+ */
6168
+ public avaConversionConvertToUglWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, uglDestinationVersion?: 'V4' | 'V5', options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6169
+ return this.avaConversionConvertToUgl(avaProject, options.tryAutoGenerateItemNumbersAndSchema, options.uglDestinationVersion, options.options || {});
6170
+ }
5880
6171
 
5881
- export class DanglIdentityApi {
5882
- protected _basePath = defaultBasePath;
5883
- protected defaultHeaders : any = {};
5884
- protected _useQuerystring : boolean = false;
6172
+ /**
6173
+ *
6174
+ * @summary Converts Dangl.AVA projects to UGL
6175
+ * @param avaProject The Dangl.AVA project
6176
+ * @param tryAutoGenerateItemNumbersAndSchema 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.
6177
+ * @param uglDestinationVersion The UGL version to convert to. Defaults to V1.
6178
+ * @param {*} [options] Override http request options.
6179
+ */
6180
+ public avaConversionConvertToUgl (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, uglDestinationVersion?: 'V4' | 'V5', options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/ava/ugl';
6181
+ let localVarQueryParameters: any = {};
6182
+ let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
6183
+ let localVarFormParams: any = {};
5885
6184
 
5886
- protected authentications = {
5887
- 'default': <Authentication>new VoidAuth(),
5888
- 'Dangl.Identity': new OAuth(),
5889
- }
6185
+ // verify required parameter 'avaProject' is not null or undefined
6186
+ if (avaProject === null || avaProject === undefined) {
6187
+ throw new Error('Required parameter avaProject was null or undefined when calling avaConversionConvertToUgl.');
6188
+ }
5890
6189
 
5891
- constructor(basePath?: string);
5892
- constructor(basePathOrUsername: string, password?: string, basePath?: string) {
5893
- if (password) {
5894
- if (basePath) {
5895
- this.basePath = basePath;
5896
- }
5897
- } else {
5898
- if (basePathOrUsername) {
5899
- this.basePath = basePathOrUsername
5900
- }
6190
+ if (tryAutoGenerateItemNumbersAndSchema !== undefined) {
6191
+ localVarQueryParameters['TryAutoGenerateItemNumbersAndSchema'] = ObjectSerializer.serialize(tryAutoGenerateItemNumbersAndSchema, "boolean");
5901
6192
  }
5902
- }
5903
6193
 
5904
- set useQuerystring(value: boolean) {
5905
- this._useQuerystring = value;
5906
- }
6194
+ if (uglDestinationVersion !== undefined) {
6195
+ localVarQueryParameters['UglDestinationVersion'] = ObjectSerializer.serialize(uglDestinationVersion, "'V4' | 'V5'");
6196
+ }
5907
6197
 
5908
- set basePath(basePath: string) {
5909
- this._basePath = basePath;
5910
- }
6198
+ (<any>Object).assign(localVarHeaderParams, options.headers);
5911
6199
 
5912
- get basePath() {
5913
- return this._basePath;
5914
- }
6200
+ let localVarUseFormData = false;
6201
+
6202
+ let localVarRequestOptions: localVarRequest.Options = {
6203
+ method: 'POST',
6204
+ qs: localVarQueryParameters,
6205
+ headers: localVarHeaderParams,
6206
+ uri: localVarPath,
6207
+ useQuerystring: this._useQuerystring,
6208
+ encoding: null,
6209
+ body: avaProject,
6210
+ json: true
6211
+ };
6212
+
6213
+ this.authentications['Dangl.Identity'].applyToRequest(localVarRequestOptions);
6214
+
6215
+ this.authentications.default.applyToRequest(localVarRequestOptions);
6216
+
6217
+ if (Object.keys(localVarFormParams).length) {
6218
+ if (localVarUseFormData) {
6219
+ (<any>localVarRequestOptions).formData = localVarFormParams;
6220
+ } else {
6221
+ localVarRequestOptions.form = localVarFormParams;
6222
+ }
6223
+ }
6224
+ return new Promise<{ response: http.IncomingMessage; body: Buffer; }>((resolve, reject) => {
6225
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
6226
+ if (error) {
6227
+ reject(error);
6228
+ } else {
6229
+ body = ObjectSerializer.deserialize(body, "Buffer");
6230
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
6231
+ resolve({ response: response, body: body });
6232
+ } else {
6233
+ reject({ response: response, body: body });
6234
+ }
6235
+ }
6236
+ });
6237
+ });
6238
+ }
6239
+ }
6240
+ export enum DanglIdentityApiApiKeys {
6241
+ }
6242
+
6243
+ export class DanglIdentityApi {
6244
+ protected _basePath = defaultBasePath;
6245
+ protected defaultHeaders : any = {};
6246
+ protected _useQuerystring : boolean = false;
6247
+
6248
+ protected authentications = {
6249
+ 'default': <Authentication>new VoidAuth(),
6250
+ 'Dangl.Identity': new OAuth(),
6251
+ }
6252
+
6253
+ constructor(basePath?: string);
6254
+ constructor(basePathOrUsername: string, password?: string, basePath?: string) {
6255
+ if (password) {
6256
+ if (basePath) {
6257
+ this.basePath = basePath;
6258
+ }
6259
+ } else {
6260
+ if (basePathOrUsername) {
6261
+ this.basePath = basePathOrUsername
6262
+ }
6263
+ }
6264
+ }
6265
+
6266
+ set useQuerystring(value: boolean) {
6267
+ this._useQuerystring = value;
6268
+ }
6269
+
6270
+ set basePath(basePath: string) {
6271
+ this._basePath = basePath;
6272
+ }
6273
+
6274
+ get basePath() {
6275
+ return this._basePath;
6276
+ }
5915
6277
 
5916
6278
  public setDefaultAuthentication(auth: Authentication) {
5917
6279
  this.authentications.default = auth;
@@ -6261,6 +6623,128 @@ export class DanglIdentityApi {
6261
6623
  });
6262
6624
  }
6263
6625
  }
6626
+ export enum DatanormConversionApiApiKeys {
6627
+ }
6628
+
6629
+ export class DatanormConversionApi {
6630
+ protected _basePath = defaultBasePath;
6631
+ protected defaultHeaders : any = {};
6632
+ protected _useQuerystring : boolean = false;
6633
+
6634
+ protected authentications = {
6635
+ 'default': <Authentication>new VoidAuth(),
6636
+ 'Dangl.Identity': new OAuth(),
6637
+ }
6638
+
6639
+ constructor(basePath?: string);
6640
+ constructor(basePathOrUsername: string, password?: string, basePath?: string) {
6641
+ if (password) {
6642
+ if (basePath) {
6643
+ this.basePath = basePath;
6644
+ }
6645
+ } else {
6646
+ if (basePathOrUsername) {
6647
+ this.basePath = basePathOrUsername
6648
+ }
6649
+ }
6650
+ }
6651
+
6652
+ set useQuerystring(value: boolean) {
6653
+ this._useQuerystring = value;
6654
+ }
6655
+
6656
+ set basePath(basePath: string) {
6657
+ this._basePath = basePath;
6658
+ }
6659
+
6660
+ get basePath() {
6661
+ return this._basePath;
6662
+ }
6663
+
6664
+ public setDefaultAuthentication(auth: Authentication) {
6665
+ this.authentications.default = auth;
6666
+ }
6667
+
6668
+ public setApiKey(key: DatanormConversionApiApiKeys, value: string) {
6669
+ (this.authentications as any)[DatanormConversionApiApiKeys[key]].apiKey = value;
6670
+ }
6671
+
6672
+ set accessToken(token: string) {
6673
+ this.authentications['Dangl.Identity'].accessToken = token;
6674
+ }
6675
+ /**
6676
+ * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
6677
+ */
6678
+ public datanormConversionConvertToAvaWithRequestObject(datanormFile: FileParameter, options: { removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: ProjectDto; }> {
6679
+ return this.datanormConversionConvertToAva(datanormFile, options.removePlainTextLongTexts, options.removeHtmlLongTexts, options.options || {});
6680
+ }
6681
+
6682
+ /**
6683
+ *
6684
+ * @summary Converts Datanorm files to Dangl.AVA projects
6685
+ * @param datanormFile The input file
6686
+ * @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
6687
+ * @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
6688
+ * @param {*} [options] Override http request options.
6689
+ */
6690
+ public datanormConversionConvertToAva (datanormFile: FileParameter, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: ProjectDto; }> { const localVarPath = this.basePath + '/conversion/datanorm/ava';
6691
+ let localVarQueryParameters: any = {};
6692
+ let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
6693
+ let localVarFormParams: any = {};
6694
+
6695
+ if (removePlainTextLongTexts !== undefined) {
6696
+ localVarQueryParameters['RemovePlainTextLongTexts'] = ObjectSerializer.serialize(removePlainTextLongTexts, "boolean");
6697
+ }
6698
+
6699
+ if (removeHtmlLongTexts !== undefined) {
6700
+ localVarQueryParameters['RemoveHtmlLongTexts'] = ObjectSerializer.serialize(removeHtmlLongTexts, "boolean");
6701
+ }
6702
+
6703
+ (<any>Object).assign(localVarHeaderParams, options.headers);
6704
+
6705
+ let localVarUseFormData = false;
6706
+
6707
+ if (datanormFile !== undefined) {
6708
+ localVarFormParams['datanormFile'] = datanormFile;
6709
+ }
6710
+ localVarUseFormData = true;
6711
+
6712
+ let localVarRequestOptions: localVarRequest.Options = {
6713
+ method: 'POST',
6714
+ qs: localVarQueryParameters,
6715
+ headers: localVarHeaderParams,
6716
+ uri: localVarPath,
6717
+ useQuerystring: this._useQuerystring,
6718
+ json: true,
6719
+ };
6720
+
6721
+ this.authentications['Dangl.Identity'].applyToRequest(localVarRequestOptions);
6722
+
6723
+ this.authentications.default.applyToRequest(localVarRequestOptions);
6724
+
6725
+ if (Object.keys(localVarFormParams).length) {
6726
+ if (localVarUseFormData) {
6727
+ (<any>localVarRequestOptions).formData = localVarFormParams;
6728
+ } else {
6729
+ localVarRequestOptions.form = localVarFormParams;
6730
+ }
6731
+ }
6732
+ return new Promise<{ response: http.IncomingMessage; body: ProjectDto; }>((resolve, reject) => {
6733
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
6734
+ if (error) {
6735
+ reject(error);
6736
+ } else {
6737
+ body = ObjectSerializer.deserialize(body, "ProjectDto");
6738
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
6739
+ resolve({ response: response, body: body });
6740
+ } else {
6741
+ reject({ response: response, body: body });
6742
+ }
6743
+ }
6744
+ });
6745
+ });
6746
+ }
6747
+ }
6264
6748
  export enum ExcelConversionApiApiKeys {
6265
6749
  }
6266
6750
 
@@ -6496,7 +6980,7 @@ export class ExcelConversionApi {
6496
6980
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
6497
6981
  * @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.
6498
6982
  * @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.
6499
- * @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.
6983
+ * @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.
6500
6984
  * @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.
6501
6985
  * @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.
6502
6986
  * @param {*} [options] Override http request options.
@@ -6602,7 +7086,7 @@ export class ExcelConversionApi {
6602
7086
  * @param destinationOenormType Defaults to Lv2015
6603
7087
  * @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
6604
7088
  * @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.
6605
- * @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.
7089
+ * @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.
6606
7090
  * @param {*} [options] Override http request options.
6607
7091
  */
6608
7092
  public excelConversionConvertToOenorm (excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/excel/oenorm';
@@ -6731,20 +7215,23 @@ export class GaebConversionApi {
6731
7215
  /**
6732
7216
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
6733
7217
  */
6734
- public gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: ProjectDto; }> {
6735
- return this.gaebConversionConvertToAva(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.removePlainTextLongTexts, options.removeHtmlLongTexts, options.options || {});
7218
+ public gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: ProjectDto; }> {
7219
+ return this.gaebConversionConvertToAva(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.removePlainTextLongTexts, options.removeHtmlLongTexts, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.allowUpperCaseItemNumbers, options.options || {});
6736
7220
  }
6737
7221
 
6738
7222
  /**
6739
7223
  *
6740
7224
  * @summary Converts GAEB files to Dangl.AVA projects
6741
7225
  * @param gaebFile The input file
6742
- * @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.
7226
+ * @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.
6743
7227
  * @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
6744
7228
  * @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
7229
+ * @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;.
7230
+ * @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.
7231
+ * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
6745
7232
  * @param {*} [options] Override http request options.
6746
7233
  */
6747
- public gaebConversionConvertToAva (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: ProjectDto; }> { const localVarPath = this.basePath + '/conversion/gaeb/ava';
7234
+ public gaebConversionConvertToAva (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: ProjectDto; }> { const localVarPath = this.basePath + '/conversion/gaeb/ava';
6748
7235
  let localVarQueryParameters: any = {};
6749
7236
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
6750
7237
  let localVarFormParams: any = {};
@@ -6761,6 +7248,18 @@ export class GaebConversionApi {
6761
7248
  localVarQueryParameters['RemoveHtmlLongTexts'] = ObjectSerializer.serialize(removeHtmlLongTexts, "boolean");
6762
7249
  }
6763
7250
 
7251
+ if (outputHtmlAsXml !== undefined) {
7252
+ localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
7253
+ }
7254
+
7255
+ if (keepEmptyHtmlText !== undefined) {
7256
+ localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
7257
+ }
7258
+
7259
+ if (allowUpperCaseItemNumbers !== undefined) {
7260
+ localVarQueryParameters['AllowUpperCaseItemNumbers'] = ObjectSerializer.serialize(allowUpperCaseItemNumbers, "boolean");
7261
+ }
7262
+
6764
7263
  (<any>Object).assign(localVarHeaderParams, options.headers);
6765
7264
 
6766
7265
  let localVarUseFormData = false;
@@ -6808,21 +7307,24 @@ export class GaebConversionApi {
6808
7307
  /**
6809
7308
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
6810
7309
  */
6811
- public gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6812
- return this.gaebConversionConvertToExcel(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.writePrices, options.writeLongTexts, options.conversionCulture, options.options || {});
7310
+ public gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
7311
+ return this.gaebConversionConvertToExcel(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.writePrices, options.writeLongTexts, options.conversionCulture, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.allowUpperCaseItemNumbers, options.options || {});
6813
7312
  }
6814
7313
 
6815
7314
  /**
6816
7315
  *
6817
7316
  * @summary Converts GAEB files to Excel
6818
7317
  * @param gaebFile The input file
6819
- * @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.
7318
+ * @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.
6820
7319
  * @param writePrices Defaults to true
6821
7320
  * @param writeLongTexts Defaults to true
6822
7321
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
7322
+ * @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;.
7323
+ * @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.
7324
+ * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
6823
7325
  * @param {*} [options] Override http request options.
6824
7326
  */
6825
- public gaebConversionConvertToExcel (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/excel';
7327
+ public gaebConversionConvertToExcel (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/excel';
6826
7328
  let localVarQueryParameters: any = {};
6827
7329
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
6828
7330
  let localVarFormParams: any = {};
@@ -6843,6 +7345,18 @@ export class GaebConversionApi {
6843
7345
  localVarQueryParameters['ConversionCulture'] = ObjectSerializer.serialize(conversionCulture, "string");
6844
7346
  }
6845
7347
 
7348
+ if (outputHtmlAsXml !== undefined) {
7349
+ localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
7350
+ }
7351
+
7352
+ if (keepEmptyHtmlText !== undefined) {
7353
+ localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
7354
+ }
7355
+
7356
+ if (allowUpperCaseItemNumbers !== undefined) {
7357
+ localVarQueryParameters['AllowUpperCaseItemNumbers'] = ObjectSerializer.serialize(allowUpperCaseItemNumbers, "boolean");
7358
+ }
7359
+
6846
7360
  (<any>Object).assign(localVarHeaderParams, options.headers);
6847
7361
 
6848
7362
  let localVarUseFormData = false;
@@ -6890,25 +7404,28 @@ export class GaebConversionApi {
6890
7404
  /**
6891
7405
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
6892
7406
  */
6893
- public gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options: { 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<{ response: http.IncomingMessage; body: Buffer; }> {
6894
- return this.gaebConversionConvertToGaeb(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.destinationGaebType, options.targetExchangePhaseTransform, options.enforceStrictOfferPhaseLongTextOutput, options.exportQuantityDetermination, options.removeUnprintableCharactersFromTexts, options.forceIncludeDescriptions, options.treatNullItemNumberSchemaAsInvalid, options.options || {});
7407
+ public gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options: { 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, allowUpperCaseItemNumbers?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
7408
+ return this.gaebConversionConvertToGaeb(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.destinationGaebType, options.targetExchangePhaseTransform, options.enforceStrictOfferPhaseLongTextOutput, options.exportQuantityDetermination, options.removeUnprintableCharactersFromTexts, options.forceIncludeDescriptions, options.treatNullItemNumberSchemaAsInvalid, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.allowUpperCaseItemNumbers, options.options || {});
6895
7409
  }
6896
7410
 
6897
7411
  /**
6898
7412
  *
6899
7413
  * @summary Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
6900
7414
  * @param gaebFile The input file
6901
- * @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.
7415
+ * @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.
6902
7416
  * @param destinationGaebType Defaults to GAEB XML V3.2
6903
7417
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
6904
7418
  * @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.
6905
7419
  * @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.
6906
- * @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.
7420
+ * @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.
6907
7421
  * @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.
6908
7422
  * @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.
7423
+ * @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;.
7424
+ * @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.
7425
+ * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
6909
7426
  * @param {*} [options] Override http request options.
6910
7427
  */
6911
- public 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<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/gaeb';
7428
+ public 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, allowUpperCaseItemNumbers?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/gaeb';
6912
7429
  let localVarQueryParameters: any = {};
6913
7430
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
6914
7431
  let localVarFormParams: any = {};
@@ -6945,6 +7462,18 @@ export class GaebConversionApi {
6945
7462
  localVarQueryParameters['TreatNullItemNumberSchemaAsInvalid'] = ObjectSerializer.serialize(treatNullItemNumberSchemaAsInvalid, "boolean");
6946
7463
  }
6947
7464
 
7465
+ if (outputHtmlAsXml !== undefined) {
7466
+ localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
7467
+ }
7468
+
7469
+ if (keepEmptyHtmlText !== undefined) {
7470
+ localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
7471
+ }
7472
+
7473
+ if (allowUpperCaseItemNumbers !== undefined) {
7474
+ localVarQueryParameters['AllowUpperCaseItemNumbers'] = ObjectSerializer.serialize(allowUpperCaseItemNumbers, "boolean");
7475
+ }
7476
+
6948
7477
  (<any>Object).assign(localVarHeaderParams, options.headers);
6949
7478
 
6950
7479
  let localVarUseFormData = false;
@@ -6992,22 +7521,25 @@ export class GaebConversionApi {
6992
7521
  /**
6993
7522
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
6994
7523
  */
6995
- public gaebConversionConvertToOenormWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6996
- return this.gaebConversionConvertToOenorm(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.destinationOenormType, options.tryRepairProjectStructure, options.skipTryEnforceSchemaCompliantXmlOutput, options.removeUnprintableCharactersFromTexts, options.options || {});
7524
+ public gaebConversionConvertToOenormWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
7525
+ return this.gaebConversionConvertToOenorm(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.destinationOenormType, options.tryRepairProjectStructure, options.skipTryEnforceSchemaCompliantXmlOutput, options.removeUnprintableCharactersFromTexts, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.allowUpperCaseItemNumbers, options.options || {});
6997
7526
  }
6998
7527
 
6999
7528
  /**
7000
7529
  *
7001
7530
  * @summary Converts GAEB files to Oenorm files
7002
7531
  * @param gaebFile The input file
7003
- * @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.
7532
+ * @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.
7004
7533
  * @param destinationOenormType Defaults to Lv2015
7005
7534
  * @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
7006
7535
  * @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.
7007
- * @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.
7536
+ * @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.
7537
+ * @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;.
7538
+ * @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.
7539
+ * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
7008
7540
  * @param {*} [options] Override http request options.
7009
7541
  */
7010
- public gaebConversionConvertToOenorm (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/oenorm';
7542
+ public gaebConversionConvertToOenorm (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/oenorm';
7011
7543
  let localVarQueryParameters: any = {};
7012
7544
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
7013
7545
  let localVarFormParams: any = {};
@@ -7032,6 +7564,18 @@ export class GaebConversionApi {
7032
7564
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
7033
7565
  }
7034
7566
 
7567
+ if (outputHtmlAsXml !== undefined) {
7568
+ localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
7569
+ }
7570
+
7571
+ if (keepEmptyHtmlText !== undefined) {
7572
+ localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
7573
+ }
7574
+
7575
+ if (allowUpperCaseItemNumbers !== undefined) {
7576
+ localVarQueryParameters['AllowUpperCaseItemNumbers'] = ObjectSerializer.serialize(allowUpperCaseItemNumbers, "boolean");
7577
+ }
7578
+
7035
7579
  (<any>Object).assign(localVarHeaderParams, options.headers);
7036
7580
 
7037
7581
  let localVarUseFormData = false;
@@ -7290,7 +7834,7 @@ export class OenormConversionApi {
7290
7834
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
7291
7835
  * @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.
7292
7836
  * @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.
7293
- * @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.
7837
+ * @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.
7294
7838
  * @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.
7295
7839
  * @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.
7296
7840
  * @param {*} [options] Override http request options.
@@ -7386,7 +7930,7 @@ export class OenormConversionApi {
7386
7930
  * @param destinationOenormType Defaults to Lv2015
7387
7931
  * @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
7388
7932
  * @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.
7389
- * @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.
7933
+ * @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.
7390
7934
  * @param {*} [options] Override http request options.
7391
7935
  */
7392
7936
  public oenormConversionConvertToOenorm (oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/oenorm/oenorm';
@@ -7668,7 +8212,7 @@ export class RebConversionApi {
7668
8212
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
7669
8213
  * @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.
7670
8214
  * @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.
7671
- * @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.
8215
+ * @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.
7672
8216
  * @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.
7673
8217
  * @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.
7674
8218
  * @param {*} [options] Override http request options.
@@ -7764,7 +8308,7 @@ export class RebConversionApi {
7764
8308
  * @param destinationOenormType Defaults to Lv2015
7765
8309
  * @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
7766
8310
  * @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.
7767
- * @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.
8311
+ * @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.
7768
8312
  * @param {*} [options] Override http request options.
7769
8313
  */
7770
8314
  public rebConversionConvertToOenorm (rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/reb/oenorm';
@@ -8046,7 +8590,7 @@ export class SiaConversionApi {
8046
8590
  * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
8047
8591
  * @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.
8048
8592
  * @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.
8049
- * @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.
8593
+ * @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.
8050
8594
  * @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.
8051
8595
  * @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.
8052
8596
  * @param {*} [options] Override http request options.
@@ -8142,7 +8686,7 @@ export class SiaConversionApi {
8142
8686
  * @param destinationOenormType Defaults to Lv2015
8143
8687
  * @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
8144
8688
  * @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.
8145
- * @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.
8689
+ * @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.
8146
8690
  * @param {*} [options] Override http request options.
8147
8691
  */
8148
8692
  public siaConversionConvertToOenorm (siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/sia/oenorm';
@@ -8311,6 +8855,128 @@ export class StatusApi {
8311
8855
  });
8312
8856
  }
8313
8857
  }
8858
+ export enum UglConversionApiApiKeys {
8859
+ }
8860
+
8861
+ export class UglConversionApi {
8862
+ protected _basePath = defaultBasePath;
8863
+ protected defaultHeaders : any = {};
8864
+ protected _useQuerystring : boolean = false;
8865
+
8866
+ protected authentications = {
8867
+ 'default': <Authentication>new VoidAuth(),
8868
+ 'Dangl.Identity': new OAuth(),
8869
+ }
8870
+
8871
+ constructor(basePath?: string);
8872
+ constructor(basePathOrUsername: string, password?: string, basePath?: string) {
8873
+ if (password) {
8874
+ if (basePath) {
8875
+ this.basePath = basePath;
8876
+ }
8877
+ } else {
8878
+ if (basePathOrUsername) {
8879
+ this.basePath = basePathOrUsername
8880
+ }
8881
+ }
8882
+ }
8883
+
8884
+ set useQuerystring(value: boolean) {
8885
+ this._useQuerystring = value;
8886
+ }
8887
+
8888
+ set basePath(basePath: string) {
8889
+ this._basePath = basePath;
8890
+ }
8891
+
8892
+ get basePath() {
8893
+ return this._basePath;
8894
+ }
8895
+
8896
+ public setDefaultAuthentication(auth: Authentication) {
8897
+ this.authentications.default = auth;
8898
+ }
8899
+
8900
+ public setApiKey(key: UglConversionApiApiKeys, value: string) {
8901
+ (this.authentications as any)[UglConversionApiApiKeys[key]].apiKey = value;
8902
+ }
8903
+
8904
+ set accessToken(token: string) {
8905
+ this.authentications['Dangl.Identity'].accessToken = token;
8906
+ }
8907
+ /**
8908
+ * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
8909
+ */
8910
+ public uglConversionConvertToAvaWithRequestObject(uglFile: FileParameter, options: { removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: ProjectDto; }> {
8911
+ return this.uglConversionConvertToAva(uglFile, options.removePlainTextLongTexts, options.removeHtmlLongTexts, options.options || {});
8912
+ }
8913
+
8914
+ /**
8915
+ *
8916
+ * @summary Converts Ugl files to Dangl.AVA projects
8917
+ * @param uglFile The input file
8918
+ * @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
8919
+ * @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
8920
+ * @param {*} [options] Override http request options.
8921
+ */
8922
+ public uglConversionConvertToAva (uglFile: FileParameter, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: ProjectDto; }> { const localVarPath = this.basePath + '/conversion/ugl/ava';
8923
+ let localVarQueryParameters: any = {};
8924
+ let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
8925
+ let localVarFormParams: any = {};
8926
+
8927
+ if (removePlainTextLongTexts !== undefined) {
8928
+ localVarQueryParameters['RemovePlainTextLongTexts'] = ObjectSerializer.serialize(removePlainTextLongTexts, "boolean");
8929
+ }
8930
+
8931
+ if (removeHtmlLongTexts !== undefined) {
8932
+ localVarQueryParameters['RemoveHtmlLongTexts'] = ObjectSerializer.serialize(removeHtmlLongTexts, "boolean");
8933
+ }
8934
+
8935
+ (<any>Object).assign(localVarHeaderParams, options.headers);
8936
+
8937
+ let localVarUseFormData = false;
8938
+
8939
+ if (uglFile !== undefined) {
8940
+ localVarFormParams['uglFile'] = uglFile;
8941
+ }
8942
+ localVarUseFormData = true;
8943
+
8944
+ let localVarRequestOptions: localVarRequest.Options = {
8945
+ method: 'POST',
8946
+ qs: localVarQueryParameters,
8947
+ headers: localVarHeaderParams,
8948
+ uri: localVarPath,
8949
+ useQuerystring: this._useQuerystring,
8950
+ json: true,
8951
+ };
8952
+
8953
+ this.authentications['Dangl.Identity'].applyToRequest(localVarRequestOptions);
8954
+
8955
+ this.authentications.default.applyToRequest(localVarRequestOptions);
8956
+
8957
+ if (Object.keys(localVarFormParams).length) {
8958
+ if (localVarUseFormData) {
8959
+ (<any>localVarRequestOptions).formData = localVarFormParams;
8960
+ } else {
8961
+ localVarRequestOptions.form = localVarFormParams;
8962
+ }
8963
+ }
8964
+ return new Promise<{ response: http.IncomingMessage; body: ProjectDto; }>((resolve, reject) => {
8965
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
8966
+ if (error) {
8967
+ reject(error);
8968
+ } else {
8969
+ body = ObjectSerializer.deserialize(body, "ProjectDto");
8970
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
8971
+ resolve({ response: response, body: body });
8972
+ } else {
8973
+ reject({ response: response, body: body });
8974
+ }
8975
+ }
8976
+ });
8977
+ });
8978
+ }
8979
+ }
8314
8980
  export enum ValidationApiApiKeys {
8315
8981
  }
8316
8982