@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/.swagger-codegen/VERSION +1 -1
- package/api.d.ts +321 -29
- package/api.js +570 -32
- package/api.js.map +1 -1
- package/api.ts +735 -69
- package/package.json +1 -1
package/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AVACloud API 1.
|
|
2
|
+
* AVACloud API 1.41.0
|
|
3
3
|
* AVACloud API specification
|
|
4
4
|
*
|
|
5
|
-
* OpenAPI spec version: 1.
|
|
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.
|
|
@@ -367,6 +367,10 @@ export declare class CommercePropertiesDto {
|
|
|
367
367
|
* This optional property can be used to indicate the basis for prices for a single position. Price basis means that the price is given per unit of the basis, e.g. per a pack of five when this property is set to '5'.
|
|
368
368
|
*/
|
|
369
369
|
'priceBasis'?: number;
|
|
370
|
+
/**
|
|
371
|
+
* This optional property can be used to indicate a sub position identifier specific for the commerce exchange
|
|
372
|
+
*/
|
|
373
|
+
'subPositionIdentifier'?: string;
|
|
370
374
|
static discriminator: string | undefined;
|
|
371
375
|
static attributeTypeMap: Array<{
|
|
372
376
|
name: string;
|
|
@@ -404,6 +408,22 @@ export declare class ComplementedByQuantityDto {
|
|
|
404
408
|
}[];
|
|
405
409
|
}
|
|
406
410
|
/**
|
|
411
|
+
* Represents valid Datanorm versions for export
|
|
412
|
+
*/
|
|
413
|
+
export declare class DatanormDestinationVersion {
|
|
414
|
+
static discriminator: string | undefined;
|
|
415
|
+
static attributeTypeMap: Array<{
|
|
416
|
+
name: string;
|
|
417
|
+
baseName: string;
|
|
418
|
+
type: string;
|
|
419
|
+
}>;
|
|
420
|
+
static getAttributeTypeMap(): {
|
|
421
|
+
name: string;
|
|
422
|
+
baseName: string;
|
|
423
|
+
type: string;
|
|
424
|
+
}[];
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
407
427
|
* The GAEB exchange phase to transform to
|
|
408
428
|
*/
|
|
409
429
|
export declare class DestinationGaebExchangePhase {
|
|
@@ -664,6 +684,38 @@ export declare class GrossPriceComponentDto {
|
|
|
664
684
|
}[];
|
|
665
685
|
}
|
|
666
686
|
/**
|
|
687
|
+
* Duration used in retention positions
|
|
688
|
+
*/
|
|
689
|
+
export declare class HoldOutDurationUnitDto {
|
|
690
|
+
static discriminator: string | undefined;
|
|
691
|
+
static attributeTypeMap: Array<{
|
|
692
|
+
name: string;
|
|
693
|
+
baseName: string;
|
|
694
|
+
type: string;
|
|
695
|
+
}>;
|
|
696
|
+
static getAttributeTypeMap(): {
|
|
697
|
+
name: string;
|
|
698
|
+
baseName: string;
|
|
699
|
+
type: string;
|
|
700
|
+
}[];
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* Types of retentions to be used in positions
|
|
704
|
+
*/
|
|
705
|
+
export declare class HoldOutTypeDto {
|
|
706
|
+
static discriminator: string | undefined;
|
|
707
|
+
static attributeTypeMap: Array<{
|
|
708
|
+
name: string;
|
|
709
|
+
baseName: string;
|
|
710
|
+
type: string;
|
|
711
|
+
}>;
|
|
712
|
+
static getAttributeTypeMap(): {
|
|
713
|
+
name: string;
|
|
714
|
+
baseName: string;
|
|
715
|
+
type: string;
|
|
716
|
+
}[];
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
667
719
|
*
|
|
668
720
|
*/
|
|
669
721
|
export declare class HttpStatusCode {
|
|
@@ -688,7 +740,7 @@ export declare class ItemNumberDto {
|
|
|
688
740
|
*/
|
|
689
741
|
'id': string;
|
|
690
742
|
/**
|
|
691
|
-
* 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.
|
|
743
|
+
* 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.
|
|
692
744
|
*/
|
|
693
745
|
'stringRepresentation'?: string;
|
|
694
746
|
/**
|
|
@@ -763,6 +815,10 @@ export declare class ItemNumberSchemaDto {
|
|
|
763
815
|
* 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.
|
|
764
816
|
*/
|
|
765
817
|
'schemaIsCorrectlyDefined': boolean;
|
|
818
|
+
/**
|
|
819
|
+
* Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation.
|
|
820
|
+
*/
|
|
821
|
+
'allowUpperCaseLettering': boolean;
|
|
766
822
|
static discriminator: string | undefined;
|
|
767
823
|
static attributeTypeMap: Array<{
|
|
768
824
|
name: string;
|
|
@@ -1409,6 +1465,46 @@ export declare class PositionDto extends IElementDto {
|
|
|
1409
1465
|
* This property can optionally be used in GAEB exchange scenarios. It is only meaningful if this position itself is a complementing position, meaning if this position is marked in other positions in their ComplementedBy list. Then, it specifies how the complementing should be expressed in GAEB. By default, positions are always explicitly referenced, but other options are possible. Please also note that the Dangl.AVA.Converter package, which is used for GAEB exports, will check if the given type is valid in the current project configuration. If not, directly referenced positions will be used as fallback.
|
|
1410
1466
|
*/
|
|
1411
1467
|
'gaebComplementingType': PositionComplementingTypeDto;
|
|
1468
|
+
/**
|
|
1469
|
+
* HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site.
|
|
1470
|
+
*/
|
|
1471
|
+
'holdOutProperties'?: PositionHoldOutPropertiesDto;
|
|
1472
|
+
static discriminator: string | undefined;
|
|
1473
|
+
static attributeTypeMap: Array<{
|
|
1474
|
+
name: string;
|
|
1475
|
+
baseName: string;
|
|
1476
|
+
type: string;
|
|
1477
|
+
}>;
|
|
1478
|
+
static getAttributeTypeMap(): {
|
|
1479
|
+
name: string;
|
|
1480
|
+
baseName: string;
|
|
1481
|
+
type: string;
|
|
1482
|
+
}[];
|
|
1483
|
+
}
|
|
1484
|
+
/**
|
|
1485
|
+
* 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
|
|
1486
|
+
*/
|
|
1487
|
+
export declare class PositionHoldOutPropertiesDto {
|
|
1488
|
+
/**
|
|
1489
|
+
* Elements GUID identifier.
|
|
1490
|
+
*/
|
|
1491
|
+
'id': string;
|
|
1492
|
+
/**
|
|
1493
|
+
* The actual type
|
|
1494
|
+
*/
|
|
1495
|
+
'holdOutType': HoldOutTypeDto;
|
|
1496
|
+
/**
|
|
1497
|
+
* The duration of the period
|
|
1498
|
+
*/
|
|
1499
|
+
'holdOutDuration': number;
|
|
1500
|
+
/**
|
|
1501
|
+
* The time unit of the period
|
|
1502
|
+
*/
|
|
1503
|
+
'holdOutDurationUnit': HoldOutDurationUnitDto;
|
|
1504
|
+
/**
|
|
1505
|
+
* References to base positions
|
|
1506
|
+
*/
|
|
1507
|
+
'basePositionReferences'?: Array<string>;
|
|
1412
1508
|
static discriminator: string | undefined;
|
|
1413
1509
|
static attributeTypeMap: Array<{
|
|
1414
1510
|
name: string;
|
|
@@ -1522,7 +1618,7 @@ export declare class PostGaebDestinationOptions {
|
|
|
1522
1618
|
*/
|
|
1523
1619
|
'exportQuantityDetermination': boolean;
|
|
1524
1620
|
/**
|
|
1525
|
-
* If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
1621
|
+
* If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
1526
1622
|
*/
|
|
1527
1623
|
'removeUnprintableCharactersFromTexts': boolean;
|
|
1528
1624
|
/**
|
|
@@ -1562,7 +1658,7 @@ export declare class PostOenormDestinationOptions {
|
|
|
1562
1658
|
*/
|
|
1563
1659
|
'skipTryEnforceSchemaCompliantXmlOutput': boolean;
|
|
1564
1660
|
/**
|
|
1565
|
-
* If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
1661
|
+
* If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
1566
1662
|
*/
|
|
1567
1663
|
'removeUnprintableCharactersFromTexts': boolean;
|
|
1568
1664
|
static discriminator: string | undefined;
|
|
@@ -1847,6 +1943,14 @@ export declare class ProjectInformationDto {
|
|
|
1847
1943
|
* This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary
|
|
1848
1944
|
*/
|
|
1849
1945
|
'specialAwardKind': SpecialAwardKindDto;
|
|
1946
|
+
/**
|
|
1947
|
+
* Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners.
|
|
1948
|
+
*/
|
|
1949
|
+
'requesters'?: Array<PartyInformationDto>;
|
|
1950
|
+
/**
|
|
1951
|
+
* Notification sites are addresses that are used for delivering messages in the context of construction projects.
|
|
1952
|
+
*/
|
|
1953
|
+
'notificationSites'?: Array<PartyInformationDto>;
|
|
1850
1954
|
static discriminator: string | undefined;
|
|
1851
1955
|
static attributeTypeMap: Array<{
|
|
1852
1956
|
name: string;
|
|
@@ -2201,6 +2305,18 @@ export declare class ServiceSpecificationDto {
|
|
|
2201
2305
|
*/
|
|
2202
2306
|
'decisionDate'?: Date;
|
|
2203
2307
|
/**
|
|
2308
|
+
* Date of when the offer / bid was created
|
|
2309
|
+
*/
|
|
2310
|
+
'bidDate'?: Date;
|
|
2311
|
+
/**
|
|
2312
|
+
* 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.
|
|
2313
|
+
*/
|
|
2314
|
+
'warrantyBondPercentage': number;
|
|
2315
|
+
/**
|
|
2316
|
+
* 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.
|
|
2317
|
+
*/
|
|
2318
|
+
'executionGuaranteePercentage': number;
|
|
2319
|
+
/**
|
|
2204
2320
|
* String indicating where the physical submission of the offer is taking place.
|
|
2205
2321
|
*/
|
|
2206
2322
|
'submissionLocation'?: string;
|
|
@@ -2390,6 +2506,14 @@ export declare class ServiceSpecificationGroupDto extends IElementDto {
|
|
|
2390
2506
|
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
2391
2507
|
*/
|
|
2392
2508
|
'addendumStatus'?: AddendumStatusDto;
|
|
2509
|
+
/**
|
|
2510
|
+
* 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.
|
|
2511
|
+
*/
|
|
2512
|
+
'alternativeIdentifier'?: number;
|
|
2513
|
+
/**
|
|
2514
|
+
* 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.
|
|
2515
|
+
*/
|
|
2516
|
+
'alternativeGroupIdentifier'?: number;
|
|
2393
2517
|
static discriminator: string | undefined;
|
|
2394
2518
|
static attributeTypeMap: Array<{
|
|
2395
2519
|
name: string;
|
|
@@ -2639,6 +2763,22 @@ export declare class TradeDiscountDto {
|
|
|
2639
2763
|
}[];
|
|
2640
2764
|
}
|
|
2641
2765
|
/**
|
|
2766
|
+
* Represents valid UGL versions for export
|
|
2767
|
+
*/
|
|
2768
|
+
export declare class UglDestinationVersion {
|
|
2769
|
+
static discriminator: string | undefined;
|
|
2770
|
+
static attributeTypeMap: Array<{
|
|
2771
|
+
name: string;
|
|
2772
|
+
baseName: string;
|
|
2773
|
+
type: string;
|
|
2774
|
+
}>;
|
|
2775
|
+
static getAttributeTypeMap(): {
|
|
2776
|
+
name: string;
|
|
2777
|
+
baseName: string;
|
|
2778
|
+
type: string;
|
|
2779
|
+
}[];
|
|
2780
|
+
}
|
|
2781
|
+
/**
|
|
2642
2782
|
* This class models the results of a single check performed during a validation action
|
|
2643
2783
|
*/
|
|
2644
2784
|
export declare class ValidationCheckResult {
|
|
@@ -2922,7 +3062,7 @@ export declare class AslvConversionApi {
|
|
|
2922
3062
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2923
3063
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
2924
3064
|
* @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.
|
|
2925
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3065
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
2926
3066
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
2927
3067
|
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
2928
3068
|
* @param {*} [options] Override http request options.
|
|
@@ -2951,7 +3091,7 @@ export declare class AslvConversionApi {
|
|
|
2951
3091
|
* @param destinationOenormType Defaults to Lv2015
|
|
2952
3092
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
2953
3093
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
2954
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3094
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
2955
3095
|
* @param {*} [options] Override http request options.
|
|
2956
3096
|
*/
|
|
2957
3097
|
aslvConversionConvertToOenorm(aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
@@ -3004,6 +3144,29 @@ export declare class AvaConversionApi {
|
|
|
3004
3144
|
/**
|
|
3005
3145
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3006
3146
|
*/
|
|
3147
|
+
avaConversionConvertToDatanormWithRequestObject(avaProject: ProjectDto, options: {
|
|
3148
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3149
|
+
datanormDestinationVersion?: 'V4' | 'V5';
|
|
3150
|
+
options?: any;
|
|
3151
|
+
}): Promise<{
|
|
3152
|
+
response: http.IncomingMessage;
|
|
3153
|
+
body: Buffer;
|
|
3154
|
+
}>;
|
|
3155
|
+
/**
|
|
3156
|
+
*
|
|
3157
|
+
* @summary Converts Dangl.AVA projects to Datanorm
|
|
3158
|
+
* @param avaProject The Dangl.AVA project
|
|
3159
|
+
* @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.
|
|
3160
|
+
* @param datanormDestinationVersion The Datanorm version to convert to. Defaults to V4.
|
|
3161
|
+
* @param {*} [options] Override http request options.
|
|
3162
|
+
*/
|
|
3163
|
+
avaConversionConvertToDatanorm(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, datanormDestinationVersion?: 'V4' | 'V5', options?: any): Promise<{
|
|
3164
|
+
response: http.IncomingMessage;
|
|
3165
|
+
body: Buffer;
|
|
3166
|
+
}>;
|
|
3167
|
+
/**
|
|
3168
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3169
|
+
*/
|
|
3007
3170
|
avaConversionConvertToExcelWithRequestObject(avaProject: ProjectDto, options: {
|
|
3008
3171
|
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3009
3172
|
writePrices?: boolean;
|
|
@@ -3054,7 +3217,7 @@ export declare class AvaConversionApi {
|
|
|
3054
3217
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
3055
3218
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
3056
3219
|
* @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.
|
|
3057
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3220
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3058
3221
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
3059
3222
|
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
3060
3223
|
* @param {*} [options] Override http request options.
|
|
@@ -3085,7 +3248,7 @@ export declare class AvaConversionApi {
|
|
|
3085
3248
|
* @param destinationOenormType Defaults to Lv2015
|
|
3086
3249
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
3087
3250
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
3088
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3251
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3089
3252
|
* @param {*} [options] Override http request options.
|
|
3090
3253
|
*/
|
|
3091
3254
|
avaConversionConvertToOenorm(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
@@ -3097,7 +3260,7 @@ export declare class AvaConversionApi {
|
|
|
3097
3260
|
*/
|
|
3098
3261
|
avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: {
|
|
3099
3262
|
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3100
|
-
destinationRebType?: 'D11' | 'X31GaebXmlV32';
|
|
3263
|
+
destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33';
|
|
3101
3264
|
options?: any;
|
|
3102
3265
|
}): Promise<{
|
|
3103
3266
|
response: http.IncomingMessage;
|
|
@@ -3111,7 +3274,7 @@ export declare class AvaConversionApi {
|
|
|
3111
3274
|
* @param destinationRebType Defaults to D11
|
|
3112
3275
|
* @param {*} [options] Override http request options.
|
|
3113
3276
|
*/
|
|
3114
|
-
avaConversionConvertToReb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32', options?: any): Promise<{
|
|
3277
|
+
avaConversionConvertToReb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33', options?: any): Promise<{
|
|
3115
3278
|
response: http.IncomingMessage;
|
|
3116
3279
|
body: Buffer;
|
|
3117
3280
|
}>;
|
|
@@ -3136,6 +3299,29 @@ export declare class AvaConversionApi {
|
|
|
3136
3299
|
response: http.IncomingMessage;
|
|
3137
3300
|
body: Buffer;
|
|
3138
3301
|
}>;
|
|
3302
|
+
/**
|
|
3303
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3304
|
+
*/
|
|
3305
|
+
avaConversionConvertToUglWithRequestObject(avaProject: ProjectDto, options: {
|
|
3306
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3307
|
+
uglDestinationVersion?: 'V4' | 'V5';
|
|
3308
|
+
options?: any;
|
|
3309
|
+
}): Promise<{
|
|
3310
|
+
response: http.IncomingMessage;
|
|
3311
|
+
body: Buffer;
|
|
3312
|
+
}>;
|
|
3313
|
+
/**
|
|
3314
|
+
*
|
|
3315
|
+
* @summary Converts Dangl.AVA projects to UGL
|
|
3316
|
+
* @param avaProject The Dangl.AVA project
|
|
3317
|
+
* @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.
|
|
3318
|
+
* @param uglDestinationVersion The UGL version to convert to. Defaults to V1.
|
|
3319
|
+
* @param {*} [options] Override http request options.
|
|
3320
|
+
*/
|
|
3321
|
+
avaConversionConvertToUgl(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, uglDestinationVersion?: 'V4' | 'V5', options?: any): Promise<{
|
|
3322
|
+
response: http.IncomingMessage;
|
|
3323
|
+
body: Buffer;
|
|
3324
|
+
}>;
|
|
3139
3325
|
}
|
|
3140
3326
|
export declare enum DanglIdentityApiApiKeys {
|
|
3141
3327
|
}
|
|
@@ -3219,6 +3405,47 @@ export declare class DanglIdentityApi {
|
|
|
3219
3405
|
body?: any;
|
|
3220
3406
|
}>;
|
|
3221
3407
|
}
|
|
3408
|
+
export declare enum DatanormConversionApiApiKeys {
|
|
3409
|
+
}
|
|
3410
|
+
export declare class DatanormConversionApi {
|
|
3411
|
+
protected _basePath: string;
|
|
3412
|
+
protected defaultHeaders: any;
|
|
3413
|
+
protected _useQuerystring: boolean;
|
|
3414
|
+
protected authentications: {
|
|
3415
|
+
default: Authentication;
|
|
3416
|
+
'Dangl.Identity': OAuth;
|
|
3417
|
+
};
|
|
3418
|
+
constructor(basePath?: string);
|
|
3419
|
+
set useQuerystring(value: boolean);
|
|
3420
|
+
set basePath(basePath: string);
|
|
3421
|
+
get basePath(): string;
|
|
3422
|
+
setDefaultAuthentication(auth: Authentication): void;
|
|
3423
|
+
setApiKey(key: DatanormConversionApiApiKeys, value: string): void;
|
|
3424
|
+
set accessToken(token: string);
|
|
3425
|
+
/**
|
|
3426
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3427
|
+
*/
|
|
3428
|
+
datanormConversionConvertToAvaWithRequestObject(datanormFile: FileParameter, options: {
|
|
3429
|
+
removePlainTextLongTexts?: boolean;
|
|
3430
|
+
removeHtmlLongTexts?: boolean;
|
|
3431
|
+
options?: any;
|
|
3432
|
+
}): Promise<{
|
|
3433
|
+
response: http.IncomingMessage;
|
|
3434
|
+
body: ProjectDto;
|
|
3435
|
+
}>;
|
|
3436
|
+
/**
|
|
3437
|
+
*
|
|
3438
|
+
* @summary Converts Datanorm files to Dangl.AVA projects
|
|
3439
|
+
* @param datanormFile The input file
|
|
3440
|
+
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
3441
|
+
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
3442
|
+
* @param {*} [options] Override http request options.
|
|
3443
|
+
*/
|
|
3444
|
+
datanormConversionConvertToAva(datanormFile: FileParameter, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
3445
|
+
response: http.IncomingMessage;
|
|
3446
|
+
body: ProjectDto;
|
|
3447
|
+
}>;
|
|
3448
|
+
}
|
|
3222
3449
|
export declare enum ExcelConversionApiApiKeys {
|
|
3223
3450
|
}
|
|
3224
3451
|
export declare class ExcelConversionApi {
|
|
@@ -3320,7 +3547,7 @@ export declare class ExcelConversionApi {
|
|
|
3320
3547
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
3321
3548
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
3322
3549
|
* @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.
|
|
3323
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3550
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3324
3551
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
3325
3552
|
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
3326
3553
|
* @param {*} [options] Override http request options.
|
|
@@ -3353,7 +3580,7 @@ export declare class ExcelConversionApi {
|
|
|
3353
3580
|
* @param destinationOenormType Defaults to Lv2015
|
|
3354
3581
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
3355
3582
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
3356
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3583
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3357
3584
|
* @param {*} [options] Override http request options.
|
|
3358
3585
|
*/
|
|
3359
3586
|
excelConversionConvertToOenorm(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
@@ -3385,6 +3612,9 @@ export declare class GaebConversionApi {
|
|
|
3385
3612
|
supportSkippedItemNumberLevelsInPositions?: boolean;
|
|
3386
3613
|
removePlainTextLongTexts?: boolean;
|
|
3387
3614
|
removeHtmlLongTexts?: boolean;
|
|
3615
|
+
outputHtmlAsXml?: boolean;
|
|
3616
|
+
keepEmptyHtmlText?: boolean;
|
|
3617
|
+
allowUpperCaseItemNumbers?: boolean;
|
|
3388
3618
|
options?: any;
|
|
3389
3619
|
}): Promise<{
|
|
3390
3620
|
response: http.IncomingMessage;
|
|
@@ -3394,12 +3624,15 @@ export declare class GaebConversionApi {
|
|
|
3394
3624
|
*
|
|
3395
3625
|
* @summary Converts GAEB files to Dangl.AVA projects
|
|
3396
3626
|
* @param gaebFile The input file
|
|
3397
|
-
* @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
|
|
3627
|
+
* @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.
|
|
3398
3628
|
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
3399
3629
|
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
3630
|
+
* @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>'.
|
|
3631
|
+
* @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.
|
|
3632
|
+
* @param allowUpperCaseItemNumbers Defaults to 'false'. 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.
|
|
3400
3633
|
* @param {*} [options] Override http request options.
|
|
3401
3634
|
*/
|
|
3402
|
-
gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
3635
|
+
gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
|
|
3403
3636
|
response: http.IncomingMessage;
|
|
3404
3637
|
body: ProjectDto;
|
|
3405
3638
|
}>;
|
|
@@ -3411,6 +3644,9 @@ export declare class GaebConversionApi {
|
|
|
3411
3644
|
writePrices?: boolean;
|
|
3412
3645
|
writeLongTexts?: boolean;
|
|
3413
3646
|
conversionCulture?: string;
|
|
3647
|
+
outputHtmlAsXml?: boolean;
|
|
3648
|
+
keepEmptyHtmlText?: boolean;
|
|
3649
|
+
allowUpperCaseItemNumbers?: boolean;
|
|
3414
3650
|
options?: any;
|
|
3415
3651
|
}): Promise<{
|
|
3416
3652
|
response: http.IncomingMessage;
|
|
@@ -3420,13 +3656,16 @@ export declare class GaebConversionApi {
|
|
|
3420
3656
|
*
|
|
3421
3657
|
* @summary Converts GAEB files to Excel
|
|
3422
3658
|
* @param gaebFile The input file
|
|
3423
|
-
* @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
|
|
3659
|
+
* @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.
|
|
3424
3660
|
* @param writePrices Defaults to true
|
|
3425
3661
|
* @param writeLongTexts Defaults to true
|
|
3426
3662
|
* @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
|
|
3663
|
+
* @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>'.
|
|
3664
|
+
* @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.
|
|
3665
|
+
* @param allowUpperCaseItemNumbers Defaults to 'false'. 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.
|
|
3427
3666
|
* @param {*} [options] Override http request options.
|
|
3428
3667
|
*/
|
|
3429
|
-
gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
3668
|
+
gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
|
|
3430
3669
|
response: http.IncomingMessage;
|
|
3431
3670
|
body: Buffer;
|
|
3432
3671
|
}>;
|
|
@@ -3442,6 +3681,9 @@ export declare class GaebConversionApi {
|
|
|
3442
3681
|
removeUnprintableCharactersFromTexts?: boolean;
|
|
3443
3682
|
forceIncludeDescriptions?: boolean;
|
|
3444
3683
|
treatNullItemNumberSchemaAsInvalid?: boolean;
|
|
3684
|
+
outputHtmlAsXml?: boolean;
|
|
3685
|
+
keepEmptyHtmlText?: boolean;
|
|
3686
|
+
allowUpperCaseItemNumbers?: boolean;
|
|
3445
3687
|
options?: any;
|
|
3446
3688
|
}): Promise<{
|
|
3447
3689
|
response: http.IncomingMessage;
|
|
@@ -3451,17 +3693,20 @@ export declare class GaebConversionApi {
|
|
|
3451
3693
|
*
|
|
3452
3694
|
* @summary Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
|
|
3453
3695
|
* @param gaebFile The input file
|
|
3454
|
-
* @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
|
|
3696
|
+
* @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.
|
|
3455
3697
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
3456
3698
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
3457
3699
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
3458
3700
|
* @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.
|
|
3459
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3701
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3460
3702
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
3461
3703
|
* @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.
|
|
3704
|
+
* @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>'.
|
|
3705
|
+
* @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.
|
|
3706
|
+
* @param allowUpperCaseItemNumbers Defaults to 'false'. 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.
|
|
3462
3707
|
* @param {*} [options] Override http request options.
|
|
3463
3708
|
*/
|
|
3464
|
-
gaebConversionConvertToGaeb(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
|
|
3709
|
+
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<{
|
|
3465
3710
|
response: http.IncomingMessage;
|
|
3466
3711
|
body: Buffer;
|
|
3467
3712
|
}>;
|
|
@@ -3474,6 +3719,9 @@ export declare class GaebConversionApi {
|
|
|
3474
3719
|
tryRepairProjectStructure?: boolean;
|
|
3475
3720
|
skipTryEnforceSchemaCompliantXmlOutput?: boolean;
|
|
3476
3721
|
removeUnprintableCharactersFromTexts?: boolean;
|
|
3722
|
+
outputHtmlAsXml?: boolean;
|
|
3723
|
+
keepEmptyHtmlText?: boolean;
|
|
3724
|
+
allowUpperCaseItemNumbers?: boolean;
|
|
3477
3725
|
options?: any;
|
|
3478
3726
|
}): Promise<{
|
|
3479
3727
|
response: http.IncomingMessage;
|
|
@@ -3483,14 +3731,17 @@ export declare class GaebConversionApi {
|
|
|
3483
3731
|
*
|
|
3484
3732
|
* @summary Converts GAEB files to Oenorm files
|
|
3485
3733
|
* @param gaebFile The input file
|
|
3486
|
-
* @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
|
|
3734
|
+
* @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.
|
|
3487
3735
|
* @param destinationOenormType Defaults to Lv2015
|
|
3488
3736
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
3489
3737
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
3490
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3738
|
+
* @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.
|
|
3739
|
+
* @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>'.
|
|
3740
|
+
* @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.
|
|
3741
|
+
* @param allowUpperCaseItemNumbers Defaults to 'false'. 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.
|
|
3491
3742
|
* @param {*} [options] Override http request options.
|
|
3492
3743
|
*/
|
|
3493
|
-
gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
3744
|
+
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<{
|
|
3494
3745
|
response: http.IncomingMessage;
|
|
3495
3746
|
body: Buffer;
|
|
3496
3747
|
}>;
|
|
@@ -3584,7 +3835,7 @@ export declare class OenormConversionApi {
|
|
|
3584
3835
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
3585
3836
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
3586
3837
|
* @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.
|
|
3587
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3838
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3588
3839
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
3589
3840
|
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
3590
3841
|
* @param {*} [options] Override http request options.
|
|
@@ -3613,7 +3864,7 @@ export declare class OenormConversionApi {
|
|
|
3613
3864
|
* @param destinationOenormType Defaults to Lv2015
|
|
3614
3865
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
3615
3866
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
3616
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3867
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3617
3868
|
* @param {*} [options] Override http request options.
|
|
3618
3869
|
*/
|
|
3619
3870
|
oenormConversionConvertToOenorm(oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
@@ -3710,7 +3961,7 @@ export declare class RebConversionApi {
|
|
|
3710
3961
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
3711
3962
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
3712
3963
|
* @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.
|
|
3713
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3964
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3714
3965
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
3715
3966
|
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
3716
3967
|
* @param {*} [options] Override http request options.
|
|
@@ -3739,7 +3990,7 @@ export declare class RebConversionApi {
|
|
|
3739
3990
|
* @param destinationOenormType Defaults to Lv2015
|
|
3740
3991
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
3741
3992
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
3742
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
3993
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3743
3994
|
* @param {*} [options] Override http request options.
|
|
3744
3995
|
*/
|
|
3745
3996
|
rebConversionConvertToOenorm(rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
@@ -3836,7 +4087,7 @@ export declare class SiaConversionApi {
|
|
|
3836
4087
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
3837
4088
|
* @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
3838
4089
|
* @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.
|
|
3839
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
4090
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3840
4091
|
* @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
3841
4092
|
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
3842
4093
|
* @param {*} [options] Override http request options.
|
|
@@ -3865,7 +4116,7 @@ export declare class SiaConversionApi {
|
|
|
3865
4116
|
* @param destinationOenormType Defaults to Lv2015
|
|
3866
4117
|
* @param tryRepairProjectStructure Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
|
|
3867
4118
|
* @param skipTryEnforceSchemaCompliantXmlOutput If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
|
|
3868
|
-
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
4119
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
3869
4120
|
* @param {*} [options] Override http request options.
|
|
3870
4121
|
*/
|
|
3871
4122
|
siaConversionConvertToOenorm(siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
@@ -3900,6 +4151,47 @@ export declare class StatusApi {
|
|
|
3900
4151
|
body: GetStatus;
|
|
3901
4152
|
}>;
|
|
3902
4153
|
}
|
|
4154
|
+
export declare enum UglConversionApiApiKeys {
|
|
4155
|
+
}
|
|
4156
|
+
export declare class UglConversionApi {
|
|
4157
|
+
protected _basePath: string;
|
|
4158
|
+
protected defaultHeaders: any;
|
|
4159
|
+
protected _useQuerystring: boolean;
|
|
4160
|
+
protected authentications: {
|
|
4161
|
+
default: Authentication;
|
|
4162
|
+
'Dangl.Identity': OAuth;
|
|
4163
|
+
};
|
|
4164
|
+
constructor(basePath?: string);
|
|
4165
|
+
set useQuerystring(value: boolean);
|
|
4166
|
+
set basePath(basePath: string);
|
|
4167
|
+
get basePath(): string;
|
|
4168
|
+
setDefaultAuthentication(auth: Authentication): void;
|
|
4169
|
+
setApiKey(key: UglConversionApiApiKeys, value: string): void;
|
|
4170
|
+
set accessToken(token: string);
|
|
4171
|
+
/**
|
|
4172
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4173
|
+
*/
|
|
4174
|
+
uglConversionConvertToAvaWithRequestObject(uglFile: FileParameter, options: {
|
|
4175
|
+
removePlainTextLongTexts?: boolean;
|
|
4176
|
+
removeHtmlLongTexts?: boolean;
|
|
4177
|
+
options?: any;
|
|
4178
|
+
}): Promise<{
|
|
4179
|
+
response: http.IncomingMessage;
|
|
4180
|
+
body: ProjectDto;
|
|
4181
|
+
}>;
|
|
4182
|
+
/**
|
|
4183
|
+
*
|
|
4184
|
+
* @summary Converts Ugl files to Dangl.AVA projects
|
|
4185
|
+
* @param uglFile The input file
|
|
4186
|
+
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
4187
|
+
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
4188
|
+
* @param {*} [options] Override http request options.
|
|
4189
|
+
*/
|
|
4190
|
+
uglConversionConvertToAva(uglFile: FileParameter, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
4191
|
+
response: http.IncomingMessage;
|
|
4192
|
+
body: ProjectDto;
|
|
4193
|
+
}>;
|
|
4194
|
+
}
|
|
3903
4195
|
export declare enum ValidationApiApiKeys {
|
|
3904
4196
|
}
|
|
3905
4197
|
export declare class ValidationApi {
|