@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.
@@ -1,187 +1,327 @@
1
+ /** This enum configures rounding modes for price calculations in projects */
1
2
  declare enum PriceRoundingModeDto {
2
3
  Normal = "Normal",
3
4
  Floor = "Floor",
4
5
  Ceiling = "Ceiling"
5
6
  }
7
+ /** General information about a Project. */
6
8
  declare class ProjectInformationDto implements IProjectInformationDto {
9
+ /** Information about the buyer. */
7
10
  buyer?: PartyInformationDto | undefined;
11
+ /** Description for the project. */
8
12
  description?: string | undefined;
13
+ /** Short description for the project. */
9
14
  descriptionShort?: string | undefined;
15
+ /** Name of the project. */
10
16
  name?: string | undefined;
17
+ /** Information about the site. */
11
18
  site?: PartyInformationDto | undefined;
19
+ /** The ItemNumberSchema used in the project. */
12
20
  itemNumberSchema?: ItemNumberSchemaDto | undefined;
21
+ /** Short label for the currency used. */
13
22
  currencyShort?: string | undefined;
23
+ /** Full label of the currency used. */
14
24
  currencyLong?: string | undefined;
25
+ /** Label for the labour time part of prices used in the project. */
15
26
  labourTimeLabel?: string | undefined;
27
+ /** 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. */
16
28
  priceComponents?: string[] | undefined;
29
+ /** 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. */
17
30
  readonly priceComponentTypes?: {
18
31
  [key: string]: PriceComponentTypeDto;
19
32
  } | undefined;
33
+ /** 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. */
20
34
  bidderCommentAllowed: boolean;
35
+ /** This property indicates if the project should allow side offers from contractors. In GAEB, a side offer would typically be in exchange phase 85. */
21
36
  sideOffersAllowed: boolean;
22
- awardType?: AwardTypeDto | undefined;
23
- specialAwardKind?: SpecialAwardKindDto | undefined;
37
+ /** 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 */
38
+ awardType: AwardTypeDto;
39
+ /** 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 */
40
+ specialAwardKind: SpecialAwardKindDto;
41
+ /** Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners. */
24
42
  requesters?: PartyInformationDto[] | undefined;
43
+ /** Notification sites are addresses that are used for delivering messages in the context of construction projects. */
25
44
  notificationSites?: PartyInformationDto[] | undefined;
26
45
  constructor(data?: IProjectInformationDto);
27
46
  init?(_data?: any): void;
28
47
  static fromJS(data: any): ProjectInformationDto;
29
48
  toJSON?(data?: any): any;
30
49
  }
50
+ /** General information about a Project. */
31
51
  interface IProjectInformationDto {
52
+ /** Information about the buyer. */
32
53
  buyer?: IPartyInformationDto | undefined;
54
+ /** Description for the project. */
33
55
  description?: string | undefined;
56
+ /** Short description for the project. */
34
57
  descriptionShort?: string | undefined;
58
+ /** Name of the project. */
35
59
  name?: string | undefined;
60
+ /** Information about the site. */
36
61
  site?: IPartyInformationDto | undefined;
62
+ /** The ItemNumberSchema used in the project. */
37
63
  itemNumberSchema?: IItemNumberSchemaDto | undefined;
64
+ /** Short label for the currency used. */
38
65
  currencyShort?: string | undefined;
66
+ /** Full label of the currency used. */
39
67
  currencyLong?: string | undefined;
68
+ /** Label for the labour time part of prices used in the project. */
40
69
  labourTimeLabel?: string | undefined;
70
+ /** 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. */
41
71
  priceComponents?: string[] | undefined;
72
+ /** 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. */
42
73
  priceComponentTypes?: {
43
74
  [key: string]: PriceComponentTypeDto;
44
75
  } | undefined;
76
+ /** 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. */
45
77
  bidderCommentAllowed: boolean;
78
+ /** This property indicates if the project should allow side offers from contractors. In GAEB, a side offer would typically be in exchange phase 85. */
46
79
  sideOffersAllowed: boolean;
47
- awardType?: AwardTypeDto | undefined;
48
- specialAwardKind?: SpecialAwardKindDto | undefined;
80
+ /** 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 */
81
+ awardType: AwardTypeDto;
82
+ /** 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 */
83
+ specialAwardKind: SpecialAwardKindDto;
84
+ /** Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners. */
49
85
  requesters?: IPartyInformationDto[] | undefined;
86
+ /** Notification sites are addresses that are used for delivering messages in the context of construction projects. */
50
87
  notificationSites?: IPartyInformationDto[] | undefined;
51
88
  }
89
+ /** Represents information about a party (a site or an organization). */
52
90
  declare class PartyInformationDto implements IPartyInformationDto {
91
+ /** Elements GUID identifier. */
53
92
  id: string;
93
+ /** This party's name. */
54
94
  name?: string | undefined;
95
+ /** This party's street. */
55
96
  street?: string | undefined;
97
+ /** This party's ZipCode. */
56
98
  zipCode?: string | undefined;
99
+ /** This party's City. */
57
100
  city?: string | undefined;
101
+ /** This party's Country. */
58
102
  country?: string | undefined;
103
+ /** This party's Identifier. */
59
104
  identifier?: string | undefined;
105
+ /** Remarks for this party. */
60
106
  remarks?: string | undefined;
107
+ /** An email address for this party. */
61
108
  email?: string | undefined;
109
+ /** A phone number for this party. */
62
110
  phone?: string | undefined;
111
+ /** The name of a contact person. */
63
112
  contactPersonName?: string | undefined;
113
+ /** 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. */
64
114
  awardIdentifier?: string | undefined;
115
+ /** This property indicates if the party is registered within the European Economic Area. */
65
116
  isInEuropeanEconomicArea: boolean;
117
+ /** If this is within the European Economic Area (see IsInEuropeanEconomicArea, then as a business entity it likely has an EU VAT Id. */
66
118
  vatId?: string | undefined;
119
+ /** The fax number for this party. */
67
120
  fax?: string | undefined;
121
+ /** The two letter ISO country code, e.g. DE for Germany. */
68
122
  countryCode?: string | undefined;
123
+ /** Depending on which party this class represents, it might have either a 'creditor' or 'debtor' number. This is often used in internal accounting systems. */
69
124
  creditorOrDebtorIdentifier?: string | undefined;
125
+ /** 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. */
70
126
  globalLocationNumber?: string | undefined;
127
+ /** This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders. */
71
128
  bankingInformation?: BankingInformationDto[] | undefined;
129
+ /** 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. */
72
130
  registrationNumber?: string | undefined;
131
+ /** 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. */
73
132
  taxId?: string | undefined;
74
133
  constructor(data?: IPartyInformationDto);
75
134
  init?(_data?: any): void;
76
135
  static fromJS(data: any): PartyInformationDto;
77
136
  toJSON?(data?: any): any;
78
137
  }
138
+ /** Represents information about a party (a site or an organization). */
79
139
  interface IPartyInformationDto {
140
+ /** Elements GUID identifier. */
80
141
  id: string;
142
+ /** This party's name. */
81
143
  name?: string | undefined;
144
+ /** This party's street. */
82
145
  street?: string | undefined;
146
+ /** This party's ZipCode. */
83
147
  zipCode?: string | undefined;
148
+ /** This party's City. */
84
149
  city?: string | undefined;
150
+ /** This party's Country. */
85
151
  country?: string | undefined;
152
+ /** This party's Identifier. */
86
153
  identifier?: string | undefined;
154
+ /** Remarks for this party. */
87
155
  remarks?: string | undefined;
156
+ /** An email address for this party. */
88
157
  email?: string | undefined;
158
+ /** A phone number for this party. */
89
159
  phone?: string | undefined;
160
+ /** The name of a contact person. */
90
161
  contactPersonName?: string | undefined;
162
+ /** 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. */
91
163
  awardIdentifier?: string | undefined;
164
+ /** This property indicates if the party is registered within the European Economic Area. */
92
165
  isInEuropeanEconomicArea: boolean;
166
+ /** If this is within the European Economic Area (see IsInEuropeanEconomicArea, then as a business entity it likely has an EU VAT Id. */
93
167
  vatId?: string | undefined;
168
+ /** The fax number for this party. */
94
169
  fax?: string | undefined;
170
+ /** The two letter ISO country code, e.g. DE for Germany. */
95
171
  countryCode?: string | undefined;
172
+ /** Depending on which party this class represents, it might have either a 'creditor' or 'debtor' number. This is often used in internal accounting systems. */
96
173
  creditorOrDebtorIdentifier?: string | undefined;
174
+ /** 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. */
97
175
  globalLocationNumber?: string | undefined;
176
+ /** This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders. */
98
177
  bankingInformation?: IBankingInformationDto[] | undefined;
178
+ /** 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. */
99
179
  registrationNumber?: string | undefined;
180
+ /** 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. */
100
181
  taxId?: string | undefined;
101
182
  }
183
+ /** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
102
184
  declare class BankingInformationDto implements IBankingInformationDto {
185
+ /** Elements GUID identifier. */
103
186
  id: string;
187
+ /** The name of the bank. */
104
188
  name?: string | undefined;
189
+ /** The international identifier for the bank account. */
105
190
  iban?: string | undefined;
191
+ /** The account number. Typically no longer used since the introduction of IBAN within the SEPA area. */
106
192
  accountNumber?: string | undefined;
193
+ /** The international bank identifier. */
107
194
  bic?: string | undefined;
195
+ /** The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area. */
108
196
  routingNumber?: string | undefined;
109
197
  constructor(data?: IBankingInformationDto);
110
198
  init?(_data?: any): void;
111
199
  static fromJS(data: any): BankingInformationDto;
112
200
  toJSON?(data?: any): any;
113
201
  }
202
+ /** This is a class that represents the information about a bank connection. It is usually used within a PartyInformation. */
114
203
  interface IBankingInformationDto {
204
+ /** Elements GUID identifier. */
115
205
  id: string;
206
+ /** The name of the bank. */
116
207
  name?: string | undefined;
208
+ /** The international identifier for the bank account. */
117
209
  iban?: string | undefined;
210
+ /** The account number. Typically no longer used since the introduction of IBAN within the SEPA area. */
118
211
  accountNumber?: string | undefined;
212
+ /** The international bank identifier. */
119
213
  bic?: string | undefined;
214
+ /** The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area. */
120
215
  routingNumber?: string | undefined;
121
216
  }
217
+ /** The schema for ItemNumber's in a Project. */
122
218
  declare class ItemNumberSchemaDto implements IItemNumberSchemaDto {
219
+ /** The count of tiers in the ItemNumberSchema */
123
220
  readonly totalLength: number;
221
+ /** The collection of tiers for this ItemNumberSchema. */
124
222
  tiers?: ItemNumberSchemaTierDto[] | undefined;
223
+ /** 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 */
125
224
  separator?: string | undefined;
225
+ /** 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. */
126
226
  filler?: string | undefined;
227
+ /** 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. */
127
228
  identifier?: string | undefined;
229
+ /** 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. */
128
230
  skipNonExistingLevelsInPositionItemNumbers: boolean;
231
+ /** 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. */
129
232
  skippedTiersFiller?: string | undefined;
233
+ /** 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. */
130
234
  readonly schemaIsCorrectlyDefined: boolean;
235
+ /** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
131
236
  allowUpperCaseLettering: boolean;
237
+ /** 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. */
132
238
  disableLeftPaddingTiersWithFiller: boolean;
239
+ /** 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. */
133
240
  disableItemNumberIdentifierTransformations: boolean;
241
+ /** 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 */
134
242
  disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
135
243
  constructor(data?: IItemNumberSchemaDto);
136
244
  init?(_data?: any): void;
137
245
  static fromJS(data: any): ItemNumberSchemaDto;
138
246
  toJSON?(data?: any): any;
139
247
  }
248
+ /** The schema for ItemNumber's in a Project. */
140
249
  interface IItemNumberSchemaDto {
250
+ /** The count of tiers in the ItemNumberSchema */
141
251
  totalLength: number;
252
+ /** The collection of tiers for this ItemNumberSchema. */
142
253
  tiers?: IItemNumberSchemaTierDto[] | undefined;
254
+ /** 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 */
143
255
  separator?: string | undefined;
256
+ /** 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. */
144
257
  filler?: string | undefined;
258
+ /** 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. */
145
259
  identifier?: string | undefined;
260
+ /** 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. */
146
261
  skipNonExistingLevelsInPositionItemNumbers: boolean;
262
+ /** 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. */
147
263
  skippedTiersFiller?: string | undefined;
264
+ /** 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. */
148
265
  schemaIsCorrectlyDefined: boolean;
266
+ /** Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation. */
149
267
  allowUpperCaseLettering: boolean;
268
+ /** 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. */
150
269
  disableLeftPaddingTiersWithFiller: boolean;
270
+ /** 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. */
151
271
  disableItemNumberIdentifierTransformations: boolean;
272
+ /** 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 */
152
273
  disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers: boolean;
153
274
  }
275
+ /** Represents information about a single Tier in an ItemNumber. */
154
276
  declare class ItemNumberSchemaTierDto implements IItemNumberSchemaTierDto {
277
+ /** The (maximum) length for this tier. Will not accept a length less than 1. Defaults to 1 if length less than one is specified. */
155
278
  length: number;
156
- type?: ItemNumberTypeDto | undefined;
279
+ /** This ItemNumberSchemaTier's type. */
280
+ type: ItemNumberTypeDto;
281
+ /** 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. */
157
282
  alignment?: ItemNumberSchemaTierAlignmentDto | undefined;
158
- tierType?: ItemNumberSchemaTierTypeDto | undefined;
283
+ /** This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level. */
284
+ tierType: ItemNumberSchemaTierTypeDto;
285
+ /** Indicates if this tier represents a lot. See the documentation for more information about lots. */
159
286
  readonly isLot: boolean;
287
+ /** 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' */
160
288
  increment: number;
289
+ /** This is an optional name for the given tier */
161
290
  tierName?: string | undefined;
162
291
  constructor(data?: IItemNumberSchemaTierDto);
163
292
  init?(_data?: any): void;
164
293
  static fromJS(data: any): ItemNumberSchemaTierDto;
165
294
  toJSON?(data?: any): any;
166
295
  }
296
+ /** Represents information about a single Tier in an ItemNumber. */
167
297
  interface IItemNumberSchemaTierDto {
298
+ /** The (maximum) length for this tier. Will not accept a length less than 1. Defaults to 1 if length less than one is specified. */
168
299
  length: number;
169
- type?: ItemNumberTypeDto | undefined;
300
+ /** This ItemNumberSchemaTier's type. */
301
+ type: ItemNumberTypeDto;
302
+ /** 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. */
170
303
  alignment?: ItemNumberSchemaTierAlignmentDto | undefined;
171
- tierType?: ItemNumberSchemaTierTypeDto | undefined;
304
+ /** This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level. */
305
+ tierType: ItemNumberSchemaTierTypeDto;
306
+ /** Indicates if this tier represents a lot. See the documentation for more information about lots. */
172
307
  isLot: boolean;
308
+ /** 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' */
173
309
  increment: number;
310
+ /** This is an optional name for the given tier */
174
311
  tierName?: string | undefined;
175
312
  }
313
+ /** Determines the type of an ItemNumberSchema */
176
314
  declare enum ItemNumberTypeDto {
177
315
  Numeric = "Numeric",
178
316
  Alphanumeric = "Alphanumeric"
179
317
  }
318
+ /** 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. */
180
319
  declare enum ItemNumberSchemaTierAlignmentDto {
181
320
  Undefined = "Undefined",
182
321
  Left = "Left",
183
322
  Right = "Right"
184
323
  }
