@dangl/ava-model 2.31.0 → 2.31.1-beta0013

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.
@@ -5,29 +5,48 @@
5
5
  //----------------------
6
6
  /* eslint-disable */
7
7
  // ReSharper disable InconsistentNaming
8
+ /** This enum configures rounding modes for price calculations in projects */
8
9
  var PriceRoundingModeDto;
9
10
  (function (PriceRoundingModeDto) {
10
11
  PriceRoundingModeDto["Normal"] = "Normal";
11
12
  PriceRoundingModeDto["Floor"] = "Floor";
12
13
  PriceRoundingModeDto["Ceiling"] = "Ceiling";
13
14
  })(PriceRoundingModeDto || (PriceRoundingModeDto = {}));
15
+ /** General information about a Project. */
14
16
  class ProjectInformationDto {
17
+ /** Information about the buyer. */
15
18
  buyer;
19
+ /** Description for the project. */
16
20
  description;
21
+ /** Short description for the project. */
17
22
  descriptionShort;
23
+ /** Name of the project. */
18
24
  name;
25
+ /** Information about the site. */
19
26
  site;
27
+ /** The ItemNumberSchema used in the project. */
20
28
  itemNumberSchema;
29
+ /** Short label for the currency used. */
21
30
  currencyShort;
31
+ /** Full label of the currency used. */
22
32
  currencyLong;
33
+ /** Label for the labour time part of prices used in the project. */
23
34
  labourTimeLabel;
35
+ /** 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. */
24
36
  priceComponents;
37
+ /** This dictionary specifies actual types used for the PriceComponents. For example, a single price component might have the name 'Material' as a string, ans this dictionary would then have a key 'Material' and a value of Materials. You can not add keys here that are not also present in the PriceComponents property, and removing price components will also remove them from this dictionary here. */
25
38
  priceComponentTypes;
39
+ /** This bool indicates if this project allows the bidder to add bidder comments. Bidder comments are a way to attach clarifying information when submitting an offer. */
26
40
  bidderCommentAllowed;
41
+ /** This property indicates if the project should allow side offers from contractors. In GAEB, a side offer would typically be in exchange phase 85. */
27
42
  sideOffersAllowed;
43
+ /** This enumeration describes the type of the award / procurement process. If this is used in a GAEB context, more information about award types can be found in the German VOB/A rules and the GAEB standard */
28
44
  awardType;
45
+ /** This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary */
29
46
  specialAwardKind;
47
+ /** Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners. */
30
48
  requesters;
49
+ /** Notification sites are addresses that are used for delivering messages in the context of construction projects. */
31
50
  notificationSites;
32
51
  constructor(data) {
33
52
  if (data) {
@@ -179,27 +198,49 @@ class ProjectInformationDto {
179
198
  return data;
180
199
  }
181
200
  }
201
+ /** Represents information about a party (a site or an organization). */
182
202
  class PartyInformationDto {
203
+ /** Elements GUID identifier. */
183
204
  id;
205
+ /** This party's name. */
184
206
  name;
207
+ /** This party's street. */
185
208
  street;
209
+ /** This party's ZipCode. */
186
210
  zipCode;
211
+ /** This party's City. */
187
212
  city;
213
+ /** This party's Country. */
188
214
  country;
215
+ /** This party's Identifier. */
189
216
  identifier;
217
+ /** Remarks for this party. */
190
218
  remarks;
219
+ /** An email address for this party. */
191
220
  email;
221
+ /** A phone number for this party. */
192
222
  phone;
223
+ /** The name of a contact person. */
193
224
  contactPersonName;
225
+ /** This is an identifier related to this PartyInformation and their internal reference of the tender (or award). This might be used to assign an identifier (German "Vergabenummer") for the current project. This is typically only used in Buyer and Bidder representations and should map to the concept of "Vergabenummer" or "AwardNo" in GAEB. */
194
226
  awardIdentifier;
227
+ /** This property indicates if the party is registered within the European Economic Area. */
195
228
  isInEuropeanEconomicArea;
229
+ /** If this is within the European Economic Area (see IsInEuropeanEconomicArea, then as a business entity it likely has an EU VAT Id. */
196
230
  vatId;
231
+ /** The fax number for this party. */
197
232
  fax;
233
+ /** The two letter ISO country code, e.g. DE for Germany. */
198
234
  countryCode;
235
+ /** Depending on which party this class represents, it might have either a 'creditor' or 'debtor' number. This is often used in internal accounting systems. */
199
236
  creditorOrDebtorIdentifier;
237
+ /** The Global Location Number (GLN) is issued by GS1 and is intended to be a unique identifier for the physical address of a party, e.g. a business office. */
200
238
  globalLocationNumber;
239
+ /** This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders. */
201
240
  bankingInformation;
241
+ /** This can be used to specify a registration number for this party, e.g. a company registration number. It is usually used in GAEB XML commerce exchanges for bidders to supply their WEEE registration number, which is used to identify them as a registered WEEE company. */
202
242
  registrationNumber;
243
+ /** This can be used to specify a tax id for this party. It is different from the VatId and the RegistrationNumber. For example, in Germany this would be the "Steuernummer". This is usually not mapped to any AVA exchanges, but it's used e.g. in the XRechnung electronic invoices. */
203
244
  taxId;
204
245
  constructor(data) {
205
246
  if (data) {
@@ -286,12 +327,19 @@ class PartyInformationDto {
286
327
  return data;
287
328
  }
288
329
  }
330
+ /** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
289
331
  class BankingInformationDto {
332
+ /** Elements GUID identifier. */
290
333
  id;
334
+ /** The name of the bank. */
291
335
  name;
336
+ /** The international identifier for the bank account. */
292
337
  iban;
338
+ /** The account number. Typically no longer used since the introduction of IBAN within the SEPA area. */
293
339
  accountNumber;
340
+ /** The international bank identifier. */
294
341
  bic;
342
+ /** The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area. */
295
343
  routingNumber;
296
344
  constructor(data) {
297
345
  if (data) {
@@ -328,18 +376,31 @@ class BankingInformationDto {
328
376
  return data;
329
377
  }
330
378
  }
379
+ /** The schema for ItemNumber's in a Project. */
331
380
  class ItemNumberSchemaDto {
381
+ /** The count of tiers in the ItemNumberSchema */
332
382
  totalLength;
383
+ /** The collection of tiers for this ItemNumberSchema. */
333
384
  tiers;
385
+ /** 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 */
334
386
  separator;
387
+ /** 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. */
335
388
  filler;
389
+ /** 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. */
336
390
  identifier;
391
+ /** 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. */
337
392
  skipNonExistingLevelsInPositionItemNumbers;
393
+ /** 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. */
338
394
  skippedTiersFiller;
395
+ /** 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. */
339
396
  schemaIsCorrectlyDefined;
397
+ /** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
340
398
  allowUpperCaseLettering;
399
+ /** If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false. */
341
400
  disableLeftPaddingTiersWithFiller;
401
+ /** If this is enabled, then item numbers will not be transformed, except padded. This makes it possible to represent item numbers as-is from e.g. a GAEB file, and also mixing padded and non-padded segments in an item number. This is not recommonded to use by default, since it will lead to inconsistent item numbers in the project. */
342
402
  disableItemNumberIdentifierTransformations;
403
+ /** This property is used in combination with DisableItemNumberIdentifierTransformations. If this is enabled, then the transformation of item numbers is only disabled for alphanumeric tiers. This means that numeric tiers will still be padded with the filler character, but alphanumeric tiers will not be transformed */
343
404
  disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers;
344
405
  constructor(data) {
345
406
  if (data) {
@@ -408,13 +469,21 @@ class ItemNumberSchemaDto {
408
469
  return data;
409
470
  }
410
471
  }
472
+ /** Represents information about a single Tier in an ItemNumber. */
411
473
  class ItemNumberSchemaTierDto {
474
+ /** The (maximum) length for this tier. Will not accept a length less than 1. Defaults to 1 if length less than one is specified. */
412
475
  length;
476
+ /** This ItemNumberSchemaTier's type. */
413
477
  type;
478
+ /** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
414
479
  alignment;
480
+ /** This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level. */
415
481
  tierType;
482
+ /** Indicates if this tier represents a lot. See the documentation for more information about lots. */
416
483
  isLot;
484
+ /** 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' */
417
485
  increment;
486
+ /** This is an optional name for the given tier */
418
487
  tierName;
419
488
  constructor(data) {
420
489
  if (data) {
@@ -453,17 +522,20 @@ class ItemNumberSchemaTierDto {
453
522
  return data;
454
523
  }
455
524
  }
525
+ /** Determines the type of an ItemNumberSchema */
456
526
  var ItemNumberTypeDto;
457
527
  (function (ItemNumberTypeDto) {
458
528
  ItemNumberTypeDto["Numeric"] = "Numeric";
459
529
  ItemNumberTypeDto["Alphanumeric"] = "Alphanumeric";
460
530
  })(ItemNumberTypeDto || (ItemNumberTypeDto = {}));
531
+ /** This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value. */
461
532
  var ItemNumberSchemaTierAlignmentDto;
462
533
  (function (ItemNumberSchemaTierAlignmentDto) {
463
534
  ItemNumberSchemaTierAlignmentDto["Undefined"] = "Undefined";
464
535
  ItemNumberSchemaTierAlignmentDto["Left"] = "Left";
465
536
  ItemNumberSchemaTierAlignmentDto["Right"] = "Right";
466
537
  })(ItemNumberSchemaTierAlignmentDto || (ItemNumberSchemaTierAlignmentDto = {}));
538
+ /** Specifies the type an ItemNumberSchemaTier represents. For example, a tier may indicate to be used for positions or for groups. */
467
539
  var ItemNumberSchemaTierTypeDto;
468
540
  (function (ItemNumberSchemaTierTypeDto) {
469
541
  ItemNumberSchemaTierTypeDto["Undefined"] = "Undefined";
@@ -472,6 +544,7 @@ var ItemNumberSchemaTierTypeDto;
472
544
  ItemNumberSchemaTierTypeDto["Group"] = "Group";
473
545
  ItemNumberSchemaTierTypeDto["Lot"] = "Lot";
474
546
  })(ItemNumberSchemaTierTypeDto || (ItemNumberSchemaTierTypeDto = {}));
547
+ /** This enumeration models types of price components for better classification. */
475
548
  var PriceComponentTypeDto;
476
549
  (function (PriceComponentTypeDto) {
477
550
  PriceComponentTypeDto["Unknown"] = "Unknown";
@@ -480,6 +553,7 @@ var PriceComponentTypeDto;
480
553
  PriceComponentTypeDto["Plant"] = "Plant";
481
554
  PriceComponentTypeDto["Miscellaneous"] = "Miscellaneous";
482
555
  })(PriceComponentTypeDto || (PriceComponentTypeDto = {}));
556
+ /** This enumeration describes the type of the award / procurement process. If this is used in a GAEB context, more information about award types can be found in the German VOB/A rules and the GAEB standard */
483
557
  var AwardTypeDto;
484
558
  (function (AwardTypeDto) {
485
559
  AwardTypeDto["Unspecified"] = "Unspecified";
@@ -495,6 +569,7 @@ var AwardTypeDto;
495
569
  AwardTypeDto["CompetitiveDialog"] = "CompetitiveDialog";
496
570
  AwardTypeDto["InnovationPartnership"] = "InnovationPartnership";
497
571
  })(AwardTypeDto || (AwardTypeDto = {}));
572
+ /** This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary */
498
573
  var SpecialAwardKindDto;
499
574
  (function (SpecialAwardKindDto) {
500
575
  SpecialAwardKindDto["Unspecified"] = "Unspecified";
@@ -502,62 +577,119 @@ var SpecialAwardKindDto;
502
577
  SpecialAwardKindDto["OutlineContract"] = "OutlineContract";
503
578
  SpecialAwardKindDto["OutlineForMaintenanceContract"] = "OutlineForMaintenanceContract";
504
579
  })(SpecialAwardKindDto || (SpecialAwardKindDto = {}));
580
+ /** This is the base class that holds information about a whole service specification. */
505
581
  class ServiceSpecificationDto {
582
+ /** Elements GUID identifier. */
506
583
  id;
584
+ /** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
507
585
  projectHourlyWage;
586
+ /** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
508
587
  projectTaxRate;
588
+ /** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
509
589
  projectPriceComponents;
590
+ /** The ItemNumberSchema that is used within this project. */
510
591
  projectItemNumberSchema;
592
+ /** The IElements within this ElementContainerBase. */
511
593
  elements;
594
+ /** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
512
595
  projectLabourTimeLabel;
596
+ /** Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers. */
513
597
  containsDuplicateItemNumbers;
598
+ /** Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers. */
514
599
  containsDuplicateElementIds;
600
+ /** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
515
601
  ignoreDuplicateItemNumbers;
602
+ /** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties */
516
603
  ignoreProjectCataloguePropagation;
604
+ /** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
517
605
  ignoreDuplicateElementIds;
606
+ /** Price composition by tax rate. */
518
607
  totalPriceGrossByTaxRate;
608
+ /** Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once. */
519
609
  ignoreChildPriceUpdates;
610
+ /** Net price after applied deductions. */
520
611
  deductedPrice;
612
+ /** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
521
613
  deductionFactor;
614
+ /** 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. */
522
615
  absoluteDeduction;
616
+ /** Will return this ElementContainerBase's total price. */
523
617
  totalPrice;
618
+ /** The total gross price for this ElementContainerBase including all child elements. */
524
619
  totalPriceGross;
620
+ /** Total gross price after applied deductions. */
525
621
  totalPriceGrossDeducted;
622
+ /** Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not. */
526
623
  priceType;
624
+ /** Information about the bidder. */
527
625
  bidder;
626
+ /** This discriminator is used to identify different bidders in a project. It is different from the Identifier property in the Bidder in that the BidderDiscriminator is intended to be a numerical identifier within a project, while the Identifier does uniquely identify a bidder in the system independent of a specific project. This property should map to "Bieternummer" or "BidderNo" in GAEB. */
528
627
  bidderDiscriminator;
628
+ /** This is used to store the GAEB XML Id within this ServiceSpecification. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
529
629
  gaebXmlId;
630
+ /** The ProjectInformation used within the Project in which this ElementContainerBase is contained. This is reference equal to the ProjectInformation used in the parent project. */
530
631
  projectInformation;
632
+ /** This service specifications exchange phase, i.e. the current status in the project it is intended to be used (such as request for offer, offer, awarding...). */
531
633
  exchangePhase;
634
+ /** This indicates where the service specification originates, i.e. from an exchange file format or self created. If applicable, additional information is present in the OriginDetail property. */
532
635
  origin;
636
+ /** This property complements the Origin property. Some formats, e.g. GaebXml might have additional information attached, e.g. GAEB XML V3.2 oder GAEB XML V3.1. This string property is used to hold such data. The Dangl.AVA module does not have a list of possible values, since this is defined in the native format assemblies, e.g. Dangl.GAEB or Dangl.Oenorm. */
533
637
  originDetail;
638
+ /** This property is an informational property that can give more information about the origin or source of the data. Some exchange formats, e.g. GAEB XML or ÖNorm A 2063 might have information about the software, libraries or version used when creating files, and this is contained here. Please note that this will be set to null when doing a copy, and the Dangl-converters will ignore these properties when writing since they have their own mechanisms for exporting these values. It should be treated as an informational read-only property, and not as a value that is used for any calculations or evaluations. */
534
639
  originSystem;
640
+ /** This property is an informational property that can give more information about the origin or source of the data. Some exchange formats, e.g. GAEB XML or ÖNorm A 2063 might have information about the software, libraries or version used when creating files, and this is contained here. Please note that this will be set to null when doing a copy, and the Dangl-converters will ignore these properties when writing since they have their own mechanisms for exporting these values. It should be treated as an informational read-only property, and not as a value that is used for any calculations or evaluations. */
535
641
  originApplication;
642
+ /** This property is an informational property that can give more information about the origin or source of the data. Some exchange formats, e.g. GAEB XML or ÖNorm A 2063 might have information about the software, libraries or version used when creating files, and this is contained here. Please note that this will be set to null when doing a copy, and the Dangl-converters will ignore these properties when writing since they have their own mechanisms for exporting these values. It should be treated as an informational read-only property, and not as a value that is used for any calculations or evaluations. */
536
643
  originVersion;
644
+ /** Creation date of this ServiceSpecification. */
537
645
  creationDate;
646
+ /** Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin" */
538
647
  offerByDate;
648
+ /** Date indicating by when the buyer will select a contractor. */
539
649
  decisionDate;
650
+ /** Date of when the offer / bid was created */
540
651
  bidDate;
652
+ /** If a construction project requires a warranty bond, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as a warranty bond. */
541
653
  warrantyBondPercentage;
654
+ /** If a construction project requires an execution guarantty, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as an execution guarantee. In practice, this percentage is usually deducted from intermediate invoices and only billed in the final invoice. */
542
655
  executionGuaranteePercentage;
656
+ /** String indicating where the physical submission of the offer is taking place. */
543
657
  submissionLocation;
658
+ /** Description of this ServiceSpecification. */
544
659
  description;
660
+ /** The name of this ServiceSpecification. */
545
661
  name;
662
+ /** This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually. */
546
663
  priceInformation;
664
+ /** These are Catalogue that are used within this ElementContainerBase. Catalogue references 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. */
547
665
  projectCatalogues;
666
+ /** Referenced catalogues for this ElementContainerBase. */
548
667
  catalogueReferences;
668
+ /** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
549
669
  sustainabilityCatalogues;
670
+ /** The date when the execution of the services is scheduled to start */
550
671
  plannedExecutionStart;
672
+ /** The date then the execution of the services is scheduled to be finished */
551
673
  plannedExecutionEnd;
674
+ /** The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB */
552
675
  contractDate;
676
+ /** This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB */
553
677
  contractIdentifier;
678
+ /** This indicates how long the warranty period is for this ServiceSpecification */
554
679
  warrantyDuration;
680
+ /** The date on which the warranty period ends */
555
681
  warrantyEnd;
682
+ /** The date on which the services rendered by the bidder are scheduled to be approved by the buyer */
556
683
  approvalDate;
684
+ /** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
557
685
  typeOfApproval;
686
+ /** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
558
687
  addendumNumber;
688
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
559
689
  addendumStatus;
690
+ /** This property holds additional information that's only valid in commerce exchange phases. */
560
691
  commerceProperties;
692
+ /** This property holds ÖNorm-specific properties for this service specification, such as LB reference data. */
561
693
  serviceSpecificationOenormProperties;
562
694
  constructor(data) {
563
695
  if (data) {
@@ -872,11 +1004,15 @@ class ServiceSpecificationDto {
872
1004
  return data;
873
1005
  }
874
1006
  }
1007
+ /** Base interface definition for elements within an ElementContainerBase. */
875
1008
  class IElementDto {
876
1009
  elementType;
877
1010
  elementTypeDiscriminator;
1011
+ /** Elements GUID identifier. */
878
1012
  id;
1013
+ /** 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. */
879
1014
  gaebXmlId;
1015
+ /** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
880
1016
  addendumNumber;
881
1017
  projectCatalogues;
882
1018
  catalogueReferences;
@@ -976,12 +1112,19 @@ class IElementDto {
976
1112
  return data;
977
1113
  }
978
1114
  }
1115
+ /** This class describes an external catalogue. Catalogues, or collections, hold information to categorize and describe items. For example, the German DIN 276 cost group standards describe different types of costs for building projects. When referencing the DIN 276 catalogue and providing an item key or identifier, it is possible to reference data in this catalogue. */
979
1116
  class CatalogueDto {
1117
+ /** Elements GUID identifier. */
980
1118
  id;
1119
+ /** This is used to store the GAEB XML Id within this Catalogue. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
981
1120
  gaebXmlId;
1121
+ /** The name that is given for this catalogue. */
982
1122
  name;
1123
+ /** Additional information about this catalogue. */
983
1124
  description;
1125
+ /** If given, this gives a classification for the contents of the catalogue */
984
1126
  catalogueType;
1127
+ /** This property may hold additional information about the catalogue type. It is currently only used in GAEB XML exchange to carry detailed information about a catalogue type, but it's otherwise just a free text field. */
985
1128
  catalogueTypeDetail;
986
1129
  constructor(data) {
987
1130
  if (data) {
@@ -1018,6 +1161,7 @@ class CatalogueDto {
1018
1161
  return data;
1019
1162
  }
1020
1163
  }
1164
+ /** This enumeration describes the type of a catalogue. Catalogues, or collections, hold information to categorize and describe items. For example, the German DIN 276 cost group standards describe different types of costs for building projects. When referencing the DIN 276 catalogue and providing an item key or identifier, it is possible to reference data in this catalogue. */
1021
1165
  var CatalogueTypeDto;
1022
1166
  (function (CatalogueTypeDto) {
1023
1167
  CatalogueTypeDto["Unknown"] = "Unknown";
@@ -1029,11 +1173,17 @@ var CatalogueTypeDto;
1029
1173
  CatalogueTypeDto["BIM"] = "BIM";
1030
1174
  CatalogueTypeDto["Attachment"] = "Attachment";
1031
1175
  })(CatalogueTypeDto || (CatalogueTypeDto = {}));
1176
+ /** This class is used to link data between catalogues and objects. */
1032
1177
  class CatalogueReferenceDto {
1178
+ /** Elements GUID identifier. */
1033
1179
  id;
1180
+ /** This points to the item in the catalogue itself. This means that, for example when this quantity assignment references a "DIN 276" catalogue, this property indicates the number / identifier / key in DIN 276 that is referenced. */
1034
1181
  catalogueReferenceKey;
1182
+ /** The Id of the CatalogueReference that is targeted by this item. Set this property to set the referenced catalogue. */
1035
1183
  catalogueReferenceId;
1184
+ /** These are CatalogueReference that are used within this ServiceSpecification. Catalogue references 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. */
1036
1185
  projectCatalogues;
1186
+ /** This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues. */
1037
1187
  catalogue;
1038
1188
  constructor(data) {
1039
1189
  if (data) {
@@ -1099,91 +1249,135 @@ class CatalogueReferenceDto {
1099
1249
  return data;
1100
1250
  }
1101
1251
  }
1252
+ /** A Position is the main item type in a ServiceSpecification, holding information about tasks to be done, their prices, description, amounts etc. */
1102
1253
  class PositionDto extends IElementDto {
1254
+ /** Will return the price per unit, rounded according to the project settings or the default value of three decimal places */
1103
1255
  unitPrice;
1104
- /** You can use this property to directly set the unit price for this position. This will
1105
- override any given PriceComponents */
1256
+ /** You can use this property to directly set the unit price for this position. This will override any given PriceComponents */
1106
1257
  unitPriceOverride;
1258
+ /** Will return this Position's total quantity, rounded to three decimal places. */
1107
1259
  quantity;
1108
- /** You can use this property to directly set the quantity for this position. This will
1109
- override any given QuantityComponents */
1260
+ /** You can use this property to directly set the quantity for this position. This will override any given QuantityComponents */
1110
1261
  quantityOverride;
1111
- /** This indicates true if this specific position is specified as a complementing position
1112
- for any base position. */
1262
+ /** This indicates true if this specific position is specified as a complementing position for any base position. */
1113
1263
  isComplementingPosition;
1114
- /** If IsComplementingPosition is set to true, this will indicate which base
1115
- positions are targeted by this complementing position. */
1264
+ /** If IsComplementingPosition is set to true, this will indicate which base positions are targeted by this complementing position. */
1116
1265
  complementsPositions;
1117
- /** You can use this property to directly specify the total price of this position as a
1118
- percentage of the sum of the total prices of base positions that this position
1119
- complements. It will essentially set the total price for this position to the sum of all
1120
- total prices of the positions specified in ComplementsPositions multiplied
1121
- by the percentage here. If present, this has precedence over UnitPriceOverride as well as QuantityOverride. */
1266
+ /** You can use this property to directly specify the total price of this position as a percentage of the sum of the total prices of base positions that this position complements. It will essentially set the total price for this position to the sum of all total prices of the positions specified in ComplementsPositions multiplied by the percentage here. If present, this has precedence over UnitPriceOverride as well as QuantityOverride. */
1122
1267
  complementingPricePercentageOverride;
1123
- /** This is a read only property showing the total price of this positions as a percentage
1124
- of the sum of the total prices of all base positions, in case this position is a
1125
- complementing positions. If this position is not a complementing position, this will be
1126
- null. Also, if no prices are present, this will also be null. */
1268
+ /** This is a read only property showing the total price of this positions as a percentage of the sum of the total prices of all base positions, in case this position is a complementing positions. If this position is not a complementing position, this will be null. Also, if no prices are present, this will also be null. */
1127
1269
  complementingPricePercentage;
1270
+ /** The tag of the unit used for this positions quantity. */
1128
1271
  unitTag;
1272
+ /** The components for labour time in this Position. */
1129
1273
  labourComponents;
1274
+ /** The single price components in this Position. Price components should not be handled directly on a per-position basis but set globally in the parent Projects ProjectInformation. */
1130
1275
  priceComponents;
1276
+ /** The quantity components of this Position. */
1131
1277
  quantityComponents;
1278
+ /** Further structuring of this Position. */
1132
1279
  subDescriptions;
1280
+ /** Indicates the status of this Position's comission. */
1133
1281
  comissionStatus;
1282
+ /** A list of positions that complement this Position. The positions are referenced by their GUIDs. It might be used together with ComplementedByQuantities in case that only a given quantity is complemented by positions. */
1134
1283
  complementedBy;
1284
+ /** This list contains information about sustainability indicators or environmental impact for this position. */
1135
1285
  sustainabilityIndicators;
1286
+ /** Will indicate if this Position is complemented in this ServiceSpecification by other Positions. It can not be set to false when there are entries in the ComplementedBy property. */
1136
1287
  complemented;
1288
+ /** Indicates that the amount for this Position is to be set by the bidder. */
1137
1289
  amountToBeEnteredByBidder;
1290
+ /** Indicates if the bidder demands for prices to be broken up into their price components. */
1138
1291
  priceCompositionRequired;
1292
+ /** Indicates if this Position should use a different TaxRate than what is the default for the Project. */
1139
1293
  useDifferentTaxRate;
1294
+ /** Will return either the parent ServiceSpecification's TaxRate or it's own if it has a different value. (For example, in Germany Water has a different TaxRate than regular Positions) */
1140
1295
  taxRate;
1296
+ /** The ItemNumber for this Position. */
1141
1297
  itemNumber;
1298
+ /** The rate of deductions, i.e. 0.12m means 12% price deduction. */
1142
1299
  deductionFactor;
1300
+ /** Returns the product of UnitPrice times Quantity. */
1143
1301
  totalPrice;
1302
+ /** The total gross price for this Position. */
1144
1303
  totalPriceGross;
1304
+ /** Total gross price after applied deductions. */
1145
1305
  totalPriceGrossDeducted;
1306
+ /** Net price after applied deductions. Please be aware that this is the total price, from TotalPrice, not the unit price of the position. */
1146
1307
  deductedPrice;
1308
+ /** This indicates the type of a position. If this is an alternative position, its AlternativeTo property should be set to the id of the position it can replace. */
1147
1309
  positionType;
1310
+ /** Indicates the PriceType of this Position. */
1148
1311
  priceType;
1312
+ /** This indicates if this position is regular or describing a labour / hourly paid work service */
1149
1313
  serviceType;
1314
+ /** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
1150
1315
  productData;
1151
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
1152
- property. If you want to convert from DTO objects, and you want to work with the
1153
- `HtmlShortText` property, you need to set this property to null. */
1316
+ /** Short description for this DescriptionBase element.
1317
+ Please note that by default, this property takes precedence over the `HtmlShortText`
1318
+ property. If you want to convert from DTO objects, and you want to work with the
1319
+ `HtmlShortText` property, you need to set this property to null.
1320
+ */
1154
1321
  shortText;
1155
- /** This property is used to store the short text in HTML format. If you want to convert
1156
- from DTO objects, and you want to use this property, then you need to ensure that
1157
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
1322
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
1323
+ This property is used to store the short text in HTML format. If you want to convert
1324
+ from DTO objects, and you want to use this property, then you need to ensure that
1325
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
1326
+ */
1158
1327
  htmlShortText;
1328
+ /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
1159
1329
  longText;
1330
+ /** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
1160
1331
  htmlLongText;
1332
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
1161
1333
  additionType;
1162
1334
  elementType = 'Position';
1163
1335
  elementTypeDiscriminator = 'Position';
1336
+ /** Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of this 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. */
1164
1337
  quantityAssignments;
1338
+ /** The CommerceProperties support specialized information that is only useful in GAEB XML 9x data exchange phases. It is intended to provide article information. */
1165
1339
  commerceProperties;
1340
+ /** 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. */
1166
1341
  alternativeTo;
1342
+ /** 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. */
1167
1343
  alternativeIdentifier;
1344
+ /** 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. */
1168
1345
  alternativeGroupIdentifier;
1346
+ /** 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. */
1169
1347
  isLumpSum;
1348
+ /** 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 */
1170
1349
  repetitionTo;
1171
1350
  v1CompatibilityPriceType;
1351
+ /** 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. */
1172
1352
  standardizedDescription;
1353
+ /** This list contains references to positions that complement this one, additionally also specifying a quantity for which the addition is intended. This does not replace the ComplementedBy property and there are no automatic checks being done between these two properties, so it's up to the user code to ensure deletions (and additions, if desired) are performed for both properties. When copying withing keeping Ids, this list will not be part of the copy process, since it would only contain quantities without actual position references. Containers, however, will rebuild the list with updated position references when copying positions that contain entries here. */
1173
1354
  complementedByQuantities;
1355
+ /** 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. */
1174
1356
  executionDescriptionReference;
1357
+ /** 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. */
1175
1358
  notOffered;
1359
+ /** 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. */
1176
1360
  oenormPositionProperties;
1361
+ /** 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. */
1177
1362
  descriptionId;
1363
+ /** 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. */
1178
1364
  hierarchyLevel;
1365
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
1179
1366
  addendumStatus;
1180
1367
  hasBidderCommentInHtmlLongText;
1368
+ /** This property can optionally be used in GAEB exchange scenarios. It is only meaningful if this position itself is a complementing position, meaning if this position is marked in other positions in their ComplementedBy list. Then, it specifies how the complementing should be expressed in GAEB. By default, positions are always explicitly referenced, but other options are possible. Please also note that the Dangl.AVA.Converter package, which is used for GAEB exports, will check if the given type is valid in the current project configuration. If not, directly referenced positions will be used as fallback. */
1181
1369
  gaebComplementingType;
1370
+ /** HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site. */
1182
1371
  holdOutProperties;
1372
+ /** This is an informational property, which directly holds a numerical value for an estimated quantity. It is not used for any price calculations. */
1183
1373
  estimatedQuantity;
1374
+ /** This is an optional property that holds price catalogue data. These are prices that may represent an estimate, and they typically come from a price catalogue. */
1184
1375
  priceCatalogueData;
1376
+ /** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties. */
1185
1377
  ignoreProjectCataloguePropagation;
1378
+ /** A main position means that this position is important and should be highlighted in the user interface. Important meaning that is is usually a bigger part of the total sum of the services, or it needs special attention in another way. */
1186
1379
  isMainPosition;
1380
+ /** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
1187
1381
  baseCatalogueNumber;
1188
1382
  constructor(data) {
1189
1383
  super(data);
@@ -1558,13 +1752,21 @@ from DTO objects, and you want to use this property, then you need to ensure tha
1558
1752
  return data;
1559
1753
  }
1560
1754
  }
1755
+ /** Based on the PriceComponent, this class is responsible for labour time components. */
1561
1756
  class LabourPriceComponentDto {
1757
+ /** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
1562
1758
  label;
1759
+ /** The total, calculated price of this component. Will multiply the calculated amount of hours with the ServiceSpecifications hourly wage rate. */
1563
1760
  price;
1761
+ /** The cost per hour of manual labor. */
1564
1762
  hourlyWage;
1763
+ /** The single Calculation elements this price component is composed of. */
1565
1764
  values;
1765
+ /** Indicates if the ServiceSpecification's standard HourlyWage is to be used or a custom value. */
1566
1766
  useOwnHourlyWage;
1767
+ /** The total, calculated time of this component. Will return the result rounded to three decimal places. */
1567
1768
  totalTime;
1769
+ /** 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. */
1568
1770
  projectCatalogues;
1569
1771
  constructor(data) {
1570
1772
  if (data) {
@@ -1643,13 +1845,21 @@ class LabourPriceComponentDto {
1643
1845
  return data;
1644
1846
  }
1645
1847
  }
1848
+ /** This class holds means to calculate mathematical expressions from given strings. */
1646
1849
  class CalculationDto {
1850
+ /** Descriptive text for this calculation. */
1647
1851
  description;
1852
+ /** This Calculation's mathematical expression. Please note that thousands separators are not supported. Both comma and point will be treated as decimal separators. */
1648
1853
  formula;
1854
+ /** The calculated result from the formula, 0 if invalid. */
1649
1855
  result;
1856
+ /** Whether the Formula is a valid expression. */
1650
1857
  valid;
1858
+ /** 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. */
1651
1859
  errorPositionInLine;
1860
+ /** 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. */
1652
1861
  projectCatalogues;
1862
+ /** Referenced catalogues for this Calculation. */
1653
1863
  catalogueReferences;
1654
1864
  constructor(data) {
1655
1865
  if (data) {
@@ -1728,10 +1938,15 @@ class CalculationDto {
1728
1938
  return data;
1729
1939
  }
1730
1940
  }
1941
+ /** 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. */
1731
1942
  class PriceComponentDto {
1943
+ /** The total, calculated price of this component. */
1732
1944
  price;
1945
+ /** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
1733
1946
  label;
1947
+ /** The single Calculation elements this price component is composed of. */
1734
1948
  values;
1949
+ /** 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. */
1735
1950
  projectCatalogues;
1736
1951
  constructor(data) {
1737
1952
  if (data) {
@@ -1804,32 +2019,50 @@ class PriceComponentDto {
1804
2019
  return data;
1805
2020
  }
1806
2021
  }
2022
+ /** This is appended to a Position and is used to separate the complete Position into smaller amounts to be described separately, for example concrete walls could be attached to different building storeys. */
1807
2023
  class SubDescriptionDto {
2024
+ /** Elements GUID identifier. */
1808
2025
  id;
2026
+ /** Returns the total calculated sum of all quantity assignments. Will return the result rounded to three decimal places. */
1809
2027
  quantity;
1810
- /** You can use this property to directly set the quantity for this
1811
- sub description. This will override any given QuantityComponents */
2028
+ /** You can use this property to directly set the quantity for this sub description. This will override any given QuantityComponents */
1812
2029
  quantityOverride;
2030
+ /** Holds quantity information for this sub description. Quantity is listening to changes here and is reporting the total sum of all quantity components. */
1813
2031
  quantityComponents;
2032
+ /** Indicates if the bidder is asked to specify an amount. */
1814
2033
  amountToBeEnteredByBidder;
2034
+ /** Identifier for this SubDescription. */
1815
2035
  identifier;
1816
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
1817
- property. If you want to convert from DTO objects, and you want to work with the
1818
- `HtmlShortText` property, you need to set this property to null. */
2036
+ /** Short description for this DescriptionBase element.
2037
+ Please note that by default, this property takes precedence over the `HtmlShortText`
2038
+ property. If you want to convert from DTO objects, and you want to work with the
2039
+ `HtmlShortText` property, you need to set this property to null.
2040
+ */
1819
2041
  shortText;
1820
- /** This property is used to store the short text in HTML format. If you want to convert
1821
- from DTO objects, and you want to use this property, then you need to ensure that
1822
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
2042
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
2043
+ This property is used to store the short text in HTML format. If you want to convert
2044
+ from DTO objects, and you want to use this property, then you need to ensure that
2045
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
2046
+ */
1823
2047
  htmlShortText;
2048
+ /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
1824
2049
  longText;
2050
+ /** If this is given, then the sub description has a different unit tag than the parent position. */
1825
2051
  unitTag;
2052
+ /** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
1826
2053
  htmlLongText;
2054
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
1827
2055
  additionType;
2056
+ /** 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. */
1828
2057
  standardizedDescription;
2058
+ /** 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. */
1829
2059
  executionDescriptionReference;
2060
+ /** 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. */
1830
2061
  projectCatalogues;
2062
+ /** 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. */
1831
2063
  descriptionId;
1832
2064
  hasBidderCommentInHtmlLongText;
2065
+ /** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
1833
2066
  baseCatalogueNumber;
1834
2067
  constructor(data) {
1835
2068
  if (data) {
@@ -1941,15 +2174,20 @@ from DTO objects, and you want to use this property, then you need to ensure tha
1941
2174
  return data;
1942
2175
  }
1943
2176
  }
2177
+ /** Indicates the origin of an element. */
1944
2178
  var AdditionTypeDto;
1945
2179
  (function (AdditionTypeDto) {
1946
2180
  AdditionTypeDto["None"] = "None";
1947
2181
  AdditionTypeDto["ByBuyer"] = "ByBuyer";
1948
2182
  AdditionTypeDto["ByBidder"] = "ByBidder";
1949
2183
  })(AdditionTypeDto || (AdditionTypeDto = {}));
2184
+ /** This class 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. */
1950
2185
  class StandardizedDescriptionDto {
2186
+ /** This enumeration identifies a pre-known standard used for referencing standardized descriptions. */
1951
2187
  standardReferenceType;
2188
+ /** This string property is the identifier to map to the references standard. Its type is given in the StandardReferenceType */
1952
2189
  standardReference;
2190
+ /** This is a special reference to the German STLB "Standardleistungsbuch Bau" reference. If this is used, the StandardReference property should not be set. */
1953
2191
  stlbReference;
1954
2192
  constructor(data) {
1955
2193
  if (data) {
@@ -1991,6 +2229,7 @@ class StandardizedDescriptionDto {
1991
2229
  return data;
1992
2230
  }
1993
2231
  }
2232
+ /** This enumeration identifies a pre-known standard used for referencing standardized descriptions. */
1994
2233
  var StandardReferenceTypeDto;
1995
2234
  (function (StandardReferenceTypeDto) {
1996
2235
  StandardReferenceTypeDto["Unknown"] = "Unknown";
@@ -1998,12 +2237,19 @@ var StandardReferenceTypeDto;
1998
2237
  StandardReferenceTypeDto["StLK"] = "StLK";
1999
2238
  StandardReferenceTypeDto["STLBBauZ"] = "STLBBauZ";
2000
2239
  })(StandardReferenceTypeDto || (StandardReferenceTypeDto = {}));
2240
+ /** This class represents a specialized reference to the German STLB "Standardleistungsbuch Bau". The STLB is a commercial offering and describes common services in the construction sector. When this is used, this describes the exact type of a service via a reference to this standard */
2001
2241
  class STLBReferenceDto {
2242
+ /** The date of the STLB version. Typically, only the Year and Month are used */
2002
2243
  versionDate;
2244
+ /** The name of the catalogue within the STLB */
2003
2245
  catalogueName;
2246
+ /** The name of the group in STLB */
2004
2247
  group;
2248
+ /** The cost group this service is associated with */
2005
2249
  costGroup;
2250
+ /** The service area (or type) in the STLB */
2006
2251
  serviceArea;
2252
+ /** These keys may optionally be used to further reference multiple, specific items within the STLB */
2007
2253
  keys;
2008
2254
  constructor(data) {
2009
2255
  if (data) {
@@ -2060,9 +2306,13 @@ class STLBReferenceDto {
2060
2306
  return data;
2061
2307
  }
2062
2308
  }
2309
+ /** This class represents a single key reference within the German STLB "Standardleistungsbuch Bau" */
2063
2310
  class STLBKeyDto {
2311
+ /** This identifier is required and uniquely describes a single reference within the STLB standard. It maps to "ArtChrIdent" in GAEB XML */
2064
2312
  artIdentifier;
2313
+ /** This optional index property further categorizes a single reference within the STLB standard. It maps to "ArtChIdx" in GAEB XML */
2065
2314
  artIndex;
2315
+ /** This optional identifier further specifies the execution kind of the reference in the STLB standard. It maps to "ChVIdent" in GAEB XML */
2066
2316
  kindIdentifier;
2067
2317
  constructor(data) {
2068
2318
  if (data) {
@@ -2093,6 +2343,7 @@ class STLBKeyDto {
2093
2343
  return data;
2094
2344
  }
2095
2345
  }
2346
+ /** Indicates if this service specification item is commissioned (and therefore should be executed), postponed for later or undefined. */
2096
2347
  var ComissionStatusDto;
2097
2348
  (function (ComissionStatusDto) {
2098
2349
  ComissionStatusDto["Undefined"] = "Undefined";
@@ -2100,14 +2351,23 @@ var ComissionStatusDto;
2100
2351
  ComissionStatusDto["Postponed"] = "Postponed";
2101
2352
  ComissionStatusDto["Removed"] = "Removed";
2102
2353
  })(ComissionStatusDto || (ComissionStatusDto = {}));
2354
+ /** This model contains the sustainability or environment impact data. */
2103
2355
  class PositionSustainabilityIndicatorDto {
2356
+ /** Elements GUID identifier. */
2104
2357
  id;
2358
+ /** This is usually in the form of an URL that specifies the indicator. */
2105
2359
  source;
2360
+ /** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
2106
2361
  comment;
2362
+ /** If present, this indicator may be divided up into different life cycle stages. */
2107
2363
  lifeCycleStages;
2364
+ /** This is a key that specifies the type of indicator. It is not used for any calculations but can be used to identify the indicator type, e.g. "carbonFootprint", "waterConsumption" or similar. The actual value of this property is not defined in the library and can be set freely, but it is recommended to use a consistent naming scheme, e.g. by using URLs or IRIs to avoid conflicts. In GAEB XML, it has a max length of 50 characters. */
2108
2365
  indicatorKey;
2366
+ /** This is the actual value of the indicator. */
2109
2367
  value;
2368
+ /** The unit of measurement for the value. */
2110
2369
  unitTag;
2370
+ /** If present, this is a conversion factor used here in this indicator for the value. */
2111
2371
  conversionFactor;
2112
2372
  constructor(data) {
2113
2373
  if (data) {
@@ -2168,9 +2428,13 @@ class PositionSustainabilityIndicatorDto {
2168
2428
  return data;
2169
2429
  }
2170
2430
  }
2431
+ /** This model represents the life cycle stages for sustainability indicators. For example, for a carbon footprint indicator, you could specify the carbon footprint for the production stage, the transportation stage and the disposal stage of a service or product. */
2171
2432
  class SustainabilityLifeCycleStageDto {
2433
+ /** Elements GUID identifier. */
2172
2434
  id;
2435
+ /** The key is the name or identifier of the stage. */
2173
2436
  key;
2437
+ /** The value for this given stage. */
2174
2438
  value;
2175
2439
  constructor(data) {
2176
2440
  if (data) {
@@ -2201,14 +2465,23 @@ class SustainabilityLifeCycleStageDto {
2201
2465
  return data;
2202
2466
  }
2203
2467
  }
2468
+ /** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
2204
2469
  class ItemNumberDto {
2470
+ /** Elements GUID identifier. */
2205
2471
  id;
2472
+ /** Will return this ItemNumber as point delimited string. Will not distinguish between upper- and lowercase and return an all-lowercase representation. Will consider first numbers, then characters, e.g. 1a is considered preceding aa. Transformation to all lowercase can be configured in the ItemNumberSchema property. */
2206
2473
  stringRepresentation;
2474
+ /** Indicates if the characters and the length of the Identifiers match the current ItemNumberSchema. */
2207
2475
  isSchemaCompliant;
2476
+ /** Used for representing and validating this ItemNumber. */
2208
2477
  itemNumberSchema;
2478
+ /** Collection of the single identifiers in this ItemNumber. P.e., "02.03.004" will have three elements "02", "03", and "004". Since ReadOnlyObservableCollection`1 does have the event set to protected, it can be accessed like this: (itemNumber.Identifiers as INotifyCollectionChanged).CollectionChanged */
2209
2479
  identifiers;
2480
+ /** This indicates if this item number is at the lot level. Find out more about lots in the documentation. */
2210
2481
  isLot;
2482
+ /** 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. */
2211
2483
  hierarchyLevel;
2484
+ /** This property indicates if this ItemNumber is attached to an object of the Position type. */
2212
2485
  isAttachedToPosition;
2213
2486
  itemNumberSchemaBeforeMapping;
2214
2487
  constructor(data) {
@@ -2282,28 +2555,38 @@ class ItemNumberDto {
2282
2555
  return data;
2283
2556
  }
2284
2557
  }
2558
+ /** This is a classification for Position elements. */
2285
2559
  var PositionTypeDto;
2286
2560
  (function (PositionTypeDto) {
2287
2561
  PositionTypeDto["Regular"] = "Regular";
2288
2562
  PositionTypeDto["Optional"] = "Optional";
2289
2563
  PositionTypeDto["Alternative"] = "Alternative";
2290
2564
  })(PositionTypeDto || (PositionTypeDto = {}));
2565
+ /** This indicates the price type of a IPricedElement. */
2291
2566
  var PriceTypeDto;
2292
2567
  (function (PriceTypeDto) {
2293
2568
  PriceTypeDto["WithTotal"] = "WithTotal";
2294
2569
  PriceTypeDto["WithoutTotal"] = "WithoutTotal";
2295
2570
  })(PriceTypeDto || (PriceTypeDto = {}));
2571
+ /** The service type describes the type of service a Position represents. */
2296
2572
  var ServiceTypeDto;
2297
2573
  (function (ServiceTypeDto) {
2298
2574
  ServiceTypeDto["Regular"] = "Regular";
2299
2575
  ServiceTypeDto["HourlyPaidWork"] = "HourlyPaidWork";
2300
2576
  })(ServiceTypeDto || (ServiceTypeDto = {}));
2577
+ /** This class represents data about products and their vendor */
2301
2578
  class ProductDataDto {
2579
+ /** Elements GUID identifier. */
2302
2580
  id;
2581
+ /** This PartyInformation is used to describe details about the vendor of this ProductData. */
2303
2582
  vendor;
2583
+ /** The collection of ArticleData that describe this product, e.g. a pipe product could be composed out of multiple pipe segments and fittings. */
2304
2584
  articles;
2585
+ /** Short description for this ITextElement element. */
2305
2586
  shortText;
2587
+ /** Detailed description for this ITextElement element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2306
2588
  longText;
2589
+ /** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
2307
2590
  htmlLongText;
2308
2591
  constructor(data) {
2309
2592
  if (data) {
@@ -2371,15 +2654,25 @@ class ProductDataDto {
2371
2654
  return data;
2372
2655
  }
2373
2656
  }
2657
+ /** This class represents a single article, usually used within ProductData */
2374
2658
  class ArticleDataDto {
2659
+ /** Elements GUID identifier. */
2375
2660
  id;
2661
+ /** The name (or brand name) for this article, usually given by the supplier or vendor. */
2376
2662
  name;
2663
+ /** An article number that describes it, useful when integrating other systems. */
2377
2664
  articleNumber;
2665
+ /** Quantity for this article. If this is used within a Position, the quantity here should be the quantity required for the full quantity of the position, not for a single unit. */
2378
2666
  quantity;
2667
+ /** The unit tag for this single ArticleData. */
2379
2668
  unitTag;
2669
+ /** This is an optional text element that can be used to further describe the ArticleData. */
2380
2670
  description;
2671
+ /** Short description for this ITextElement element. */
2381
2672
  shortText;
2673
+ /** Detailed description for this ITextElement element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2382
2674
  longText;
2675
+ /** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
2383
2676
  htmlLongText;
2384
2677
  constructor(data) {
2385
2678
  if (data) {
@@ -2422,10 +2715,15 @@ class ArticleDataDto {
2422
2715
  return data;
2423
2716
  }
2424
2717
  }
2718
+ /** 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. */
2425
2719
  class QuantityAssignmentDto {
2720
+ /** Elements GUID identifier. */
2426
2721
  id;
2722
+ /** The total quantity in this quantity assignment */
2427
2723
  quantity;
2724
+ /** These are Catalogue that are used within this ServiceSpecification. Catalogue references 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. */
2428
2725
  projectCatalogues;
2726
+ /** Referenced catalogues for this QuantityAssignment. */
2429
2727
  catalogueReferences;
2430
2728
  constructor(data) {
2431
2729
  if (data) {
@@ -2498,14 +2796,23 @@ class QuantityAssignmentDto {
2498
2796
  return data;
2499
2797
  }
2500
2798
  }
2799
+ /** This class holds specialized information that is relevant to trade or commerce based data exchange scenarios, e.g. between customers, vendors, suppliers and distributors. It is used when exporting to GAEB XML 9x exchange phases. */
2501
2800
  class CommercePropertiesDto {
2801
+ /** This maps to ArtNo in GAEB XML and represents an article number given by the supplier. */
2502
2802
  articleNumber;
2803
+ /** This maps to EAN in GAEB XML and represents an GTIN (formerly EAN) article number. */
2503
2804
  eanGtinArticleNumber;
2805
+ /** This maps to ArtNoID in GAEB XML and represents an ILN article number. */
2504
2806
  ilnArticleNumber;
2807
+ /** This maps to CatalogNo in GAEB XML and represents an identifier of a specific catalogue. The referenced catalogue is usually a customer specific one, not related to CatalogueReferences. */
2505
2808
  catalogueNumber;
2809
+ /** This maps to CatalogArtNo in GAEB XML and represents a key that maps to an entry in a specific catalogue. The referenced catalogue is usually a customer specific one, not related to CatalogueReferences. */
2506
2810
  catalogueArticleNumber;
2811
+ /** This optional property can be used to indicate the basis for prices for a single position. Price basis means that the price is given per unit of the basis, e.g. per a pack of five when this property is set to '5'. */
2507
2812
  priceBasis;
2813
+ /** This optional property can be used to indicate a sub position identifier specific for the commerce exchange */
2508
2814
  subPositionIdentifier;
2815
+ /** In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file */
2509
2816
  customerBaseItemNumber;
2510
2817
  constructor(data) {
2511
2818
  if (data) {
@@ -2546,8 +2853,11 @@ class CommercePropertiesDto {
2546
2853
  return data;
2547
2854
  }
2548
2855
  }
2856
+ /** This class represents the linking to a complementary position with a specific quantity set. For example, Position 'A' could be complementing Position 'B' with a total quantity of 20 units */
2549
2857
  class ComplementedByQuantityDto {
2858
+ /** The quantity that is complemented. E.g., if the base position has a quantity of 100 m² of a brick wall, a complementing position might be for 'walls that exceed 3 m height' and for a total quantity of 10 m². */
2550
2859
  quantity;
2860
+ /** This is the reference to the Id of the Position that is complementing. This means it does NOT reference the base position but the one that contains the actual addition. */
2551
2861
  complementingPositionId;
2552
2862
  constructor(data) {
2553
2863
  if (data) {
@@ -2576,13 +2886,21 @@ class ComplementedByQuantityDto {
2576
2886
  return data;
2577
2887
  }
2578
2888
  }
2889
+ /** 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. */
2579
2890
  class OenormPositionPropertiesDto {
2891
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
2580
2892
  originCode;
2893
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
2581
2894
  openingTextIsFreeText;
2895
+ /** This indicates if the ÖNorm 'wesentliche position' mark is set. This should no longer be used, please use the IsMainPosition property on the parent position instead. */
2582
2896
  isMainPosition;
2897
+ /** 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 */
2583
2898
  isUndividedPosition;
2899
+ /** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
2584
2900
  oenormShortText;
2901
+ /** In some ÖNorm formats, the short text can have it's own addition, so the text is split up in OenormShortText and OenormShortTextAddition To serialize this, either the ShortText property of the parent position needs to be null, or OenormShortText ' ' OenormShortTextAddition needs to match the ShortText. */
2585
2902
  oenormShortTextAddition;
2903
+ /** This maps to 'teilangebotskennzeichen' in ÖNorm positions, which means positions that are only partially offered. */
2586
2904
  partialOfferMark;
2587
2905
  constructor(data) {
2588
2906
  if (data) {
@@ -2621,12 +2939,14 @@ class OenormPositionPropertiesDto {
2621
2939
  return data;
2622
2940
  }
2623
2941
  }
2942
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
2624
2943
  var OenormOriginCodeDto;
2625
2944
  (function (OenormOriginCodeDto) {
2626
2945
  OenormOriginCodeDto["Unknown"] = "Unknown";
2627
2946
  OenormOriginCodeDto["FreeText"] = "FreeText";
2628
2947
  OenormOriginCodeDto["AdditionDescription"] = "AdditionDescription";
2629
2948
  })(OenormOriginCodeDto || (OenormOriginCodeDto = {}));
2949
+ /** This enumeration represents the status of an addendum, 'Nachtrag' in German */
2630
2950
  var AddendumStatusDto;
2631
2951
  (function (AddendumStatusDto) {
2632
2952
  AddendumStatusDto["Unknown"] = "Unknown";
@@ -2639,6 +2959,7 @@ var AddendumStatusDto;
2639
2959
  AddendumStatusDto["FormallyAcknowledged"] = "FormallyAcknowledged";
2640
2960
  AddendumStatusDto["Approved"] = "Approved";
2641
2961
  })(AddendumStatusDto || (AddendumStatusDto = {}));
2962
+ /** This enum represents the different ways in which a complementing position type can be specified. It is typically only used in GAEB exports, since in Dangl.AVA, complementing positions are always explicitly referenced. */
2642
2963
  var PositionComplementingTypeDto;
2643
2964
  (function (PositionComplementingTypeDto) {
2644
2965
  PositionComplementingTypeDto["Undefined"] = "Undefined";
@@ -2646,11 +2967,17 @@ var PositionComplementingTypeDto;
2646
2967
  PositionComplementingTypeDto["AllPreviousPositions"] = "AllPreviousPositions";
2647
2968
  PositionComplementingTypeDto["ReferencedPositions"] = "ReferencedPositions";
2648
2969
  })(PositionComplementingTypeDto || (PositionComplementingTypeDto = {}));
2970
+ /** This class holds properties that describe retention types in position. Retention / hold out usually means that a service is provided and kept available for a specific amount of time, e.g. fences on a construction site */
2649
2971
  class PositionHoldOutPropertiesDto {
2972
+ /** Elements GUID identifier. */
2650
2973
  id;
2974
+ /** The actual type */
2651
2975
  holdOutType;
2976
+ /** The duration of the period */
2652
2977
  holdOutDuration;
2978
+ /** The time unit of the period */
2653
2979
  holdOutDurationUnit;
2980
+ /** References to base positions */
2654
2981
  basePositionReferences;
2655
2982
  constructor(data) {
2656
2983
  if (data) {
@@ -2693,6 +3020,7 @@ class PositionHoldOutPropertiesDto {
2693
3020
  return data;
2694
3021
  }
2695
3022
  }
3023
+ /** Types of retentions to be used in positions */
2696
3024
  var HoldOutTypeDto;
2697
3025
  (function (HoldOutTypeDto) {
2698
3026
  HoldOutTypeDto["Unknown"] = "Unknown";
@@ -2700,6 +3028,7 @@ var HoldOutTypeDto;
2700
3028
  HoldOutTypeDto["Extension"] = "Extension";
2701
3029
  HoldOutTypeDto["Rent"] = "Rent";
2702
3030
  })(HoldOutTypeDto || (HoldOutTypeDto = {}));
3031
+ /** Duration used in retention positions */
2703
3032
  var HoldOutDurationUnitDto;
2704
3033
  (function (HoldOutDurationUnitDto) {
2705
3034
  HoldOutDurationUnitDto["Unknown"] = "Unknown";
@@ -2709,13 +3038,21 @@ var HoldOutDurationUnitDto;
2709
3038
  HoldOutDurationUnitDto["Weeks"] = "Weeks";
2710
3039
  HoldOutDurationUnitDto["Months"] = "Months";
2711
3040
  })(HoldOutDurationUnitDto || (HoldOutDurationUnitDto = {}));
3041
+ /** Price catalogue data represents assumed or estimated prices from a catalogue source */
2712
3042
  class PriceCatalogueDataDto {
3043
+ /** Elements GUID identifier. */
2713
3044
  id;
3045
+ /** The lower bound of the unit price */
2714
3046
  unitPriceFrom;
3047
+ /** The upper bound of the unit price */
2715
3048
  unitPriceTo;
3049
+ /** The average unit price */
2716
3050
  unitPriceAverage;
3051
+ /** The lower bound of the wage price */
2717
3052
  wagePriceFrom;
3053
+ /** The upper bound of the wage price */
2718
3054
  wagePriceTo;
3055
+ /** The average wage price */
2719
3056
  wagePriceAverage;
2720
3057
  constructor(data) {
2721
3058
  if (data) {
@@ -2754,9 +3091,13 @@ class PriceCatalogueDataDto {
2754
3091
  return data;
2755
3092
  }
2756
3093
  }
3094
+ /** An ExecutionDescription is used to give more details for certain items, especially on how they are meant to be executed. */
2757
3095
  class ExecutionDescriptionDto extends IElementDto {
3096
+ /** Blocks within an ExecutionDescription contain the actual information. */
2758
3097
  blocks;
3098
+ /** Labels this ExecutionDescription. */
2759
3099
  label;
3100
+ /** Uniquely identifies this ExecutionDescription. */
2760
3101
  identifier;
2761
3102
  elementType = 'ExecutionDescription';
2762
3103
  elementTypeDiscriminator = 'ExecutionDescription';
@@ -2806,27 +3147,42 @@ class ExecutionDescriptionDto extends IElementDto {
2806
3147
  return data;
2807
3148
  }
2808
3149
  }
3150
+ /** Represents an element that holds text information. */
2809
3151
  class NoteTextDto extends IElementDto {
3152
+ /** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special opening text at the beginning of the project. For example, in GAEB XML, this would map to the GAEB.Award.AddText. Typically, such texts describe project-wide contractual definitions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
2810
3153
  isOpeningText;
3154
+ /** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
2811
3155
  isClosingText;
2812
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
2813
- property. If you want to convert from DTO objects, and you want to work with the
2814
- `HtmlShortText` property, you need to set this property to null. */
3156
+ /** Short description for this DescriptionBase element.
3157
+ Please note that by default, this property takes precedence over the `HtmlShortText`
3158
+ property. If you want to convert from DTO objects, and you want to work with the
3159
+ `HtmlShortText` property, you need to set this property to null.
3160
+ */
2815
3161
  shortText;
2816
- /** This property is used to store the short text in HTML format. If you want to convert
2817
- from DTO objects, and you want to use this property, then you need to ensure that
2818
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
3162
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
3163
+ This property is used to store the short text in HTML format. If you want to convert
3164
+ from DTO objects, and you want to use this property, then you need to ensure that
3165
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
3166
+ */
2819
3167
  htmlShortText;
3168
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
2820
3169
  additionType;
3170
+ /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2821
3171
  longText;
3172
+ /** This contains the Html representation of the Longtext. When the LongText is set, this is automatically overwritten and filled with the appropriate Html representation of the plaintext. Vice versa, setting this property overrides the LongText. GAEB 90 and GAEB 2000 exports do not support any image functionality. In GAEB XML, only images that use an embedded Base64 data uri are exported, regular url references are cleared before written out. */
2822
3173
  htmlLongText;
3174
+ /** This is an optional internal identifier that may be used to add additional information to this NoteText. It is not supported in GAEB import or export. */
2823
3175
  identifier;
3176
+ /** 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. */
2824
3177
  standardizedDescription;
2825
3178
  elementType = 'NoteText';
2826
3179
  elementTypeDiscriminator = 'NoteText';
3180
+ /** 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. */
2827
3181
  descriptionId;
3182
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
2828
3183
  oenormNoteTextProperties;
2829
3184
  hasBidderCommentInHtmlLongText;
3185
+ /** This is a string reference that's used by some description elements to reference a base or parent catalogue. For example, it's 'WICNo' in GAEB. */
2830
3186
  baseCatalogueNumber;
2831
3187
  constructor(data) {
2832
3188
  super(data);
@@ -2905,9 +3261,13 @@ from DTO objects, and you want to use this property, then you need to ensure tha
2905
3261
  return data;
2906
3262
  }
2907
3263
  }
3264
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
2908
3265
  class OenormNoteTextPropertiesDto {
3266
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
2909
3267
  originCode;
3268
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
2910
3269
  openingTextIsFreeText;
3270
+ /** This indicates if the ÖNorm position / note text was a 'ungeteilteposition' (undivided position). This will only be taken into account when the position / note text is also the sole element inside it's parent group */
2911
3271
  isUndividedPosition;
2912
3272
  constructor(data) {
2913
3273
  if (data) {
@@ -2938,38 +3298,69 @@ class OenormNoteTextPropertiesDto {
2938
3298
  return data;
2939
3299
  }
2940
3300
  }
3301
+ /** This is a grouping IElement that holds other IElements within. */
2941
3302
  class ServiceSpecificationGroupDto extends IElementDto {
3303
+ /** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
2942
3304
  projectHourlyWage;
3305
+ /** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
2943
3306
  projectTaxRate;
3307
+ /** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
2944
3308
  projectPriceComponents;
3309
+ /** The ItemNumberSchema that is used within this project. */
2945
3310
  projectItemNumberSchema;
3311
+ /** The IElements within this ElementContainerBase. */
2946
3312
  elements;
3313
+ /** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
2947
3314
  projectLabourTimeLabel;
3315
+ /** Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers. */
2948
3316
  containsDuplicateItemNumbers;
3317
+ /** Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers. */
2949
3318
  containsDuplicateElementIds;
3319
+ /** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
2950
3320
  ignoreDuplicateItemNumbers;
3321
+ /** If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties */
2951
3322
  ignoreProjectCataloguePropagation;
3323
+ /** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
2952
3324
  ignoreDuplicateElementIds;
3325
+ /** Price composition by tax rate. */
2953
3326
  totalPriceGrossByTaxRate;
3327
+ /** Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once. */
2954
3328
  ignoreChildPriceUpdates;
3329
+ /** Net price after applied deductions. */
2955
3330
  deductedPrice;
3331
+ /** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
2956
3332
  deductionFactor;
3333
+ /** 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. */
2957
3334
  absoluteDeduction;
3335
+ /** Will return this ElementContainerBase's total price. */
2958
3336
  totalPrice;
3337
+ /** The total gross price for this ElementContainerBase including all child elements. */
2959
3338
  totalPriceGross;
3339
+ /** Total gross price after applied deductions. */
2960
3340
  totalPriceGrossDeducted;
3341
+ /** Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not. */
2961
3342
  priceType;
3343
+ /** Description for this ServiceSpecificationGroup. */
2962
3344
  shortText;
3345
+ /** Indicates if this service specification group is commissioned (and therefore should be executed), postponed for later or undefined. */
2963
3346
  comissionStatus;
3347
+ /** The ItemNumber for this INumberedElement interface. */
2964
3348
  itemNumber;
2965
3349
  elementType = 'ServiceSpecificationGroup';
2966
3350
  elementTypeDiscriminator = 'ServiceSpecificationGroup';
3351
+ /** This indicates if this group is the parent of a lot. See the documentation for more information about working with lots. */
2967
3352
  isLot;
3353
+ /** If this group is an alternative for a base group, then this property should point to the id of the group in this service specification that it can replace. If this is an alternative group to a base group, the PriceType should typically be set to "WithoutTotal" so this group does not factor into total costs. The PriceType is not changed when this property is set */
2968
3354
  alternativeTo;
3355
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
2969
3356
  oenormProperties;
3357
+ /** 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. */
2970
3358
  hierarchyLevel;
3359
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
2971
3360
  addendumStatus;
3361
+ /** This is an optional property that can be used together with AlternativeTo. If this is set, you can indicate which alternative group a specific group is assigned to. That way, if you specifiy multiple alternative ServiceSpecificationGroups with the same AlternativeIdentifier, you can indicate that to replace a single base ServiceSpecificationGroup, multiple alternative ServiceSpecificationGroups should be used. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo. */
2972
3362
  alternativeIdentifier;
3363
+ /** This is an optional property that can be used together with AlternativeTo and AlternativeGroupIdentifier. If this is set, you can indicate which alternative group a specific group is assigned to. That way, you can specify the id (in integer format) for the alternative group this group belongs to. It's different to AlternativeIdentifier in that the other property describes the id of the group, while this property here describes the group itself. If a group only has set AlternativeGroupIdentifier but not AlternativeIdentifier, then it likely is a base group for a specific group. This property is not checked or managed automatically, so it is possible for this property to become invalid, by for example setting this property but not setting a base group via AlternativeTo. */
2973
3364
  alternativeGroupIdentifier;
2974
3365
  constructor(data) {
2975
3366
  super(data);
@@ -3134,14 +3525,23 @@ class ServiceSpecificationGroupDto extends IElementDto {
3134
3525
  return data;
3135
3526
  }
3136
3527
  }
3528
+ /** This is used in an ElementContainerBase to hold the price composition. */
3137
3529
  class GrossPriceComponentDto {
3530
+ /** This components tax rate. */
3138
3531
  taxRate;
3532
+ /** This is the factor of applied deductions for this component */
3139
3533
  deductionFactor;
3534
+ /** The total net price for all components of a given tax rate. */
3140
3535
  totalNet;
3536
+ /** The resulting price component after applied deductions */
3141
3537
  totalDeducted;
3538
+ /** The total tax amount for all components of a given tax rate. */
3142
3539
  totalTax;
3540
+ /** The total gross price for all components of a given tax rate. */
3143
3541
  totalGross;
3542
+ /** The total gross price for all components of a given tax rate, after applied deductions. */
3144
3543
  totalGrossDeducted;
3544
+ /** The total tax amount for all components of a given tax rate, after applied deductions. */
3145
3545
  totalTaxDeducted;
3146
3546
  constructor(data) {
3147
3547
  if (data) {
@@ -3182,8 +3582,11 @@ class GrossPriceComponentDto {
3182
3582
  return data;
3183
3583
  }
3184
3584
  }
3585
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
3185
3586
  class OenormPropertiesDto {
3587
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
3186
3588
  originCode;
3589
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
3187
3590
  openingTextIsFreeText;
3188
3591
  constructor(data) {
3189
3592
  if (data) {
@@ -3212,6 +3615,7 @@ class OenormPropertiesDto {
3212
3615
  return data;
3213
3616
  }
3214
3617
  }
3618
+ /** Indicates a ServiceSpecification's exchange phase, based on the GAEB exchange phases. */
3215
3619
  var ExchangePhaseDto;
3216
3620
  (function (ExchangePhaseDto) {
3217
3621
  ExchangePhaseDto["Undefined"] = "Undefined";
@@ -3222,6 +3626,7 @@ var ExchangePhaseDto;
3222
3626
  ExchangePhaseDto["SideOffer"] = "SideOffer";
3223
3627
  ExchangePhaseDto["Grant"] = "Grant";
3224
3628
  })(ExchangePhaseDto || (ExchangePhaseDto = {}));
3629
+ /** Indicates where a service specification was originally created. */
3225
3630
  var OriginDto;
3226
3631
  (function (OriginDto) {
3227
3632
  OriginDto["Self"] = "Self";
@@ -3232,13 +3637,21 @@ var OriginDto;
3232
3637
  OriginDto["Reb"] = "Reb";
3233
3638
  OriginDto["Sia"] = "Sia";
3234
3639
  })(OriginDto || (OriginDto = {}));
3640
+ /** Holds global price information for a ServiceSpecification */
3235
3641
  class PriceInformationDto {
3642
+ /** Elements GUID identifier. */
3236
3643
  id;
3644
+ /** The amount of currency per one hour of manual labour work in this project. */
3237
3645
  hourlyWage;
3646
+ /** The final, total price will be deducted by this rate. */
3238
3647
  deductionFactor;
3648
+ /** This is given when there is only one flat price for the whole service specification. */
3239
3649
  flatSum;
3650
+ /** Global tax rate for the project. Note that certain elements may have a different, specific tax rate. */
3240
3651
  taxRate;
3652
+ /** This property indicates if the TaxRate property is actually zero (0) or if it's just unset. The TaxRate is a non-nullable property, so it can't be null and therefore a distinction between unset and zero relies on this additional property. When exporting to GAEB, this can be used e.g. to decide whether or not the tax rate should be serialized. This property is automtically set to false when the TaxRate is set to any value, even zero. If the TaxRate is not set to zero, this property will always return false and can not be set to true. */
3241
3653
  hasUnsetTaxRate;
3654
+ /** Trade discounts for offered in this ServiceSpecification. */
3242
3655
  tradeDiscounts;
3243
3656
  constructor(data) {
3244
3657
  if (data) {
@@ -3297,9 +3710,13 @@ class PriceInformationDto {
3297
3710
  return data;
3298
3711
  }
3299
3712
  }
3713
+ /** This class holds information about offered trade discounts (Skonto in German) */
3300
3714
  class TradeDiscountDto {
3715
+ /** Elements GUID identifier. */
3301
3716
  id;
3717
+ /** The amount of days for how long a declared trade discount applies. Must be a positive number, negative values will be ignored and not set. */
3302
3718
  deadline;
3719
+ /** The rate of the trade discount. */
3303
3720
  rate;
3304
3721
  constructor(data) {
3305
3722
  if (data) {
@@ -3330,9 +3747,13 @@ class TradeDiscountDto {
3330
3747
  return data;
3331
3748
  }
3332
3749
  }
3750
+ /** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
3333
3751
  class SustainabilityCatalogueDto {
3752
+ /** Elements GUID identifier. */
3334
3753
  id;
3754
+ /** The key must be a unique identifier for the sustainability catalogue. It is used to link sustainability data in positions to a catalogue. The Dangl.AVA module does not enforce uniqueness, but it is recommended to use a unique key for each catalogue. */
3335
3755
  key;
3756
+ /** The description property can be used to provide further information about the sustainability catalogue. */
3336
3757
  description;
3337
3758
  constructor(data) {
3338
3759
  if (data) {
@@ -3363,8 +3784,11 @@ class SustainabilityCatalogueDto {
3363
3784
  return data;
3364
3785
  }
3365
3786
  }
3787
+ /** 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 */
3366
3788
  class WarrantyDurationDto {
3789
+ /** 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. */
3367
3790
  duration;
3791
+ /** The unit of the duration */
3368
3792
  unit;
3369
3793
  constructor(data) {
3370
3794
  if (data) {
@@ -3393,23 +3817,37 @@ class WarrantyDurationDto {
3393
3817
  return data;
3394
3818
  }
3395
3819
  }
3820
+ /** This enumeration represents the unit of a duration */
3396
3821
  var DurationUnitDto;
3397
3822
  (function (DurationUnitDto) {
3398
3823
  DurationUnitDto["Months"] = "Months";
3399
3824
  DurationUnitDto["Years"] = "Years";
3400
3825
  })(DurationUnitDto || (DurationUnitDto = {}));
3826
+ /** This class represents properties used in commerce exchange scenarios */
3401
3827
  class ServiceSpecificationCommercePropertiesDto {
3828
+ /** The date until the price is valid or fixed. */
3402
3829
  fixedPriceDate;
3830
+ /** The date of the delivery voucher note. */
3403
3831
  deliveryVoucherDate;
3832
+ /** The actual date of delivery. */
3404
3833
  deliveryDate;
3834
+ /** The number of the inquiry, usually in a context of offer requests. */
3405
3835
  inquiryNumber;
3836
+ /** The number of the offer, usually in a context of an offer. */
3406
3837
  offerNumber;
3838
+ /** The order number, usually in the context of a grant or contract. */
3407
3839
  orderNumber;
3840
+ /** The order confirmation number */
3408
3841
  orderConfirmationNumber;
3842
+ /** The number of the delivery, e.g. on the delivery note voucher. */
3409
3843
  deliveryNumber;
3844
+ /** The reference number of the customer / buyer. */
3410
3845
  customerReferenceNumber;
3846
+ /** The reference number of the supplier / bidder. */
3411
3847
  supplierReferenceNumber;
3848
+ /** The type of shippment. */
3412
3849
  shippingType;
3850
+ /** The type of the price inquiry. */
3413
3851
  inquiryType;
3414
3852
  constructor(data) {
3415
3853
  if (data) {
@@ -3458,6 +3896,7 @@ class ServiceSpecificationCommercePropertiesDto {
3458
3896
  return data;
3459
3897
  }
3460
3898
  }
3899
+ /** This enum represents types of price inquiries */
3461
3900
  var CommerceInquiryTypeDto;
3462
3901
  (function (CommerceInquiryTypeDto) {
3463
3902
  CommerceInquiryTypeDto["Unknown"] = "Unknown";
@@ -3465,10 +3904,15 @@ var CommerceInquiryTypeDto;
3465
3904
  CommerceInquiryTypeDto["Immediate"] = "Immediate";
3466
3905
  CommerceInquiryTypeDto["Exhibition"] = "Exhibition";
3467
3906
  })(CommerceInquiryTypeDto || (CommerceInquiryTypeDto = {}));
3907
+ /** This class holds ÖNorm-specific properties for a ServiceSpecification. */
3468
3908
  class ServiceSpecificationOenormPropertiesDto {
3909
+ /** The LB (Leistungsbeschreibung) references for this service specification. */
3469
3910
  lbReferences;
3911
+ /** The LB (Leistungsbeschreibung) references for addition descriptions of this service specification. */
3470
3912
  lbReferenceAdditions;
3913
+ /** The party that created the service specification (LV-Ersteller in ÖNorm). */
3471
3914
  serviceSpecificationCreator;
3915
+ /** The awarding authority (ausschreibende Stelle / vergebende Stelle in ÖNorm). */
3472
3916
  awardingAuthority;
3473
3917
  constructor(data) {
3474
3918
  if (data) {
@@ -3563,21 +4007,37 @@ class ServiceSpecificationOenormPropertiesDto {
3563
4007
  return data;
3564
4008
  }
3565
4009
  }
4010
+ /** This class holds reference data for an ÖNorm LB (Leistungsbeschreibung / service specification). */
3566
4011
  class OenormLBReferenceDto {
4012
+ /** Elements GUID identifier. */
3567
4013
  id;
4014
+ /** The name of the referenced service specification. */
3568
4015
  name;
4016
+ /** The number of the referenced service specification. */
3569
4017
  number;
4018
+ /** The addition number of the referenced service specification. */
3570
4019
  additionNumber;
4020
+ /** The date of the referenced service specification. */
3571
4021
  date;
4022
+ /** The subject area identifier of the referenced service specification. */
3572
4023
  subjectAreaIdentifier;
4024
+ /** The download URL for the referenced service specification. */
3573
4025
  downloadUrl;
4026
+ /** The part/edition name of the referenced service specification. */
3574
4027
  partEditionName;
4028
+ /** The publisher name. */
3575
4029
  publisherName;
4030
+ /** The publisher street address. */
3576
4031
  publisherStreet;
4032
+ /** The publisher city. */
3577
4033
  publisherCity;
4034
+ /** The publisher country. */
3578
4035
  publisherCountry;
4036
+ /** The publisher zip code. */
3579
4037
  publisherZipCode;
4038
+ /** The publisher phone number. */
3580
4039
  publisherPhone;
4040
+ /** The publisher website URL. */
3581
4041
  publisherWebsite;
3582
4042
  constructor(data) {
3583
4043
  if (data) {
@@ -3632,14 +4092,23 @@ class OenormLBReferenceDto {
3632
4092
  return data;
3633
4093
  }
3634
4094
  }
4095
+ /** A Project contains all relevant information for a construction project. */
3635
4096
  class ProjectDto {
4097
+ /** Elements GUID identifier. */
3636
4098
  id;
4099
+ /** This property controls the accuracy of all price properties, meaning how many decimal places are preserved in calculations. It defaults to DEFAULT_PRICE_ACCURACY. Please see the Dangl.AVA documentation for further information about decimal precision. If UnitPriceAccuracy is set, then this property is ignored for unit prices. */
3637
4100
  priceAccuracy;
4101
+ /** This property controls the accuracy of position unit price properties, meaning how many decimal places are preserved in calculations. Please see the Dangl.AVA documentation for further information about decimal precision. This can be separately set from PriceAccuracy, and it only controls the accuracy of the unit price of positions, not the total price. It defaults to null, which means the standard PriceAccuracy is used for unit prices. */
3638
4102
  unitPriceAccuracy;
4103
+ /** This forces total prices to be the strict product of quantities times unit price in positions. It is enabled by default. If this is disabled, both the unit price and the total price of positions is calculated from the non-rounded values. Please see the documentation for a more detailed explanation of this setting. */
3639
4104
  forceStrictTotals;
4105
+ /** This property controls the rounding mode of all price properties, meaning how rounding of decimal places is performed in price calculations. It defaults to DEFAULT_ROUNDING_MODE. Please see the Dangl.AVA documentation for further information about decimal precision. */
3640
4106
  priceRoundingMode;
4107
+ /** The ProjectInformation contains information that describes the project and its structure. */
3641
4108
  projectInformation;
4109
+ /** The ServiceSpecifications in this Project. */
3642
4110
  serviceSpecifications;
4111
+ /** This is used to store the GAEB XML Id within this Project. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization. */
3643
4112
  gaebXmlId;
3644
4113
  constructor(data) {
3645
4114
  if (data) {
@@ -3714,12 +4183,12 @@ class ProjectDto {
3714
4183
 
3715
4184
  // This file is automatically generated as part of the build process
3716
4185
  const avaModelsVersion = {
3717
- version: "2.31.0",
3718
- commitInfo: "Branch.master.Sha.a1e3dc03c5e2937d4b5110d3836096aae5c45f70",
3719
- commitDate: "2026-08-13",
3720
- commitHash: "a1e3dc03c5e2937d4b5110d3836096aae5c45f70",
3721
- informationalVersion: "2.31.0+Branch.master.Sha.a1e3dc03c5e2937d4b5110d3836096aae5c45f70",
3722
- buildDateUtc: new Date(Date.UTC(2026, 7, 13, 12, 27, 10))
4186
+ version: "2.31.1-beta0013",
4187
+ commitInfo: "Branch.develop.Sha.f97eb8f5e0378cc8f04c8531efce9f043f7c0091",
4188
+ commitDate: "2026-09-22",
4189
+ commitHash: "f97eb8f5e0378cc8f04c8531efce9f043f7c0091",
4190
+ informationalVersion: "2.31.1-beta.13+Branch.develop.Sha.f97eb8f5e0378cc8f04c8531efce9f043f7c0091",
4191
+ buildDateUtc: new Date(Date.UTC(2026, 8, 22, 14, 44, 33))
3723
4192
  };
3724
4193
 
3725
4194
  /**