@dangl/avacloud-client-node 1.13.0 → 1.16.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 +295 -25
- package/api.js +435 -30
- package/api.js.map +1 -1
- package/api.ts +641 -32
- package/package.json +1 -1
package/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AVACloud API 1.
|
|
2
|
+
* AVACloud API 1.26.0
|
|
3
3
|
* AVACloud API specification
|
|
4
4
|
*
|
|
5
|
-
* OpenAPI spec version: 1.
|
|
5
|
+
* OpenAPI spec version: 1.26.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 {
|
|
@@ -182,6 +198,14 @@ export declare class CalculationDto {
|
|
|
182
198
|
* Will be -1 if the Formula is correct, else it will show the position in the formula where an error was encountered. This is a zero based index.
|
|
183
199
|
*/
|
|
184
200
|
'errorPositionInLine': number;
|
|
201
|
+
/**
|
|
202
|
+
* These are Catalogues that are used within this Calculation. 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.
|
|
203
|
+
*/
|
|
204
|
+
'projectCatalogues'?: Array<CatalogueDto>;
|
|
205
|
+
/**
|
|
206
|
+
* Referenced catalogues for this Calculation.
|
|
207
|
+
*/
|
|
208
|
+
'catalogueReferences'?: Array<CatalogueReferenceDto>;
|
|
185
209
|
static discriminator: string | undefined;
|
|
186
210
|
static attributeTypeMap: Array<{
|
|
187
211
|
name: string;
|
|
@@ -450,6 +474,10 @@ export declare class IElementDto {
|
|
|
450
474
|
* 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.
|
|
451
475
|
*/
|
|
452
476
|
'gaebXmlId'?: string;
|
|
477
|
+
/**
|
|
478
|
+
* This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
|
|
479
|
+
*/
|
|
480
|
+
'addendumNumber'?: string;
|
|
453
481
|
'elementTypeDiscriminator': string;
|
|
454
482
|
static discriminator: string | undefined;
|
|
455
483
|
static attributeTypeMap: Array<{
|
|
@@ -624,6 +652,14 @@ export declare class ItemNumberDto {
|
|
|
624
652
|
* This indicates if this item number is at the lot level. Find out more about lots in the documentation.
|
|
625
653
|
*/
|
|
626
654
|
'isLot': boolean;
|
|
655
|
+
/**
|
|
656
|
+
* 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.
|
|
657
|
+
*/
|
|
658
|
+
'hierarchyLevel': number;
|
|
659
|
+
/**
|
|
660
|
+
* This property indicates if this ItemNumber is attached to an object of the Position type.
|
|
661
|
+
*/
|
|
662
|
+
'isAttachedToPosition': boolean;
|
|
627
663
|
static discriminator: string | undefined;
|
|
628
664
|
static attributeTypeMap: Array<{
|
|
629
665
|
name: string;
|
|
@@ -648,6 +684,30 @@ export declare class ItemNumberSchemaDto {
|
|
|
648
684
|
* The collection of tiers for this ItemNumberSchema.
|
|
649
685
|
*/
|
|
650
686
|
'tiers'?: Array<ItemNumberSchemaTierDto>;
|
|
687
|
+
/**
|
|
688
|
+
* The separator to use for separiting the different levels in an ItemNumber. Defaults to DEFAULT_SEPARATOR, which is a point '.'. Setting this to a space or other whitespaces is discouraged, as this might not work correct in all situations and item numbers could be displayed not as intended. This can not be set to an empty or null string, trying that will default to the DEFAULT_SEPARATOR. If a value is set that has a different length than one '1', the DEFAULT_SEPARATOR will be used instead. You should also not use values for the separator that are also valid for the item numbers themselves, as that might also lead to incorrect results
|
|
689
|
+
*/
|
|
690
|
+
'separator'?: string;
|
|
691
|
+
/**
|
|
692
|
+
* 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.
|
|
693
|
+
*/
|
|
694
|
+
'filler'?: string;
|
|
695
|
+
/**
|
|
696
|
+
* 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.
|
|
697
|
+
*/
|
|
698
|
+
'identifier'?: string;
|
|
699
|
+
/**
|
|
700
|
+
* 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.
|
|
701
|
+
*/
|
|
702
|
+
'skipNonExistingLevelsInPositionItemNumbers': boolean;
|
|
703
|
+
/**
|
|
704
|
+
* 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.
|
|
705
|
+
*/
|
|
706
|
+
'skippedTiersFiller'?: string;
|
|
707
|
+
/**
|
|
708
|
+
* 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.
|
|
709
|
+
*/
|
|
710
|
+
'schemaIsCorrectlyDefined': boolean;
|
|
651
711
|
static discriminator: string | undefined;
|
|
652
712
|
static attributeTypeMap: Array<{
|
|
653
713
|
name: string;
|
|
@@ -680,6 +740,14 @@ export declare class ItemNumberSchemaTierDto {
|
|
|
680
740
|
* Indicates if this tier represents a lot. See the documentation for more information about lots.
|
|
681
741
|
*/
|
|
682
742
|
'isLot': boolean;
|
|
743
|
+
/**
|
|
744
|
+
* This value is the increment, or step size, that should be used for new item numbers. It defaults to DEFAULT_INCREMENT, but can be changed to any other positive number greater than zero. Invalid values make this be set to one '1'
|
|
745
|
+
*/
|
|
746
|
+
'increment': number;
|
|
747
|
+
/**
|
|
748
|
+
* This is an optional name for the given tier
|
|
749
|
+
*/
|
|
750
|
+
'tierName'?: string;
|
|
683
751
|
static discriminator: string | undefined;
|
|
684
752
|
static attributeTypeMap: Array<{
|
|
685
753
|
name: string;
|
|
@@ -752,6 +820,10 @@ export declare class LabourPriceComponentDto {
|
|
|
752
820
|
* The total, calculated time of this component. Will return the result rounded to three decimal places.
|
|
753
821
|
*/
|
|
754
822
|
'totalTime': number;
|
|
823
|
+
/**
|
|
824
|
+
* These are Catalogues that are used within this PriceComponent. 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.
|
|
825
|
+
*/
|
|
826
|
+
'projectCatalogues'?: Array<CatalogueDto>;
|
|
755
827
|
static discriminator: string | undefined;
|
|
756
828
|
static attributeTypeMap: Array<{
|
|
757
829
|
name: string;
|
|
@@ -814,6 +886,106 @@ export declare class NoteTextDto extends IElementDto {
|
|
|
814
886
|
*/
|
|
815
887
|
'standardizedDescription'?: StandardizedDescriptionDto;
|
|
816
888
|
'elementType'?: string;
|
|
889
|
+
/**
|
|
890
|
+
* 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.
|
|
891
|
+
*/
|
|
892
|
+
'descriptionId'?: string;
|
|
893
|
+
/**
|
|
894
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts.
|
|
895
|
+
*/
|
|
896
|
+
'oenormNoteTextProperties'?: OenormNoteTextPropertiesDto;
|
|
897
|
+
static discriminator: string | undefined;
|
|
898
|
+
static attributeTypeMap: Array<{
|
|
899
|
+
name: string;
|
|
900
|
+
baseName: string;
|
|
901
|
+
type: string;
|
|
902
|
+
}>;
|
|
903
|
+
static getAttributeTypeMap(): {
|
|
904
|
+
name: string;
|
|
905
|
+
baseName: string;
|
|
906
|
+
type: string;
|
|
907
|
+
}[];
|
|
908
|
+
}
|
|
909
|
+
/**
|
|
910
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts.
|
|
911
|
+
*/
|
|
912
|
+
export declare class OenormNoteTextPropertiesDto {
|
|
913
|
+
/**
|
|
914
|
+
* This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm
|
|
915
|
+
*/
|
|
916
|
+
'originCode': OenormOriginCodeDto;
|
|
917
|
+
static discriminator: string | undefined;
|
|
918
|
+
static attributeTypeMap: Array<{
|
|
919
|
+
name: string;
|
|
920
|
+
baseName: string;
|
|
921
|
+
type: string;
|
|
922
|
+
}>;
|
|
923
|
+
static getAttributeTypeMap(): {
|
|
924
|
+
name: string;
|
|
925
|
+
baseName: string;
|
|
926
|
+
type: string;
|
|
927
|
+
}[];
|
|
928
|
+
}
|
|
929
|
+
/**
|
|
930
|
+
* This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm
|
|
931
|
+
*/
|
|
932
|
+
export declare class OenormOriginCodeDto {
|
|
933
|
+
static discriminator: string | undefined;
|
|
934
|
+
static attributeTypeMap: Array<{
|
|
935
|
+
name: string;
|
|
936
|
+
baseName: string;
|
|
937
|
+
type: string;
|
|
938
|
+
}>;
|
|
939
|
+
static getAttributeTypeMap(): {
|
|
940
|
+
name: string;
|
|
941
|
+
baseName: string;
|
|
942
|
+
type: string;
|
|
943
|
+
}[];
|
|
944
|
+
}
|
|
945
|
+
/**
|
|
946
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class.
|
|
947
|
+
*/
|
|
948
|
+
export declare class OenormPositionPropertiesDto {
|
|
949
|
+
/**
|
|
950
|
+
* This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm
|
|
951
|
+
*/
|
|
952
|
+
'originCode': OenormOriginCodeDto;
|
|
953
|
+
/**
|
|
954
|
+
* This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm.
|
|
955
|
+
*/
|
|
956
|
+
'openingTextIsFreeText': boolean;
|
|
957
|
+
/**
|
|
958
|
+
* This indicates if the ÖNorm 'wesentliche position' mark is set
|
|
959
|
+
*/
|
|
960
|
+
'isMainPosition': boolean;
|
|
961
|
+
/**
|
|
962
|
+
* 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
|
|
963
|
+
*/
|
|
964
|
+
'isUndividedPosition': boolean;
|
|
965
|
+
static discriminator: string | undefined;
|
|
966
|
+
static attributeTypeMap: Array<{
|
|
967
|
+
name: string;
|
|
968
|
+
baseName: string;
|
|
969
|
+
type: string;
|
|
970
|
+
}>;
|
|
971
|
+
static getAttributeTypeMap(): {
|
|
972
|
+
name: string;
|
|
973
|
+
baseName: string;
|
|
974
|
+
type: string;
|
|
975
|
+
}[];
|
|
976
|
+
}
|
|
977
|
+
/**
|
|
978
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used.
|
|
979
|
+
*/
|
|
980
|
+
export declare class OenormPropertiesDto {
|
|
981
|
+
/**
|
|
982
|
+
* This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm
|
|
983
|
+
*/
|
|
984
|
+
'originCode': OenormOriginCodeDto;
|
|
985
|
+
/**
|
|
986
|
+
* This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm.
|
|
987
|
+
*/
|
|
988
|
+
'openingTextIsFreeText': boolean;
|
|
817
989
|
static discriminator: string | undefined;
|
|
818
990
|
static attributeTypeMap: Array<{
|
|
819
991
|
name: string;
|
|
@@ -1020,7 +1192,7 @@ export declare class PositionDto extends IElementDto {
|
|
|
1020
1192
|
*/
|
|
1021
1193
|
'totalPriceGrossDeducted': number;
|
|
1022
1194
|
/**
|
|
1023
|
-
* Net price after applied deductions.
|
|
1195
|
+
* Net price after applied deductions. Please be aware that this is the total price, from TotalPrice, not the unit price of the position.
|
|
1024
1196
|
*/
|
|
1025
1197
|
'deductedPrice': number;
|
|
1026
1198
|
/**
|
|
@@ -1065,10 +1237,18 @@ export declare class PositionDto extends IElementDto {
|
|
|
1065
1237
|
*/
|
|
1066
1238
|
'commerceProperties'?: CommercePropertiesDto;
|
|
1067
1239
|
/**
|
|
1068
|
-
* If this position is an Alternative, then this property should point to the id of the position in this service specification that it can replace.
|
|
1240
|
+
* If this position is an Alternative, then this property should point to the id of the position in this service specification that it can replace. If this is set to a value, you can optionally also specify an identifier via AlternativeIdentifier to specifiy multiple positions that must be used together to be an alternative to a single base position.
|
|
1069
1241
|
*/
|
|
1070
1242
|
'alternativeTo'?: string;
|
|
1071
1243
|
/**
|
|
1244
|
+
* This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific position is assigned to. That way, if you specifiy multiple alternative Positions with the same AlternativeIdentifier, you can indicate that to replace a single base Position, multiple alternative Positions 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 position via AlternativeTo.
|
|
1245
|
+
*/
|
|
1246
|
+
'alternativeIdentifier'?: number;
|
|
1247
|
+
/**
|
|
1248
|
+
* 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 position is assigned to. That way, you can specify the id (in integer format) for the alternative group this position 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 position only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base position for a specific group. This was introduced in version v2.9.0 to be able to model both position and group ids for alternative group combinations. 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 position via AlternativeTo.
|
|
1249
|
+
*/
|
|
1250
|
+
'alternativeGroupIdentifier'?: number;
|
|
1251
|
+
/**
|
|
1072
1252
|
* If this is true, it indicates that the position is intended to be a lump sum, \"Pauschal\" in German. This means the position total price that is being invoiced should not depend on the actual quantity. In practice, partial invoices are still often used for partial services rendered. This property does not affect the price calculation for this position. Typically, the Quantity should be set to 1.0 when this flag is used.
|
|
1073
1253
|
*/
|
|
1074
1254
|
'isLumpSum': boolean;
|
|
@@ -1097,6 +1277,26 @@ export declare class PositionDto extends IElementDto {
|
|
|
1097
1277
|
* This identifier can be used to point to the Id of an ExecutionDescription in the same ServiceSpecification. ExecutionDescriptions act as a way to centrally describe how positions should be executed in practice. Often, the position itself still has text of its own to highlight deviations from that or add more details.
|
|
1098
1278
|
*/
|
|
1099
1279
|
'executionDescriptionReference'?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* This indicates if a position has not been offered. This is typically only expected to be true when the exchange phase of the parent ServiceSpecification is Offer, and it means that the position has not been offered at all.
|
|
1282
|
+
*/
|
|
1283
|
+
'notOffered': boolean;
|
|
1284
|
+
/**
|
|
1285
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class.
|
|
1286
|
+
*/
|
|
1287
|
+
'oenormPositionProperties'?: OenormPositionPropertiesDto;
|
|
1288
|
+
/**
|
|
1289
|
+
* 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.
|
|
1290
|
+
*/
|
|
1291
|
+
'descriptionId'?: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* 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.
|
|
1294
|
+
*/
|
|
1295
|
+
'hierarchyLevel': number;
|
|
1296
|
+
/**
|
|
1297
|
+
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
1298
|
+
*/
|
|
1299
|
+
'addendumStatus'?: AddendumStatusDto;
|
|
1100
1300
|
static discriminator: string | undefined;
|
|
1101
1301
|
static attributeTypeMap: Array<{
|
|
1102
1302
|
name: string;
|
|
@@ -1141,6 +1341,10 @@ export declare class PriceComponentDto {
|
|
|
1141
1341
|
* The single Calculation elements this price component is composed of.
|
|
1142
1342
|
*/
|
|
1143
1343
|
'values'?: Array<CalculationDto>;
|
|
1344
|
+
/**
|
|
1345
|
+
* These are Catalogues that are used within this PriceComponent. 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.
|
|
1346
|
+
*/
|
|
1347
|
+
'projectCatalogues'?: Array<CatalogueDto>;
|
|
1144
1348
|
static discriminator: string | undefined;
|
|
1145
1349
|
static attributeTypeMap: Array<{
|
|
1146
1350
|
name: string;
|
|
@@ -1712,6 +1916,14 @@ export declare class ServiceSpecificationDto {
|
|
|
1712
1916
|
* This should specify how the approval is performed by the buyer. This matches \"AcceptType\" in GAEB
|
|
1713
1917
|
*/
|
|
1714
1918
|
'typeOfApproval'?: string;
|
|
1919
|
+
/**
|
|
1920
|
+
* This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
|
|
1921
|
+
*/
|
|
1922
|
+
'addendumNumber'?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
1925
|
+
*/
|
|
1926
|
+
'addendumStatus'?: AddendumStatusDto;
|
|
1715
1927
|
static discriminator: string | undefined;
|
|
1716
1928
|
static attributeTypeMap: Array<{
|
|
1717
1929
|
name: string;
|
|
@@ -1827,6 +2039,18 @@ export declare class ServiceSpecificationGroupDto extends IElementDto {
|
|
|
1827
2039
|
* Referenced catalogues for this QuantityAssignment.
|
|
1828
2040
|
*/
|
|
1829
2041
|
'catalogueReferences'?: Array<CatalogueReferenceDto>;
|
|
2042
|
+
/**
|
|
2043
|
+
* This class models special properties that only apply to some exchange scenarios where ÖNorm is used.
|
|
2044
|
+
*/
|
|
2045
|
+
'oenormProperties'?: OenormPropertiesDto;
|
|
2046
|
+
/**
|
|
2047
|
+
* 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.
|
|
2048
|
+
*/
|
|
2049
|
+
'hierarchyLevel': number;
|
|
2050
|
+
/**
|
|
2051
|
+
* This indicates, if this element is part of an addendum an, if yes, with what status.
|
|
2052
|
+
*/
|
|
2053
|
+
'addendumStatus'?: AddendumStatusDto;
|
|
1830
2054
|
static discriminator: string | undefined;
|
|
1831
2055
|
static attributeTypeMap: Array<{
|
|
1832
2056
|
name: string;
|
|
@@ -1963,6 +2187,14 @@ export declare class SubDescriptionDto {
|
|
|
1963
2187
|
* This identifier can be used to point to the Id of an ExecutionDescription in the same ServiceSpecification. ExecutionDescriptions act as a way to centrally describe how positions (or sub descriptions) should be executed in practice. Often, the position (or sub description) itself still has text of its own to highlight deviations from that or add more details. When working with import and export features, this property is only supported in GAEB 90 data exchange.
|
|
1964
2188
|
*/
|
|
1965
2189
|
'executionDescriptionReference'?: string;
|
|
2190
|
+
/**
|
|
2191
|
+
* These are Catalogues that are used within this Calculation. 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.
|
|
2192
|
+
*/
|
|
2193
|
+
'projectCatalogues'?: Array<CatalogueDto>;
|
|
2194
|
+
/**
|
|
2195
|
+
* 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.
|
|
2196
|
+
*/
|
|
2197
|
+
'descriptionId'?: string;
|
|
1966
2198
|
static discriminator: string | undefined;
|
|
1967
2199
|
static attributeTypeMap: Array<{
|
|
1968
2200
|
name: string;
|
|
@@ -2061,7 +2293,7 @@ export declare class TradeDiscountDto {
|
|
|
2061
2293
|
*/
|
|
2062
2294
|
export declare class WarrantyDurationDto {
|
|
2063
2295
|
/**
|
|
2064
|
-
* The scalar value of the duration. This value must be equal to or bigger than zero (
|
|
2296
|
+
* The scalar value of the duration. This value must be equal to or bigger than zero (>= 0). Negative values can not be set and will be ignored.
|
|
2065
2297
|
*/
|
|
2066
2298
|
'duration': number;
|
|
2067
2299
|
/**
|
|
@@ -2156,9 +2388,11 @@ export declare class AslvConversionApi {
|
|
|
2156
2388
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2157
2389
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2158
2390
|
* @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.
|
|
2391
|
+
* @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.
|
|
2392
|
+
* @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.
|
|
2159
2393
|
* @param {*} [options] Override http request options.
|
|
2160
2394
|
*/
|
|
2161
|
-
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, options?: any): Promise<{
|
|
2395
|
+
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, options?: any): Promise<{
|
|
2162
2396
|
response: http.IncomingMessage;
|
|
2163
2397
|
body: Buffer;
|
|
2164
2398
|
}>;
|
|
@@ -2168,9 +2402,11 @@ export declare class AslvConversionApi {
|
|
|
2168
2402
|
* @param aslvFile The input file
|
|
2169
2403
|
* @param destinationOenormType Defaults to Lv2015
|
|
2170
2404
|
* @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
|
|
2405
|
+
* @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.
|
|
2406
|
+
* @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.
|
|
2171
2407
|
* @param {*} [options] Override http request options.
|
|
2172
2408
|
*/
|
|
2173
|
-
aslvConversionConvertToOenorm(aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2409
|
+
aslvConversionConvertToOenorm(aslvFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2174
2410
|
response: http.IncomingMessage;
|
|
2175
2411
|
body: Buffer;
|
|
2176
2412
|
}>;
|
|
@@ -2196,11 +2432,12 @@ export declare class AvaConversionApi {
|
|
|
2196
2432
|
*
|
|
2197
2433
|
* @summary Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
|
|
2198
2434
|
* @param avaProject The Dangl.AVA project
|
|
2435
|
+
* @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.
|
|
2199
2436
|
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
2200
2437
|
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
2201
2438
|
* @param {*} [options] Override http request options.
|
|
2202
2439
|
*/
|
|
2203
|
-
avaConversionConvertToAva(avaProject: ProjectDto, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2440
|
+
avaConversionConvertToAva(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2204
2441
|
response: http.IncomingMessage;
|
|
2205
2442
|
body: ProjectDto;
|
|
2206
2443
|
}>;
|
|
@@ -2208,12 +2445,13 @@ export declare class AvaConversionApi {
|
|
|
2208
2445
|
*
|
|
2209
2446
|
* @summary Converts Dangl.AVA projects to Excel
|
|
2210
2447
|
* @param avaProject The Dangl.AVA project
|
|
2448
|
+
* @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.
|
|
2211
2449
|
* @param writePrices Defaults to true
|
|
2212
2450
|
* @param writeLongTexts Defaults to true
|
|
2213
2451
|
* @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
|
|
2214
2452
|
* @param {*} [options] Override http request options.
|
|
2215
2453
|
*/
|
|
2216
|
-
avaConversionConvertToExcel(avaProject: ProjectDto, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2454
|
+
avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2217
2455
|
response: http.IncomingMessage;
|
|
2218
2456
|
body: Buffer;
|
|
2219
2457
|
}>;
|
|
@@ -2221,12 +2459,15 @@ export declare class AvaConversionApi {
|
|
|
2221
2459
|
*
|
|
2222
2460
|
* @summary Converts Dangl.AVA projects to GAEB
|
|
2223
2461
|
* @param avaProject The Dangl.AVA project
|
|
2462
|
+
* @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.
|
|
2224
2463
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2225
2464
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2226
2465
|
* @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.
|
|
2466
|
+
* @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.
|
|
2467
|
+
* @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.
|
|
2227
2468
|
* @param {*} [options] Override http request options.
|
|
2228
2469
|
*/
|
|
2229
|
-
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, options?: any): Promise<{
|
|
2470
|
+
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, options?: any): Promise<{
|
|
2230
2471
|
response: http.IncomingMessage;
|
|
2231
2472
|
body: Buffer;
|
|
2232
2473
|
}>;
|
|
@@ -2234,11 +2475,14 @@ export declare class AvaConversionApi {
|
|
|
2234
2475
|
*
|
|
2235
2476
|
* @summary Converts Dangl.AVA projects to Oenorm
|
|
2236
2477
|
* @param avaProject The Dangl.AVA project
|
|
2478
|
+
* @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.
|
|
2237
2479
|
* @param destinationOenormType Defaults to Lv2015
|
|
2238
2480
|
* @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
|
|
2481
|
+
* @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.
|
|
2482
|
+
* @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.
|
|
2239
2483
|
* @param {*} [options] Override http request options.
|
|
2240
2484
|
*/
|
|
2241
|
-
avaConversionConvertToOenorm(avaProject: ProjectDto, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2485
|
+
avaConversionConvertToOenorm(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2242
2486
|
response: http.IncomingMessage;
|
|
2243
2487
|
body: Buffer;
|
|
2244
2488
|
}>;
|
|
@@ -2246,9 +2490,10 @@ export declare class AvaConversionApi {
|
|
|
2246
2490
|
*
|
|
2247
2491
|
* @summary Converts Dangl.AVA projects to REB
|
|
2248
2492
|
* @param avaProject The Dangl.AVA project
|
|
2493
|
+
* @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.
|
|
2249
2494
|
* @param {*} [options] Override http request options.
|
|
2250
2495
|
*/
|
|
2251
|
-
avaConversionConvertToReb(avaProject: ProjectDto, options?: any): Promise<{
|
|
2496
|
+
avaConversionConvertToReb(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
|
|
2252
2497
|
response: http.IncomingMessage;
|
|
2253
2498
|
body: Buffer;
|
|
2254
2499
|
}>;
|
|
@@ -2256,9 +2501,10 @@ export declare class AvaConversionApi {
|
|
|
2256
2501
|
*
|
|
2257
2502
|
* @summary Converts Dangl.AVA projects to SIA 451
|
|
2258
2503
|
* @param avaProject The Dangl.AVA project
|
|
2504
|
+
* @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.
|
|
2259
2505
|
* @param {*} [options] Override http request options.
|
|
2260
2506
|
*/
|
|
2261
|
-
avaConversionConvertToSia(avaProject: ProjectDto, options?: any): Promise<{
|
|
2507
|
+
avaConversionConvertToSia(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
|
|
2262
2508
|
response: http.IncomingMessage;
|
|
2263
2509
|
body: Buffer;
|
|
2264
2510
|
}>;
|
|
@@ -2390,9 +2636,11 @@ export declare class ExcelConversionApi {
|
|
|
2390
2636
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2391
2637
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2392
2638
|
* @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.
|
|
2639
|
+
* @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.
|
|
2640
|
+
* @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.
|
|
2393
2641
|
* @param {*} [options] Override http request options.
|
|
2394
2642
|
*/
|
|
2395
|
-
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, options?: any): Promise<{
|
|
2643
|
+
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, options?: any): Promise<{
|
|
2396
2644
|
response: http.IncomingMessage;
|
|
2397
2645
|
body: Buffer;
|
|
2398
2646
|
}>;
|
|
@@ -2404,9 +2652,11 @@ export declare class ExcelConversionApi {
|
|
|
2404
2652
|
* @param rebuildItemNumberSchema When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
|
|
2405
2653
|
* @param destinationOenormType Defaults to Lv2015
|
|
2406
2654
|
* @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
|
|
2655
|
+
* @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.
|
|
2656
|
+
* @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.
|
|
2407
2657
|
* @param {*} [options] Override http request options.
|
|
2408
2658
|
*/
|
|
2409
|
-
excelConversionConvertToOenorm(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2659
|
+
excelConversionConvertToOenorm(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2410
2660
|
response: http.IncomingMessage;
|
|
2411
2661
|
body: Buffer;
|
|
2412
2662
|
}>;
|
|
@@ -2432,11 +2682,12 @@ export declare class GaebConversionApi {
|
|
|
2432
2682
|
*
|
|
2433
2683
|
* @summary Converts GAEB files to Dangl.AVA projects
|
|
2434
2684
|
* @param gaebFile The input file
|
|
2685
|
+
* @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.
|
|
2435
2686
|
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
2436
2687
|
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
2437
2688
|
* @param {*} [options] Override http request options.
|
|
2438
2689
|
*/
|
|
2439
|
-
gaebConversionConvertToAva(gaebFile: FileParameter, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2690
|
+
gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
2440
2691
|
response: http.IncomingMessage;
|
|
2441
2692
|
body: ProjectDto;
|
|
2442
2693
|
}>;
|
|
@@ -2444,12 +2695,13 @@ export declare class GaebConversionApi {
|
|
|
2444
2695
|
*
|
|
2445
2696
|
* @summary Converts GAEB files to Excel
|
|
2446
2697
|
* @param gaebFile The input file
|
|
2698
|
+
* @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.
|
|
2447
2699
|
* @param writePrices Defaults to true
|
|
2448
2700
|
* @param writeLongTexts Defaults to true
|
|
2449
2701
|
* @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
|
|
2450
2702
|
* @param {*} [options] Override http request options.
|
|
2451
2703
|
*/
|
|
2452
|
-
gaebConversionConvertToExcel(gaebFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2704
|
+
gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
|
|
2453
2705
|
response: http.IncomingMessage;
|
|
2454
2706
|
body: Buffer;
|
|
2455
2707
|
}>;
|
|
@@ -2457,12 +2709,15 @@ export declare class GaebConversionApi {
|
|
|
2457
2709
|
*
|
|
2458
2710
|
* @summary Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
|
|
2459
2711
|
* @param gaebFile The input file
|
|
2712
|
+
* @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.
|
|
2460
2713
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2461
2714
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2462
2715
|
* @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.
|
|
2716
|
+
* @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.
|
|
2717
|
+
* @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.
|
|
2463
2718
|
* @param {*} [options] Override http request options.
|
|
2464
2719
|
*/
|
|
2465
|
-
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, options?: any): Promise<{
|
|
2720
|
+
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, options?: any): Promise<{
|
|
2466
2721
|
response: http.IncomingMessage;
|
|
2467
2722
|
body: Buffer;
|
|
2468
2723
|
}>;
|
|
@@ -2470,11 +2725,14 @@ export declare class GaebConversionApi {
|
|
|
2470
2725
|
*
|
|
2471
2726
|
* @summary Converts GAEB files to Oenorm files
|
|
2472
2727
|
* @param gaebFile The input file
|
|
2728
|
+
* @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.
|
|
2473
2729
|
* @param destinationOenormType Defaults to Lv2015
|
|
2474
2730
|
* @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
|
|
2731
|
+
* @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.
|
|
2732
|
+
* @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.
|
|
2475
2733
|
* @param {*} [options] Override http request options.
|
|
2476
2734
|
*/
|
|
2477
|
-
gaebConversionConvertToOenorm(gaebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2735
|
+
gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2478
2736
|
response: http.IncomingMessage;
|
|
2479
2737
|
body: Buffer;
|
|
2480
2738
|
}>;
|
|
@@ -2528,9 +2786,11 @@ export declare class OenormConversionApi {
|
|
|
2528
2786
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2529
2787
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2530
2788
|
* @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.
|
|
2789
|
+
* @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.
|
|
2790
|
+
* @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.
|
|
2531
2791
|
* @param {*} [options] Override http request options.
|
|
2532
2792
|
*/
|
|
2533
|
-
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, options?: any): Promise<{
|
|
2793
|
+
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, options?: any): Promise<{
|
|
2534
2794
|
response: http.IncomingMessage;
|
|
2535
2795
|
body: Buffer;
|
|
2536
2796
|
}>;
|
|
@@ -2540,9 +2800,11 @@ export declare class OenormConversionApi {
|
|
|
2540
2800
|
* @param oenormFile The input file
|
|
2541
2801
|
* @param destinationOenormType Defaults to Lv2015
|
|
2542
2802
|
* @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
|
|
2803
|
+
* @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.
|
|
2804
|
+
* @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.
|
|
2543
2805
|
* @param {*} [options] Override http request options.
|
|
2544
2806
|
*/
|
|
2545
|
-
oenormConversionConvertToOenorm(oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2807
|
+
oenormConversionConvertToOenorm(oenormFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2546
2808
|
response: http.IncomingMessage;
|
|
2547
2809
|
body: Buffer;
|
|
2548
2810
|
}>;
|
|
@@ -2596,9 +2858,11 @@ export declare class RebConversionApi {
|
|
|
2596
2858
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2597
2859
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2598
2860
|
* @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.
|
|
2861
|
+
* @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.
|
|
2862
|
+
* @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.
|
|
2599
2863
|
* @param {*} [options] Override http request options.
|
|
2600
2864
|
*/
|
|
2601
|
-
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, options?: any): Promise<{
|
|
2865
|
+
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, options?: any): Promise<{
|
|
2602
2866
|
response: http.IncomingMessage;
|
|
2603
2867
|
body: Buffer;
|
|
2604
2868
|
}>;
|
|
@@ -2608,9 +2872,11 @@ export declare class RebConversionApi {
|
|
|
2608
2872
|
* @param rebFile The input file
|
|
2609
2873
|
* @param destinationOenormType Defaults to Lv2015
|
|
2610
2874
|
* @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
|
|
2875
|
+
* @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.
|
|
2876
|
+
* @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.
|
|
2611
2877
|
* @param {*} [options] Override http request options.
|
|
2612
2878
|
*/
|
|
2613
|
-
rebConversionConvertToOenorm(rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2879
|
+
rebConversionConvertToOenorm(rebFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2614
2880
|
response: http.IncomingMessage;
|
|
2615
2881
|
body: Buffer;
|
|
2616
2882
|
}>;
|
|
@@ -2664,9 +2930,11 @@ export declare class SiaConversionApi {
|
|
|
2664
2930
|
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
2665
2931
|
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
|
|
2666
2932
|
* @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.
|
|
2933
|
+
* @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.
|
|
2934
|
+
* @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.
|
|
2667
2935
|
* @param {*} [options] Override http request options.
|
|
2668
2936
|
*/
|
|
2669
|
-
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, options?: any): Promise<{
|
|
2937
|
+
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, options?: any): Promise<{
|
|
2670
2938
|
response: http.IncomingMessage;
|
|
2671
2939
|
body: Buffer;
|
|
2672
2940
|
}>;
|
|
@@ -2676,9 +2944,11 @@ export declare class SiaConversionApi {
|
|
|
2676
2944
|
* @param siaFile The input file
|
|
2677
2945
|
* @param destinationOenormType Defaults to Lv2015
|
|
2678
2946
|
* @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
|
|
2947
|
+
* @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.
|
|
2948
|
+
* @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.
|
|
2679
2949
|
* @param {*} [options] Override http request options.
|
|
2680
2950
|
*/
|
|
2681
|
-
siaConversionConvertToOenorm(siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063', tryRepairProjectStructure?: boolean, options?: any): Promise<{
|
|
2951
|
+
siaConversionConvertToOenorm(siaFile: FileParameter, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
2682
2952
|
response: http.IncomingMessage;
|
|
2683
2953
|
body: Buffer;
|
|
2684
2954
|
}>;
|