@dangl/avacloud-client-node 1.21.1 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.swagger-codegen/VERSION +1 -1
- package/api.d.ts +140 -28
- package/api.js +161 -32
- package/api.js.map +1 -1
- package/api.ts +232 -37
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AVACloud API 1.
|
|
2
|
+
* AVACloud API 1.40.0
|
|
3
3
|
* AVACloud API specification
|
|
4
4
|
*
|
|
5
|
-
* OpenAPI spec version: 1.
|
|
5
|
+
* OpenAPI spec version: 1.40.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by the swagger code generator program.
|
|
@@ -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() {
|
|
@@ -1067,6 +1076,36 @@ export class GrossPriceComponentDto {
|
|
|
1067
1076
|
}
|
|
1068
1077
|
}
|
|
1069
1078
|
|
|
1079
|
+
/**
|
|
1080
|
+
* Duration used in retention positions
|
|
1081
|
+
*/
|
|
1082
|
+
export class HoldOutDurationUnitDto {
|
|
1083
|
+
|
|
1084
|
+
static discriminator: string | undefined = undefined;
|
|
1085
|
+
|
|
1086
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
1087
|
+
];
|
|
1088
|
+
|
|
1089
|
+
static getAttributeTypeMap() {
|
|
1090
|
+
return HoldOutDurationUnitDto.attributeTypeMap;
|
|
1091
|
+
}
|
|
1092
|
+
}
|
|
1093
|
+
|
|
1094
|
+
/**
|
|
1095
|
+
* Types of retentions to be used in positions
|
|
1096
|
+
*/
|
|
1097
|
+
export class HoldOutTypeDto {
|
|
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 HoldOutTypeDto.attributeTypeMap;
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
|
|
1070
1109
|
/**
|
|
1071
1110
|
*
|
|
1072
1111
|
*/
|
|
@@ -2150,6 +2189,10 @@ export class PositionDto extends IElementDto {
|
|
|
2150
2189
|
* 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
2190
|
*/
|
|
2152
2191
|
'gaebComplementingType': PositionComplementingTypeDto;
|
|
2192
|
+
/**
|
|
2193
|
+
* HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site.
|
|
2194
|
+
*/
|
|
2195
|
+
'holdOutProperties'?: PositionHoldOutPropertiesDto;
|
|
2153
2196
|
|
|
2154
2197
|
static discriminator: string | undefined = undefined;
|
|
2155
2198
|
|
|
@@ -2413,6 +2456,11 @@ export class PositionDto extends IElementDto {
|
|
|
2413
2456
|
"name": "gaebComplementingType",
|
|
2414
2457
|
"baseName": "gaebComplementingType",
|
|
2415
2458
|
"type": "PositionComplementingTypeDto"
|
|
2459
|
+
},
|
|
2460
|
+
{
|
|
2461
|
+
"name": "holdOutProperties",
|
|
2462
|
+
"baseName": "holdOutProperties",
|
|
2463
|
+
"type": "PositionHoldOutPropertiesDto"
|
|
2416
2464
|
} ];
|
|
2417
2465
|
|
|
2418
2466
|
static getAttributeTypeMap() {
|
|
@@ -2420,6 +2468,65 @@ export class PositionDto extends IElementDto {
|
|
|
2420
2468
|
}
|
|
2421
2469
|
}
|
|
2422
2470
|
|
|
2471
|
+
/**
|
|
2472
|
+
* 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
|
|
2473
|
+
*/
|
|
2474
|
+
export class PositionHoldOutPropertiesDto {
|
|
2475
|
+
/**
|
|
2476
|
+
* Elements GUID identifier.
|
|
2477
|
+
*/
|
|
2478
|
+
'id': string;
|
|
2479
|
+
/**
|
|
2480
|
+
* The actual type
|
|
2481
|
+
*/
|
|
2482
|
+
'holdOutType': HoldOutTypeDto;
|
|
2483
|
+
/**
|
|
2484
|
+
* The duration of the period
|
|
2485
|
+
*/
|
|
2486
|
+
'holdOutDuration': number;
|
|
2487
|
+
/**
|
|
2488
|
+
* The time unit of the period
|
|
2489
|
+
*/
|
|
2490
|
+
'holdOutDurationUnit': HoldOutDurationUnitDto;
|
|
2491
|
+
/**
|
|
2492
|
+
* References to base positions
|
|
2493
|
+
*/
|
|
2494
|
+
'basePositionReferences'?: Array<string>;
|
|
2495
|
+
|
|
2496
|
+
static discriminator: string | undefined = undefined;
|
|
2497
|
+
|
|
2498
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
2499
|
+
{
|
|
2500
|
+
"name": "id",
|
|
2501
|
+
"baseName": "id",
|
|
2502
|
+
"type": "string"
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"name": "holdOutType",
|
|
2506
|
+
"baseName": "holdOutType",
|
|
2507
|
+
"type": "HoldOutTypeDto"
|
|
2508
|
+
},
|
|
2509
|
+
{
|
|
2510
|
+
"name": "holdOutDuration",
|
|
2511
|
+
"baseName": "holdOutDuration",
|
|
2512
|
+
"type": "number"
|
|
2513
|
+
},
|
|
2514
|
+
{
|
|
2515
|
+
"name": "holdOutDurationUnit",
|
|
2516
|
+
"baseName": "holdOutDurationUnit",
|
|
2517
|
+
"type": "HoldOutDurationUnitDto"
|
|
2518
|
+
},
|
|
2519
|
+
{
|
|
2520
|
+
"name": "basePositionReferences",
|
|
2521
|
+
"baseName": "basePositionReferences",
|
|
2522
|
+
"type": "Array<string>"
|
|
2523
|
+
} ];
|
|
2524
|
+
|
|
2525
|
+
static getAttributeTypeMap() {
|
|
2526
|
+
return PositionHoldOutPropertiesDto.attributeTypeMap;
|
|
2527
|
+
}
|
|
2528
|
+
}
|
|
2529
|
+
|
|
2423
2530
|
/**
|
|
2424
2531
|
* This is a classification for Position elements.
|
|
2425
2532
|
*/
|
|
@@ -2556,7 +2663,7 @@ export class PostGaebDestinationOptions {
|
|
|
2556
2663
|
*/
|
|
2557
2664
|
'exportQuantityDetermination': boolean;
|
|
2558
2665
|
/**
|
|
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.
|
|
2666
|
+
* 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
2667
|
*/
|
|
2561
2668
|
'removeUnprintableCharactersFromTexts': boolean;
|
|
2562
2669
|
/**
|
|
@@ -2629,7 +2736,7 @@ export class PostOenormDestinationOptions {
|
|
|
2629
2736
|
*/
|
|
2630
2737
|
'skipTryEnforceSchemaCompliantXmlOutput': boolean;
|
|
2631
2738
|
/**
|
|
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.
|
|
2739
|
+
* 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
2740
|
*/
|
|
2634
2741
|
'removeUnprintableCharactersFromTexts': boolean;
|
|
2635
2742
|
|
|
@@ -3034,6 +3141,14 @@ export class ProjectInformationDto {
|
|
|
3034
3141
|
* 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
3142
|
*/
|
|
3036
3143
|
'specialAwardKind': SpecialAwardKindDto;
|
|
3144
|
+
/**
|
|
3145
|
+
* Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners.
|
|
3146
|
+
*/
|
|
3147
|
+
'requesters'?: Array<PartyInformationDto>;
|
|
3148
|
+
/**
|
|
3149
|
+
* Notification sites are addresses that are used for delivering messages in the context of construction projects.
|
|
3150
|
+
*/
|
|
3151
|
+
'notificationSites'?: Array<PartyInformationDto>;
|
|
3037
3152
|
|
|
3038
3153
|
static discriminator: string | undefined = undefined;
|
|
3039
3154
|
|
|
@@ -3112,6 +3227,16 @@ export class ProjectInformationDto {
|
|
|
3112
3227
|
"name": "specialAwardKind",
|
|
3113
3228
|
"baseName": "specialAwardKind",
|
|
3114
3229
|
"type": "SpecialAwardKindDto"
|
|
3230
|
+
},
|
|
3231
|
+
{
|
|
3232
|
+
"name": "requesters",
|
|
3233
|
+
"baseName": "requesters",
|
|
3234
|
+
"type": "Array<PartyInformationDto>"
|
|
3235
|
+
},
|
|
3236
|
+
{
|
|
3237
|
+
"name": "notificationSites",
|
|
3238
|
+
"baseName": "notificationSites",
|
|
3239
|
+
"type": "Array<PartyInformationDto>"
|
|
3115
3240
|
} ];
|
|
3116
3241
|
|
|
3117
3242
|
static getAttributeTypeMap() {
|
|
@@ -3598,6 +3723,18 @@ export class ServiceSpecificationDto {
|
|
|
3598
3723
|
*/
|
|
3599
3724
|
'decisionDate'?: Date;
|
|
3600
3725
|
/**
|
|
3726
|
+
* Date of when the offer / bid was created
|
|
3727
|
+
*/
|
|
3728
|
+
'bidDate'?: Date;
|
|
3729
|
+
/**
|
|
3730
|
+
* 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.
|
|
3731
|
+
*/
|
|
3732
|
+
'warrantyBondPercentage': number;
|
|
3733
|
+
/**
|
|
3734
|
+
* 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.
|
|
3735
|
+
*/
|
|
3736
|
+
'executionGuaranteePercentage': number;
|
|
3737
|
+
/**
|
|
3601
3738
|
* String indicating where the physical submission of the offer is taking place.
|
|
3602
3739
|
*/
|
|
3603
3740
|
'submissionLocation'?: string;
|
|
@@ -3819,6 +3956,21 @@ export class ServiceSpecificationDto {
|
|
|
3819
3956
|
"baseName": "decisionDate",
|
|
3820
3957
|
"type": "Date"
|
|
3821
3958
|
},
|
|
3959
|
+
{
|
|
3960
|
+
"name": "bidDate",
|
|
3961
|
+
"baseName": "bidDate",
|
|
3962
|
+
"type": "Date"
|
|
3963
|
+
},
|
|
3964
|
+
{
|
|
3965
|
+
"name": "warrantyBondPercentage",
|
|
3966
|
+
"baseName": "warrantyBondPercentage",
|
|
3967
|
+
"type": "number"
|
|
3968
|
+
},
|
|
3969
|
+
{
|
|
3970
|
+
"name": "executionGuaranteePercentage",
|
|
3971
|
+
"baseName": "executionGuaranteePercentage",
|
|
3972
|
+
"type": "number"
|
|
3973
|
+
},
|
|
3822
3974
|
{
|
|
3823
3975
|
"name": "submissionLocation",
|
|
3824
3976
|
"baseName": "submissionLocation",
|
|
@@ -4838,6 +4990,8 @@ let typeMap: {[index: string]: any} = {
|
|
|
4838
4990
|
"ForgotPasswordPost": ForgotPasswordPost,
|
|
4839
4991
|
"GetStatus": GetStatus,
|
|
4840
4992
|
"GrossPriceComponentDto": GrossPriceComponentDto,
|
|
4993
|
+
"HoldOutDurationUnitDto": HoldOutDurationUnitDto,
|
|
4994
|
+
"HoldOutTypeDto": HoldOutTypeDto,
|
|
4841
4995
|
"HttpStatusCode": HttpStatusCode,
|
|
4842
4996
|
"IElementDto": IElementDto,
|
|
4843
4997
|
"ItemNumberDto": ItemNumberDto,
|
|
@@ -4857,6 +5011,7 @@ let typeMap: {[index: string]: any} = {
|
|
|
4857
5011
|
"PartyInformationDto": PartyInformationDto,
|
|
4858
5012
|
"PositionComplementingTypeDto": PositionComplementingTypeDto,
|
|
4859
5013
|
"PositionDto": PositionDto,
|
|
5014
|
+
"PositionHoldOutPropertiesDto": PositionHoldOutPropertiesDto,
|
|
4860
5015
|
"PositionTypeDto": PositionTypeDto,
|
|
4861
5016
|
"PostAvaProjectValidationSourceOptions": PostAvaProjectValidationSourceOptions,
|
|
4862
5017
|
"PostAvaSourceOptions": PostAvaSourceOptions,
|
|
@@ -5162,7 +5317,7 @@ export class AslvConversionApi {
|
|
|
5162
5317
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
5163
5318
|
* @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
5319
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
5320
|
+
* @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
5321
|
* @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
5322
|
* @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
5323
|
* @param {*} [options] Override http request options.
|
|
@@ -5258,7 +5413,7 @@ export class AslvConversionApi {
|
|
|
5258
5413
|
* @param destinationOenormType Defaults to Lv2015
|
|
5259
5414
|
* @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
5415
|
* @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.
|
|
5416
|
+
* @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
5417
|
* @param {*} [options] Override http request options.
|
|
5263
5418
|
*/
|
|
5264
5419
|
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';
|
|
@@ -5554,7 +5709,7 @@ export class AvaConversionApi {
|
|
|
5554
5709
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
5555
5710
|
* @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
5711
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
5712
|
+
* @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
5713
|
* @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
5714
|
* @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
5715
|
* @param {*} [options] Override http request options.
|
|
@@ -5657,7 +5812,7 @@ export class AvaConversionApi {
|
|
|
5657
5812
|
* @param destinationOenormType Defaults to Lv2015
|
|
5658
5813
|
* @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
5814
|
* @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.
|
|
5815
|
+
* @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
5816
|
* @param {*} [options] Override http request options.
|
|
5662
5817
|
*/
|
|
5663
5818
|
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 +5889,7 @@ export class AvaConversionApi {
|
|
|
5734
5889
|
/**
|
|
5735
5890
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
5736
5891
|
*/
|
|
5737
|
-
public avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32', options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
|
|
5892
|
+
public avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: { tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33', options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
|
|
5738
5893
|
return this.avaConversionConvertToReb(avaProject, options.tryAutoGenerateItemNumbersAndSchema, options.destinationRebType, options.options || {});
|
|
5739
5894
|
}
|
|
5740
5895
|
|
|
@@ -5746,7 +5901,7 @@ export class AvaConversionApi {
|
|
|
5746
5901
|
* @param destinationRebType Defaults to D11
|
|
5747
5902
|
* @param {*} [options] Override http request options.
|
|
5748
5903
|
*/
|
|
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';
|
|
5904
|
+
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
5905
|
let localVarQueryParameters: any = {};
|
|
5751
5906
|
let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
|
|
5752
5907
|
let localVarFormParams: any = {};
|
|
@@ -5761,7 +5916,7 @@ export class AvaConversionApi {
|
|
|
5761
5916
|
}
|
|
5762
5917
|
|
|
5763
5918
|
if (destinationRebType !== undefined) {
|
|
5764
|
-
localVarQueryParameters['DestinationRebType'] = ObjectSerializer.serialize(destinationRebType, "'D11' | 'X31GaebXmlV32'");
|
|
5919
|
+
localVarQueryParameters['DestinationRebType'] = ObjectSerializer.serialize(destinationRebType, "'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33'");
|
|
5765
5920
|
}
|
|
5766
5921
|
|
|
5767
5922
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
@@ -6496,7 +6651,7 @@ export class ExcelConversionApi {
|
|
|
6496
6651
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
6497
6652
|
* @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
6653
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
6654
|
+
* @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
6655
|
* @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
6656
|
* @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
6657
|
* @param {*} [options] Override http request options.
|
|
@@ -6602,7 +6757,7 @@ export class ExcelConversionApi {
|
|
|
6602
6757
|
* @param destinationOenormType Defaults to Lv2015
|
|
6603
6758
|
* @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
6759
|
* @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.
|
|
6760
|
+
* @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
6761
|
* @param {*} [options] Override http request options.
|
|
6607
6762
|
*/
|
|
6608
6763
|
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 +6886,22 @@ export class GaebConversionApi {
|
|
|
6731
6886
|
/**
|
|
6732
6887
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
6733
6888
|
*/
|
|
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 || {});
|
|
6889
|
+
public gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: ProjectDto; }> {
|
|
6890
|
+
return this.gaebConversionConvertToAva(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.removePlainTextLongTexts, options.removeHtmlLongTexts, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.options || {});
|
|
6736
6891
|
}
|
|
6737
6892
|
|
|
6738
6893
|
/**
|
|
6739
6894
|
*
|
|
6740
6895
|
* @summary Converts GAEB files to Dangl.AVA projects
|
|
6741
6896
|
* @param gaebFile The input file
|
|
6742
|
-
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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
|
|
6897
|
+
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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 '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
6743
6898
|
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
6744
6899
|
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
6900
|
+
* @param outputHtmlAsXml Defaults to 'false'. 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 '<br />' instead of '<br>'.
|
|
6901
|
+
* @param keepEmptyHtmlText Defaults to 'false'. 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.
|
|
6745
6902
|
* @param {*} [options] Override http request options.
|
|
6746
6903
|
*/
|
|
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';
|
|
6904
|
+
public gaebConversionConvertToAva (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: ProjectDto; }> { const localVarPath = this.basePath + '/conversion/gaeb/ava';
|
|
6748
6905
|
let localVarQueryParameters: any = {};
|
|
6749
6906
|
let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
|
|
6750
6907
|
let localVarFormParams: any = {};
|
|
@@ -6761,6 +6918,14 @@ export class GaebConversionApi {
|
|
|
6761
6918
|
localVarQueryParameters['RemoveHtmlLongTexts'] = ObjectSerializer.serialize(removeHtmlLongTexts, "boolean");
|
|
6762
6919
|
}
|
|
6763
6920
|
|
|
6921
|
+
if (outputHtmlAsXml !== undefined) {
|
|
6922
|
+
localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
|
|
6923
|
+
}
|
|
6924
|
+
|
|
6925
|
+
if (keepEmptyHtmlText !== undefined) {
|
|
6926
|
+
localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
|
|
6927
|
+
}
|
|
6928
|
+
|
|
6764
6929
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
6765
6930
|
|
|
6766
6931
|
let localVarUseFormData = false;
|
|
@@ -6808,21 +6973,23 @@ export class GaebConversionApi {
|
|
|
6808
6973
|
/**
|
|
6809
6974
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
6810
6975
|
*/
|
|
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 || {});
|
|
6976
|
+
public gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options: { supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
|
|
6977
|
+
return this.gaebConversionConvertToExcel(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.writePrices, options.writeLongTexts, options.conversionCulture, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.options || {});
|
|
6813
6978
|
}
|
|
6814
6979
|
|
|
6815
6980
|
/**
|
|
6816
6981
|
*
|
|
6817
6982
|
* @summary Converts GAEB files to Excel
|
|
6818
6983
|
* @param gaebFile The input file
|
|
6819
|
-
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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
|
|
6984
|
+
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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 '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
6820
6985
|
* @param writePrices Defaults to true
|
|
6821
6986
|
* @param writeLongTexts Defaults to true
|
|
6822
6987
|
* @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
|
|
6988
|
+
* @param outputHtmlAsXml Defaults to 'false'. 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 '<br />' instead of '<br>'.
|
|
6989
|
+
* @param keepEmptyHtmlText Defaults to 'false'. 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.
|
|
6823
6990
|
* @param {*} [options] Override http request options.
|
|
6824
6991
|
*/
|
|
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';
|
|
6992
|
+
public gaebConversionConvertToExcel (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/excel';
|
|
6826
6993
|
let localVarQueryParameters: any = {};
|
|
6827
6994
|
let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
|
|
6828
6995
|
let localVarFormParams: any = {};
|
|
@@ -6843,6 +7010,14 @@ export class GaebConversionApi {
|
|
|
6843
7010
|
localVarQueryParameters['ConversionCulture'] = ObjectSerializer.serialize(conversionCulture, "string");
|
|
6844
7011
|
}
|
|
6845
7012
|
|
|
7013
|
+
if (outputHtmlAsXml !== undefined) {
|
|
7014
|
+
localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
|
|
7015
|
+
}
|
|
7016
|
+
|
|
7017
|
+
if (keepEmptyHtmlText !== undefined) {
|
|
7018
|
+
localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
|
|
7019
|
+
}
|
|
7020
|
+
|
|
6846
7021
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
6847
7022
|
|
|
6848
7023
|
let localVarUseFormData = false;
|
|
@@ -6890,25 +7065,27 @@ export class GaebConversionApi {
|
|
|
6890
7065
|
/**
|
|
6891
7066
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
6892
7067
|
*/
|
|
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 || {});
|
|
7068
|
+
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, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
|
|
7069
|
+
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.options || {});
|
|
6895
7070
|
}
|
|
6896
7071
|
|
|
6897
7072
|
/**
|
|
6898
7073
|
*
|
|
6899
7074
|
* @summary Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
|
|
6900
7075
|
* @param gaebFile The input file
|
|
6901
|
-
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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
|
|
7076
|
+
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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 '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
6902
7077
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
6903
7078
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
6904
7079
|
* @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
7080
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
7081
|
+
* @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
7082
|
* @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
7083
|
* @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.
|
|
7084
|
+
* @param outputHtmlAsXml Defaults to 'false'. 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 '<br />' instead of '<br>'.
|
|
7085
|
+
* @param keepEmptyHtmlText Defaults to 'false'. 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.
|
|
6909
7086
|
* @param {*} [options] Override http request options.
|
|
6910
7087
|
*/
|
|
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';
|
|
7088
|
+
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, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/gaeb';
|
|
6912
7089
|
let localVarQueryParameters: any = {};
|
|
6913
7090
|
let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
|
|
6914
7091
|
let localVarFormParams: any = {};
|
|
@@ -6945,6 +7122,14 @@ export class GaebConversionApi {
|
|
|
6945
7122
|
localVarQueryParameters['TreatNullItemNumberSchemaAsInvalid'] = ObjectSerializer.serialize(treatNullItemNumberSchemaAsInvalid, "boolean");
|
|
6946
7123
|
}
|
|
6947
7124
|
|
|
7125
|
+
if (outputHtmlAsXml !== undefined) {
|
|
7126
|
+
localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
|
|
7127
|
+
}
|
|
7128
|
+
|
|
7129
|
+
if (keepEmptyHtmlText !== undefined) {
|
|
7130
|
+
localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
|
|
7131
|
+
}
|
|
7132
|
+
|
|
6948
7133
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
6949
7134
|
|
|
6950
7135
|
let localVarUseFormData = false;
|
|
@@ -6992,22 +7177,24 @@ export class GaebConversionApi {
|
|
|
6992
7177
|
/**
|
|
6993
7178
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
6994
7179
|
*/
|
|
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 || {});
|
|
7180
|
+
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, options?: any }): Promise<{ response: http.IncomingMessage; body: Buffer; }> {
|
|
7181
|
+
return this.gaebConversionConvertToOenorm(gaebFile, options.supportSkippedItemNumberLevelsInPositions, options.destinationOenormType, options.tryRepairProjectStructure, options.skipTryEnforceSchemaCompliantXmlOutput, options.removeUnprintableCharactersFromTexts, options.outputHtmlAsXml, options.keepEmptyHtmlText, options.options || {});
|
|
6997
7182
|
}
|
|
6998
7183
|
|
|
6999
7184
|
/**
|
|
7000
7185
|
*
|
|
7001
7186
|
* @summary Converts GAEB files to Oenorm files
|
|
7002
7187
|
* @param gaebFile The input file
|
|
7003
|
-
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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
|
|
7188
|
+
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. 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 '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
7004
7189
|
* @param destinationOenormType Defaults to Lv2015
|
|
7005
7190
|
* @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
7191
|
* @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.
|
|
7192
|
+
* @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.
|
|
7193
|
+
* @param outputHtmlAsXml Defaults to 'false'. 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 '<br />' instead of '<br>'.
|
|
7194
|
+
* @param keepEmptyHtmlText Defaults to 'false'. 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.
|
|
7008
7195
|
* @param {*} [options] Override http request options.
|
|
7009
7196
|
*/
|
|
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';
|
|
7197
|
+
public gaebConversionConvertToOenorm (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> { const localVarPath = this.basePath + '/conversion/gaeb/oenorm';
|
|
7011
7198
|
let localVarQueryParameters: any = {};
|
|
7012
7199
|
let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
|
|
7013
7200
|
let localVarFormParams: any = {};
|
|
@@ -7032,6 +7219,14 @@ export class GaebConversionApi {
|
|
|
7032
7219
|
localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
|
|
7033
7220
|
}
|
|
7034
7221
|
|
|
7222
|
+
if (outputHtmlAsXml !== undefined) {
|
|
7223
|
+
localVarQueryParameters['OutputHtmlAsXml'] = ObjectSerializer.serialize(outputHtmlAsXml, "boolean");
|
|
7224
|
+
}
|
|
7225
|
+
|
|
7226
|
+
if (keepEmptyHtmlText !== undefined) {
|
|
7227
|
+
localVarQueryParameters['KeepEmptyHtmlText'] = ObjectSerializer.serialize(keepEmptyHtmlText, "boolean");
|
|
7228
|
+
}
|
|
7229
|
+
|
|
7035
7230
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
7036
7231
|
|
|
7037
7232
|
let localVarUseFormData = false;
|
|
@@ -7290,7 +7485,7 @@ export class OenormConversionApi {
|
|
|
7290
7485
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
7291
7486
|
* @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
7487
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
7488
|
+
* @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
7489
|
* @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
7490
|
* @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
7491
|
* @param {*} [options] Override http request options.
|
|
@@ -7386,7 +7581,7 @@ export class OenormConversionApi {
|
|
|
7386
7581
|
* @param destinationOenormType Defaults to Lv2015
|
|
7387
7582
|
* @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
7583
|
* @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.
|
|
7584
|
+
* @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
7585
|
* @param {*} [options] Override http request options.
|
|
7391
7586
|
*/
|
|
7392
7587
|
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 +7863,7 @@ export class RebConversionApi {
|
|
|
7668
7863
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
7669
7864
|
* @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
7865
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
7866
|
+
* @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
7867
|
* @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
7868
|
* @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
7869
|
* @param {*} [options] Override http request options.
|
|
@@ -7764,7 +7959,7 @@ export class RebConversionApi {
|
|
|
7764
7959
|
* @param destinationOenormType Defaults to Lv2015
|
|
7765
7960
|
* @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
7961
|
* @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.
|
|
7962
|
+
* @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
7963
|
* @param {*} [options] Override http request options.
|
|
7769
7964
|
*/
|
|
7770
7965
|
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 +8241,7 @@ export class SiaConversionApi {
|
|
|
8046
8241
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
8047
8242
|
* @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
8243
|
* @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
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.
|
|
8244
|
+
* @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
8245
|
* @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
8246
|
* @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
8247
|
* @param {*} [options] Override http request options.
|
|
@@ -8142,7 +8337,7 @@ export class SiaConversionApi {
|
|
|
8142
8337
|
* @param destinationOenormType Defaults to Lv2015
|
|
8143
8338
|
* @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
8339
|
* @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.
|
|
8340
|
+
* @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
8341
|
* @param {*} [options] Override http request options.
|
|
8147
8342
|
*/
|
|
8148
8343
|
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';
|