324
+ /** Specifies the type an ItemNumberSchemaTier represents. For example, a tier may indicate to be used for positions or for groups. */
185
325
  declare enum ItemNumberSchemaTierTypeDto {
186
326
  Undefined = "Undefined",
187
327
  Index = "Index",
@@ -189,6 +329,7 @@ declare enum ItemNumberSchemaTierTypeDto {
189
329
  Group = "Group",
190
330
  Lot = "Lot"
191
331
  }
332
+ /** This enumeration models types of price components for better classification. */
192
333
  declare enum PriceComponentTypeDto {
193
334
  Unknown = "Unknown",
194
335
  Wages = "Wages",
@@ -196,6 +337,7 @@ declare enum PriceComponentTypeDto {
196
337
  Plant = "Plant",
197
338
  Miscellaneous = "Miscellaneous"
198
339
  }
340
+ /** 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 */
199
341
  declare enum AwardTypeDto {
200
342
  Unspecified = "Unspecified",
201
343
  OpenProcurement = "OpenProcurement",
@@ -210,137 +352,256 @@ declare enum AwardTypeDto {
210
352
  CompetitiveDialog = "CompetitiveDialog",
211
353
  InnovationPartnership = "InnovationPartnership"
212
354
  }
355
+ /** 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 */
213
356
  declare enum SpecialAwardKindDto {
214
357
  Unspecified = "Unspecified",
215
358
  MaintenanceContract = "MaintenanceContract",
216
359
  OutlineContract = "OutlineContract",
217
360
  OutlineForMaintenanceContract = "OutlineForMaintenanceContract"
218
361
  }
362
+ /** This is the base class that holds information about a whole service specification. */
219
363
  declare class ServiceSpecificationDto implements IServiceSpecificationDto {
364
+ /** Elements GUID identifier. */
220
365
  id: string;
366
+ /** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
221
367
  readonly projectHourlyWage: number;
368
+ /** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
222
369
  projectTaxRate: number;
370
+ /** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
223
371
  projectPriceComponents?: string[] | undefined;
372
+ /** The ItemNumberSchema that is used within this project. */
224
373
  projectItemNumberSchema?: ItemNumberSchemaDto | undefined;
374
+ /** The IElements within this ElementContainerBase. */
225
375
  elements?: IElementDto[] | undefined;
376
+ /** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
226
377
  readonly projectLabourTimeLabel?: string | undefined;
378
+ /** 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. */
227
379
  readonly containsDuplicateItemNumbers: boolean;
380
+ /** 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. */
228
381
  readonly containsDuplicateElementIds: boolean;
382
+ /** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
229
383
  ignoreDuplicateItemNumbers: boolean;
384
+ /** 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 */
230
385
  ignoreProjectCataloguePropagation: boolean;
386
+ /** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
231
387
  ignoreDuplicateElementIds: boolean;
388
+ /** Price composition by tax rate. */
232
389
  totalPriceGrossByTaxRate?: GrossPriceComponentDto[] | undefined;
390
+ /** 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. */
233
391
  ignoreChildPriceUpdates: boolean;
392
+ /** Net price after applied deductions. */
234
393
  readonly deductedPrice: number;
394
+ /** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
235
395
  deductionFactor: number;
396
+ /** 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. */
236
397
  absoluteDeduction?: number | undefined;
398
+ /** Will return this ElementContainerBase's total price. */
237
399
  readonly totalPrice: number;
400
+ /** The total gross price for this ElementContainerBase including all child elements. */
238
401
  readonly totalPriceGross: number;
402
+ /** Total gross price after applied deductions. */
239
403
  readonly totalPriceGrossDeducted: number;
240
- priceType?: PriceTypeDto | undefined;
404
+ /** Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not. */
405
+ priceType: PriceTypeDto;
406
+ /** Information about the bidder. */
241
407
  bidder?: PartyInformationDto | undefined;
408
+ /** 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. */
242
409
  bidderDiscriminator?: string | undefined;
410
+ /** 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. */
243
411
  gaebXmlId?: string | undefined;
412
+ /** The ProjectInformation used within the Project in which this ElementContainerBase is contained. This is reference equal to the ProjectInformation used in the parent project. */
244
413
  readonly projectInformation?: ProjectInformationDto | undefined;
245
- exchangePhase?: ExchangePhaseDto | undefined;
246
- origin?: OriginDto | undefined;
414
+ /** 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...). */
415
+ exchangePhase: ExchangePhaseDto;
416
+ /** 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. */
417
+ origin: OriginDto;
418
+ /** 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. */
247
419
  originDetail?: string | undefined;
420
+ /** 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. */
248
421
  originSystem?: string | undefined;
422
+ /** 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. */
249
423
  originApplication?: string | undefined;
424
+ /** 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. */
250
425
  originVersion?: string | undefined;
426
+ /** Creation date of this ServiceSpecification. */
251
427
  creationDate?: Date | undefined;
428
+ /** Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin" */
252
429
  offerByDate?: Date | undefined;
430
+ /** Date indicating by when the buyer will select a contractor. */
253
431
  decisionDate?: Date | undefined;
432
+ /** Date of when the offer / bid was created */
254
433
  bidDate?: Date | undefined;
434
+ /** 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. */
255
435
  warrantyBondPercentage: number;
436
+ /** 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. */
256
437
  executionGuaranteePercentage: number;
438
+ /** String indicating where the physical submission of the offer is taking place. */
257
439
  submissionLocation?: string | undefined;
440
+ /** Description of this ServiceSpecification. */
258
441
  description?: string | undefined;
442
+ /** The name of this ServiceSpecification. */
259
443
  name?: string | undefined;
444
+ /** This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually. */
260
445
  priceInformation?: PriceInformationDto | undefined;
446
+ /** 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. */
261
447
  projectCatalogues?: CatalogueDto[] | undefined;
448
+ /** Referenced catalogues for this ElementContainerBase. */
262
449
  catalogueReferences?: CatalogueReferenceDto[] | undefined;
450
+ /** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
263
451
  sustainabilityCatalogues?: SustainabilityCatalogueDto[] | undefined;
452
+ /** The date when the execution of the services is scheduled to start */
264
453
  plannedExecutionStart?: Date | undefined;
454
+ /** The date then the execution of the services is scheduled to be finished */
265
455
  plannedExecutionEnd?: Date | undefined;
456
+ /** The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB */
266
457
  contractDate?: Date | undefined;
458
+ /** This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB */
267
459
  contractIdentifier?: string | undefined;
460
+ /** This indicates how long the warranty period is for this ServiceSpecification */
268
461
  warrantyDuration?: WarrantyDurationDto | undefined;
462
+ /** The date on which the warranty period ends */
269
463
  warrantyEnd?: Date | undefined;
464
+ /** The date on which the services rendered by the bidder are scheduled to be approved by the buyer */
270
465
  approvalDate?: Date | undefined;
466
+ /** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
271
467
  typeOfApproval?: string | undefined;
468
+ /** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
272
469
  addendumNumber?: string | undefined;
470
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
273
471
  addendumStatus?: AddendumStatusDto | undefined;
472
+ /** This property holds additional information that's only valid in commerce exchange phases. */
274
473
  commerceProperties?: ServiceSpecificationCommercePropertiesDto | undefined;
474
+ /** This property holds ÖNorm-specific properties for this service specification, such as LB reference data. */
275
475
  serviceSpecificationOenormProperties?: ServiceSpecificationOenormPropertiesDto | undefined;
276
476
  constructor(data?: IServiceSpecificationDto);
277
477
  init?(_data?: any): void;
278
478
  static fromJS(data: any): ServiceSpecificationDto;
279
479
  toJSON?(data?: any): any;
280
480
  }
481
+ /** This is the base class that holds information about a whole service specification. */
281
482
  interface IServiceSpecificationDto {
483
+ /** Elements GUID identifier. */
282
484
  id: string;
485
+ /** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
283
486
  projectHourlyWage: number;
487
+ /** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
284
488
  projectTaxRate: number;
489
+ /** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
285
490
  projectPriceComponents?: string[] | undefined;
491
+ /** The ItemNumberSchema that is used within this project. */
286
492
  projectItemNumberSchema?: IItemNumberSchemaDto | undefined;
493
+ /** The IElements within this ElementContainerBase. */
287
494
  elements?: IElementDto[] | undefined;
495
+ /** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
288
496
  projectLabourTimeLabel?: string | undefined;
497
+ /** 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. */
289
498
  containsDuplicateItemNumbers: boolean;
499
+ /** 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. */
290
500
  containsDuplicateElementIds: boolean;
501
+ /** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
291
502
  ignoreDuplicateItemNumbers: boolean;
503
+ /** 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 */
292
504
  ignoreProjectCataloguePropagation: boolean;
505
+ /** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
293
506
  ignoreDuplicateElementIds: boolean;
507
+ /** Price composition by tax rate. */
294
508
  totalPriceGrossByTaxRate?: IGrossPriceComponentDto[] | undefined;
509
+ /** 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. */
295
510
  ignoreChildPriceUpdates: boolean;
511
+ /** Net price after applied deductions. */
296
512
  deductedPrice: number;
513
+ /** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
297
514
  deductionFactor: number;
515
+ /** 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. */
298
516
  absoluteDeduction?: number | undefined;
517
+ /** Will return this ElementContainerBase's total price. */
299
518
  totalPrice: number;
519
+ /** The total gross price for this ElementContainerBase including all child elements. */
300
520
  totalPriceGross: number;
521
+ /** Total gross price after applied deductions. */
301
522
  totalPriceGrossDeducted: number;
302
- priceType?: PriceTypeDto | undefined;
523
+ /** Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not. */
524
+ priceType: PriceTypeDto;
525
+ /** Information about the bidder. */
303
526
  bidder?: IPartyInformationDto | undefined;
527
+ /** 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. */
304
528
  bidderDiscriminator?: string | undefined;
529
+ /** 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. */
305
530
  gaebXmlId?: string | undefined;
531
+ /** The ProjectInformation used within the Project in which this ElementContainerBase is contained. This is reference equal to the ProjectInformation used in the parent project. */
306
532
  projectInformation?: IProjectInformationDto | undefined;
307
- exchangePhase?: ExchangePhaseDto | undefined;
308
- origin?: OriginDto | undefined;
533
+ /** 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...). */
534
+ exchangePhase: ExchangePhaseDto;
535
+ /** 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. */
536
+ origin: OriginDto;
537
+ /** 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. */
309
538
  originDetail?: string | undefined;
539
+ /** 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. */
310
540
  originSystem?: string | undefined;
541
+ /** 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. */
311
542
  originApplication?: string | undefined;
543
+ /** 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. */
312
544
  originVersion?: string | undefined;
545
+ /** Creation date of this ServiceSpecification. */
313
546
  creationDate?: Date | undefined;
547
+ /** Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin" */
314
548
  offerByDate?: Date | undefined;
549
+ /** Date indicating by when the buyer will select a contractor. */
315
550
  decisionDate?: Date | undefined;
551
+ /** Date of when the offer / bid was created */
316
552
  bidDate?: Date | undefined;
553
+ /** 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. */
317
554
  warrantyBondPercentage: number;
555
+ /** 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. */
318
556
  executionGuaranteePercentage: number;
557
+ /** String indicating where the physical submission of the offer is taking place. */
319
558
  submissionLocation?: string | undefined;
559
+ /** Description of this ServiceSpecification. */
320
560
  description?: string | undefined;
561
+ /** The name of this ServiceSpecification. */
321
562
  name?: string | undefined;
563
+ /** This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually. */
322
564
  priceInformation?: IPriceInformationDto | undefined;
565
+ /** 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. */
323
566
  projectCatalogues?: ICatalogueDto[] | undefined;
567
+ /** Referenced catalogues for this ElementContainerBase. */
324
568
  catalogueReferences?: ICatalogueReferenceDto[] | undefined;
569
+ /** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
325
570
  sustainabilityCatalogues?: ISustainabilityCatalogueDto[] | undefined;
571
+ /** The date when the execution of the services is scheduled to start */
326
572
  plannedExecutionStart?: Date | undefined;
573
+ /** The date then the execution of the services is scheduled to be finished */
327
574
  plannedExecutionEnd?: Date | undefined;
575
+ /** The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB */
328
576
  contractDate?: Date | undefined;
577
+ /** This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB */
329
578
  contractIdentifier?: string | undefined;
579
+ /** This indicates how long the warranty period is for this ServiceSpecification */
330
580
  warrantyDuration?: IWarrantyDurationDto | undefined;
581
+ /** The date on which the warranty period ends */
331
582
  warrantyEnd?: Date | undefined;
583
+ /** The date on which the services rendered by the bidder are scheduled to be approved by the buyer */
332
584
  approvalDate?: Date | undefined;
585
+ /** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
333
586
  typeOfApproval?: string | undefined;
587
+ /** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
334
588
  addendumNumber?: string | undefined;
589
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
335
590
  addendumStatus?: AddendumStatusDto | undefined;
591
+ /** This property holds additional information that's only valid in commerce exchange phases. */
336
592
  commerceProperties?: IServiceSpecificationCommercePropertiesDto | undefined;
593
+ /** This property holds ÖNorm-specific properties for this service specification, such as LB reference data. */
337
594
  serviceSpecificationOenormProperties?: IServiceSpecificationOenormPropertiesDto | undefined;
338
595
  }
596
+ /** Base interface definition for elements within an ElementContainerBase. */
339
597
  declare abstract class IElementDto implements IIElementDto {
340
598
  elementType: string;
341
599
  elementTypeDiscriminator: string;
600
+ /** Elements GUID identifier. */
342
601
  id: string;
602
+ /** 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. */
343
603
  gaebXmlId?: string | undefined;
604
+ /** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
344
605
  addendumNumber?: string | undefined;
345
606
  projectCatalogues?: CatalogueDto[] | undefined;
346
607
  catalogueReferences?: CatalogueReferenceDto[] | undefined;
@@ -350,35 +611,54 @@ declare abstract class IElementDto implements IIElementDto {
350
611
  static fromJS(data: any): IElementDto;
351
612
  toJSON?(data?: any): any;
352
613
  }
614
+ /** Base interface definition for elements within an ElementContainerBase. */
353
615
  interface IIElementDto {
354
616
  elementType: string;
355
617
  elementTypeDiscriminator: string;
618
+ /** Elements GUID identifier. */
356
619
  id: string;
620
+ /** 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. */
357
621
  gaebXmlId?: string | undefined;
622
+ /** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
358
623
  addendumNumber?: string | undefined;
359
624
  projectCatalogues?: ICatalogueDto[] | undefined;
360
625
  catalogueReferences?: ICatalogueReferenceDto[] | undefined;
361
626
  }
627
+ /** 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. */
362
628
  declare class CatalogueDto implements ICatalogueDto {
629
+ /** Elements GUID identifier. */
363
630
  id: string;
631
+ /** 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. */
364
632
  gaebXmlId?: string | undefined;
633
+ /** The name that is given for this catalogue. */
365
634
  name?: string | undefined;
635
+ /** Additional information about this catalogue. */
366
636
  description?: string | undefined;
367
- catalogueType?: CatalogueTypeDto | undefined;
637
+ /** If given, this gives a classification for the contents of the catalogue */
638
+ catalogueType: CatalogueTypeDto;
639
+ /** 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. */
368
640
  catalogueTypeDetail?: string | undefined;
369
641
  constructor(data?: ICatalogueDto);
370
642
  init?(_data?: any): void;
371
643
  static fromJS(data: any): CatalogueDto;
372
644
  toJSON?(data?: any): any;
373
645
  }
646
+ /** 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. */
374
647
  interface ICatalogueDto {
648
+ /** Elements GUID identifier. */
375
649
  id: string;
650
+ /** 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. */
376
651
  gaebXmlId?: string | undefined;
652
+ /** The name that is given for this catalogue. */
377
653
  name?: string | undefined;
654
+ /** Additional information about this catalogue. */
378
655
  description?: string | undefined;
379
- catalogueType?: CatalogueTypeDto | undefined;
656
+ /** If given, this gives a classification for the contents of the catalogue */
657
+ catalogueType: CatalogueTypeDto;
658
+ /** 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. */
380
659
  catalogueTypeDetail?: string | undefined;
381
660
  }
661
+ /** 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. */
382
662
  declare enum CatalogueTypeDto {
383
663
  Unknown = "Unknown",
384
664
  Location = "Location",
@@ -389,432 +669,678 @@ declare enum CatalogueTypeDto {
389
669
  BIM = "BIM",
390
670
  Attachment = "Attachment"
391
671
  }
672
+ /** This class is used to link data between catalogues and objects. */
392
673
  declare class CatalogueReferenceDto implements ICatalogueReferenceDto {
674
+ /** Elements GUID identifier. */
393
675
  id: string;
676
+ /** 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. */
394
677
  catalogueReferenceKey?: string | undefined;
678
+ /** The Id of the CatalogueReference that is targeted by this item. Set this property to set the referenced catalogue. */
395
679
  catalogueReferenceId: string;
680
+ /** 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. */
396
681
  projectCatalogues?: CatalogueDto[] | undefined;
682
+ /** This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues. */
397
683
  readonly catalogue?: CatalogueDto | undefined;
398
684
  constructor(data?: ICatalogueReferenceDto);
399
685
  init?(_data?: any): void;
400
686
  static fromJS(data: any): CatalogueReferenceDto;
401
687
  toJSON?(data?: any): any;
402
688
  }
689
+ /** This class is used to link data between catalogues and objects. */
403
690
  interface ICatalogueReferenceDto {
691
+ /** Elements GUID identifier. */
404
692
  id: string;
693
+ /** 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. */
405
694
  catalogueReferenceKey?: string | undefined;
695
+ /** The Id of the CatalogueReference that is targeted by this item. Set this property to set the referenced catalogue. */
406
696
  catalogueReferenceId: string;
697
+ /** 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. */
407
698
  projectCatalogues?: ICatalogueDto[] | undefined;
699
+ /** This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues. */
408
700
  catalogue?: ICatalogueDto | undefined;
409
701
  }
702
+ /** A Position is the main item type in a ServiceSpecification, holding information about tasks to be done, their prices, description, amounts etc. */
410
703
  declare class PositionDto extends IElementDto implements IPositionDto {
704
+ /** Will return the price per unit, rounded according to the project settings or the default value of three decimal places */
411
705
  readonly unitPrice: number;
412
- /** You can use this property to directly set the unit price for this position. This will
413
- override any given PriceComponents */
706
+ /** You can use this property to directly set the unit price for this position. This will override any given PriceComponents */
414
707
  unitPriceOverride?: number | undefined;
708
+ /** Will return this Position's total quantity, rounded to three decimal places. */
415
709
  readonly quantity: number;
416
- /** You can use this property to directly set the quantity for this position. This will
417
- override any given QuantityComponents */
710
+ /** You can use this property to directly set the quantity for this position. This will override any given QuantityComponents */
418
711
  quantityOverride?: number | undefined;
419
- /** This indicates true if this specific position is specified as a complementing position
420
- for any base position. */
712
+ /** This indicates true if this specific position is specified as a complementing position for any base position. */
421
713
  isComplementingPosition: boolean;
422
- /** If IsComplementingPosition is set to true, this will indicate which base
423
- positions are targeted by this complementing position. */
714
+ /** If IsComplementingPosition is set to true, this will indicate which base positions are targeted by this complementing position. */
424
715
  complementsPositions?: string[] | undefined;
425
- /** You can use this property to directly specify the total price of this position as a
426
- percentage of the sum of the total prices of base positions that this position
427
- complements. It will essentially set the total price for this position to the sum of all
428
- total prices of the positions specified in ComplementsPositions multiplied
429
- by the percentage here. If present, this has precedence over UnitPriceOverride as well as QuantityOverride. */
716
+ /** 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. */
430
717
  complementingPricePercentageOverride?: number | undefined;
431
- /** This is a read only property showing the total price of this positions as a percentage
432
- of the sum of the total prices of all base positions, in case this position is a
433
- complementing positions. If this position is not a complementing position, this will be
434
- null. Also, if no prices are present, this will also be null. */
718
+ /** 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. */
435
719
  complementingPricePercentage?: number | undefined;
720
+ /** The tag of the unit used for this positions quantity. */
436
721
  unitTag?: string | undefined;
722
+ /** The components for labour time in this Position. */
437
723
  labourComponents?: LabourPriceComponentDto | undefined;
724
+ /** 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. */
438
725
  priceComponents?: PriceComponentDto[] | undefined;
726
+ /** The quantity components of this Position. */
439
727
  quantityComponents?: CalculationDto[] | undefined;
728
+ /** Further structuring of this Position. */
440
729
  subDescriptions?: SubDescriptionDto[] | undefined;
441
- comissionStatus?: ComissionStatusDto | undefined;
730
+ /** Indicates the status of this Position's comission. */
731
+ comissionStatus: ComissionStatusDto;
732
+ /** 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. */
442
733
  complementedBy?: string[] | undefined;
734
+ /** This list contains information about sustainability indicators or environmental impact for this position. */
443
735
  sustainabilityIndicators?: PositionSustainabilityIndicatorDto[] | undefined;
736
+ /** 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. */
444
737
  complemented: boolean;
738
+ /** Indicates that the amount for this Position is to be set by the bidder. */
445
739
  amountToBeEnteredByBidder: boolean;
740
+ /** Indicates if the bidder demands for prices to be broken up into their price components. */
446
741
  priceCompositionRequired: boolean;
742
+ /** Indicates if this Position should use a different TaxRate than what is the default for the Project. */
447
743
  useDifferentTaxRate: boolean;
744
+ /** 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) */
448
745
  taxRate: number;
746
+ /** The ItemNumber for this Position. */
449
747
  itemNumber?: ItemNumberDto | undefined;
748
+ /** The rate of deductions, i.e. 0.12m means 12% price deduction. */
450
749
  deductionFactor: number;
750
+ /** Returns the product of UnitPrice times Quantity. */
451
751
  readonly totalPrice: number;
752
+ /** The total gross price for this Position. */
452
753
  readonly totalPriceGross: number;
754
+ /** Total gross price after applied deductions. */
453
755
  readonly totalPriceGrossDeducted: number;
756
+ /** Net price after applied deductions. Please be aware that this is the total price, from TotalPrice, not the unit price of the position. */
454
757
  readonly deductedPrice: number;
455
- positionType?: PositionTypeDto | undefined;
456
- priceType?: PriceTypeDto | undefined;
457
- serviceType?: ServiceTypeDto | undefined;
758
+ /** 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. */
759
+ positionType: PositionTypeDto;
760
+ /** Indicates the PriceType of this Position. */
761
+ priceType: PriceTypeDto;
762
+ /** This indicates if this position is regular or describing a labour / hourly paid work service */
763
+ serviceType: ServiceTypeDto;
764
+ /** 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. */
458
765
  productData?: ProductDataDto | undefined;
459
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
460
- property. If you want to convert from DTO objects, and you want to work with the
461
- `HtmlShortText` property, you need to set this property to null. */
766
+ /** Short description for this DescriptionBase element.
767
+ Please note that by default, this property takes precedence over the `HtmlShortText`
768
+ property. If you want to convert from DTO objects, and you want to work with the
769
+ `HtmlShortText` property, you need to set this property to null.
770
+ */
462
771
  shortText?: string | undefined;
463
- /** This property is used to store the short text in HTML format. If you want to convert
464
- from DTO objects, and you want to use this property, then you need to ensure that
465
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
772
+ /** 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.
773
+ This property is used to store the short text in HTML format. If you want to convert
774
+ from DTO objects, and you want to use this property, then you need to ensure that
775
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
776
+ */
466
777
  htmlShortText?: string | undefined;
778
+ /** 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. */
467
779
  longText?: string | undefined;
780
+ /** 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. */
468
781
  htmlLongText?: string | undefined;
469
- additionType?: AdditionTypeDto | undefined;
782
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
783
+ additionType: AdditionTypeDto;
470
784
  elementType: string;
471
785
  elementTypeDiscriminator: string;
786
+ /** 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. */
472
787
  quantityAssignments?: QuantityAssignmentDto[] | undefined;
788
+ /** The CommerceProperties support specialized information that is only useful in GAEB XML 9x data exchange phases. It is intended to provide article information. */
473
789
  commerceProperties?: CommercePropertiesDto | undefined;
790
+ /** 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. */
474
791
  alternativeTo: string | undefined;
792
+ /** 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. */
475
793
  alternativeIdentifier?: number | undefined;
794
+ /** 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. */
476
795
  alternativeGroupIdentifier?: number | undefined;
796
+ /** 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. */
477
797
  isLumpSum: boolean;
798
+ /** 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 */
478
799
  repetitionTo: string | undefined;
479
800
  v1CompatibilityPriceType?: string | undefined;
801
+ /** 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. */
480
802
  standardizedDescription?: StandardizedDescriptionDto | undefined;
803
+ /** 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. */
481
804
  complementedByQuantities?: ComplementedByQuantityDto[] | undefined;
805
+ /** 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. */
482
806
  executionDescriptionReference: string | undefined;
807
+ /** 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. */
483
808
  notOffered: boolean;
809
+ /** 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. */
484
810
  oenormPositionProperties?: OenormPositionPropertiesDto | undefined;
811
+ /** 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. */
485
812
  descriptionId?: string | undefined;
813
+ /** 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. */
486
814
  hierarchyLevel: number;
815
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
487
816
  addendumStatus?: AddendumStatusDto | undefined;
488
817
  readonly hasBidderCommentInHtmlLongText: boolean;
489
- gaebComplementingType?: PositionComplementingTypeDto | undefined;
818
+ /** 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. */
819
+ gaebComplementingType: PositionComplementingTypeDto;
820
+ /** HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site. */
490
821
  holdOutProperties?: PositionHoldOutPropertiesDto | undefined;
822
+ /** This is an informational property, which directly holds a numerical value for an estimated quantity. It is not used for any price calculations. */
491
823
  estimatedQuantity?: number | undefined;
824
+ /** 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. */
492
825
  priceCatalogueData?: PriceCatalogueDataDto | undefined;
826
+ /** 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. */
493
827
  ignoreProjectCataloguePropagation: boolean;
828
+ /** 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. */
494
829
  isMainPosition: boolean;
830
+ /** 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. */
495
831
  baseCatalogueNumber?: string | undefined;
496
832
  constructor(data?: IPositionDto);
497
833
  init(_data?: any): void;
498
834
  static fromJS(data: any): PositionDto;
499
835
  toJSON(data?: any): any;
500
836
  }
837
+ /** A Position is the main item type in a ServiceSpecification, holding information about tasks to be done, their prices, description, amounts etc. */
501
838
  interface IPositionDto extends IIElementDto {
839
+ /** Will return the price per unit, rounded according to the project settings or the default value of three decimal places */
502
840
  unitPrice: number;
503
- /** You can use this property to directly set the unit price for this position. This will
504
- override any given PriceComponents */
841
+ /** You can use this property to directly set the unit price for this position. This will override any given PriceComponents */
505
842
  unitPriceOverride?: number | undefined;
843
+ /** Will return this Position's total quantity, rounded to three decimal places. */
506
844
  quantity: number;
507
- /** You can use this property to directly set the quantity for this position. This will
508
- override any given QuantityComponents */
845
+ /** You can use this property to directly set the quantity for this position. This will override any given QuantityComponents */
509
846
  quantityOverride?: number | undefined;
510
- /** This indicates true if this specific position is specified as a complementing position
511
- for any base position. */
847
+ /** This indicates true if this specific position is specified as a complementing position for any base position. */
512
848
  isComplementingPosition: boolean;
513
- /** If IsComplementingPosition is set to true, this will indicate which base
514
- positions are targeted by this complementing position. */
849
+ /** If IsComplementingPosition is set to true, this will indicate which base positions are targeted by this complementing position. */
515
850
  complementsPositions?: string[] | undefined;
516
- /** You can use this property to directly specify the total price of this position as a
517
- percentage of the sum of the total prices of base positions that this position
518
- complements. It will essentially set the total price for this position to the sum of all
519
- total prices of the positions specified in ComplementsPositions multiplied
520
- by the percentage here. If present, this has precedence over UnitPriceOverride as well as QuantityOverride. */
851
+ /** 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. */
521
852
  complementingPricePercentageOverride?: number | undefined;
522
- /** This is a read only property showing the total price of this positions as a percentage
523
- of the sum of the total prices of all base positions, in case this position is a
524
- complementing positions. If this position is not a complementing position, this will be
525
- null. Also, if no prices are present, this will also be null. */
853
+ /** 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. */
526
854
  complementingPricePercentage?: number | undefined;
855
+ /** The tag of the unit used for this positions quantity. */
527
856
  unitTag?: string | undefined;
857
+ /** The components for labour time in this Position. */
528
858
  labourComponents?: ILabourPriceComponentDto | undefined;
859
+ /** 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. */
529
860
  priceComponents?: IPriceComponentDto[] | undefined;
861
+ /** The quantity components of this Position. */
530
862
  quantityComponents?: ICalculationDto[] | undefined;
863
+ /** Further structuring of this Position. */
531
864
  subDescriptions?: ISubDescriptionDto[] | undefined;
532
- comissionStatus?: ComissionStatusDto | undefined;
865
+ /** Indicates the status of this Position's comission. */
866
+ comissionStatus: ComissionStatusDto;
867
+ /** 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. */
533
868
  complementedBy?: string[] | undefined;
869
+ /** This list contains information about sustainability indicators or environmental impact for this position. */
534
870
  sustainabilityIndicators?: IPositionSustainabilityIndicatorDto[] | undefined;
871
+ /** 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. */
535
872
  complemented: boolean;
873
+ /** Indicates that the amount for this Position is to be set by the bidder. */
536
874
  amountToBeEnteredByBidder: boolean;
875
+ /** Indicates if the bidder demands for prices to be broken up into their price components. */
537
876
  priceCompositionRequired: boolean;
877
+ /** Indicates if this Position should use a different TaxRate than what is the default for the Project. */
538
878
  useDifferentTaxRate: boolean;
879
+ /** 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) */
539
880
  taxRate: number;
881
+ /** The ItemNumber for this Position. */
540
882
  itemNumber?: IItemNumberDto | undefined;
883
+ /** The rate of deductions, i.e. 0.12m means 12% price deduction. */
541
884
  deductionFactor: number;
885
+ /** Returns the product of UnitPrice times Quantity. */
542
886
  totalPrice: number;
887
+ /** The total gross price for this Position. */
543
888
  totalPriceGross: number;
889
+ /** Total gross price after applied deductions. */
544
890
  totalPriceGrossDeducted: number;
891
+ /** Net price after applied deductions. Please be aware that this is the total price, from TotalPrice, not the unit price of the position. */
545
892
  deductedPrice: number;
546
- positionType?: PositionTypeDto | undefined;
547
- priceType?: PriceTypeDto | undefined;
548
- serviceType?: ServiceTypeDto | undefined;
893
+ /** 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. */
894
+ positionType: PositionTypeDto;
895
+ /** Indicates the PriceType of this Position. */
896
+ priceType: PriceTypeDto;
897
+ /** This indicates if this position is regular or describing a labour / hourly paid work service */
898
+ serviceType: ServiceTypeDto;
899
+ /** 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. */
549
900
  productData?: IProductDataDto | undefined;
550
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
551
- property. If you want to convert from DTO objects, and you want to work with the
552
- `HtmlShortText` property, you need to set this property to null. */
901
+ /** Short description for this DescriptionBase element.
902
+ Please note that by default, this property takes precedence over the `HtmlShortText`
903
+ property. If you want to convert from DTO objects, and you want to work with the
904
+ `HtmlShortText` property, you need to set this property to null.
905
+ */
553
906
  shortText?: string | undefined;
554
- /** This property is used to store the short text in HTML format. If you want to convert
555
- from DTO objects, and you want to use this property, then you need to ensure that
556
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
907
+ /** 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.
908
+ This property is used to store the short text in HTML format. If you want to convert
909
+ from DTO objects, and you want to use this property, then you need to ensure that
910
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
911
+ */
557
912
  htmlShortText?: string | undefined;
913
+ /** 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. */
558
914
  longText?: string | undefined;
915
+ /** 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. */
559
916
  htmlLongText?: string | undefined;
560
- additionType?: AdditionTypeDto | undefined;
917
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
918
+ additionType: AdditionTypeDto;
561
919
  elementType: string;
920
+ /** 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. */
562
921
  quantityAssignments?: IQuantityAssignmentDto[] | undefined;
922
+ /** The CommerceProperties support specialized information that is only useful in GAEB XML 9x data exchange phases. It is intended to provide article information. */
563
923
  commerceProperties?: ICommercePropertiesDto | undefined;
924
+ /** 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. */
564
925
  alternativeTo: string | undefined;
926
+ /** 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. */
565
927
  alternativeIdentifier?: number | undefined;
928
+ /** 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. */
566
929
  alternativeGroupIdentifier?: number | undefined;
930
+ /** 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. */
567
931
  isLumpSum: boolean;
932
+ /** 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 */
568
933
  repetitionTo: string | undefined;
569
934
  v1CompatibilityPriceType?: string | undefined;
935
+ /** 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. */
570
936
  standardizedDescription?: IStandardizedDescriptionDto | undefined;
937
+ /** 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. */
571
938
  complementedByQuantities?: IComplementedByQuantityDto[] | undefined;
939
+ /** 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. */
572
940
  executionDescriptionReference: string | undefined;
941
+ /** 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. */
573
942
  notOffered: boolean;
943
+ /** 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. */
574
944
  oenormPositionProperties?: IOenormPositionPropertiesDto | undefined;
945
+ /** 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. */
575
946
  descriptionId?: string | undefined;
947
+ /** 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. */
576
948
  hierarchyLevel: number;
949
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
577
950
  addendumStatus?: AddendumStatusDto | undefined;
578
951
  hasBidderCommentInHtmlLongText: boolean;
579
- gaebComplementingType?: PositionComplementingTypeDto | undefined;
952
+ /** 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. */
953
+ gaebComplementingType: PositionComplementingTypeDto;
954
+ /** HoldOut properties describe services that are to be provided and maintained for a specific time, e.g. fences on a construction site. */
580
955
  holdOutProperties?: IPositionHoldOutPropertiesDto | undefined;
956
+ /** This is an informational property, which directly holds a numerical value for an estimated quantity. It is not used for any price calculations. */
581
957
  estimatedQuantity?: number | undefined;
958
+ /** 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. */
582
959
  priceCatalogueData?: IPriceCatalogueDataDto | undefined;
960
+ /** 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. */
583
961
  ignoreProjectCataloguePropagation: boolean;
962
+ /** 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. */
584
963
  isMainPosition: boolean;
964
+ /** 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. */
585
965
  baseCatalogueNumber?: string | undefined;
586
966
  }
967
+ /** Based on the PriceComponent, this class is responsible for labour time components. */
587
968
  declare class LabourPriceComponentDto implements ILabourPriceComponentDto {
969
+ /** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
588
970
  label?: string | undefined;
971
+ /** The total, calculated price of this component. Will multiply the calculated amount of hours with the ServiceSpecifications hourly wage rate. */
589
972
  readonly price: number;
973
+ /** The cost per hour of manual labor. */
590
974
  hourlyWage: number;
975
+ /** The single Calculation elements this price component is composed of. */
591
976
  values?: CalculationDto[] | undefined;
977
+ /** Indicates if the ServiceSpecification's standard HourlyWage is to be used or a custom value. */
592
978
  useOwnHourlyWage: boolean;
979
+ /** The total, calculated time of this component. Will return the result rounded to three decimal places. */
593
980
  readonly totalTime: number;
981
+ /** 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. */
594
982
  projectCatalogues?: CatalogueDto[] | undefined;
595
983
  constructor(data?: ILabourPriceComponentDto);
596
984
  init?(_data?: any): void;
597
985
  static fromJS(data: any): LabourPriceComponentDto;
598
986
  toJSON?(data?: any): any;
599
987
  }
988
+ /** Based on the PriceComponent, this class is responsible for labour time components. */
600
989
  interface ILabourPriceComponentDto {
990
+ /** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
601
991
  label?: string | undefined;
992
+ /** The total, calculated price of this component. Will multiply the calculated amount of hours with the ServiceSpecifications hourly wage rate. */
602
993
  price: number;
994
+ /** The cost per hour of manual labor. */
603
995
  hourlyWage: number;
996
+ /** The single Calculation elements this price component is composed of. */
604
997
  values?: ICalculationDto[] | undefined;
998
+ /** Indicates if the ServiceSpecification's standard HourlyWage is to be used or a custom value. */
605
999
  useOwnHourlyWage: boolean;
1000
+ /** The total, calculated time of this component. Will return the result rounded to three decimal places. */
606
1001
  totalTime: number;
1002
+ /** 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. */
607
1003
  projectCatalogues?: ICatalogueDto[] | undefined;
608
1004
  }
1005
+ /** This class holds means to calculate mathematical expressions from given strings. */
609
1006
  declare class CalculationDto implements ICalculationDto {
1007
+ /** Descriptive text for this calculation. */
610
1008
  description?: string | undefined;
1009
+ /** This Calculation's mathematical expression. Please note that thousands separators are not supported. Both comma and point will be treated as decimal separators. */
611
1010
  formula?: string | undefined;
1011
+ /** The calculated result from the formula, 0 if invalid. */
612
1012
  readonly result: number;
1013
+ /** Whether the Formula is a valid expression. */
613
1014
  readonly valid: boolean;
1015
+ /** 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. */
614
1016
  readonly errorPositionInLine: number;
1017
+ /** 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. */
615
1018
  projectCatalogues?: CatalogueDto[] | undefined;
1019
+ /** Referenced catalogues for this Calculation. */
616
1020
  catalogueReferences?: CatalogueReferenceDto[] | undefined;
617
1021
  constructor(data?: ICalculationDto);
618
1022
  init?(_data?: any): void;
619
1023
  static fromJS(data: any): CalculationDto;
620
1024
  toJSON?(data?: any): any;
621
1025
  }
1026
+ /** This class holds means to calculate mathematical expressions from given strings. */
622
1027
  interface ICalculationDto {
1028
+ /** Descriptive text for this calculation. */
623
1029
  description?: string | undefined;
1030
+ /** This Calculation's mathematical expression. Please note that thousands separators are not supported. Both comma and point will be treated as decimal separators. */
624
1031
  formula?: string | undefined;
1032
+ /** The calculated result from the formula, 0 if invalid. */
625
1033
  result: number;
1034
+ /** Whether the Formula is a valid expression. */
626
1035
  valid: boolean;
1036
+ /** 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. */
627
1037
  errorPositionInLine: number;
1038
+ /** 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. */
628
1039
  projectCatalogues?: ICatalogueDto[] | undefined;
1040
+ /** Referenced catalogues for this Calculation. */
629
1041
  catalogueReferences?: ICatalogueReferenceDto[] | undefined;
630
1042
  }
1043
+ /** 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. */
631
1044
  declare class PriceComponentDto implements IPriceComponentDto {
1045
+ /** The total, calculated price of this component. */
632
1046
  readonly price: number;
1047
+ /** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
633
1048
  label?: string | undefined;
1049
+ /** The single Calculation elements this price component is composed of. */
634
1050
  values?: CalculationDto[] | undefined;
1051
+ /** 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. */
635
1052
  projectCatalogues?: CatalogueDto[] | undefined;
636
1053
  constructor(data?: IPriceComponentDto);
637
1054
  init?(_data?: any): void;
638
1055
  static fromJS(data: any): PriceComponentDto;
639
1056
  toJSON?(data?: any): any;
640
1057
  }
1058
+ /** 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. */
641
1059
  interface IPriceComponentDto {
1060
+ /** The total, calculated price of this component. */
642
1061
  price: number;
1062
+ /** The label associated with this price component. Will be taken from the parent Projects ProjectInformation. */
643
1063
  label?: string | undefined;
1064
+ /** The single Calculation elements this price component is composed of. */
644
1065
  values?: ICalculationDto[] | undefined;
1066
+ /** 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. */
645
1067
  projectCatalogues?: ICatalogueDto[] | undefined;
646
1068
  }
1069
+ /** 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. */
647
1070
  declare class SubDescriptionDto implements ISubDescriptionDto {
1071
+ /** Elements GUID identifier. */
648
1072
  id: string;
1073
+ /** Returns the total calculated sum of all quantity assignments. Will return the result rounded to three decimal places. */
649
1074
  readonly quantity: number;
650
- /** You can use this property to directly set the quantity for this
651
- sub description. This will override any given QuantityComponents */
1075
+ /** You can use this property to directly set the quantity for this sub description. This will override any given QuantityComponents */
652
1076
  quantityOverride?: number | undefined;
1077
+ /** Holds quantity information for this sub description. Quantity is listening to changes here and is reporting the total sum of all quantity components. */
653
1078
  quantityComponents?: CalculationDto[] | undefined;
1079
+ /** Indicates if the bidder is asked to specify an amount. */
654
1080
  amountToBeEnteredByBidder: boolean;
1081
+ /** Identifier for this SubDescription. */
655
1082
  identifier?: string | undefined;
656
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
657
- property. If you want to convert from DTO objects, and you want to work with the
658
- `HtmlShortText` property, you need to set this property to null. */
1083
+ /** Short description for this DescriptionBase element.
1084
+ Please note that by default, this property takes precedence over the `HtmlShortText`
1085
+ property. If you want to convert from DTO objects, and you want to work with the
1086
+ `HtmlShortText` property, you need to set this property to null.
1087
+ */
659
1088
  shortText?: string | undefined;
660
- /** This property is used to store the short text in HTML format. If you want to convert
661
- from DTO objects, and you want to use this property, then you need to ensure that
662
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
1089
+ /** 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.
1090
+ This property is used to store the short text in HTML format. If you want to convert
1091
+ from DTO objects, and you want to use this property, then you need to ensure that
1092
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
1093
+ */
663
1094
  htmlShortText?: string | undefined;
1095
+ /** 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. */
664
1096
  longText?: string | undefined;
1097
+ /** If this is given, then the sub description has a different unit tag than the parent position. */
665
1098
  unitTag?: string | undefined;
1099
+ /** 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. */
666
1100
  htmlLongText?: string | undefined;
667
- additionType?: AdditionTypeDto | undefined;
1101
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
1102
+ additionType: AdditionTypeDto;
1103
+ /** 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. */
668
1104
  standardizedDescription?: StandardizedDescriptionDto | undefined;
1105
+ /** 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. */
669
1106
  executionDescriptionReference: string | undefined;
1107
+ /** 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. */
670
1108
  projectCatalogues?: CatalogueDto[] | undefined;
1109
+ /** 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. */
671
1110
  descriptionId?: string | undefined;
672
1111
  readonly hasBidderCommentInHtmlLongText: boolean;
1112
+ /** 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. */
673
1113
  baseCatalogueNumber?: string | undefined;
674
1114
  constructor(data?: ISubDescriptionDto);
675
1115
  init?(_data?: any): void;
676
1116
  static fromJS(data: any): SubDescriptionDto;
677
1117
  toJSON?(data?: any): any;
678
1118
  }
1119
+ /** 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. */
679
1120
  interface ISubDescriptionDto {
1121
+ /** Elements GUID identifier. */
680
1122
  id: string;
1123
+ /** Returns the total calculated sum of all quantity assignments. Will return the result rounded to three decimal places. */
681
1124
  quantity: number;
682
- /** You can use this property to directly set the quantity for this
683
- sub description. This will override any given QuantityComponents */
1125
+ /** You can use this property to directly set the quantity for this sub description. This will override any given QuantityComponents */
684
1126
  quantityOverride?: number | undefined;
1127
+ /** Holds quantity information for this sub description. Quantity is listening to changes here and is reporting the total sum of all quantity components. */
685
1128
  quantityComponents?: ICalculationDto[] | undefined;
1129
+ /** Indicates if the bidder is asked to specify an amount. */
686
1130
  amountToBeEnteredByBidder: boolean;
1131
+ /** Identifier for this SubDescription. */
687
1132
  identifier?: string | undefined;
688
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
689
- property. If you want to convert from DTO objects, and you want to work with the
690
- `HtmlShortText` property, you need to set this property to null. */
1133
+ /** Short description for this DescriptionBase element.
1134
+ Please note that by default, this property takes precedence over the `HtmlShortText`
1135
+ property. If you want to convert from DTO objects, and you want to work with the
1136
+ `HtmlShortText` property, you need to set this property to null.
1137
+ */
691
1138
  shortText?: string | undefined;
692
- /** This property is used to store the short text in HTML format. If you want to convert
693
- from DTO objects, and you want to use this property, then you need to ensure that
694
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
1139
+ /** 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.
1140
+ This property is used to store the short text in HTML format. If you want to convert
1141
+ from DTO objects, and you want to use this property, then you need to ensure that
1142
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
1143
+ */
695
1144
  htmlShortText?: string | undefined;
1145
+ /** 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. */
696
1146
  longText?: string | undefined;
1147
+ /** If this is given, then the sub description has a different unit tag than the parent position. */
697
1148
  unitTag?: string | undefined;
1149
+ /** 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. */
698
1150
  htmlLongText?: string | undefined;
699
- additionType?: AdditionTypeDto | undefined;
1151
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
1152
+ additionType: AdditionTypeDto;
1153
+ /** 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. */
700
1154
  standardizedDescription?: IStandardizedDescriptionDto | undefined;
1155
+ /** 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. */
701
1156
  executionDescriptionReference: string | undefined;
1157
+ /** 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. */
702
1158
  projectCatalogues?: ICatalogueDto[] | undefined;
1159
+ /** 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. */
703
1160
  descriptionId?: string | undefined;
704
1161
  hasBidderCommentInHtmlLongText: boolean;
1162
+ /** 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. */
705
1163
  baseCatalogueNumber?: string | undefined;
706
1164
  }
1165
+ /** Indicates the origin of an element. */
707
1166
  declare enum AdditionTypeDto {
708
1167
  None = "None",
709
1168
  ByBuyer = "ByBuyer",
710
1169
  ByBidder = "ByBidder"
711
1170
  }
1171
+ /** 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. */
712
1172
  declare class StandardizedDescriptionDto implements IStandardizedDescriptionDto {
713
- standardReferenceType?: StandardReferenceTypeDto | undefined;
1173
+ /** This enumeration identifies a pre-known standard used for referencing standardized descriptions. */
1174
+ standardReferenceType: StandardReferenceTypeDto;
1175
+ /** This string property is the identifier to map to the references standard. Its type is given in the StandardReferenceType */
714
1176
  standardReference?: string | undefined;
1177
+ /** This is a special reference to the German STLB "Standardleistungsbuch Bau" reference. If this is used, the StandardReference property should not be set. */
715
1178
  stlbReference?: STLBReferenceDto | undefined;
716
1179
  constructor(data?: IStandardizedDescriptionDto);
717
1180
  init?(_data?: any): void;
718
1181
  static fromJS(data: any): StandardizedDescriptionDto;
719
1182
  toJSON?(data?: any): any;
720
1183
  }
1184
+ /** 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. */
721
1185
  interface IStandardizedDescriptionDto {
722
- standardReferenceType?: StandardReferenceTypeDto | undefined;
1186
+ /** This enumeration identifies a pre-known standard used for referencing standardized descriptions. */
1187
+ standardReferenceType: StandardReferenceTypeDto;
1188
+ /** This string property is the identifier to map to the references standard. Its type is given in the StandardReferenceType */
723
1189
  standardReference?: string | undefined;
1190
+ /** This is a special reference to the German STLB "Standardleistungsbuch Bau" reference. If this is used, the StandardReference property should not be set. */
724
1191
  stlbReference?: ISTLBReferenceDto | undefined;
725
1192
  }
1193
+ /** This enumeration identifies a pre-known standard used for referencing standardized descriptions. */
726
1194
  declare enum StandardReferenceTypeDto {
727
1195
  Unknown = "Unknown",
728
1196
  StLB = "StLB",
729
1197
  StLK = "StLK",
730
1198
  STLBBauZ = "STLBBauZ"
731
1199
  }
1200
+ /** 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 */
732
1201
  declare class STLBReferenceDto implements ISTLBReferenceDto {
1202
+ /** The date of the STLB version. Typically, only the Year and Month are used */
733
1203
  versionDate?: Date | undefined;
1204
+ /** The name of the catalogue within the STLB */
734
1205
  catalogueName?: string | undefined;
1206
+ /** The name of the group in STLB */
735
1207
  group?: string | undefined;
1208
+ /** The cost group this service is associated with */
736
1209
  costGroup?: string | undefined;
1210
+ /** The service area (or type) in the STLB */
737
1211
  serviceArea?: string | undefined;
1212
+ /** These keys may optionally be used to further reference multiple, specific items within the STLB */
738
1213
  keys?: STLBKeyDto[] | undefined;
739
1214
  constructor(data?: ISTLBReferenceDto);
740
1215
  init?(_data?: any): void;
741
1216
  static fromJS(data: any): STLBReferenceDto;
742
1217
  toJSON?(data?: any): any;
743
1218
  }
1219
+ /** 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 */
744
1220
  interface ISTLBReferenceDto {
1221
+ /** The date of the STLB version. Typically, only the Year and Month are used */
745
1222
  versionDate?: Date | undefined;
1223
+ /** The name of the catalogue within the STLB */
746
1224
  catalogueName?: string | undefined;
1225
+ /** The name of the group in STLB */
747
1226
  group?: string | undefined;
1227
+ /** The cost group this service is associated with */
748
1228
  costGroup?: string | undefined;
1229
+ /** The service area (or type) in the STLB */
749
1230
  serviceArea?: string | undefined;
1231
+ /** These keys may optionally be used to further reference multiple, specific items within the STLB */
750
1232
  keys?: ISTLBKeyDto[] | undefined;
751
1233
  }
1234
+ /** This class represents a single key reference within the German STLB "Standardleistungsbuch Bau" */
752
1235
  declare class STLBKeyDto implements ISTLBKeyDto {
1236
+ /** This identifier is required and uniquely describes a single reference within the STLB standard. It maps to "ArtChrIdent" in GAEB XML */
753
1237
  artIdentifier: number;
1238
+ /** This optional index property further categorizes a single reference within the STLB standard. It maps to "ArtChIdx" in GAEB XML */
754
1239
  artIndex?: number | undefined;
1240
+ /** This optional identifier further specifies the execution kind of the reference in the STLB standard. It maps to "ChVIdent" in GAEB XML */
755
1241
  kindIdentifier?: number | undefined;
756
1242
  constructor(data?: ISTLBKeyDto);
757
1243
  init?(_data?: any): void;
758
1244
  static fromJS(data: any): STLBKeyDto;
759
1245
  toJSON?(data?: any): any;
760
1246
  }
1247
+ /** This class represents a single key reference within the German STLB "Standardleistungsbuch Bau" */
761
1248
  interface ISTLBKeyDto {
1249
+ /** This identifier is required and uniquely describes a single reference within the STLB standard. It maps to "ArtChrIdent" in GAEB XML */
762
1250
  artIdentifier: number;
1251
+ /** This optional index property further categorizes a single reference within the STLB standard. It maps to "ArtChIdx" in GAEB XML */
763
1252
  artIndex?: number | undefined;
1253
+ /** This optional identifier further specifies the execution kind of the reference in the STLB standard. It maps to "ChVIdent" in GAEB XML */
764
1254
  kindIdentifier?: number | undefined;
765
1255
  }
1256
+ /** Indicates if this service specification item is commissioned (and therefore should be executed), postponed for later or undefined. */
766
1257
  declare enum ComissionStatusDto {
767
1258
  Undefined = "Undefined",
768
1259
  Commissioned = "Commissioned",
769
1260
  Postponed = "Postponed",
770
1261
  Removed = "Removed"
771
1262
  }
1263
+ /** This model contains the sustainability or environment impact data. */
772
1264
  declare class PositionSustainabilityIndicatorDto implements IPositionSustainabilityIndicatorDto {
1265
+ /** Elements GUID identifier. */
773
1266
  id: string;
1267
+ /** This is usually in the form of an URL that specifies the indicator. */
774
1268
  source?: string | undefined;
1269
+ /** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
775
1270
  comment?: string | undefined;
1271
+ /** If present, this indicator may be divided up into different life cycle stages. */
776
1272
  lifeCycleStages?: SustainabilityLifeCycleStageDto[] | undefined;
1273
+ /** 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. */
777
1274
  indicatorKey?: string | undefined;
1275
+ /** This is the actual value of the indicator. */
778
1276
  value?: number | undefined;
1277
+ /** The unit of measurement for the value. */
779
1278
  unitTag?: string | undefined;
1279
+ /** If present, this is a conversion factor used here in this indicator for the value. */
780
1280
  conversionFactor?: number | undefined;
781
1281
  constructor(data?: IPositionSustainabilityIndicatorDto);
782
1282
  init?(_data?: any): void;
783
1283
  static fromJS(data: any): PositionSustainabilityIndicatorDto;
784
1284
  toJSON?(data?: any): any;
785
1285
  }
1286
+ /** This model contains the sustainability or environment impact data. */
786
1287
  interface IPositionSustainabilityIndicatorDto {
1288
+ /** Elements GUID identifier. */
787
1289
  id: string;
1290
+ /** This is usually in the form of an URL that specifies the indicator. */
788
1291
  source?: string | undefined;
1292
+ /** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
789
1293
  comment?: string | undefined;
1294
+ /** If present, this indicator may be divided up into different life cycle stages. */
790
1295
  lifeCycleStages?: ISustainabilityLifeCycleStageDto[] | undefined;
1296
+ /** 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. */
791
1297
  indicatorKey?: string | undefined;
1298
+ /** This is the actual value of the indicator. */
792
1299
  value?: number | undefined;
1300
+ /** The unit of measurement for the value. */
793
1301
  unitTag?: string | undefined;
1302
+ /** If present, this is a conversion factor used here in this indicator for the value. */
794
1303
  conversionFactor?: number | undefined;
795
1304
  }
1305
+ /** 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. */
796
1306
  declare class SustainabilityLifeCycleStageDto implements ISustainabilityLifeCycleStageDto {
1307
+ /** Elements GUID identifier. */
797
1308
  id: string;
1309
+ /** The key is the name or identifier of the stage. */
798
1310
  key?: string | undefined;
1311
+ /** The value for this given stage. */
799
1312
  value?: number | undefined;
800
1313
  constructor(data?: ISustainabilityLifeCycleStageDto);
801
1314
  init?(_data?: any): void;
802
1315
  static fromJS(data: any): SustainabilityLifeCycleStageDto;
803
1316
  toJSON?(data?: any): any;
804
1317
  }
1318
+ /** 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. */
805
1319
  interface ISustainabilityLifeCycleStageDto {
1320
+ /** Elements GUID identifier. */
806
1321
  id: string;
1322
+ /** The key is the name or identifier of the stage. */
807
1323
  key?: string | undefined;
1324
+ /** The value for this given stage. */
808
1325
  value?: number | undefined;
809
1326
  }
1327
+ /** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
810
1328
  declare class ItemNumberDto implements IItemNumberDto {
1329
+ /** Elements GUID identifier. */
811
1330
  id: string;
1331
+ /** 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. */
812
1332
  stringRepresentation?: string | undefined;
1333
+ /** Indicates if the characters and the length of the Identifiers match the current ItemNumberSchema. */
813
1334
  readonly isSchemaCompliant: boolean;
1335
+ /** Used for representing and validating this ItemNumber. */
814
1336
  itemNumberSchema?: ItemNumberSchemaDto | undefined;
1337
+ /** 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 */
815
1338
  identifiers?: string[] | undefined;
1339
+ /** This indicates if this item number is at the lot level. Find out more about lots in the documentation. */
816
1340
  readonly isLot: boolean;
1341
+ /** 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. */
817
1342
  hierarchyLevel: number;
1343
+ /** This property indicates if this ItemNumber is attached to an object of the Position type. */
818
1344
  readonly isAttachedToPosition: boolean;
819
1345
  itemNumberSchemaBeforeMapping?: ItemNumberSchemaDto | undefined;
820
1346
  constructor(data?: IItemNumberDto);
@@ -822,155 +1348,253 @@ declare class ItemNumberDto implements IItemNumberDto {
822
1348
  static fromJS(data: any): ItemNumberDto;
823
1349
  toJSON?(data?: any): any;
824
1350
  }
1351
+ /** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
825
1352
  interface IItemNumberDto {
1353
+ /** Elements GUID identifier. */
826
1354
  id: string;
1355
+ /** 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. */
827
1356
  stringRepresentation?: string | undefined;
1357
+ /** Indicates if the characters and the length of the Identifiers match the current ItemNumberSchema. */
828
1358
  isSchemaCompliant: boolean;
1359
+ /** Used for representing and validating this ItemNumber. */
829
1360
  itemNumberSchema?: IItemNumberSchemaDto | undefined;
1361
+ /** 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 */
830
1362
  identifiers?: string[] | undefined;
1363
+ /** This indicates if this item number is at the lot level. Find out more about lots in the documentation. */
831
1364
  isLot: boolean;
1365
+ /** 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. */
832
1366
  hierarchyLevel: number;
1367
+ /** This property indicates if this ItemNumber is attached to an object of the Position type. */
833
1368
  isAttachedToPosition: boolean;
834
1369
  itemNumberSchemaBeforeMapping?: IItemNumberSchemaDto | undefined;
835
1370
  }
1371
+ /** This is a classification for Position elements. */
836
1372
  declare enum PositionTypeDto {
837
1373
  Regular = "Regular",
838
1374
  Optional = "Optional",
839
1375
  Alternative = "Alternative"
840
1376
  }
1377
+ /** This indicates the price type of a IPricedElement. */
841
1378
  declare enum PriceTypeDto {
842
1379
  WithTotal = "WithTotal",
843
1380
  WithoutTotal = "WithoutTotal"
844
1381
  }
1382
+ /** The service type describes the type of service a Position represents. */
845
1383
  declare enum ServiceTypeDto {
846
1384
  Regular = "Regular",
847
1385
  HourlyPaidWork = "HourlyPaidWork"
848
1386
  }
1387
+ /** This class represents data about products and their vendor */
849
1388
  declare class ProductDataDto implements IProductDataDto {
1389
+ /** Elements GUID identifier. */
850
1390
  id: string;
1391
+ /** This PartyInformation is used to describe details about the vendor of this ProductData. */
851
1392
  vendor?: PartyInformationDto | undefined;
1393
+ /** The collection of ArticleData that describe this product, e.g. a pipe product could be composed out of multiple pipe segments and fittings. */
852
1394
  articles?: ArticleDataDto[] | undefined;
1395
+ /** Short description for this ITextElement element. */
853
1396
  shortText?: string | undefined;
1397
+ /** 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. */
854
1398
  longText?: string | undefined;
1399
+ /** 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. */
855
1400
  htmlLongText?: string | undefined;
856
1401
  constructor(data?: IProductDataDto);
857
1402
  init?(_data?: any): void;
858
1403
  static fromJS(data: any): ProductDataDto;
859
1404
  toJSON?(data?: any): any;
860
1405
  }
1406
+ /** This class represents data about products and their vendor */
861
1407
  interface IProductDataDto {
1408
+ /** Elements GUID identifier. */
862
1409
  id: string;
1410
+ /** This PartyInformation is used to describe details about the vendor of this ProductData. */
863
1411
  vendor?: IPartyInformationDto | undefined;
1412
+ /** The collection of ArticleData that describe this product, e.g. a pipe product could be composed out of multiple pipe segments and fittings. */
864
1413
  articles?: IArticleDataDto[] | undefined;
1414
+ /** Short description for this ITextElement element. */
865
1415
  shortText?: string | undefined;
1416
+ /** 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. */
866
1417
  longText?: string | undefined;
1418
+ /** 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. */
867
1419
  htmlLongText?: string | undefined;
868
1420
  }
1421
+ /** This class represents a single article, usually used within ProductData */
869
1422
  declare class ArticleDataDto implements IArticleDataDto {
1423
+ /** Elements GUID identifier. */
870
1424
  id: string;
1425
+ /** The name (or brand name) for this article, usually given by the supplier or vendor. */
871
1426
  name?: string | undefined;
1427
+ /** An article number that describes it, useful when integrating other systems. */
872
1428
  articleNumber?: string | undefined;
1429
+ /** 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. */
873
1430
  quantity: number;
1431
+ /** The unit tag for this single ArticleData. */
874
1432
  unitTag?: string | undefined;
1433
+ /** This is an optional text element that can be used to further describe the ArticleData. */
875
1434
  description?: string | undefined;
1435
+ /** Short description for this ITextElement element. */
876
1436
  shortText?: string | undefined;
1437
+ /** 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. */
877
1438
  longText?: string | undefined;
1439
+ /** 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. */
878
1440
  htmlLongText?: string | undefined;
879
1441
  constructor(data?: IArticleDataDto);
880
1442
  init?(_data?: any): void;
881
1443
  static fromJS(data: any): ArticleDataDto;
882
1444
  toJSON?(data?: any): any;
883
1445
  }
1446
+ /** This class represents a single article, usually used within ProductData */
884
1447
  interface IArticleDataDto {
1448
+ /** Elements GUID identifier. */
885
1449
  id: string;
1450
+ /** The name (or brand name) for this article, usually given by the supplier or vendor. */
886
1451
  name?: string | undefined;
1452
+ /** An article number that describes it, useful when integrating other systems. */
887
1453
  articleNumber?: string | undefined;
1454
+ /** 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. */
888
1455
  quantity: number;
1456
+ /** The unit tag for this single ArticleData. */
889
1457
  unitTag?: string | undefined;
1458
+ /** This is an optional text element that can be used to further describe the ArticleData. */
890
1459
  description?: string | undefined;
1460
+ /** Short description for this ITextElement element. */
891
1461
  shortText?: string | undefined;
1462
+ /** 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. */
892
1463
  longText?: string | undefined;
1464
+ /** 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. */
893
1465
  htmlLongText?: string | undefined;
894
1466
  }
1467
+ /** 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. */
895
1468
  declare class QuantityAssignmentDto implements IQuantityAssignmentDto {
1469
+ /** Elements GUID identifier. */
896
1470
  id: string;
1471
+ /** The total quantity in this quantity assignment */
897
1472
  quantity: number;
1473
+ /** 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. */
898
1474
  projectCatalogues?: CatalogueDto[] | undefined;
1475
+ /** Referenced catalogues for this QuantityAssignment. */
899
1476
  catalogueReferences?: CatalogueReferenceDto[] | undefined;
900
1477
  constructor(data?: IQuantityAssignmentDto);
901
1478
  init?(_data?: any): void;
902
1479
  static fromJS(data: any): QuantityAssignmentDto;
903
1480
  toJSON?(data?: any): any;
904
1481
  }
1482
+ /** 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. */
905
1483
  interface IQuantityAssignmentDto {
1484
+ /** Elements GUID identifier. */
906
1485
  id: string;
1486
+ /** The total quantity in this quantity assignment */
907
1487
  quantity: number;
1488
+ /** 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. */
908
1489
  projectCatalogues?: ICatalogueDto[] | undefined;
1490
+ /** Referenced catalogues for this QuantityAssignment. */
909
1491
  catalogueReferences?: ICatalogueReferenceDto[] | undefined;
910
1492
  }
1493
+ /** 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. */
911
1494
  declare class CommercePropertiesDto implements ICommercePropertiesDto {
1495
+ /** This maps to ArtNo in GAEB XML and represents an article number given by the supplier. */
912
1496
  articleNumber?: string | undefined;
1497
+ /** This maps to EAN in GAEB XML and represents an GTIN (formerly EAN) article number. */
913
1498
  eanGtinArticleNumber?: string | undefined;
1499
+ /** This maps to ArtNoID in GAEB XML and represents an ILN article number. */
914
1500
  ilnArticleNumber?: string | undefined;
1501
+ /** 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. */
915
1502
  catalogueNumber?: string | undefined;
1503
+ /** 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. */
916
1504
  catalogueArticleNumber?: string | undefined;
1505
+ /** 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'. */
917
1506
  priceBasis?: number | undefined;
1507
+ /** This optional property can be used to indicate a sub position identifier specific for the commerce exchange */
918
1508
  subPositionIdentifier?: string | undefined;
1509
+ /** In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file */
919
1510
  customerBaseItemNumber?: string | undefined;
920
1511
  constructor(data?: ICommercePropertiesDto);
921
1512
  init?(_data?: any): void;
922
1513
  static fromJS(data: any): CommercePropertiesDto;
923
1514
  toJSON?(data?: any): any;
924
1515
  }
1516
+ /** 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. */
925
1517
  interface ICommercePropertiesDto {
1518
+ /** This maps to ArtNo in GAEB XML and represents an article number given by the supplier. */
926
1519
  articleNumber?: string | undefined;
1520
+ /** This maps to EAN in GAEB XML and represents an GTIN (formerly EAN) article number. */
927
1521
  eanGtinArticleNumber?: string | undefined;
1522
+ /** This maps to ArtNoID in GAEB XML and represents an ILN article number. */
928
1523
  ilnArticleNumber?: string | undefined;
1524
+ /** 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. */
929
1525
  catalogueNumber?: string | undefined;
1526
+ /** 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. */
930
1527
  catalogueArticleNumber?: string | undefined;
1528
+ /** 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'. */
931
1529
  priceBasis?: number | undefined;
1530
+ /** This optional property can be used to indicate a sub position identifier specific for the commerce exchange */
932
1531
  subPositionIdentifier?: string | undefined;
1532
+ /** In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file */
933
1533
  customerBaseItemNumber?: string | undefined;
934
1534
  }
1535
+ /** 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 */
935
1536
  declare class ComplementedByQuantityDto implements IComplementedByQuantityDto {
1537
+ /** 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². */
936
1538
  quantity: number;
1539
+ /** 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. */
937
1540
  complementingPositionId: string | undefined;
938
1541
  constructor(data?: IComplementedByQuantityDto);
939
1542
  init?(_data?: any): void;
940
1543
  static fromJS(data: any): ComplementedByQuantityDto;
941
1544
  toJSON?(data?: any): any;
942
1545
  }
1546
+ /** 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 */
943
1547
  interface IComplementedByQuantityDto {
1548
+ /** 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². */
944
1549
  quantity: number;
1550
+ /** 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. */
945
1551
  complementingPositionId: string | undefined;
946
1552
  }
1553
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for Positions and extends the OenormProperties base class. */
947
1554
  declare class OenormPositionPropertiesDto implements IOenormPositionPropertiesDto {
948
- originCode?: OenormOriginCodeDto | undefined;
1555
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
1556
+ originCode: OenormOriginCodeDto;
1557
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
949
1558
  openingTextIsFreeText: boolean;
1559
+ /** 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. */
950
1560
  isMainPosition: boolean;
1561
+ /** 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 */
951
1562
  isUndividedPosition: boolean;
1563
+ /** 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. */
952
1564
  oenormShortText?: string | undefined;
1565
+ /** 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. */
953
1566
  oenormShortTextAddition?: string | undefined;
1567
+ /** This maps to 'teilangebotskennzeichen' in ÖNorm positions, which means positions that are only partially offered. */
954
1568
  partialOfferMark?: string | undefined;
955
1569
  constructor(data?: IOenormPositionPropertiesDto);
956
1570
  init?(_data?: any): void;
957
1571
  static fromJS(data: any): OenormPositionPropertiesDto;
958
1572
  toJSON?(data?: any): any;
959
1573
  }
1574
+ /** 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. */
960
1575
  interface IOenormPositionPropertiesDto {
961
- originCode?: OenormOriginCodeDto | undefined;
1576
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
1577
+ originCode: OenormOriginCodeDto;
1578
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
962
1579
  openingTextIsFreeText: boolean;
1580
+ /** 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. */
963
1581
  isMainPosition: boolean;
1582
+ /** 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 */
964
1583
  isUndividedPosition: boolean;
1584
+ /** 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. */
965
1585
  oenormShortText?: string | undefined;
1586
+ /** 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. */
966
1587
  oenormShortTextAddition?: string | undefined;
1588
+ /** This maps to 'teilangebotskennzeichen' in ÖNorm positions, which means positions that are only partially offered. */
967
1589
  partialOfferMark?: string | undefined;
968
1590
  }
1591
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
969
1592
  declare enum OenormOriginCodeDto {
970
1593
  Unknown = "Unknown",
971
1594
  FreeText = "FreeText",
972
1595
  AdditionDescription = "AdditionDescription"
973
1596
  }
1597
+ /** This enumeration represents the status of an addendum, 'Nachtrag' in German */
974
1598
  declare enum AddendumStatusDto {
975
1599
  Unknown = "Unknown",
976
1600
  Recognized = "Recognized",
@@ -982,36 +1606,51 @@ declare enum AddendumStatusDto {
982
1606
  FormallyAcknowledged = "FormallyAcknowledged",
983
1607
  Approved = "Approved"
984
1608
  }
1609
+ /** 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. */
985
1610
  declare enum PositionComplementingTypeDto {
986
1611
  Undefined = "Undefined",
987
1612
  AllPreviousMarkedPositions = "AllPreviousMarkedPositions",
988
1613
  AllPreviousPositions = "AllPreviousPositions",
989
1614
  ReferencedPositions = "ReferencedPositions"
990
1615
  }
1616
+ /** 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 */
991
1617
  declare class PositionHoldOutPropertiesDto implements IPositionHoldOutPropertiesDto {
1618
+ /** Elements GUID identifier. */
992
1619
  id: string;
993
- holdOutType?: HoldOutTypeDto | undefined;
1620
+ /** The actual type */
1621
+ holdOutType: HoldOutTypeDto;
1622
+ /** The duration of the period */
994
1623
  holdOutDuration: number;
995
- holdOutDurationUnit?: HoldOutDurationUnitDto | undefined;
1624
+ /** The time unit of the period */
1625
+ holdOutDurationUnit: HoldOutDurationUnitDto;
1626
+ /** References to base positions */
996
1627
  basePositionReferences?: string[] | undefined;
997
1628
  constructor(data?: IPositionHoldOutPropertiesDto);
998
1629
  init?(_data?: any): void;
999
1630
  static fromJS(data: any): PositionHoldOutPropertiesDto;
1000
1631
  toJSON?(data?: any): any;
1001
1632
  }
1633
+ /** 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 */
1002
1634
  interface IPositionHoldOutPropertiesDto {
1635
+ /** Elements GUID identifier. */
1003
1636
  id: string;
1004
- holdOutType?: HoldOutTypeDto | undefined;
1637
+ /** The actual type */
1638
+ holdOutType: HoldOutTypeDto;
1639
+ /** The duration of the period */
1005
1640
  holdOutDuration: number;
1006
- holdOutDurationUnit?: HoldOutDurationUnitDto | undefined;
1641
+ /** The time unit of the period */
1642
+ holdOutDurationUnit: HoldOutDurationUnitDto;
1643
+ /** References to base positions */
1007
1644
  basePositionReferences?: string[] | undefined;
1008
1645
  }
1646
+ /** Types of retentions to be used in positions */
1009
1647
  declare enum HoldOutTypeDto {
1010
1648
  Unknown = "Unknown",
1011
1649
  Base = "Base",
1012
1650
  Extension = "Extension",
1013
1651
  Rent = "Rent"
1014
1652
  }
1653
+ /** Duration used in retention positions */
1015
1654
  declare enum HoldOutDurationUnitDto {
1016
1655
  Unknown = "Unknown",
1017
1656
  Minutes = "Minutes",
@@ -1020,31 +1659,51 @@ declare enum HoldOutDurationUnitDto {
1020
1659
  Weeks = "Weeks",
1021
1660
  Months = "Months"
1022
1661
  }
1662
+ /** Price catalogue data represents assumed or estimated prices from a catalogue source */
1023
1663
  declare class PriceCatalogueDataDto implements IPriceCatalogueDataDto {
1664
+ /** Elements GUID identifier. */
1024
1665
  id: string;
1666
+ /** The lower bound of the unit price */
1025
1667
  unitPriceFrom?: number | undefined;
1668
+ /** The upper bound of the unit price */
1026
1669
  unitPriceTo?: number | undefined;
1670
+ /** The average unit price */
1027
1671
  unitPriceAverage?: number | undefined;
1672
+ /** The lower bound of the wage price */
1028
1673
  wagePriceFrom?: number | undefined;
1674
+ /** The upper bound of the wage price */
1029
1675
  wagePriceTo?: number | undefined;
1676
+ /** The average wage price */
1030
1677
  wagePriceAverage?: number | undefined;
1031
1678
  constructor(data?: IPriceCatalogueDataDto);
1032
1679
  init?(_data?: any): void;
1033
1680
  static fromJS(data: any): PriceCatalogueDataDto;
1034
1681
  toJSON?(data?: any): any;
1035
1682
  }
1683
+ /** Price catalogue data represents assumed or estimated prices from a catalogue source */
1036
1684
  interface IPriceCatalogueDataDto {
1685
+ /** Elements GUID identifier. */
1037
1686
  id: string;
1687
+ /** The lower bound of the unit price */
1038
1688
  unitPriceFrom?: number | undefined;
1689
+ /** The upper bound of the unit price */
1039
1690
  unitPriceTo?: number | undefined;
1691
+ /** The average unit price */
1040
1692
  unitPriceAverage?: number | undefined;
1693
+ /** The lower bound of the wage price */
1041
1694
  wagePriceFrom?: number | undefined;
1695
+ /** The upper bound of the wage price */
1042
1696
  wagePriceTo?: number | undefined;
1697
+ /** The average wage price */
1043
1698
  wagePriceAverage?: number | undefined;
1044
1699
  }
1700
+ /** An ExecutionDescription is used to give more details for certain items, especially on how they are meant to be executed. */
1045
1701
  declare class ExecutionDescriptionDto extends IElementDto implements IExecutionDescriptionDto {
1702
+ /** Blocks within an ExecutionDescription contain the actual information. */
1046
1703
  blocks?: NoteTextDto[] | undefined;
1704
+ /** Labels this ExecutionDescription. */
1047
1705
  label?: string | undefined;
1706
+ /** Uniquely identifies this ExecutionDescription. */
1048
1707
  identifier?: string | undefined;
1049
1708
  elementType: string;
1050
1709
  elementTypeDiscriminator: string;
@@ -1053,182 +1712,311 @@ declare class ExecutionDescriptionDto extends IElementDto implements IExecutionD
1053
1712
  static fromJS(data: any): ExecutionDescriptionDto;
1054
1713
  toJSON(data?: any): any;
1055
1714
  }
1715
+ /** An ExecutionDescription is used to give more details for certain items, especially on how they are meant to be executed. */
1056
1716
  interface IExecutionDescriptionDto extends IIElementDto {
1717
+ /** Blocks within an ExecutionDescription contain the actual information. */
1057
1718
  blocks?: NoteTextDto[] | undefined;
1719
+ /** Labels this ExecutionDescription. */
1058
1720
  label?: string | undefined;
1721
+ /** Uniquely identifies this ExecutionDescription. */
1059
1722
  identifier?: string | undefined;
1060
1723
  elementType: string;
1061
1724
  }
1725
+ /** Represents an element that holds text information. */
1062
1726
  declare class NoteTextDto extends IElementDto implements INoteTextDto {
1727
+ /** 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. */
1063
1728
  isOpeningText: boolean;
1729
+ /** 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. */
1064
1730
  isClosingText: boolean;
1065
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
1066
- property. If you want to convert from DTO objects, and you want to work with the
1067
- `HtmlShortText` property, you need to set this property to null. */
1731
+ /** Short description for this DescriptionBase element.
1732
+ Please note that by default, this property takes precedence over the `HtmlShortText`
1733
+ property. If you want to convert from DTO objects, and you want to work with the
1734
+ `HtmlShortText` property, you need to set this property to null.
1735
+ */
1068
1736
  shortText?: string | undefined;
1069
- /** This property is used to store the short text in HTML format. If you want to convert
1070
- from DTO objects, and you want to use this property, then you need to ensure that
1071
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
1737
+ /** 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.
1738
+ This property is used to store the short text in HTML format. If you want to convert
1739
+ from DTO objects, and you want to use this property, then you need to ensure that
1740
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
1741
+ */
1072
1742
  htmlShortText?: string | undefined;
1073
- additionType?: AdditionTypeDto | undefined;
1743
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
1744
+ additionType: AdditionTypeDto;
1745
+ /** 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. */
1074
1746
  longText?: string | undefined;
1747
+ /** 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. */
1075
1748
  htmlLongText?: string | undefined;
1749
+ /** 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. */
1076
1750
  identifier?: string | undefined;
1751
+ /** 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. */
1077
1752
  standardizedDescription?: StandardizedDescriptionDto | undefined;
1078
1753
  elementType: string;
1079
1754
  elementTypeDiscriminator: string;
1755
+ /** 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. */
1080
1756
  descriptionId?: string | undefined;
1757
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
1081
1758
  oenormNoteTextProperties?: OenormNoteTextPropertiesDto | undefined;
1082
1759
  readonly hasBidderCommentInHtmlLongText: boolean;
1760
+ /** 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. */
1083
1761
  baseCatalogueNumber?: string | undefined;
1084
1762
  constructor(data?: INoteTextDto);
1085
1763
  init(_data?: any): void;
1086
1764
  static fromJS(data: any): NoteTextDto;
1087
1765
  toJSON(data?: any): any;
1088
1766
  }
1767
+ /** Represents an element that holds text information. */
1089
1768
  interface INoteTextDto extends IIElementDto {
1769
+ /** 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. */
1090
1770
  isOpeningText: boolean;
1771
+ /** 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. */
1091
1772
  isClosingText: boolean;
1092
- /** Please note that by default, this property takes precedence over the `HtmlShortText`
1093
- property. If you want to convert from DTO objects, and you want to work with the
1094
- `HtmlShortText` property, you need to set this property to null. */
1773
+ /** Short description for this DescriptionBase element.
1774
+ Please note that by default, this property takes precedence over the `HtmlShortText`
1775
+ property. If you want to convert from DTO objects, and you want to work with the
1776
+ `HtmlShortText` property, you need to set this property to null.
1777
+ */
1095
1778
  shortText?: string | undefined;
1096
- /** This property is used to store the short text in HTML format. If you want to convert
1097
- from DTO objects, and you want to use this property, then you need to ensure that
1098
- `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text. */
1779
+ /** 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.
1780
+ This property is used to store the short text in HTML format. If you want to convert
1781
+ from DTO objects, and you want to use this property, then you need to ensure that
1782
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
1783
+ */
1099
1784
  htmlShortText?: string | undefined;
1100
- additionType?: AdditionTypeDto | undefined;
1785
+ /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
1786
+ additionType: AdditionTypeDto;
1787
+ /** 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. */
1101
1788
  longText?: string | undefined;
1789
+ /** 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. */
1102
1790
  htmlLongText?: string | undefined;
1791
+ /** 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. */
1103
1792
  identifier?: string | undefined;
1793
+ /** 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. */
1104
1794
  standardizedDescription?: IStandardizedDescriptionDto | undefined;
1105
1795
  elementType: string;
1796
+ /** 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. */
1106
1797
  descriptionId?: string | undefined;
1798
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
1107
1799
  oenormNoteTextProperties?: IOenormNoteTextPropertiesDto | undefined;
1108
1800
  hasBidderCommentInHtmlLongText: boolean;
1801
+ /** 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. */
1109
1802
  baseCatalogueNumber?: string | undefined;
1110
1803
  }
1804
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
1111
1805
  declare class OenormNoteTextPropertiesDto implements IOenormNoteTextPropertiesDto {
1112
- originCode?: OenormOriginCodeDto | undefined;
1806
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
1807
+ originCode: OenormOriginCodeDto;
1808
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
1113
1809
  openingTextIsFreeText: boolean;
1810
+ /** 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 */
1114
1811
  isUndividedPosition: boolean;
1115
1812
  constructor(data?: IOenormNoteTextPropertiesDto);
1116
1813
  init?(_data?: any): void;
1117
1814
  static fromJS(data: any): OenormNoteTextPropertiesDto;
1118
1815
  toJSON?(data?: any): any;
1119
1816
  }
1817
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts. */
1120
1818
  interface IOenormNoteTextPropertiesDto {
1121
- originCode?: OenormOriginCodeDto | undefined;
1819
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
1820
+ originCode: OenormOriginCodeDto;
1821
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
1122
1822
  openingTextIsFreeText: boolean;
1823
+ /** 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 */
1123
1824
  isUndividedPosition: boolean;
1124
1825
  }
1826
+ /** This is a grouping IElement that holds other IElements within. */
1125
1827
  declare class ServiceSpecificationGroupDto extends IElementDto implements IServiceSpecificationGroupDto {
1828
+ /** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
1126
1829
  readonly projectHourlyWage: number;
1830
+ /** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
1127
1831
  projectTaxRate: number;
1832
+ /** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
1128
1833
  projectPriceComponents?: string[] | undefined;
1834
+ /** The ItemNumberSchema that is used within this project. */
1129
1835
  projectItemNumberSchema?: ItemNumberSchemaDto | undefined;
1836
+ /** The IElements within this ElementContainerBase. */
1130
1837
  elements?: IElementDto[] | undefined;
1838
+ /** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
1131
1839
  readonly projectLabourTimeLabel?: string | undefined;
1840
+ /** 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. */
1132
1841
  readonly containsDuplicateItemNumbers: boolean;
1842
+ /** 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. */
1133
1843
  readonly containsDuplicateElementIds: boolean;
1844
+ /** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
1134
1845
  ignoreDuplicateItemNumbers: boolean;
1846
+ /** 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 */
1135
1847
  ignoreProjectCataloguePropagation: boolean;
1848
+ /** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
1136
1849
  ignoreDuplicateElementIds: boolean;
1850
+ /** Price composition by tax rate. */
1137
1851
  totalPriceGrossByTaxRate?: GrossPriceComponentDto[] | undefined;
1852
+ /** 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. */
1138
1853
  ignoreChildPriceUpdates: boolean;
1854
+ /** Net price after applied deductions. */
1139
1855
  readonly deductedPrice: number;
1856
+ /** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
1140
1857
  deductionFactor: number;
1858
+ /** 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. */
1141
1859
  absoluteDeduction?: number | undefined;
1860
+ /** Will return this ElementContainerBase's total price. */
1142
1861
  readonly totalPrice: number;
1862
+ /** The total gross price for this ElementContainerBase including all child elements. */
1143
1863
  readonly totalPriceGross: number;
1864
+ /** Total gross price after applied deductions. */
1144
1865
  readonly totalPriceGrossDeducted: number;
1145
- priceType?: PriceTypeDto | undefined;
1866
+ /** Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not. */
1867
+ priceType: PriceTypeDto;
1868
+ /** Description for this ServiceSpecificationGroup. */
1146
1869
  shortText?: string | undefined;
1147
- comissionStatus?: ComissionStatusDto | undefined;
1870
+ /** Indicates if this service specification group is commissioned (and therefore should be executed), postponed for later or undefined. */
1871
+ comissionStatus: ComissionStatusDto;
1872
+ /** The ItemNumber for this INumberedElement interface. */
1148
1873
  itemNumber?: ItemNumberDto | undefined;
1149
1874
  elementType: string;
1150
1875
  elementTypeDiscriminator: string;
1876
+ /** This indicates if this group is the parent of a lot. See the documentation for more information about working with lots. */
1151
1877
  readonly isLot: boolean;
1878
+ /** 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 */
1152
1879
  alternativeTo: string | undefined;
1880
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
1153
1881
  oenormProperties?: OenormPropertiesDto | undefined;
1882
+ /** 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. */
1154
1883
  hierarchyLevel: number;
1884
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
1155
1885
  addendumStatus?: AddendumStatusDto | undefined;
1886
+ /** 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. */
1156
1887
  alternativeIdentifier?: number | undefined;
1888
+ /** 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. */
1157
1889
  alternativeGroupIdentifier?: number | undefined;
1158
1890
  constructor(data?: IServiceSpecificationGroupDto);
1159
1891
  init(_data?: any): void;
1160
1892
  static fromJS(data: any): ServiceSpecificationGroupDto;
1161
1893
  toJSON(data?: any): any;
1162
1894
  }
1895
+ /** This is a grouping IElement that holds other IElements within. */
1163
1896
  interface IServiceSpecificationGroupDto extends IIElementDto {
1897
+ /** The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements. */
1164
1898
  projectHourlyWage: number;
1899
+ /** The tax rate that is used within this ElementContainerBase. Will be propagated to child elements. */
1165
1900
  projectTaxRate: number;
1901
+ /** The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. */
1166
1902
  projectPriceComponents?: string[] | undefined;
1903
+ /** The ItemNumberSchema that is used within this project. */
1167
1904
  projectItemNumberSchema?: IItemNumberSchemaDto | undefined;
1905
+ /** The IElements within this ElementContainerBase. */
1168
1906
  elements?: IElementDto[] | undefined;
1907
+ /** The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". */
1169
1908
  projectLabourTimeLabel?: string | undefined;
1909
+ /** 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. */
1170
1910
  containsDuplicateItemNumbers: boolean;
1911
+ /** 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. */
1171
1912
  containsDuplicateElementIds: boolean;
1913
+ /** Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes. */
1172
1914
  ignoreDuplicateItemNumbers: boolean;
1915
+ /** 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 */
1173
1916
  ignoreProjectCataloguePropagation: boolean;
1917
+ /** Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes. */
1174
1918
  ignoreDuplicateElementIds: boolean;
1919
+ /** Price composition by tax rate. */
1175
1920
  totalPriceGrossByTaxRate?: IGrossPriceComponentDto[] | undefined;
1921
+ /** 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. */
1176
1922
  ignoreChildPriceUpdates: boolean;
1923
+ /** Net price after applied deductions. */
1177
1924
  deductedPrice: number;
1925
+ /** Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied. */
1178
1926
  deductionFactor: number;
1927
+ /** 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. */
1179
1928
  absoluteDeduction?: number | undefined;
1929
+ /** Will return this ElementContainerBase's total price. */
1180
1930
  totalPrice: number;
1931
+ /** The total gross price for this ElementContainerBase including all child elements. */
1181
1932
  totalPriceGross: number;
1933
+ /** Total gross price after applied deductions. */
1182
1934
  totalPriceGrossDeducted: number;
1183
- priceType?: PriceTypeDto | undefined;
1935
+ /** Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not. */
1936
+ priceType: PriceTypeDto;
1937
+ /** Description for this ServiceSpecificationGroup. */
1184
1938
  shortText?: string | undefined;
1185
- comissionStatus?: ComissionStatusDto | undefined;
1939
+ /** Indicates if this service specification group is commissioned (and therefore should be executed), postponed for later or undefined. */
1940
+ comissionStatus: ComissionStatusDto;
1941
+ /** The ItemNumber for this INumberedElement interface. */
1186
1942
  itemNumber?: IItemNumberDto | undefined;
1187
1943
  elementType: string;
1944
+ /** This indicates if this group is the parent of a lot. See the documentation for more information about working with lots. */
1188
1945
  isLot: boolean;
1946
+ /** 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 */
1189
1947
  alternativeTo: string | undefined;
1948
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
1190
1949
  oenormProperties?: IOenormPropertiesDto | undefined;
1950
+ /** 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. */
1191
1951
  hierarchyLevel: number;
1952
+ /** This indicates, if this element is part of an addendum an, if yes, with what status. */
1192
1953
  addendumStatus?: AddendumStatusDto | undefined;
1954
+ /** 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. */
1193
1955
  alternativeIdentifier?: number | undefined;
1956
+ /** 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. */
1194
1957
  alternativeGroupIdentifier?: number | undefined;
1195
1958
  }
1959
+ /** This is used in an ElementContainerBase to hold the price composition. */
1196
1960
  declare class GrossPriceComponentDto implements IGrossPriceComponentDto {
1961
+ /** This components tax rate. */
1197
1962
  taxRate: number;
1963
+ /** This is the factor of applied deductions for this component */
1198
1964
  deductionFactor: number;
1965
+ /** The total net price for all components of a given tax rate. */
1199
1966
  totalNet: number;
1967
+ /** The resulting price component after applied deductions */
1200
1968
  readonly totalDeducted: number;
1969
+ /** The total tax amount for all components of a given tax rate. */
1201
1970
  readonly totalTax: number;
1971
+ /** The total gross price for all components of a given tax rate. */
1202
1972
  readonly totalGross: number;
1973
+ /** The total gross price for all components of a given tax rate, after applied deductions. */
1203
1974
  readonly totalGrossDeducted: number;
1975
+ /** The total tax amount for all components of a given tax rate, after applied deductions. */
1204
1976
  readonly totalTaxDeducted: number;
1205
1977
  constructor(data?: IGrossPriceComponentDto);
1206
1978
  init?(_data?: any): void;
1207
1979
  static fromJS(data: any): GrossPriceComponentDto;
1208
1980
  toJSON?(data?: any): any;
1209
1981
  }
1982
+ /** This is used in an ElementContainerBase to hold the price composition. */
1210
1983
  interface IGrossPriceComponentDto {
1984
+ /** This components tax rate. */
1211
1985
  taxRate: number;
1986
+ /** This is the factor of applied deductions for this component */
1212
1987
  deductionFactor: number;
1988
+ /** The total net price for all components of a given tax rate. */
1213
1989
  totalNet: number;
1990
+ /** The resulting price component after applied deductions */
1214
1991
  totalDeducted: number;
1992
+ /** The total tax amount for all components of a given tax rate. */
1215
1993
  totalTax: number;
1994
+ /** The total gross price for all components of a given tax rate. */
1216
1995
  totalGross: number;
1996
+ /** The total gross price for all components of a given tax rate, after applied deductions. */
1217
1997
  totalGrossDeducted: number;
1998
+ /** The total tax amount for all components of a given tax rate, after applied deductions. */
1218
1999
  totalTaxDeducted: number;
1219
2000
  }
2001
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
1220
2002
  declare class OenormPropertiesDto implements IOenormPropertiesDto {
1221
- originCode?: OenormOriginCodeDto | undefined;
2003
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
2004
+ originCode: OenormOriginCodeDto;
2005
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
1222
2006
  openingTextIsFreeText: boolean;
1223
2007
  constructor(data?: IOenormPropertiesDto);
1224
2008
  init?(_data?: any): void;
1225
2009
  static fromJS(data: any): OenormPropertiesDto;
1226
2010
  toJSON?(data?: any): any;
1227
2011
  }
2012
+ /** This class models special properties that only apply to some exchange scenarios where ÖNorm is used. */
1228
2013
  interface IOenormPropertiesDto {
1229
- originCode?: OenormOriginCodeDto | undefined;
2014
+ /** This indicates where the content of this element originates, if set. It corresponds to 'herkunftskennzeichen' in ÖNorm */
2015
+ originCode: OenormOriginCodeDto;
2016
+ /** This marks if the opening texts within this element are considered free text. It corresponds to 'vorbemerkungskennzeichen' in ÖNorm. */
1230
2017
  openingTextIsFreeText: boolean;
1231
2018
  }
2019
+ /** Indicates a ServiceSpecification's exchange phase, based on the GAEB exchange phases. */
1232
2020
  declare enum ExchangePhaseDto {
1233
2021
  Undefined = "Undefined",
1234
2022
  Base = "Base",
@@ -1238,6 +2026,7 @@ declare enum ExchangePhaseDto {
1238
2026
  SideOffer = "SideOffer",
1239
2027
  Grant = "Grant"
1240
2028
  }
2029
+ /** Indicates where a service specification was originally created. */
1241
2030
  declare enum OriginDto {
1242
2031
  Self = "Self",
1243
2032
  Gaeb90 = "Gaeb90",
@@ -1247,186 +2036,312 @@ declare enum OriginDto {
1247
2036
  Reb = "Reb",
1248
2037
  Sia = "Sia"
1249
2038
  }
2039
+ /** Holds global price information for a ServiceSpecification */
1250
2040
  declare class PriceInformationDto implements IPriceInformationDto {
2041
+ /** Elements GUID identifier. */
1251
2042
  id: string;
2043
+ /** The amount of currency per one hour of manual labour work in this project. */
1252
2044
  hourlyWage: number;
2045
+ /** The final, total price will be deducted by this rate. */
1253
2046
  deductionFactor: number;
2047
+ /** This is given when there is only one flat price for the whole service specification. */
1254
2048
  flatSum: number;
2049
+ /** Global tax rate for the project. Note that certain elements may have a different, specific tax rate. */
1255
2050
  taxRate: number;
2051
+ /** 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. */
1256
2052
  hasUnsetTaxRate: boolean;
2053
+ /** Trade discounts for offered in this ServiceSpecification. */
1257
2054
  tradeDiscounts?: TradeDiscountDto[] | undefined;
1258
2055
  constructor(data?: IPriceInformationDto);
1259
2056
  init?(_data?: any): void;
1260
2057
  static fromJS(data: any): PriceInformationDto;
1261
2058
  toJSON?(data?: any): any;
1262
2059
  }
2060
+ /** Holds global price information for a ServiceSpecification */
1263
2061
  interface IPriceInformationDto {
2062
+ /** Elements GUID identifier. */
1264
2063
  id: string;
2064
+ /** The amount of currency per one hour of manual labour work in this project. */
1265
2065
  hourlyWage: number;
2066
+ /** The final, total price will be deducted by this rate. */
1266
2067
  deductionFactor: number;
2068
+ /** This is given when there is only one flat price for the whole service specification. */
1267
2069
  flatSum: number;
2070
+ /** Global tax rate for the project. Note that certain elements may have a different, specific tax rate. */
1268
2071
  taxRate: number;
2072
+ /** 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. */
1269
2073
  hasUnsetTaxRate: boolean;
2074
+ /** Trade discounts for offered in this ServiceSpecification. */
1270
2075
  tradeDiscounts?: ITradeDiscountDto[] | undefined;
1271
2076
  }
2077
+ /** This class holds information about offered trade discounts (Skonto in German) */
1272
2078
  declare class TradeDiscountDto implements ITradeDiscountDto {
2079
+ /** Elements GUID identifier. */
1273
2080
  id: string;
2081
+ /** 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. */
1274
2082
  deadline: number;
2083
+ /** The rate of the trade discount. */
1275
2084
  rate: number;
1276
2085
  constructor(data?: ITradeDiscountDto);
1277
2086
  init?(_data?: any): void;
1278
2087
  static fromJS(data: any): TradeDiscountDto;
1279
2088
  toJSON?(data?: any): any;
1280
2089
  }
2090
+ /** This class holds information about offered trade discounts (Skonto in German) */
1281
2091
  interface ITradeDiscountDto {
2092
+ /** Elements GUID identifier. */
1282
2093
  id: string;
2094
+ /** 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. */
1283
2095
  deadline: number;
2096
+ /** The rate of the trade discount. */
1284
2097
  rate: number;
1285
2098
  }
2099
+ /** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
1286
2100
  declare class SustainabilityCatalogueDto implements ISustainabilityCatalogueDto {
2101
+ /** Elements GUID identifier. */
1287
2102
  id: string;
2103
+ /** 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. */
1288
2104
  key?: string | undefined;
2105
+ /** The description property can be used to provide further information about the sustainability catalogue. */
1289
2106
  description?: string | undefined;
1290
2107
  constructor(data?: ISustainabilityCatalogueDto);
1291
2108
  init?(_data?: any): void;
1292
2109
  static fromJS(data: any): SustainabilityCatalogueDto;
1293
2110
  toJSON?(data?: any): any;
1294
2111
  }
2112
+ /** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
1295
2113
  interface ISustainabilityCatalogueDto {
2114
+ /** Elements GUID identifier. */
1296
2115
  id: string;
2116
+ /** 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. */
1297
2117
  key?: string | undefined;
2118
+ /** The description property can be used to provide further information about the sustainability catalogue. */
1298
2119
  description?: string | undefined;
1299
2120
  }
2121
+ /** 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 */
1300
2122
  declare class WarrantyDurationDto implements IWarrantyDurationDto {
2123
+ /** 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. */
1301
2124
  duration: number;
1302
- unit?: DurationUnitDto | undefined;
2125
+ /** The unit of the duration */
2126
+ unit: DurationUnitDto;
1303
2127
  constructor(data?: IWarrantyDurationDto);
1304
2128
  init?(_data?: any): void;
1305
2129
  static fromJS(data: any): WarrantyDurationDto;
1306
2130
  toJSON?(data?: any): any;
1307
2131
  }
2132
+ /** 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 */
1308
2133
  interface IWarrantyDurationDto {
2134
+ /** 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. */
1309
2135
  duration: number;
1310
- unit?: DurationUnitDto | undefined;
2136
+ /** The unit of the duration */
2137
+ unit: DurationUnitDto;
1311
2138
  }
2139
+ /** This enumeration represents the unit of a duration */
1312
2140
  declare enum DurationUnitDto {
1313
2141
  Months = "Months",
1314
2142
  Years = "Years"
1315
2143
  }
2144
+ /** This class represents properties used in commerce exchange scenarios */
1316
2145
  declare class ServiceSpecificationCommercePropertiesDto implements IServiceSpecificationCommercePropertiesDto {
2146
+ /** The date until the price is valid or fixed. */
1317
2147
  fixedPriceDate?: Date | undefined;
2148
+ /** The date of the delivery voucher note. */
1318
2149
  deliveryVoucherDate?: Date | undefined;
2150
+ /** The actual date of delivery. */
1319
2151
  deliveryDate?: Date | undefined;
2152
+ /** The number of the inquiry, usually in a context of offer requests. */
1320
2153
  inquiryNumber?: string | undefined;
2154
+ /** The number of the offer, usually in a context of an offer. */
1321
2155
  offerNumber?: string | undefined;
2156
+ /** The order number, usually in the context of a grant or contract. */
1322
2157
  orderNumber?: string | undefined;
2158
+ /** The order confirmation number */
1323
2159
  orderConfirmationNumber?: string | undefined;
2160
+ /** The number of the delivery, e.g. on the delivery note voucher. */
1324
2161
  deliveryNumber?: string | undefined;
2162
+ /** The reference number of the customer / buyer. */
1325
2163
  customerReferenceNumber?: string | undefined;
2164
+ /** The reference number of the supplier / bidder. */
1326
2165
  supplierReferenceNumber?: string | undefined;
2166
+ /** The type of shippment. */
1327
2167
  shippingType?: string | undefined;
1328
- inquiryType?: CommerceInquiryTypeDto | undefined;
2168
+ /** The type of the price inquiry. */
2169
+ inquiryType: CommerceInquiryTypeDto;
1329
2170
  constructor(data?: IServiceSpecificationCommercePropertiesDto);
1330
2171
  init?(_data?: any): void;
1331
2172
  static fromJS(data: any): ServiceSpecificationCommercePropertiesDto;
1332
2173
  toJSON?(data?: any): any;
1333
2174
  }
2175
+ /** This class represents properties used in commerce exchange scenarios */
1334
2176
  interface IServiceSpecificationCommercePropertiesDto {
2177
+ /** The date until the price is valid or fixed. */
1335
2178
  fixedPriceDate?: Date | undefined;
2179
+ /** The date of the delivery voucher note. */
1336
2180
  deliveryVoucherDate?: Date | undefined;
2181
+ /** The actual date of delivery. */
1337
2182
  deliveryDate?: Date | undefined;
2183
+ /** The number of the inquiry, usually in a context of offer requests. */
1338
2184
  inquiryNumber?: string | undefined;
2185
+ /** The number of the offer, usually in a context of an offer. */
1339
2186
  offerNumber?: string | undefined;
2187
+ /** The order number, usually in the context of a grant or contract. */
1340
2188
  orderNumber?: string | undefined;
2189
+ /** The order confirmation number */
1341
2190
  orderConfirmationNumber?: string | undefined;
2191
+ /** The number of the delivery, e.g. on the delivery note voucher. */
1342
2192
  deliveryNumber?: string | undefined;
2193
+ /** The reference number of the customer / buyer. */
1343
2194
  customerReferenceNumber?: string | undefined;
2195
+ /** The reference number of the supplier / bidder. */
1344
2196
  supplierReferenceNumber?: string | undefined;
2197
+ /** The type of shippment. */
1345
2198
  shippingType?: string | undefined;
1346
- inquiryType?: CommerceInquiryTypeDto | undefined;
2199
+ /** The type of the price inquiry. */
2200
+ inquiryType: CommerceInquiryTypeDto;
1347
2201
  }
2202
+ /** This enum represents types of price inquiries */
1348
2203
  declare enum CommerceInquiryTypeDto {
1349
2204
  Unknown = "Unknown",
1350
2205
  Project = "Project",
1351
2206
  Immediate = "Immediate",
1352
2207
  Exhibition = "Exhibition"
1353
2208
  }
2209
+ /** This class holds ÖNorm-specific properties for a ServiceSpecification. */
1354
2210
  declare class ServiceSpecificationOenormPropertiesDto implements IServiceSpecificationOenormPropertiesDto {
2211
+ /** The LB (Leistungsbeschreibung) references for this service specification. */
1355
2212
  lbReferences?: OenormLBReferenceDto[] | undefined;
2213
+ /** The LB (Leistungsbeschreibung) references for addition descriptions of this service specification. */
1356
2214
  lbReferenceAdditions?: OenormLBReferenceDto[] | undefined;
2215
+ /** The party that created the service specification (LV-Ersteller in ÖNorm). */
1357
2216
  serviceSpecificationCreator?: PartyInformationDto | undefined;
2217
+ /** The awarding authority (ausschreibende Stelle / vergebende Stelle in ÖNorm). */
1358
2218
  awardingAuthority?: PartyInformationDto | undefined;
1359
2219
  constructor(data?: IServiceSpecificationOenormPropertiesDto);
1360
2220
  init?(_data?: any): void;
1361
2221
  static fromJS(data: any): ServiceSpecificationOenormPropertiesDto;
1362
2222
  toJSON?(data?: any): any;
1363
2223
  }
2224
+ /** This class holds ÖNorm-specific properties for a ServiceSpecification. */
1364
2225
  interface IServiceSpecificationOenormPropertiesDto {
2226
+ /** The LB (Leistungsbeschreibung) references for this service specification. */
1365
2227
  lbReferences?: IOenormLBReferenceDto[] | undefined;
2228
+ /** The LB (Leistungsbeschreibung) references for addition descriptions of this service specification. */
1366
2229
  lbReferenceAdditions?: IOenormLBReferenceDto[] | undefined;
2230
+ /** The party that created the service specification (LV-Ersteller in ÖNorm). */
1367
2231
  serviceSpecificationCreator?: IPartyInformationDto | undefined;
2232
+ /** The awarding authority (ausschreibende Stelle / vergebende Stelle in ÖNorm). */
1368
2233
  awardingAuthority?: IPartyInformationDto | undefined;
1369
2234
  }
2235
+ /** This class holds reference data for an ÖNorm LB (Leistungsbeschreibung / service specification). */
1370
2236
  declare class OenormLBReferenceDto implements IOenormLBReferenceDto {
2237
+ /** Elements GUID identifier. */
1371
2238
  id: string;
2239
+ /** The name of the referenced service specification. */
1372
2240
  name?: string | undefined;
2241
+ /** The number of the referenced service specification. */
1373
2242
  number?: string | undefined;
2243
+ /** The addition number of the referenced service specification. */
1374
2244
  additionNumber?: string | undefined;
2245
+ /** The date of the referenced service specification. */
1375
2246
  date?: Date | undefined;
2247
+ /** The subject area identifier of the referenced service specification. */
1376
2248
  subjectAreaIdentifier?: string | undefined;
2249
+ /** The download URL for the referenced service specification. */
1377
2250
  downloadUrl?: string | undefined;
2251
+ /** The part/edition name of the referenced service specification. */
1378
2252
  partEditionName?: string | undefined;
2253
+ /** The publisher name. */
1379
2254
  publisherName?: string | undefined;
2255
+ /** The publisher street address. */
1380
2256
  publisherStreet?: string | undefined;
2257
+ /** The publisher city. */
1381
2258
  publisherCity?: string | undefined;
2259
+ /** The publisher country. */
1382
2260
  publisherCountry?: string | undefined;
2261
+ /** The publisher zip code. */
1383
2262
  publisherZipCode?: string | undefined;
2263
+ /** The publisher phone number. */
1384
2264
  publisherPhone?: string | undefined;
2265
+ /** The publisher website URL. */
1385
2266
  publisherWebsite?: string | undefined;
1386
2267
  constructor(data?: IOenormLBReferenceDto);
1387
2268
  init?(_data?: any): void;
1388
2269
  static fromJS(data: any): OenormLBReferenceDto;
1389
2270
  toJSON?(data?: any): any;
1390
2271
  }
2272
+ /** This class holds reference data for an ÖNorm LB (Leistungsbeschreibung / service specification). */
1391
2273
  interface IOenormLBReferenceDto {
2274
+ /** Elements GUID identifier. */
1392
2275
  id: string;
2276
+ /** The name of the referenced service specification. */
1393
2277
  name?: string | undefined;
2278
+ /** The number of the referenced service specification. */
1394
2279
  number?: string | undefined;
2280
+ /** The addition number of the referenced service specification. */
1395
2281
  additionNumber?: string | undefined;
2282
+ /** The date of the referenced service specification. */
1396
2283
  date?: Date | undefined;
2284
+ /** The subject area identifier of the referenced service specification. */
1397
2285
  subjectAreaIdentifier?: string | undefined;
2286
+ /** The download URL for the referenced service specification. */
1398
2287
  downloadUrl?: string | undefined;
2288
+ /** The part/edition name of the referenced service specification. */
1399
2289
  partEditionName?: string | undefined;
2290
+ /** The publisher name. */
1400
2291
  publisherName?: string | undefined;
2292
+ /** The publisher street address. */
1401
2293
  publisherStreet?: string | undefined;
2294
+ /** The publisher city. */
1402
2295
  publisherCity?: string | undefined;
2296
+ /** The publisher country. */
1403
2297
  publisherCountry?: string | undefined;
2298
+ /** The publisher zip code. */
1404
2299
  publisherZipCode?: string | undefined;
2300
+ /** The publisher phone number. */
1405
2301
  publisherPhone?: string | undefined;
2302
+ /** The publisher website URL. */
1406
2303
  publisherWebsite?: string | undefined;
1407
2304
  }
2305
+ /** A Project contains all relevant information for a construction project. */
1408
2306
  declare class ProjectDto implements IProjectDto {
2307
+ /** Elements GUID identifier. */
1409
2308
  id: string;
2309
+ /** 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. */
1410
2310
  priceAccuracy: number;
2311
+ /** 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. */
1411
2312
  unitPriceAccuracy?: number | undefined;
2313
+ /** 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. */
1412
2314
  forceStrictTotals: boolean;
1413
- priceRoundingMode?: PriceRoundingModeDto | undefined;
2315
+ /** 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. */
2316
+ priceRoundingMode: PriceRoundingModeDto;
2317
+ /** The ProjectInformation contains information that describes the project and its structure. */
1414
2318
  projectInformation?: ProjectInformationDto | undefined;
2319
+ /** The ServiceSpecifications in this Project. */
1415
2320
  serviceSpecifications?: ServiceSpecificationDto[] | undefined;
2321
+ /** 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. */
1416
2322
  gaebXmlId?: string | undefined;
1417
2323
  constructor(data?: IProjectDto);
1418
2324
  init?(_data?: any): void;
1419
2325
  static fromJS(data: any): ProjectDto;
1420
2326
  toJSON?(data?: any): any;
1421
2327
  }
2328
+ /** A Project contains all relevant information for a construction project. */
1422
2329
  interface IProjectDto {
2330
+ /** Elements GUID identifier. */
1423
2331
  id: string;
2332
+ /** 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. */
1424
2333
  priceAccuracy: number;
2334
+ /** 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. */
1425
2335
  unitPriceAccuracy?: number | undefined;
2336
+ /** 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. */
1426
2337
  forceStrictTotals: boolean;
1427
- priceRoundingMode?: PriceRoundingModeDto | undefined;
2338
+ /** 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. */
2339
+ priceRoundingMode: PriceRoundingModeDto;
2340
+ /** The ProjectInformation contains information that describes the project and its structure. */
1428
2341
  projectInformation?: IProjectInformationDto | undefined;
2342
+ /** The ServiceSpecifications in this Project. */
1429
2343
  serviceSpecifications?: IServiceSpecificationDto[] | undefined;
2344
+ /** 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. */
1430
2345
  gaebXmlId?: string | undefined;
1431
2346
  }
1432
2347