@dangl/avacloud-client-node 1.15.0 → 1.18.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/LICENSE.md +1 -1
- package/api.d.ts +552 -40
- package/api.js +774 -42
- package/api.js.map +1 -1
- package/api.ts +1102 -93
- package/package.json +1 -1
package/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AVACloud API 1.
|
|
2
|
+
* AVACloud API 1.30.0
|
|
3
3
|
* AVACloud API specification
|
|
4
4
|
*
|
|
5
|
-
* OpenAPI spec version: 1.
|
|
5
|
+
* OpenAPI spec version: 1.30.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by the swagger code generator program.
|
|
@@ -13,6 +13,22 @@
|
|
|
13
13
|
import localVarRequest = require('request');
|
|
14
14
|
import http = require('http');
|
|
15
15
|
/**
|
|
16
|
+
* This enumeration represents the status of an addendum, 'Nachtrag' in German
|
|
17
|
+
*/
|
|
18
|
+
export declare class AddendumStatusDto {
|
|
19
|
+
static discriminator: string | undefined;
|
|
20
|
+
static attributeTypeMap: Array<{
|
|
21
|
+
name: string;
|
|
22
|
+
baseName: string;
|
|
23
|
+
type: string;
|
|
24
|
+
}>;
|
|
25
|
+
static getAttributeTypeMap(): {
|
|
26
|
+
name: string;
|
|
27
|
+
baseName: string;
|
|
28
|
+
type: string;
|
|
29
|
+
}[];
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
16
32
|
* Indicates the origin of an element.
|
|
17
33
|
*/
|
|
18
34
|
export declare class AdditionTypeDto {
|
|
@@ -223,7 +239,7 @@ export declare class CatalogueDto {
|
|
|
223
239
|
*/
|
|
224
240
|
'description'?: string;
|
|
225
241
|
/**
|
|
226
|
-
* If given,
|
|
242
|
+
* If given, this gives a classification for the contents of the catalogue
|
|
227
243
|
*/
|
|
228
244
|
'catalogueType': CatalogueTypeDto;
|
|
229
245
|
static discriminator: string | undefined;
|
|
@@ -415,6 +431,22 @@ export declare class DestinationOenormType {
|
|
|
415
431
|
}[];
|
|
416
432
|
}
|
|
417
433
|
/**
|
|
434
|
+
* Represents valid REB target types
|
|
435
|
+
*/
|
|
436
|
+
export declare class DestinationRebType {
|
|
437
|
+
static discriminator: string | undefined;
|
|
438
|
+
static attributeTypeMap: Array<{
|
|
439
|
+
name: string;
|
|
440
|
+
baseName: string;
|
|
441
|
+
type: string;
|
|
442
|
+
}>;
|
|
443
|
+
static getAttributeTypeMap(): {
|
|
444
|
+
name: string;
|
|
445
|
+
baseName: string;
|
|
446
|
+
type: string;
|
|
447
|
+
}[];
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
418
450
|
* This enumeration represents the unit of a duration
|
|
419
451
|
*/
|
|
420
452
|
export declare class DurationUnitDto {
|
|
@@ -458,6 +490,12 @@ export declare class IElementDto {
|
|
|
458
490
|
* This is used to store the GAEB XML Id within this IElement. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization.
|
|
459
491
|
*/
|
|
460
492
|
'gaebXmlId'?: string;
|
|
493
|
+
/**
|
|
494
|
+
* This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
|
|
495
|
+
*/
|
|
496
|
+
'addendumNumber'?: string;
|
|
497
|
+
'projectCatalogues'?: Array<CatalogueDto>;
|
|
498
|
+
'catalogueReferences'?: Array<CatalogueReferenceDto>;
|
|
461
499
|
'elementTypeDiscriminator': string;
|
|
462
500
|
static discriminator: string | undefined;
|
|
463
501
|
static attributeTypeMap: Array<{
|
|
@@ -497,6 +535,22 @@ export declare class ExecutionDescriptionDto extends IElementDto {
|
|
|
497
535
|
type: string;
|
|
498
536
|
}[];
|
|
499
537
|
}
|
|
538
|
+
/**
|
|
539
|
+
* This enum represents the source type for a file based validation operation
|
|
540
|
+
*/
|
|
541
|
+
export declare class FileValidationSourceType {
|
|
542
|
+
static discriminator: string | undefined;
|
|
543
|
+
static attributeTypeMap: Array<{
|
|
544
|
+
name: string;
|
|
545
|
+
baseName: string;
|
|
546
|
+
type: string;
|
|
547
|
+
}>;
|
|
548
|
+
static getAttributeTypeMap(): {
|
|
549
|
+
name: string;
|
|
550
|
+
baseName: string;
|
|
551
|
+
type: string;
|
|
552
|
+
}[];
|
|
553
|
+
}
|
|
500
554
|
export declare class ForgotPasswordPost {
|
|
501
555
|
'identifier': string;
|
|
502
556
|
'preferredLanguages'?: Array<string>;
|
|
@@ -632,6 +686,14 @@ export declare class ItemNumberDto {
|
|
|
632
686
|
* This indicates if this item number is at the lot level. Find out more about lots in the documentation.
|
|
633
687
|
*/
|
|
634
688
|
'isLot': boolean;
|
|
689
|
+
/**
|
|
690
|
+
* This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element.
|
|
691
|
+
*/
|
|
692
|
+
'hierarchyLevel': number;
|
|
693
|
+
/**
|
|
694
|
+
* This property indicates if this ItemNumber is attached to an object of the Position type.
|
|
695
|
+
*/
|
|
696
|
+
'isAttachedToPosition': boolean;
|
|
635
697
|
static discriminator: string | undefined;
|
|
636
698
|
static attributeTypeMap: Array<{
|
|
637
699
|
name: string;
|
|
@@ -661,13 +723,25 @@ export declare class ItemNumberSchemaDto {
|
|
|
661
723
|
*/
|
|
662
724
|
'separator'?: string;
|
|
663
725
|
/**
|
|
664
|
-
* This string is used to fill (left-pad) item numbers. For example, if a tier has a length of '4' but the given item number is '12', with a Filler of '0', then the final item number will be represented as '0'. This must be a single character string, if a value is given where the Length property does not evaluate to '1', the DEFAULT_FILLER '0' is used. A space is fine to use. You should ensure that you use a value different than Separator, as that might produce unexpected results. No attempt is done by the code to recover from such ambiguous configurations
|
|
726
|
+
* This string is used to fill (left-pad) item numbers. For example, if a tier has a length of '4' but the given item number is '12', with a Filler of '0', then the final item number will be represented as '0'. This must be a single character string, if a value is given where the Length property does not evaluate to '1', the DEFAULT_FILLER '0' is used. A space is fine to use. You should ensure that you use a value different than Separator, as that might produce unexpected results. No attempt is done by the code to recover from such ambiguous configurations.
|
|
665
727
|
*/
|
|
666
728
|
'filler'?: string;
|
|
667
729
|
/**
|
|
668
730
|
* This is just a string property that can optionally be used to store additional data for this ItemNumberSchema, e.g. an identification or a type. It does not have any influence over how item numbers are generated, and is not supported in most exchange formats. However, it is used to store ÖNorm service specification structure types.
|
|
669
731
|
*/
|
|
670
732
|
'identifier'?: string;
|
|
733
|
+
/**
|
|
734
|
+
* This property indicates if ItemNumbers using this ItemNumberSchema should skip empty group levels. This is commonly only used in GAEB files, where there might be gaps in the hierarchy of elements and position identifiers should be placed at the end of the string representation.
|
|
735
|
+
*/
|
|
736
|
+
'skipNonExistingLevelsInPositionItemNumbers': boolean;
|
|
737
|
+
/**
|
|
738
|
+
* This string is used only when the property SkipNonExistingLevelsInPositionItemNumbers in this ItemNumberSchema is also set to true. It defaults to DEFAULT_SKIPPED_TIERS_FILLER, but can be set to any string with a lenght of one. Null values or values with a longer length will lead to this property reverting back to the default value. This is used to fill skipped tiers in item numbers where a position is placed in a higher hierarchy level than what would be defined in the Tiers. For example, it could produce an item number like '01.__.02', which would indicate a skipped second level. This should be using different values than Filler and Separator, since that could cause ambiguities in the code that generates the actual item numbers. No attempt is done by the code to recover from such ambiguous configurations.
|
|
739
|
+
*/
|
|
740
|
+
'skippedTiersFiller'?: string;
|
|
741
|
+
/**
|
|
742
|
+
* 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.
|
|
743
|
+
*/
|
|
744
|
+
'schemaIsCorrectlyDefined': boolean;
|
|
671
745
|
static discriminator: string | undefined;
|
|
672
746
|
static attributeTypeMap: Array<{
|
|
673
747
|
name: string;
|
|
@@ -850,6 +924,51 @@ export declare class NoteTextDto extends IElementDto {
|
|
|
850
924
|
* This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself.
|
|
851
925
|
*/
|
|
852
926
|
'descriptionId'?: string;
|
|
927
|
+
/**
|
|
928
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts.
|
|
929
|
+
*/
|
|
930
|
+
'oenormNoteTextProperties'?: OenormNoteTextPropertiesDto;
|
|
931
|
+
'hasBidderCommentInHtmlLongText': boolean;
|
|
932
|
+
static discriminator: string | undefined;
|
|
933
|
+
static attributeTypeMap: Array<{
|
|
934
|
+
name: string;
|
|
935
|
+
baseName: string;
|
|
936
|
+
type: string;
|
|
937
|
+
}>;
|
|
938
|
+
static getAttributeTypeMap(): {
|
|
939
|
+
name: string;
|
|
940
|
+
baseName: string;
|
|
941
|
+
type: string;
|
|
942
|
+
}[];
|
|
943
|
+
}
|
|
944
|
+
/**
|
|
945
|
+
* Basic information about Object check validation details, commonly used when checking GAEB 2000 files
|
|
946
|
+
*/
|
|
947
|
+
export declare class ObjectValidationCheckDetails {
|
|
948
|
+
/**
|
|
949
|
+
* The path under which the element with error was found.
|
|
950
|
+
*/
|
|
951
|
+
'elementPath'?: string;
|
|
952
|
+
static discriminator: string | undefined;
|
|
953
|
+
static attributeTypeMap: Array<{
|
|
954
|
+
name: string;
|
|
955
|
+
baseName: string;
|
|
956
|
+
type: string;
|
|
957
|
+
}>;
|
|
958
|
+
static getAttributeTypeMap(): {
|
|
959
|
+
name: string;
|
|
960
|
+
baseName: string;
|
|
961
|
+
type: string;
|
|
962
|
+
}[];
|
|
963
|
+
}
|
|
964
|
+
/**
|
|
965
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts.
|
|
966
|
+
*/
|
|
967
|
+
export declare class OenormNoteTextPropertiesDto {
|
|
968
|
+
/**
|
|
969
|
+
* This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm
|
|
970
|
+
*/
|
|
971
|
+
'originCode': OenormOriginCodeDto;
|
|
853
972
|
static discriminator: string | undefined;
|
|
854
973
|
static attributeTypeMap: Array<{
|
|
855
974
|
name: string;
|
|
@@ -894,6 +1013,10 @@ export declare class OenormPositionPropertiesDto {
|
|
|
894
1013
|
* This indicates if the ÖNorm 'wesentliche position' mark is set
|
|
895
1014
|
*/
|
|
896
1015
|
'isMainPosition': boolean;
|
|
1016
|
+
/**
|
|
1017
|
+
* This indicates if the ÖNorm position was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position is also the sole element inside it's parent group
|
|
1018
|
+
*/
|
|
1019
|
+
'isUndividedPosition': boolean;
|
|
897
1020
|
static discriminator: string | undefined;
|
|
898
1021
|
static attributeTypeMap: Array<{
|
|
899
1022
|
name: string;
|
|
@@ -1188,14 +1311,6 @@ export declare class PositionDto extends IElementDto {
|
|
|
1188
1311
|
* This identifier can be used to point to the Id of a position in the same ServiceSpecification that acts as a base position. It matches \"Bezugsposition\" in GAEB. This can be used for positions that repeat partially or are linked together
|
|
1189
1312
|
*/
|
|
1190
1313
|
'repetitionTo'?: string;
|
|
1191
|
-
/**
|
|
1192
|
-
* These are Catalogues that are used within this Position. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection.
|
|
1193
|
-
*/
|
|
1194
|
-
'projectCatalogues'?: Array<CatalogueDto>;
|
|
1195
|
-
/**
|
|
1196
|
-
* Referenced catalogues for this Position.
|
|
1197
|
-
*/
|
|
1198
|
-
'catalogueReferences'?: Array<CatalogueReferenceDto>;
|
|
1199
1314
|
'type'?: string;
|
|
1200
1315
|
/**
|
|
1201
1316
|
* This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding.
|
|
@@ -1221,6 +1336,15 @@ export declare class PositionDto extends IElementDto {
|
|
|
1221
1336
|
* This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself.
|
|
1222
1337
|
*/
|
|
1223
1338
|
'descriptionId'?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element.
|
|
1341
|
+
*/
|
|
1342
|
+
'hierarchyLevel': number;
|
|
1343
|
+
/**
|
|
1344
|
+
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
1345
|
+
*/
|
|
1346
|
+
'addendumStatus'?: AddendumStatusDto;
|
|
1347
|
+
'hasBidderCommentInHtmlLongText': boolean;
|
|
1224
1348
|
static discriminator: string | undefined;
|
|
1225
1349
|
static attributeTypeMap: Array<{
|
|
1226
1350
|
name: string;
|
|
@@ -1250,6 +1374,142 @@ export declare class PositionTypeDto {
|
|
|
1250
1374
|
}[];
|
|
1251
1375
|
}
|
|
1252
1376
|
/**
|
|
1377
|
+
* Options for validating an AVA project
|
|
1378
|
+
*/
|
|
1379
|
+
export declare class PostAvaProjectValidationSourceOptions {
|
|
1380
|
+
/**
|
|
1381
|
+
* The project that should be validated
|
|
1382
|
+
*/
|
|
1383
|
+
'avaProject': ProjectDto;
|
|
1384
|
+
/**
|
|
1385
|
+
* The index of the ServiceSpecification that should be validated. If not given, will default to the first one in the project.
|
|
1386
|
+
*/
|
|
1387
|
+
'serviceSpecificationIndex'?: number;
|
|
1388
|
+
/**
|
|
1389
|
+
* This can optionally be specified to simulate a conversion to a specific target.
|
|
1390
|
+
*/
|
|
1391
|
+
'validationType': ValidationType;
|
|
1392
|
+
/**
|
|
1393
|
+
* This can optionally be supplied to test for a specific exchange phase. For example, missing prices will only trigger errors in some specific exchange phases. Please note: If a conversion to a specific format, e.g. GAEB or ÖNorm, is given, this parameter is not applied to the internal conversion. The converter options must be set in the appropriate properties as well.
|
|
1394
|
+
*/
|
|
1395
|
+
'exchangePhase'?: ExchangePhaseDto;
|
|
1396
|
+
/**
|
|
1397
|
+
* Options for importing the AVA project
|
|
1398
|
+
*/
|
|
1399
|
+
'avaSourceOptions'?: PostAvaSourceOptions;
|
|
1400
|
+
/**
|
|
1401
|
+
* Options for conversion to Oenorm. Should be given if ValidationType is set to Oenorm.
|
|
1402
|
+
*/
|
|
1403
|
+
'oenormDestinationOptions'?: PostOenormDestinationOptions;
|
|
1404
|
+
/**
|
|
1405
|
+
* Options for conversion to GAEB. Should be given if ValidationType is set to GAEB.
|
|
1406
|
+
*/
|
|
1407
|
+
'gaebDestinationOptions'?: PostGaebDestinationOptions;
|
|
1408
|
+
static discriminator: string | undefined;
|
|
1409
|
+
static attributeTypeMap: Array<{
|
|
1410
|
+
name: string;
|
|
1411
|
+
baseName: string;
|
|
1412
|
+
type: string;
|
|
1413
|
+
}>;
|
|
1414
|
+
static getAttributeTypeMap(): {
|
|
1415
|
+
name: string;
|
|
1416
|
+
baseName: string;
|
|
1417
|
+
type: string;
|
|
1418
|
+
}[];
|
|
1419
|
+
}
|
|
1420
|
+
/**
|
|
1421
|
+
* Options for conversions from AVA
|
|
1422
|
+
*/
|
|
1423
|
+
export declare class PostAvaSourceOptions {
|
|
1424
|
+
/**
|
|
1425
|
+
* If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
|
|
1426
|
+
*/
|
|
1427
|
+
'tryAutoGenerateItemNumbersAndSchema': boolean;
|
|
1428
|
+
static discriminator: string | undefined;
|
|
1429
|
+
static attributeTypeMap: Array<{
|
|
1430
|
+
name: string;
|
|
1431
|
+
baseName: string;
|
|
1432
|
+
type: string;
|
|
1433
|
+
}>;
|
|
1434
|
+
static getAttributeTypeMap(): {
|
|
1435
|
+
name: string;
|
|
1436
|
+
baseName: string;
|
|
1437
|
+
type: string;
|
|
1438
|
+
}[];
|
|
1439
|
+
}
|
|
1440
|
+
/**
|
|
1441
|
+
* Options for conversions to GAEB
|
|
1442
|
+
*/
|
|
1443
|
+
export declare class PostGaebDestinationOptions {
|
|
1444
|
+
/**
|
|
1445
|
+
* Defaults to GAEB XML V3.2
|
|
1446
|
+
*/
|
|
1447
|
+
'destinationGaebType': DestinationGaebType;
|
|
1448
|
+
/**
|
|
1449
|
+
* Defaults to none, meaning no transformation will be done
|
|
1450
|
+
*/
|
|
1451
|
+
'targetExchangePhaseTransform': DestinationGaebExchangePhase;
|
|
1452
|
+
/**
|
|
1453
|
+
* Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
|
|
1454
|
+
*/
|
|
1455
|
+
'enforceStrictOfferPhaseLongTextOutput': boolean;
|
|
1456
|
+
/**
|
|
1457
|
+
* Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
|
|
1458
|
+
*/
|
|
1459
|
+
'exportQuantityDetermination': boolean;
|
|
1460
|
+
/**
|
|
1461
|
+
* If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
1462
|
+
*/
|
|
1463
|
+
'removeUnprintableCharactersFromTexts': boolean;
|
|
1464
|
+
/**
|
|
1465
|
+
* If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
|
|
1466
|
+
*/
|
|
1467
|
+
'forceIncludeDescriptions': boolean;
|
|
1468
|
+
static discriminator: string | undefined;
|
|
1469
|
+
static attributeTypeMap: Array<{
|
|
1470
|
+
name: string;
|
|
1471
|
+
baseName: string;
|
|
1472
|
+
type: string;
|
|
1473
|
+
}>;
|
|
1474
|
+
static getAttributeTypeMap(): {
|
|
1475
|
+
name: string;
|
|
1476
|
+
baseName: string;
|
|
1477
|
+
type: string;
|
|
1478
|
+
}[];
|
|
1479
|
+
}
|
|
1480
|
+
/**
|
|
1481
|
+
* Options for conversions to Oenorm
|
|
1482
|
+
*/
|
|
1483
|
+
export declare class PostOenormDestinationOptions {
|
|
1484
|
+
/**
|
|
1485
|
+
* Defaults to Lv2015
|
|
1486
|
+
*/
|
|
1487
|
+
'destinationOenormType': DestinationOenormType;
|
|
1488
|
+
/**
|
|
1489
|
+
* 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
|
|
1490
|
+
*/
|
|
1491
|
+
'tryRepairProjectStructure': boolean;
|
|
1492
|
+
/**
|
|
1493
|
+
* 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.
|
|
1494
|
+
*/
|
|
1495
|
+
'skipTryEnforceSchemaCompliantXmlOutput': boolean;
|
|
1496
|
+
/**
|
|
1497
|
+
* 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.
|
|
1498
|
+
*/
|
|
1499
|
+
'removeUnprintableCharactersFromTexts': boolean;
|
|
1500
|
+
static discriminator: string | undefined;
|
|
1501
|
+
static attributeTypeMap: Array<{
|
|
1502
|
+
name: string;
|
|
1503
|
+
baseName: string;
|
|
1504
|
+
type: string;
|
|
1505
|
+
}>;
|
|
1506
|
+
static getAttributeTypeMap(): {
|
|
1507
|
+
name: string;
|
|
1508
|
+
baseName: string;
|
|
1509
|
+
type: string;
|
|
1510
|
+
}[];
|
|
1511
|
+
}
|
|
1512
|
+
/**
|
|
1253
1513
|
* This class provides means to store information about a price and it's composition. Note that this is referencing to a single price component, so for example a Position would have a list of PriceComponents, one for Material, one for Labour etc.
|
|
1254
1514
|
*/
|
|
1255
1515
|
export declare class PriceComponentDto {
|
|
@@ -1494,7 +1754,7 @@ export declare class ProjectInformationDto {
|
|
|
1494
1754
|
*/
|
|
1495
1755
|
'labourTimeLabel'?: string;
|
|
1496
1756
|
/**
|
|
1497
|
-
* Labels for the price components used in the project. Caution: Removal of a price component will trigger to have dependent price informations be deleted in IElements that use this property.
|
|
1757
|
+
* Labels for the price components used in the project. Caution: Removal of a price component will trigger to have dependent price informations be deleted in IElements that use this property. If this property is changed or altered after the project has already been used, it is strongly advised to do operations step by step, e.g. if renaming and reordering multiple price components, this should be done one by one. Otherwise, a combination of rename and reordering will not be correctly propagated downwards to child objects in this Project.
|
|
1498
1758
|
*/
|
|
1499
1759
|
'priceComponents'?: Array<string>;
|
|
1500
1760
|
/**
|
|
@@ -1532,6 +1792,26 @@ export declare class ProjectInformationDto {
|
|
|
1532
1792
|
}[];
|
|
1533
1793
|
}
|
|
1534
1794
|
/**
|
|
1795
|
+
* Check details specificly for checking ProjectDto objects
|
|
1796
|
+
*/
|
|
1797
|
+
export declare class ProjectValidationCheckDetails {
|
|
1798
|
+
/**
|
|
1799
|
+
* The id of the element
|
|
1800
|
+
*/
|
|
1801
|
+
'elementId': string;
|
|
1802
|
+
static discriminator: string | undefined;
|
|
1803
|
+
static attributeTypeMap: Array<{
|
|
1804
|
+
name: string;
|
|
1805
|
+
baseName: string;
|
|
1806
|
+
type: string;
|
|
1807
|
+
}>;
|
|
1808
|
+
static getAttributeTypeMap(): {
|
|
1809
|
+
name: string;
|
|
1810
|
+
baseName: string;
|
|
1811
|
+
type: string;
|
|
1812
|
+
}[];
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1535
1815
|
* Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes.
|
|
1536
1816
|
*/
|
|
1537
1817
|
export declare class QuantityAssignmentDto {
|
|
@@ -1729,6 +2009,10 @@ export declare class ServiceSpecificationDto {
|
|
|
1729
2009
|
*/
|
|
1730
2010
|
'deductionFactor': number;
|
|
1731
2011
|
/**
|
|
2012
|
+
* The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum.
|
|
2013
|
+
*/
|
|
2014
|
+
'absoluteDeduction'?: number;
|
|
2015
|
+
/**
|
|
1732
2016
|
* Will return this ElementContainerBase's total price.
|
|
1733
2017
|
*/
|
|
1734
2018
|
'totalPrice': number;
|
|
@@ -1805,7 +2089,7 @@ export declare class ServiceSpecificationDto {
|
|
|
1805
2089
|
*/
|
|
1806
2090
|
'projectCatalogues'?: Array<CatalogueDto>;
|
|
1807
2091
|
/**
|
|
1808
|
-
* Referenced catalogues for this
|
|
2092
|
+
* Referenced catalogues for this ElementContainerBase.
|
|
1809
2093
|
*/
|
|
1810
2094
|
'catalogueReferences'?: Array<CatalogueReferenceDto>;
|
|
1811
2095
|
/**
|
|
@@ -1840,6 +2124,14 @@ export declare class ServiceSpecificationDto {
|
|
|
1840
2124
|
* This should specify how the approval is performed by the buyer. This matches \"AcceptType\" in GAEB
|
|
1841
2125
|
*/
|
|
1842
2126
|
'typeOfApproval'?: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
|
|
2129
|
+
*/
|
|
2130
|
+
'addendumNumber'?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
2133
|
+
*/
|
|
2134
|
+
'addendumStatus'?: AddendumStatusDto;
|
|
1843
2135
|
static discriminator: string | undefined;
|
|
1844
2136
|
static attributeTypeMap: Array<{
|
|
1845
2137
|
name: string;
|
|
@@ -1910,6 +2202,10 @@ export declare class ServiceSpecificationGroupDto extends IElementDto {
|
|
|
1910
2202
|
*/
|
|
1911
2203
|
'deductionFactor': number;
|
|
1912
2204
|
/**
|
|
2205
|
+
* The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum.
|
|
2206
|
+
*/
|
|
2207
|
+
'absoluteDeduction'?: number;
|
|
2208
|
+
/**
|
|
1913
2209
|
* Will return this ElementContainerBase's total price.
|
|
1914
2210
|
*/
|
|
1915
2211
|
'totalPrice': number;
|
|
@@ -1948,17 +2244,17 @@ export declare class ServiceSpecificationGroupDto extends IElementDto {
|
|
|
1948
2244
|
'alternativeTo'?: string;
|
|
1949
2245
|
'type'?: string;
|
|
1950
2246
|
/**
|
|
1951
|
-
*
|
|
2247
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used.
|
|
1952
2248
|
*/
|
|
1953
|
-
'
|
|
2249
|
+
'oenormProperties'?: OenormPropertiesDto;
|
|
1954
2250
|
/**
|
|
1955
|
-
*
|
|
2251
|
+
* This is a zero based hierarchy level. It's set automatically when used in the context of a Project, and can be used to identify the hierarchy level of the current element.
|
|
1956
2252
|
*/
|
|
1957
|
-
'
|
|
2253
|
+
'hierarchyLevel': number;
|
|
1958
2254
|
/**
|
|
1959
|
-
* This
|
|
2255
|
+
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
1960
2256
|
*/
|
|
1961
|
-
'
|
|
2257
|
+
'addendumStatus'?: AddendumStatusDto;
|
|
1962
2258
|
static discriminator: string | undefined;
|
|
1963
2259
|
static attributeTypeMap: Array<{
|
|
1964
2260
|
name: string;
|
|
@@ -2103,6 +2399,7 @@ export declare class SubDescriptionDto {
|
|
|
2103
2399
|
* This is an identifier specific for this description. Some exchange formats, like GAEB XML, use it to identify descriptions. It's different to an elements identifier in that it should only apply to the description component, meaning the text itself.
|
|
2104
2400
|
*/
|
|
2105
2401
|
'descriptionId'?: string;
|
|
2402
|
+
'hasBidderCommentInHtmlLongText': boolean;
|
|
2106
2403
|
static discriminator: string | undefined;
|
|
2107
2404
|
static attributeTypeMap: Array<{
|
|
2108
2405
|
name: string;
|
|
@@ -2197,6 +2494,126 @@ export declare class TradeDiscountDto {
|
|
|
2197
2494
|
}[];
|
|
2198
2495
|
}
|
|
2199
2496
|
/**
|
|
2497
|
+
* This class models the results of a single check performed during a validation action
|
|
2498
|
+
*/
|
|
2499
|
+
export declare class ValidationCheckResult {
|
|
2500
|
+
/**
|
|
2501
|
+
* The severity for this check. Usually, low severity checks do not impact data exchange with third party applications
|
|
2502
|
+
*/
|
|
2503
|
+
'severity': ValidationSeverity;
|
|
2504
|
+
/**
|
|
2505
|
+
* The actual check that is represented by this result. Additional information may be found in other properties of this class, depending on the check.
|
|
2506
|
+
*/
|
|
2507
|
+
'checkType': ValidationCheckType;
|
|
2508
|
+
/**
|
|
2509
|
+
* A human readable message describing the result of the check.
|
|
2510
|
+
*/
|
|
2511
|
+
'message'?: string;
|
|
2512
|
+
/**
|
|
2513
|
+
* For CheckType of types ObjectValidation
|
|
2514
|
+
*/
|
|
2515
|
+
'objectValidationCheckDetails'?: ObjectValidationCheckDetails;
|
|
2516
|
+
/**
|
|
2517
|
+
* For CheckType of types XmlSchemaCheck
|
|
2518
|
+
*/
|
|
2519
|
+
'xmlSchemaValidationCheckDetails'?: XmlSchemaValidationCheckDetails;
|
|
2520
|
+
/**
|
|
2521
|
+
* For CheckType of types ProjectValidation
|
|
2522
|
+
*/
|
|
2523
|
+
'projectValidationCheckDetails'?: ProjectValidationCheckDetails;
|
|
2524
|
+
static discriminator: string | undefined;
|
|
2525
|
+
static attributeTypeMap: Array<{
|
|
2526
|
+
name: string;
|
|
2527
|
+
baseName: string;
|
|
2528
|
+
type: string;
|
|
2529
|
+
}>;
|
|
2530
|
+
static getAttributeTypeMap(): {
|
|
2531
|
+
name: string;
|
|
2532
|
+
baseName: string;
|
|
2533
|
+
type: string;
|
|
2534
|
+
}[];
|
|
2535
|
+
}
|
|
2536
|
+
/**
|
|
2537
|
+
* Enumeration for the different types of checks performed
|
|
2538
|
+
*/
|
|
2539
|
+
export declare class ValidationCheckType {
|
|
2540
|
+
static discriminator: string | undefined;
|
|
2541
|
+
static attributeTypeMap: Array<{
|
|
2542
|
+
name: string;
|
|
2543
|
+
baseName: string;
|
|
2544
|
+
type: string;
|
|
2545
|
+
}>;
|
|
2546
|
+
static getAttributeTypeMap(): {
|
|
2547
|
+
name: string;
|
|
2548
|
+
baseName: string;
|
|
2549
|
+
type: string;
|
|
2550
|
+
}[];
|
|
2551
|
+
}
|
|
2552
|
+
/**
|
|
2553
|
+
* This class represents the result of a validation operation
|
|
2554
|
+
*/
|
|
2555
|
+
export declare class ValidationResult {
|
|
2556
|
+
/**
|
|
2557
|
+
* Indicates if the validation produced no errors
|
|
2558
|
+
*/
|
|
2559
|
+
'isSchemaCompliant': boolean;
|
|
2560
|
+
/**
|
|
2561
|
+
* List of validation check results, which are usually errors
|
|
2562
|
+
*/
|
|
2563
|
+
'checkResults'?: Array<ValidationCheckResult>;
|
|
2564
|
+
/**
|
|
2565
|
+
* The type of the validation that was performed
|
|
2566
|
+
*/
|
|
2567
|
+
'validationType': ValidationType;
|
|
2568
|
+
/**
|
|
2569
|
+
* Name of the validated file
|
|
2570
|
+
*/
|
|
2571
|
+
'fileName'?: string;
|
|
2572
|
+
static discriminator: string | undefined;
|
|
2573
|
+
static attributeTypeMap: Array<{
|
|
2574
|
+
name: string;
|
|
2575
|
+
baseName: string;
|
|
2576
|
+
type: string;
|
|
2577
|
+
}>;
|
|
2578
|
+
static getAttributeTypeMap(): {
|
|
2579
|
+
name: string;
|
|
2580
|
+
baseName: string;
|
|
2581
|
+
type: string;
|
|
2582
|
+
}[];
|
|
2583
|
+
}
|
|
2584
|
+
/**
|
|
2585
|
+
* Indicates the severity of a check
|
|
2586
|
+
*/
|
|
2587
|
+
export declare class ValidationSeverity {
|
|
2588
|
+
static discriminator: string | undefined;
|
|
2589
|
+
static attributeTypeMap: Array<{
|
|
2590
|
+
name: string;
|
|
2591
|
+
baseName: string;
|
|
2592
|
+
type: string;
|
|
2593
|
+
}>;
|
|
2594
|
+
static getAttributeTypeMap(): {
|
|
2595
|
+
name: string;
|
|
2596
|
+
baseName: string;
|
|
2597
|
+
type: string;
|
|
2598
|
+
}[];
|
|
2599
|
+
}
|
|
2600
|
+
/**
|
|
2601
|
+
* This enumeration represents the possible conversion targets when performing a validation
|
|
2602
|
+
*/
|
|
2603
|
+
export declare class ValidationType {
|
|
2604
|
+
static discriminator: string | undefined;
|
|
2605
|
+
static attributeTypeMap: Array<{
|
|
2606
|
+
name: string;
|
|
2607
|
+
baseName: string;
|
|
2608
|
+
type: string;
|
|
2609
|
+
}>;
|
|
2610
|
+
static getAttributeTypeMap(): {
|
|
2611
|
+
name: string;
|
|
2612
|
+
baseName: string;
|
|
2613
|
+
type: string;
|
|
2614
|
+
}[];
|
|
2615
|
+
}
|
|
2616
|
+
/**
|
|
2200
2617
|
* This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months
|
|
2201
2618
|
*/
|
|
2202
2619
|
export declare class WarrantyDurationDto {
|
|
@@ -2220,6 +2637,30 @@ export declare class WarrantyDurationDto {
|
|
|
2220
2637
|
type: string;
|
|
2221
2638
|
}[];
|
|
2222
2639
|
}
|
|
2640
|
+
/**
|
|
2641
|
+
* Check details for an XML schema validation result
|
|
2642
|
+
*/
|
|
2643
|
+
export declare class XmlSchemaValidationCheckDetails {
|
|
2644
|
+
/**
|
|
2645
|
+
* The line number on which the validation happened
|
|
2646
|
+
*/
|
|
2647
|
+
'lineNumber': number;
|
|
2648
|
+
/**
|
|
2649
|
+
* The position in the line
|
|
2650
|
+
*/
|
|
2651
|
+
'linePosition': number;
|
|
2652
|
+
static discriminator: string | undefined;
|
|
2653
|
+
static attributeTypeMap: Array<{
|
|
2654
|
+
name: string;
|
|
2655
|
+
baseName: string;
|
|
2656
|
+
type: string;
|
|
2657
|
+
}>;
|
|
2658
|
+
static getAttributeTypeMap(): {
|
|
2659
|
+
name: string;
|
|
2660
|
+
baseName: string;
|
|
2661
|
+
type: string;
|
|
2662
|
+
}[];
|
|
2663
|
+
}
|
|
2223
2664
|
export interface Authentication {
|
|
2224
2665
|
/**
|
|
2225
2666
|
* Apply authentication settings to header and query params.
|
|
@@ -2297,9 +2738,11 @@ export declare class AslvConversionApi {
|
|
|
2297
2738
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2298
2739
|
* @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.
|
|
2299
2740
|
* @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.
|
|
2741
|
+
* @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.
|
|
2742
|
+
* @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.
|
|
2300
2743
|
* @param {*} [options] Override http request options.
|
|
2301
2744
|
*/
|
|
2302
|
-
aslvConversionConvertToGaeb(aslvFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
2745
|
+
aslvConversionConvertToGaeb(aslvFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2303
2746
|
response: http.IncomingMessage;
|
|
2304
2747
|
body: Buffer;
|
|
2305
2748
|
}>;
|
|
@@ -2310,9 +2753,10 @@ export declare class AslvConversionApi {
|
|
|
2310
2753
|
* @param destinationOenormType Defaults to Lv2015
|
|
2311
2754
|
* @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
|
|
2312
2755
|
* @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.
|
|
2756
|
+
* @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.
|
|
2313
2757
|
* @param {*} [options] Override http request options.
|
|
2314
2758
|
*/
|
|
2315
|
-
aslvConversionConvertToOenorm(aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
2759
|
+
aslvConversionConvertToOenorm(aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2316
2760
|
response: http.IncomingMessage;
|
|
2317
2761
|
body: Buffer;
|
|
2318
2762
|
}>;
|
|
@@ -2338,11 +2782,12 @@ export declare class AvaConversionApi {
|
|
|
2338
2782
|
*
|
|
2339
2783
|
* @summary Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
|
|
2340
2784
|
* @param avaProject The Dangl.AVA project
|
|
2785
|
+
* @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.
|
|
2341
2786
|
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
2342
2787
|
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
2343
2788
|
* @param {*} [options] Override http request options.
|
|
2344
2789
|
*/
|
|
2345
|
-
avaConversionConvertToAva(avaProject: ProjectDto, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2790
|
+
avaConversionConvertToAva(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2346
2791
|
response: http.IncomingMessage;
|
|
2347
2792
|
body: ProjectDto;
|
|
2348
2793
|
}>;
|
|
@@ -2350,12 +2795,13 @@ export declare class AvaConversionApi {
|
|
|
2350
2795
|
*
|
|
2351
2796
|
* @summary Converts Dangl.AVA projects to Excel
|
|
2352
2797
|
* @param avaProject The Dangl.AVA project
|
|
2798
|
+
* @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.
|
|
2353
2799
|
* @param writePrices Defaults to true
|
|
2354
2800
|
* @param writeLongTexts Defaults to true
|
|
2355
2801
|
* @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
|
|
2356
2802
|
* @param {*} [options] Override http request options.
|
|
2357
2803
|
*/
|
|
2358
|
-
avaConversionConvertToExcel(avaProject: ProjectDto, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2804
|
+
avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2359
2805
|
response: http.IncomingMessage;
|
|
2360
2806
|
body: Buffer;
|
|
2361
2807
|
}>;
|
|
@@ -2363,13 +2809,16 @@ export declare class AvaConversionApi {
|
|
|
2363
2809
|
*
|
|
2364
2810
|
* @summary Converts Dangl.AVA projects to GAEB
|
|
2365
2811
|
* @param avaProject The Dangl.AVA project
|
|
2812
|
+
* @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.
|
|
2366
2813
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2367
2814
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2368
2815
|
* @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.
|
|
2369
2816
|
* @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.
|
|
2817
|
+
* @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.
|
|
2818
|
+
* @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.
|
|
2370
2819
|
* @param {*} [options] Override http request options.
|
|
2371
2820
|
*/
|
|
2372
|
-
avaConversionConvertToGaeb(avaProject: ProjectDto, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
2821
|
+
avaConversionConvertToGaeb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2373
2822
|
response: http.IncomingMessage;
|
|
2374
2823
|
body: Buffer;
|
|
2375
2824
|
}>;
|
|
@@ -2377,12 +2826,14 @@ export declare class AvaConversionApi {
|
|
|
2377
2826
|
*
|
|
2378
2827
|
* @summary Converts Dangl.AVA projects to Oenorm
|
|
2379
2828
|
* @param avaProject The Dangl.AVA project
|
|
2829
|
+
* @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.
|
|
2380
2830
|
* @param destinationOenormType Defaults to Lv2015
|
|
2381
2831
|
* @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
|
|
2382
2832
|
* @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.
|
|
2833
|
+
* @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.
|
|
2383
2834
|
* @param {*} [options] Override http request options.
|
|
2384
2835
|
*/
|
|
2385
|
-
avaConversionConvertToOenorm(avaProject: ProjectDto, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
2836
|
+
avaConversionConvertToOenorm(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2386
2837
|
response: http.IncomingMessage;
|
|
2387
2838
|
body: Buffer;
|
|
2388
2839
|
}>;
|
|
@@ -2390,9 +2841,11 @@ export declare class AvaConversionApi {
|
|
|
2390
2841
|
*
|
|
2391
2842
|
* @summary Converts Dangl.AVA projects to REB
|
|
2392
2843
|
* @param avaProject The Dangl.AVA project
|
|
2844
|
+
* @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.
|
|
2845
|
+
* @param destinationRebType Defaults to D11
|
|
2393
2846
|
* @param {*} [options] Override http request options.
|
|
2394
2847
|
*/
|
|
2395
|
-
avaConversionConvertToReb(avaProject: ProjectDto, options?: any): Promise<{
|
|
2848
|
+
avaConversionConvertToReb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32', options?: any): Promise<{
|
|
2396
2849
|
response: http.IncomingMessage;
|
|
2397
2850
|
body: Buffer;
|
|
2398
2851
|
}>;
|
|
@@ -2400,9 +2853,10 @@ export declare class AvaConversionApi {
|
|
|
2400
2853
|
*
|
|
2401
2854
|
* @summary Converts Dangl.AVA projects to SIA 451
|
|
2402
2855
|
* @param avaProject The Dangl.AVA project
|
|
2856
|
+
* @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.
|
|
2403
2857
|
* @param {*} [options] Override http request options.
|
|
2404
2858
|
*/
|
|
2405
|
-
avaConversionConvertToSia(avaProject: ProjectDto, options?: any): Promise<{
|
|
2859
|
+
avaConversionConvertToSia(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
|
|
2406
2860
|
response: http.IncomingMessage;
|
|
2407
2861
|
body: Buffer;
|
|
2408
2862
|
}>;
|
|
@@ -2535,9 +2989,11 @@ export declare class ExcelConversionApi {
|
|
|
2535
2989
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2536
2990
|
* @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.
|
|
2537
2991
|
* @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.
|
|
2992
|
+
* @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.
|
|
2993
|
+
* @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.
|
|
2538
2994
|
* @param {*} [options] Override http request options.
|
|
2539
2995
|
*/
|
|
2540
|
-
excelConversionConvertToGaeb(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
2996
|
+
excelConversionConvertToGaeb(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2541
2997
|
response: http.IncomingMessage;
|
|
2542
2998
|
body: Buffer;
|
|
2543
2999
|
}>;
|
|
@@ -2550,9 +3006,10 @@ export declare class ExcelConversionApi {
|
|
|
2550
3006
|
* @param destinationOenormType Defaults to Lv2015
|
|
2551
3007
|
* @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
|
|
2552
3008
|
* @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.
|
|
3009
|
+
* @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.
|
|
2553
3010
|
* @param {*} [options] Override http request options.
|
|
2554
3011
|
*/
|
|
2555
|
-
excelConversionConvertToOenorm(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
3012
|
+
excelConversionConvertToOenorm(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2556
3013
|
response: http.IncomingMessage;
|
|
2557
3014
|
body: Buffer;
|
|
2558
3015
|
}>;
|
|
@@ -2578,11 +3035,12 @@ export declare class GaebConversionApi {
|
|
|
2578
3035
|
*
|
|
2579
3036
|
* @summary Converts GAEB files to Dangl.AVA projects
|
|
2580
3037
|
* @param gaebFile The input file
|
|
3038
|
+
* @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 levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
2581
3039
|
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
2582
3040
|
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
2583
3041
|
* @param {*} [options] Override http request options.
|
|
2584
3042
|
*/
|
|
2585
|
-
gaebConversionConvertToAva(gaebFile: FileParameter, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
3043
|
+
gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2586
3044
|
response: http.IncomingMessage;
|
|
2587
3045
|
body: ProjectDto;
|
|
2588
3046
|
}>;
|
|
@@ -2590,12 +3048,13 @@ export declare class GaebConversionApi {
|
|
|
2590
3048
|
*
|
|
2591
3049
|
* @summary Converts GAEB files to Excel
|
|
2592
3050
|
* @param gaebFile The input file
|
|
3051
|
+
* @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 levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
2593
3052
|
* @param writePrices Defaults to true
|
|
2594
3053
|
* @param writeLongTexts Defaults to true
|
|
2595
3054
|
* @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
|
|
2596
3055
|
* @param {*} [options] Override http request options.
|
|
2597
3056
|
*/
|
|
2598
|
-
gaebConversionConvertToExcel(gaebFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
3057
|
+
gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2599
3058
|
response: http.IncomingMessage;
|
|
2600
3059
|
body: Buffer;
|
|
2601
3060
|
}>;
|
|
@@ -2603,13 +3062,16 @@ export declare class GaebConversionApi {
|
|
|
2603
3062
|
*
|
|
2604
3063
|
* @summary Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
|
|
2605
3064
|
* @param gaebFile The input file
|
|
3065
|
+
* @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 levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
2606
3066
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2607
3067
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2608
3068
|
* @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.
|
|
2609
3069
|
* @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.
|
|
3070
|
+
* @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.
|
|
3071
|
+
* @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.
|
|
2610
3072
|
* @param {*} [options] Override http request options.
|
|
2611
3073
|
*/
|
|
2612
|
-
gaebConversionConvertToGaeb(gaebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
3074
|
+
gaebConversionConvertToGaeb(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2613
3075
|
response: http.IncomingMessage;
|
|
2614
3076
|
body: Buffer;
|
|
2615
3077
|
}>;
|
|
@@ -2617,12 +3079,14 @@ export declare class GaebConversionApi {
|
|
|
2617
3079
|
*
|
|
2618
3080
|
* @summary Converts GAEB files to Oenorm files
|
|
2619
3081
|
* @param gaebFile The input file
|
|
3082
|
+
* @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 levels - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
2620
3083
|
* @param destinationOenormType Defaults to Lv2015
|
|
2621
3084
|
* @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
|
|
2622
3085
|
* @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.
|
|
3086
|
+
* @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.
|
|
2623
3087
|
* @param {*} [options] Override http request options.
|
|
2624
3088
|
*/
|
|
2625
|
-
gaebConversionConvertToOenorm(gaebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
3089
|
+
gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2626
3090
|
response: http.IncomingMessage;
|
|
2627
3091
|
body: Buffer;
|
|
2628
3092
|
}>;
|
|
@@ -2677,9 +3141,11 @@ export declare class OenormConversionApi {
|
|
|
2677
3141
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2678
3142
|
* @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.
|
|
2679
3143
|
* @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.
|
|
3144
|
+
* @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.
|
|
3145
|
+
* @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.
|
|
2680
3146
|
* @param {*} [options] Override http request options.
|
|
2681
3147
|
*/
|
|
2682
|
-
oenormConversionConvertToGaeb(oenormFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
3148
|
+
oenormConversionConvertToGaeb(oenormFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2683
3149
|
response: http.IncomingMessage;
|
|
2684
3150
|
body: Buffer;
|
|
2685
3151
|
}>;
|
|
@@ -2690,9 +3156,10 @@ export declare class OenormConversionApi {
|
|
|
2690
3156
|
* @param destinationOenormType Defaults to Lv2015
|
|
2691
3157
|
* @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
|
|
2692
3158
|
* @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.
|
|
3159
|
+
* @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.
|
|
2693
3160
|
* @param {*} [options] Override http request options.
|
|
2694
3161
|
*/
|
|
2695
|
-
oenormConversionConvertToOenorm(oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
3162
|
+
oenormConversionConvertToOenorm(oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2696
3163
|
response: http.IncomingMessage;
|
|
2697
3164
|
body: Buffer;
|
|
2698
3165
|
}>;
|
|
@@ -2747,9 +3214,11 @@ export declare class RebConversionApi {
|
|
|
2747
3214
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2748
3215
|
* @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.
|
|
2749
3216
|
* @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.
|
|
3217
|
+
* @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.
|
|
3218
|
+
* @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.
|
|
2750
3219
|
* @param {*} [options] Override http request options.
|
|
2751
3220
|
*/
|
|
2752
|
-
rebConversionConvertToGaeb(rebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
3221
|
+
rebConversionConvertToGaeb(rebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2753
3222
|
response: http.IncomingMessage;
|
|
2754
3223
|
body: Buffer;
|
|
2755
3224
|
}>;
|
|
@@ -2760,9 +3229,10 @@ export declare class RebConversionApi {
|
|
|
2760
3229
|
* @param destinationOenormType Defaults to Lv2015
|
|
2761
3230
|
* @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
|
|
2762
3231
|
* @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.
|
|
3232
|
+
* @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.
|
|
2763
3233
|
* @param {*} [options] Override http request options.
|
|
2764
3234
|
*/
|
|
2765
|
-
rebConversionConvertToOenorm(rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
3235
|
+
rebConversionConvertToOenorm(rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2766
3236
|
response: http.IncomingMessage;
|
|
2767
3237
|
body: Buffer;
|
|
2768
3238
|
}>;
|
|
@@ -2817,9 +3287,11 @@ export declare class SiaConversionApi {
|
|
|
2817
3287
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2818
3288
|
* @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.
|
|
2819
3289
|
* @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.
|
|
3290
|
+
* @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.
|
|
3291
|
+
* @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.
|
|
2820
3292
|
* @param {*} [options] Override http request options.
|
|
2821
3293
|
*/
|
|
2822
|
-
siaConversionConvertToGaeb(siaFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, options?: any): Promise<{
|
|
3294
|
+
siaConversionConvertToGaeb(siaFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options?: any): Promise<{
|
|
2823
3295
|
response: http.IncomingMessage;
|
|
2824
3296
|
body: Buffer;
|
|
2825
3297
|
}>;
|
|
@@ -2830,9 +3302,10 @@ export declare class SiaConversionApi {
|
|
|
2830
3302
|
* @param destinationOenormType Defaults to Lv2015
|
|
2831
3303
|
* @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
|
|
2832
3304
|
* @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.
|
|
3305
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
|
|
2833
3306
|
* @param {*} [options] Override http request options.
|
|
2834
3307
|
*/
|
|
2835
|
-
siaConversionConvertToOenorm(siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, options?: any): Promise<{
|
|
3308
|
+
siaConversionConvertToOenorm(siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2836
3309
|
response: http.IncomingMessage;
|
|
2837
3310
|
body: Buffer;
|
|
2838
3311
|
}>;
|
|
@@ -2864,6 +3337,45 @@ export declare class StatusApi {
|
|
|
2864
3337
|
body: GetStatus;
|
|
2865
3338
|
}>;
|
|
2866
3339
|
}
|
|
3340
|
+
export declare enum ValidationApiApiKeys {
|
|
3341
|
+
}
|
|
3342
|
+
export declare class ValidationApi {
|
|
3343
|
+
protected _basePath: string;
|
|
3344
|
+
protected defaultHeaders: any;
|
|
3345
|
+
protected _useQuerystring: boolean;
|
|
3346
|
+
protected authentications: {
|
|
3347
|
+
default: Authentication;
|
|
3348
|
+
'Dangl.Identity': OAuth;
|
|
3349
|
+
};
|
|
3350
|
+
constructor(basePath?: string);
|
|
3351
|
+
set useQuerystring(value: boolean);
|
|
3352
|
+
set basePath(basePath: string);
|
|
3353
|
+
get basePath(): string;
|
|
3354
|
+
setDefaultAuthentication(auth: Authentication): void;
|
|
3355
|
+
setApiKey(key: ValidationApiApiKeys, value: string): void;
|
|
3356
|
+
set accessToken(token: string);
|
|
3357
|
+
/**
|
|
3358
|
+
*
|
|
3359
|
+
* @summary This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided as a query parameter, since there is no auto detection of the uploaded file type.
|
|
3360
|
+
* @param avaFile The file to validate
|
|
3361
|
+
* @param fileValidationSourceType You need to indicate which type of file is being provided, there is no auto detection mechanism
|
|
3362
|
+
* @param {*} [options] Override http request options.
|
|
3363
|
+
*/
|
|
3364
|
+
validationValidateFile(avaFile: FileParameter, fileValidationSourceType?: 'Gaeb' | 'Oenorm', options?: any): Promise<{
|
|
3365
|
+
response: http.IncomingMessage;
|
|
3366
|
+
body: ValidationResult;
|
|
3367
|
+
}>;
|
|
3368
|
+
/**
|
|
3369
|
+
*
|
|
3370
|
+
* @summary This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase into account and do some general project validation. Optionally, a conversion to a desired target can also be done, in which case the target file will also be validated.
|
|
3371
|
+
* @param avaProjectValidationSourceOptions The options used for the validation operation
|
|
3372
|
+
* @param {*} [options] Override http request options.
|
|
3373
|
+
*/
|
|
3374
|
+
validationValidateProject(avaProjectValidationSourceOptions: PostAvaProjectValidationSourceOptions, options?: any): Promise<{
|
|
3375
|
+
response: http.IncomingMessage;
|
|
3376
|
+
body: ValidationResult;
|
|
3377
|
+
}>;
|
|
3378
|
+
}
|
|
2867
3379
|
export interface FileParameter {
|
|
2868
3380
|
value: Buffer;
|
|
2869
3381
|
options: {
|