@dangl/avacloud-client-node 1.25.0 → 1.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * AVACloud API 1.42.0
2
+ * AVACloud API 1.45.0
3
3
  * AVACloud API specification
4
4
  *
5
- * OpenAPI spec version: 1.42.0
5
+ * OpenAPI spec version: 1.45.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -243,6 +243,10 @@ export declare class CatalogueDto {
243
243
  * If given, this gives a classification for the contents of the catalogue
244
244
  */
245
245
  'catalogueType': CatalogueTypeDto;
246
+ /**
247
+ * 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.
248
+ */
249
+ 'catalogueTypeDetail'?: string;
246
250
  static discriminator: string | undefined;
247
251
  static attributeTypeMap: Array<{
248
252
  name: string;
@@ -371,6 +375,10 @@ export declare class CommercePropertiesDto {
371
375
  * This optional property can be used to indicate a sub position identifier specific for the commerce exchange
372
376
  */
373
377
  'subPositionIdentifier'?: string;
378
+ /**
379
+ * In a commerce exchange, this property is usually used to reference the base item number of an underlying phase 83 exchange file
380
+ */
381
+ 'customerBaseItemNumber'?: string;
374
382
  static discriminator: string | undefined;
375
383
  static attributeTypeMap: Array<{
376
384
  name: string;
@@ -424,7 +432,7 @@ export declare class DatanormDestinationVersion {
424
432
  }[];
425
433
  }
426
434
  /**
427
- * The GAEB exchange phase to transform to
435
+ * The GAEB exchange phase to transform to. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
428
436
  */
429
437
  export declare class DestinationGaebExchangePhase {
430
438
  static discriminator: string | undefined;
@@ -595,6 +603,7 @@ export declare class FileValidationSourceType {
595
603
  export declare class ForgotPasswordPost {
596
604
  'identifier': string;
597
605
  'preferredLanguages'?: Array<string>;
606
+ 'serviceLoginRedirectUri'?: string;
598
607
  static discriminator: string | undefined;
599
608
  static attributeTypeMap: Array<{
600
609
  name: string;
@@ -1489,6 +1498,14 @@ export declare class PositionDto extends IElementDto {
1489
1498
  * This is an informational property, which directly holds a numerical value for an estimated quantity. It is not used for any price calculations.
1490
1499
  */
1491
1500
  'estimatedQuantity'?: number;
1501
+ /**
1502
+ * 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.
1503
+ */
1504
+ 'priceCatalogueData'?: PriceCatalogueDataDto;
1505
+ /**
1506
+ * 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.
1507
+ */
1508
+ 'ignoreProjectCataloguePropagation': boolean;
1492
1509
  static discriminator: string | undefined;
1493
1510
  static attributeTypeMap: Array<{
1494
1511
  name: string;
@@ -1626,7 +1643,7 @@ export declare class PostGaebDestinationOptions {
1626
1643
  */
1627
1644
  'destinationGaebType': DestinationGaebType;
1628
1645
  /**
1629
- * Defaults to none, meaning no transformation will be done
1646
+ * Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
1630
1647
  */
1631
1648
  'targetExchangePhaseTransform': DestinationGaebExchangePhase;
1632
1649
  /**
@@ -1694,6 +1711,50 @@ export declare class PostOenormDestinationOptions {
1694
1711
  }[];
1695
1712
  }
1696
1713
  /**
1714
+ * Price catalogue data represents assumed or estimated prices from a catalogue source
1715
+ */
1716
+ export declare class PriceCatalogueDataDto {
1717
+ /**
1718
+ * Elements GUID identifier.
1719
+ */
1720
+ 'id': string;
1721
+ /**
1722
+ * The lower bound of the unit price
1723
+ */
1724
+ 'unitPriceFrom'?: number;
1725
+ /**
1726
+ * The upper bound of the unit price
1727
+ */
1728
+ 'unitPriceTo'?: number;
1729
+ /**
1730
+ * The average unit price
1731
+ */
1732
+ 'unitPriceAverage'?: number;
1733
+ /**
1734
+ * The lower bound of the wage price
1735
+ */
1736
+ 'wagePriceFrom'?: number;
1737
+ /**
1738
+ * The upper bound of the wage price
1739
+ */
1740
+ 'wagePriceTo'?: number;
1741
+ /**
1742
+ * The average wage price
1743
+ */
1744
+ 'wagePriceAverage'?: number;
1745
+ static discriminator: string | undefined;
1746
+ static attributeTypeMap: Array<{
1747
+ name: string;
1748
+ baseName: string;
1749
+ type: string;
1750
+ }>;
1751
+ static getAttributeTypeMap(): {
1752
+ name: string;
1753
+ baseName: string;
1754
+ type: string;
1755
+ }[];
1756
+ }
1757
+ /**
1697
1758
  * 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.
1698
1759
  */
1699
1760
  export declare class PriceComponentDto {
@@ -2044,6 +2105,7 @@ export declare class RegisterPost {
2044
2105
  'email': string;
2045
2106
  'password': string;
2046
2107
  'preferredLanguages'?: Array<string>;
2108
+ 'serviceLoginRedirectUri'?: string;
2047
2109
  static discriminator: string | undefined;
2048
2110
  static attributeTypeMap: Array<{
2049
2111
  name: string;
@@ -2249,6 +2311,10 @@ export declare class ServiceSpecificationDto {
2249
2311
  */
2250
2312
  'ignoreDuplicateItemNumbers': boolean;
2251
2313
  /**
2314
+ * 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
2315
+ */
2316
+ 'ignoreProjectCataloguePropagation': boolean;
2317
+ /**
2252
2318
  * Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes.
2253
2319
  */
2254
2320
  'ignoreDuplicateElementIds': boolean;
@@ -2458,6 +2524,10 @@ export declare class ServiceSpecificationGroupDto extends IElementDto {
2458
2524
  */
2459
2525
  'ignoreDuplicateItemNumbers': boolean;
2460
2526
  /**
2527
+ * 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
2528
+ */
2529
+ 'ignoreProjectCataloguePropagation': boolean;
2530
+ /**
2461
2531
  * Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes.
2462
2532
  */
2463
2533
  'ignoreDuplicateElementIds': boolean;
@@ -2567,6 +2637,22 @@ export declare class ServiceTypeDto {
2567
2637
  }[];
2568
2638
  }
2569
2639
  /**
2640
+ * Represents valid SIA destination types
2641
+ */
2642
+ export declare class SiaDestinationType {
2643
+ static discriminator: string | undefined;
2644
+ static attributeTypeMap: Array<{
2645
+ name: string;
2646
+ baseName: string;
2647
+ type: string;
2648
+ }>;
2649
+ static getAttributeTypeMap(): {
2650
+ name: string;
2651
+ baseName: string;
2652
+ type: string;
2653
+ }[];
2654
+ }
2655
+ /**
2570
2656
  * 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
2571
2657
  */
2572
2658
  export declare class SpecialAwardKindDto {
@@ -3017,7 +3103,7 @@ export declare class AslvConversionApi {
3017
3103
  /**
3018
3104
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3019
3105
  */
3020
- aslvConversionConvertToAvaWithRequestObject(aslvFile: FileParameter, options: {
3106
+ aslvConversionConvertToAvaWithRequestObject(aslvFile: FileParameter, options?: {
3021
3107
  removePlainTextLongTexts?: boolean;
3022
3108
  removeHtmlLongTexts?: boolean;
3023
3109
  options?: any;
@@ -3040,10 +3126,11 @@ export declare class AslvConversionApi {
3040
3126
  /**
3041
3127
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3042
3128
  */
3043
- aslvConversionConvertToExcelWithRequestObject(aslvFile: FileParameter, options: {
3129
+ aslvConversionConvertToExcelWithRequestObject(aslvFile: FileParameter, options?: {
3044
3130
  writePrices?: boolean;
3045
3131
  writeLongTexts?: boolean;
3046
3132
  conversionCulture?: string;
3133
+ includeArticleNumbers?: boolean;
3047
3134
  options?: any;
3048
3135
  }): Promise<{
3049
3136
  response: http.IncomingMessage;
@@ -3056,16 +3143,17 @@ export declare class AslvConversionApi {
3056
3143
  * @param writePrices Defaults to true
3057
3144
  * @param writeLongTexts Defaults to true
3058
3145
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3146
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
3059
3147
  * @param {*} [options] Override http request options.
3060
3148
  */
3061
- aslvConversionConvertToExcel(aslvFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3149
+ aslvConversionConvertToExcel(aslvFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3062
3150
  response: http.IncomingMessage;
3063
3151
  body: Buffer;
3064
3152
  }>;
3065
3153
  /**
3066
3154
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3067
3155
  */
3068
- aslvConversionConvertToGaebWithRequestObject(aslvFile: FileParameter, options: {
3156
+ aslvConversionConvertToGaebWithRequestObject(aslvFile: FileParameter, options?: {
3069
3157
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
3070
3158
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
3071
3159
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -3083,7 +3171,7 @@ export declare class AslvConversionApi {
3083
3171
  * @summary Converts Aslv files to GAEB files
3084
3172
  * @param aslvFile The input file
3085
3173
  * @param destinationGaebType Defaults to GAEB XML V3.2
3086
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3174
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
3087
3175
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
3088
3176
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
3089
3177
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -3098,7 +3186,7 @@ export declare class AslvConversionApi {
3098
3186
  /**
3099
3187
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3100
3188
  */
3101
- aslvConversionConvertToOenormWithRequestObject(aslvFile: FileParameter, options: {
3189
+ aslvConversionConvertToOenormWithRequestObject(aslvFile: FileParameter, options?: {
3102
3190
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3103
3191
  tryRepairProjectStructure?: boolean;
3104
3192
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -3143,7 +3231,7 @@ export declare class AvaConversionApi {
3143
3231
  /**
3144
3232
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3145
3233
  */
3146
- avaConversionConvertToAvaWithRequestObject(avaProject: ProjectDto, options: {
3234
+ avaConversionConvertToAvaWithRequestObject(avaProject: ProjectDto, options?: {
3147
3235
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3148
3236
  removePlainTextLongTexts?: boolean;
3149
3237
  removeHtmlLongTexts?: boolean;
@@ -3168,7 +3256,7 @@ export declare class AvaConversionApi {
3168
3256
  /**
3169
3257
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3170
3258
  */
3171
- avaConversionConvertToDatanormWithRequestObject(avaProject: ProjectDto, options: {
3259
+ avaConversionConvertToDatanormWithRequestObject(avaProject: ProjectDto, options?: {
3172
3260
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3173
3261
  datanormDestinationVersion?: 'V4' | 'V5';
3174
3262
  options?: any;
@@ -3191,11 +3279,12 @@ export declare class AvaConversionApi {
3191
3279
  /**
3192
3280
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3193
3281
  */
3194
- avaConversionConvertToExcelWithRequestObject(avaProject: ProjectDto, options: {
3282
+ avaConversionConvertToExcelWithRequestObject(avaProject: ProjectDto, options?: {
3195
3283
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3196
3284
  writePrices?: boolean;
3197
3285
  writeLongTexts?: boolean;
3198
3286
  conversionCulture?: string;
3287
+ includeArticleNumbers?: boolean;
3199
3288
  options?: any;
3200
3289
  }): Promise<{
3201
3290
  response: http.IncomingMessage;
@@ -3209,16 +3298,17 @@ export declare class AvaConversionApi {
3209
3298
  * @param writePrices Defaults to true
3210
3299
  * @param writeLongTexts Defaults to true
3211
3300
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3301
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
3212
3302
  * @param {*} [options] Override http request options.
3213
3303
  */
3214
- avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3304
+ avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3215
3305
  response: http.IncomingMessage;
3216
3306
  body: Buffer;
3217
3307
  }>;
3218
3308
  /**
3219
3309
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3220
3310
  */
3221
- avaConversionConvertToGaebWithRequestObject(avaProject: ProjectDto, options: {
3311
+ avaConversionConvertToGaebWithRequestObject(avaProject: ProjectDto, options?: {
3222
3312
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3223
3313
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
3224
3314
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
@@ -3238,7 +3328,7 @@ export declare class AvaConversionApi {
3238
3328
  * @param avaProject The Dangl.AVA project
3239
3329
  * @param tryAutoGenerateItemNumbersAndSchema If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
3240
3330
  * @param destinationGaebType Defaults to GAEB XML V3.2
3241
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3331
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
3242
3332
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
3243
3333
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
3244
3334
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -3253,7 +3343,7 @@ export declare class AvaConversionApi {
3253
3343
  /**
3254
3344
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3255
3345
  */
3256
- avaConversionConvertToIdsConnectWithRequestObject(avaProject: ProjectDto, options: {
3346
+ avaConversionConvertToIdsConnectWithRequestObject(avaProject: ProjectDto, options?: {
3257
3347
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3258
3348
  version?: 'V2_5';
3259
3349
  options?: any;
@@ -3276,7 +3366,7 @@ export declare class AvaConversionApi {
3276
3366
  /**
3277
3367
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3278
3368
  */
3279
- avaConversionConvertToOenormWithRequestObject(avaProject: ProjectDto, options: {
3369
+ avaConversionConvertToOenormWithRequestObject(avaProject: ProjectDto, options?: {
3280
3370
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3281
3371
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3282
3372
  tryRepairProjectStructure?: boolean;
@@ -3305,7 +3395,7 @@ export declare class AvaConversionApi {
3305
3395
  /**
3306
3396
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3307
3397
  */
3308
- avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: {
3398
+ avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options?: {
3309
3399
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3310
3400
  destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33';
3311
3401
  options?: any;
@@ -3328,8 +3418,9 @@ export declare class AvaConversionApi {
3328
3418
  /**
3329
3419
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3330
3420
  */
3331
- avaConversionConvertToSiaWithRequestObject(avaProject: ProjectDto, options: {
3421
+ avaConversionConvertToSiaWithRequestObject(avaProject: ProjectDto, options?: {
3332
3422
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3423
+ siaDestinationType?: 'Sia451' | 'Ifa18';
3333
3424
  options?: any;
3334
3425
  }): Promise<{
3335
3426
  response: http.IncomingMessage;
@@ -3340,16 +3431,17 @@ export declare class AvaConversionApi {
3340
3431
  * @summary Converts Dangl.AVA projects to SIA 451
3341
3432
  * @param avaProject The Dangl.AVA project
3342
3433
  * @param tryAutoGenerateItemNumbersAndSchema If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
3434
+ * @param siaDestinationType Defaults to Sia451
3343
3435
  * @param {*} [options] Override http request options.
3344
3436
  */
3345
- avaConversionConvertToSia(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
3437
+ avaConversionConvertToSia(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, siaDestinationType?: 'Sia451' | 'Ifa18', options?: any): Promise<{
3346
3438
  response: http.IncomingMessage;
3347
3439
  body: Buffer;
3348
3440
  }>;
3349
3441
  /**
3350
3442
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3351
3443
  */
3352
- avaConversionConvertToUglWithRequestObject(avaProject: ProjectDto, options: {
3444
+ avaConversionConvertToUglWithRequestObject(avaProject: ProjectDto, options?: {
3353
3445
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3354
3446
  uglDestinationVersion?: 'V4' | 'V5';
3355
3447
  options?: any;
@@ -3399,7 +3491,7 @@ export declare class DanglIdentityApi {
3399
3491
  /**
3400
3492
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3401
3493
  */
3402
- danglIdentityLoginWithCookieWithRequestObject(model: LoginPost, options: {
3494
+ danglIdentityLoginWithCookieWithRequestObject(model: LoginPost, options?: {
3403
3495
  redirectUrl?: string;
3404
3496
  options?: any;
3405
3497
  }): Promise<{
@@ -3472,7 +3564,7 @@ export declare class DatanormConversionApi {
3472
3564
  /**
3473
3565
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3474
3566
  */
3475
- datanormConversionConvertToAvaWithRequestObject(datanormFile: FileParameter, options: {
3567
+ datanormConversionConvertToAvaWithRequestObject(datanormFile: FileParameter, options?: {
3476
3568
  removePlainTextLongTexts?: boolean;
3477
3569
  removeHtmlLongTexts?: boolean;
3478
3570
  options?: any;
@@ -3513,7 +3605,7 @@ export declare class ExcelConversionApi {
3513
3605
  /**
3514
3606
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3515
3607
  */
3516
- excelConversionConvertToAvaWithRequestObject(excelFile: FileParameter, options: {
3608
+ excelConversionConvertToAvaWithRequestObject(excelFile: FileParameter, options?: {
3517
3609
  readNewElements?: boolean;
3518
3610
  rebuildItemNumberSchema?: boolean;
3519
3611
  removePlainTextLongTexts?: boolean;
@@ -3540,12 +3632,13 @@ export declare class ExcelConversionApi {
3540
3632
  /**
3541
3633
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3542
3634
  */
3543
- excelConversionConvertToExcelWithRequestObject(excelFile: FileParameter, options: {
3635
+ excelConversionConvertToExcelWithRequestObject(excelFile: FileParameter, options?: {
3544
3636
  readNewElements?: boolean;
3545
3637
  rebuildItemNumberSchema?: boolean;
3546
3638
  writePrices?: boolean;
3547
3639
  writeLongTexts?: boolean;
3548
3640
  conversionCulture?: string;
3641
+ includeArticleNumbers?: boolean;
3549
3642
  options?: any;
3550
3643
  }): Promise<{
3551
3644
  response: http.IncomingMessage;
@@ -3560,16 +3653,17 @@ export declare class ExcelConversionApi {
3560
3653
  * @param writePrices Defaults to true
3561
3654
  * @param writeLongTexts Defaults to true
3562
3655
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3656
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
3563
3657
  * @param {*} [options] Override http request options.
3564
3658
  */
3565
- excelConversionConvertToExcel(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3659
+ excelConversionConvertToExcel(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3566
3660
  response: http.IncomingMessage;
3567
3661
  body: Buffer;
3568
3662
  }>;
3569
3663
  /**
3570
3664
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3571
3665
  */
3572
- excelConversionConvertToGaebWithRequestObject(excelFile: FileParameter, options: {
3666
+ excelConversionConvertToGaebWithRequestObject(excelFile: FileParameter, options?: {
3573
3667
  readNewElements?: boolean;
3574
3668
  rebuildItemNumberSchema?: boolean;
3575
3669
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
@@ -3591,7 +3685,7 @@ export declare class ExcelConversionApi {
3591
3685
  * @param readNewElements Defaults to false
3592
3686
  * @param rebuildItemNumberSchema When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
3593
3687
  * @param destinationGaebType Defaults to GAEB XML V3.2
3594
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3688
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
3595
3689
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
3596
3690
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
3597
3691
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -3606,7 +3700,7 @@ export declare class ExcelConversionApi {
3606
3700
  /**
3607
3701
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3608
3702
  */
3609
- excelConversionConvertToOenormWithRequestObject(excelFile: FileParameter, options: {
3703
+ excelConversionConvertToOenormWithRequestObject(excelFile: FileParameter, options?: {
3610
3704
  readNewElements?: boolean;
3611
3705
  rebuildItemNumberSchema?: boolean;
3612
3706
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
@@ -3655,13 +3749,14 @@ export declare class GaebConversionApi {
3655
3749
  /**
3656
3750
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3657
3751
  */
3658
- gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options: {
3752
+ gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options?: {
3659
3753
  supportSkippedItemNumberLevelsInPositions?: boolean;
3660
3754
  removePlainTextLongTexts?: boolean;
3661
3755
  removeHtmlLongTexts?: boolean;
3662
3756
  outputHtmlAsXml?: boolean;
3663
3757
  keepEmptyHtmlText?: boolean;
3664
3758
  allowUpperCaseItemNumbers?: boolean;
3759
+ allowLumpSumItemsWithDifferingQuantities?: boolean;
3665
3760
  options?: any;
3666
3761
  }): Promise<{
3667
3762
  response: http.IncomingMessage;
@@ -3677,23 +3772,26 @@ export declare class GaebConversionApi {
3677
3772
  * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3678
3773
  * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3679
3774
  * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
3775
+ * @param allowLumpSumItemsWithDifferingQuantities Defaults to &#39;false&#39;. By default, the GAEB standard requires lump sum items (&#39;Pauschalpositionen&#39; in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to &#39;true&#39;, then differing quantities will be kept during the import.
3680
3776
  * @param {*} [options] Override http request options.
3681
3777
  */
3682
- gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
3778
+ gaebConversionConvertToAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, allowLumpSumItemsWithDifferingQuantities?: boolean, options?: any): Promise<{
3683
3779
  response: http.IncomingMessage;
3684
3780
  body: ProjectDto;
3685
3781
  }>;
3686
3782
  /**
3687
3783
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3688
3784
  */
3689
- gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options: {
3785
+ gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options?: {
3690
3786
  supportSkippedItemNumberLevelsInPositions?: boolean;
3691
3787
  writePrices?: boolean;
3692
3788
  writeLongTexts?: boolean;
3693
3789
  conversionCulture?: string;
3790
+ includeArticleNumbers?: boolean;
3694
3791
  outputHtmlAsXml?: boolean;
3695
3792
  keepEmptyHtmlText?: boolean;
3696
3793
  allowUpperCaseItemNumbers?: boolean;
3794
+ allowLumpSumItemsWithDifferingQuantities?: boolean;
3697
3795
  options?: any;
3698
3796
  }): Promise<{
3699
3797
  response: http.IncomingMessage;
@@ -3707,19 +3805,21 @@ export declare class GaebConversionApi {
3707
3805
  * @param writePrices Defaults to true
3708
3806
  * @param writeLongTexts Defaults to true
3709
3807
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3808
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
3710
3809
  * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3711
3810
  * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3712
3811
  * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
3812
+ * @param allowLumpSumItemsWithDifferingQuantities Defaults to &#39;false&#39;. By default, the GAEB standard requires lump sum items (&#39;Pauschalpositionen&#39; in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to &#39;true&#39;, then differing quantities will be kept during the import.
3713
3813
  * @param {*} [options] Override http request options.
3714
3814
  */
3715
- gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
3815
+ gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, allowLumpSumItemsWithDifferingQuantities?: boolean, options?: any): Promise<{
3716
3816
  response: http.IncomingMessage;
3717
3817
  body: Buffer;
3718
3818
  }>;
3719
3819
  /**
3720
3820
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3721
3821
  */
3722
- gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options: {
3822
+ gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options?: {
3723
3823
  supportSkippedItemNumberLevelsInPositions?: boolean;
3724
3824
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
3725
3825
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
@@ -3731,6 +3831,7 @@ export declare class GaebConversionApi {
3731
3831
  outputHtmlAsXml?: boolean;
3732
3832
  keepEmptyHtmlText?: boolean;
3733
3833
  allowUpperCaseItemNumbers?: boolean;
3834
+ allowLumpSumItemsWithDifferingQuantities?: boolean;
3734
3835
  options?: any;
3735
3836
  }): Promise<{
3736
3837
  response: http.IncomingMessage;
@@ -3742,7 +3843,7 @@ export declare class GaebConversionApi {
3742
3843
  * @param gaebFile The input file
3743
3844
  * @param supportSkippedItemNumberLevelsInPositions Defaults to &#39;false&#39;. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just &#39;01.02&#39;, then it will be displayed as &#39;01.__.02&#39; if this is set to true.
3744
3845
  * @param destinationGaebType Defaults to GAEB XML V3.2
3745
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
3846
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
3746
3847
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
3747
3848
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
3748
3849
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -3751,16 +3852,17 @@ export declare class GaebConversionApi {
3751
3852
  * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3752
3853
  * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3753
3854
  * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
3855
+ * @param allowLumpSumItemsWithDifferingQuantities Defaults to &#39;false&#39;. By default, the GAEB standard requires lump sum items (&#39;Pauschalpositionen&#39; in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to &#39;true&#39;, then differing quantities will be kept during the import.
3754
3856
  * @param {*} [options] Override http request options.
3755
3857
  */
3756
- gaebConversionConvertToGaeb(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
3858
+ gaebConversionConvertToGaeb(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, allowLumpSumItemsWithDifferingQuantities?: boolean, options?: any): Promise<{
3757
3859
  response: http.IncomingMessage;
3758
3860
  body: Buffer;
3759
3861
  }>;
3760
3862
  /**
3761
3863
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3762
3864
  */
3763
- gaebConversionConvertToOenormWithRequestObject(gaebFile: FileParameter, options: {
3865
+ gaebConversionConvertToOenormWithRequestObject(gaebFile: FileParameter, options?: {
3764
3866
  supportSkippedItemNumberLevelsInPositions?: boolean;
3765
3867
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3766
3868
  tryRepairProjectStructure?: boolean;
@@ -3769,6 +3871,7 @@ export declare class GaebConversionApi {
3769
3871
  outputHtmlAsXml?: boolean;
3770
3872
  keepEmptyHtmlText?: boolean;
3771
3873
  allowUpperCaseItemNumbers?: boolean;
3874
+ allowLumpSumItemsWithDifferingQuantities?: boolean;
3772
3875
  options?: any;
3773
3876
  }): Promise<{
3774
3877
  response: http.IncomingMessage;
@@ -3786,9 +3889,10 @@ export declare class GaebConversionApi {
3786
3889
  * @param outputHtmlAsXml Defaults to &#39;false&#39;. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce &#39;&lt;br /&gt;&#39; instead of &#39;&lt;br&gt;&#39;.
3787
3890
  * @param keepEmptyHtmlText Defaults to &#39;false&#39;. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
3788
3891
  * @param allowUpperCaseItemNumbers Defaults to &#39;false&#39;. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
3892
+ * @param allowLumpSumItemsWithDifferingQuantities Defaults to &#39;false&#39;. By default, the GAEB standard requires lump sum items (&#39;Pauschalpositionen&#39; in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to &#39;true&#39;, then differing quantities will be kept during the import.
3789
3893
  * @param {*} [options] Override http request options.
3790
3894
  */
3791
- gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
3895
+ gaebConversionConvertToOenorm(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, allowLumpSumItemsWithDifferingQuantities?: boolean, options?: any): Promise<{
3792
3896
  response: http.IncomingMessage;
3793
3897
  body: Buffer;
3794
3898
  }>;
@@ -3813,7 +3917,7 @@ export declare class IdsConnectConversionApi {
3813
3917
  /**
3814
3918
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3815
3919
  */
3816
- idsConnectConversionConvertToAvaWithRequestObject(idsConnectFile: FileParameter, options: {
3920
+ idsConnectConversionConvertToAvaWithRequestObject(idsConnectFile: FileParameter, options?: {
3817
3921
  removePlainTextLongTexts?: boolean;
3818
3922
  removeHtmlLongTexts?: boolean;
3819
3923
  options?: any;
@@ -3854,7 +3958,7 @@ export declare class OenormConversionApi {
3854
3958
  /**
3855
3959
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3856
3960
  */
3857
- oenormConversionConvertToAvaWithRequestObject(oenormFile: FileParameter, options: {
3961
+ oenormConversionConvertToAvaWithRequestObject(oenormFile: FileParameter, options?: {
3858
3962
  removePlainTextLongTexts?: boolean;
3859
3963
  removeHtmlLongTexts?: boolean;
3860
3964
  options?: any;
@@ -3877,10 +3981,11 @@ export declare class OenormConversionApi {
3877
3981
  /**
3878
3982
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3879
3983
  */
3880
- oenormConversionConvertToExcelWithRequestObject(oenormFile: FileParameter, options: {
3984
+ oenormConversionConvertToExcelWithRequestObject(oenormFile: FileParameter, options?: {
3881
3985
  writePrices?: boolean;
3882
3986
  writeLongTexts?: boolean;
3883
3987
  conversionCulture?: string;
3988
+ includeArticleNumbers?: boolean;
3884
3989
  options?: any;
3885
3990
  }): Promise<{
3886
3991
  response: http.IncomingMessage;
@@ -3893,16 +3998,17 @@ export declare class OenormConversionApi {
3893
3998
  * @param writePrices Defaults to true
3894
3999
  * @param writeLongTexts Defaults to true
3895
4000
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
4001
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
3896
4002
  * @param {*} [options] Override http request options.
3897
4003
  */
3898
- oenormConversionConvertToExcel(oenormFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
4004
+ oenormConversionConvertToExcel(oenormFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3899
4005
  response: http.IncomingMessage;
3900
4006
  body: Buffer;
3901
4007
  }>;
3902
4008
  /**
3903
4009
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3904
4010
  */
3905
- oenormConversionConvertToGaebWithRequestObject(oenormFile: FileParameter, options: {
4011
+ oenormConversionConvertToGaebWithRequestObject(oenormFile: FileParameter, options?: {
3906
4012
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
3907
4013
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
3908
4014
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -3920,7 +4026,7 @@ export declare class OenormConversionApi {
3920
4026
  * @summary Converts ÖNorm files to GAEB files.
3921
4027
  * @param oenormFile The input file
3922
4028
  * @param destinationGaebType Defaults to GAEB XML V3.2
3923
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
4029
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
3924
4030
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
3925
4031
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
3926
4032
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -3935,7 +4041,7 @@ export declare class OenormConversionApi {
3935
4041
  /**
3936
4042
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3937
4043
  */
3938
- oenormConversionConvertToOenormWithRequestObject(oenormFile: FileParameter, options: {
4044
+ oenormConversionConvertToOenormWithRequestObject(oenormFile: FileParameter, options?: {
3939
4045
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3940
4046
  tryRepairProjectStructure?: boolean;
3941
4047
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -3980,7 +4086,7 @@ export declare class RebConversionApi {
3980
4086
  /**
3981
4087
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3982
4088
  */
3983
- rebConversionConvertToAvaWithRequestObject(rebFile: FileParameter, options: {
4089
+ rebConversionConvertToAvaWithRequestObject(rebFile: FileParameter, options?: {
3984
4090
  removePlainTextLongTexts?: boolean;
3985
4091
  removeHtmlLongTexts?: boolean;
3986
4092
  options?: any;
@@ -4003,10 +4109,11 @@ export declare class RebConversionApi {
4003
4109
  /**
4004
4110
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4005
4111
  */
4006
- rebConversionConvertToExcelWithRequestObject(rebFile: FileParameter, options: {
4112
+ rebConversionConvertToExcelWithRequestObject(rebFile: FileParameter, options?: {
4007
4113
  writePrices?: boolean;
4008
4114
  writeLongTexts?: boolean;
4009
4115
  conversionCulture?: string;
4116
+ includeArticleNumbers?: boolean;
4010
4117
  options?: any;
4011
4118
  }): Promise<{
4012
4119
  response: http.IncomingMessage;
@@ -4019,16 +4126,17 @@ export declare class RebConversionApi {
4019
4126
  * @param writePrices Defaults to true
4020
4127
  * @param writeLongTexts Defaults to true
4021
4128
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
4129
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
4022
4130
  * @param {*} [options] Override http request options.
4023
4131
  */
4024
- rebConversionConvertToExcel(rebFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
4132
+ rebConversionConvertToExcel(rebFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
4025
4133
  response: http.IncomingMessage;
4026
4134
  body: Buffer;
4027
4135
  }>;
4028
4136
  /**
4029
4137
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4030
4138
  */
4031
- rebConversionConvertToGaebWithRequestObject(rebFile: FileParameter, options: {
4139
+ rebConversionConvertToGaebWithRequestObject(rebFile: FileParameter, options?: {
4032
4140
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
4033
4141
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
4034
4142
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -4046,7 +4154,7 @@ export declare class RebConversionApi {
4046
4154
  * @summary Converts REB files to GAEB files
4047
4155
  * @param rebFile The input file
4048
4156
  * @param destinationGaebType Defaults to GAEB XML V3.2
4049
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
4157
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
4050
4158
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
4051
4159
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
4052
4160
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -4061,7 +4169,7 @@ export declare class RebConversionApi {
4061
4169
  /**
4062
4170
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4063
4171
  */
4064
- rebConversionConvertToOenormWithRequestObject(rebFile: FileParameter, options: {
4172
+ rebConversionConvertToOenormWithRequestObject(rebFile: FileParameter, options?: {
4065
4173
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
4066
4174
  tryRepairProjectStructure?: boolean;
4067
4175
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -4106,7 +4214,7 @@ export declare class SiaConversionApi {
4106
4214
  /**
4107
4215
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4108
4216
  */
4109
- siaConversionConvertToAvaWithRequestObject(siaFile: FileParameter, options: {
4217
+ siaConversionConvertToAvaWithRequestObject(siaFile: FileParameter, options?: {
4110
4218
  removePlainTextLongTexts?: boolean;
4111
4219
  removeHtmlLongTexts?: boolean;
4112
4220
  options?: any;
@@ -4129,10 +4237,11 @@ export declare class SiaConversionApi {
4129
4237
  /**
4130
4238
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4131
4239
  */
4132
- siaConversionConvertToExcelWithRequestObject(siaFile: FileParameter, options: {
4240
+ siaConversionConvertToExcelWithRequestObject(siaFile: FileParameter, options?: {
4133
4241
  writePrices?: boolean;
4134
4242
  writeLongTexts?: boolean;
4135
4243
  conversionCulture?: string;
4244
+ includeArticleNumbers?: boolean;
4136
4245
  options?: any;
4137
4246
  }): Promise<{
4138
4247
  response: http.IncomingMessage;
@@ -4145,16 +4254,17 @@ export declare class SiaConversionApi {
4145
4254
  * @param writePrices Defaults to true
4146
4255
  * @param writeLongTexts Defaults to true
4147
4256
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
4257
+ * @param includeArticleNumbers If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from &#39;position.commerceProperties.articleNumber&#39;
4148
4258
  * @param {*} [options] Override http request options.
4149
4259
  */
4150
- siaConversionConvertToExcel(siaFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
4260
+ siaConversionConvertToExcel(siaFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
4151
4261
  response: http.IncomingMessage;
4152
4262
  body: Buffer;
4153
4263
  }>;
4154
4264
  /**
4155
4265
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4156
4266
  */
4157
- siaConversionConvertToGaebWithRequestObject(siaFile: FileParameter, options: {
4267
+ siaConversionConvertToGaebWithRequestObject(siaFile: FileParameter, options?: {
4158
4268
  destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce';
4159
4269
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
4160
4270
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -4172,7 +4282,7 @@ export declare class SiaConversionApi {
4172
4282
  * @summary Converts SIA 451 files to GAEB files
4173
4283
  * @param siaFile The input file
4174
4284
  * @param destinationGaebType Defaults to GAEB XML V3.2
4175
- * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done
4285
+ * @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base &#x3D; 81 CostEstimate &#x3D; 82 OfferRequest &#x3D; 83 Offer &#x3D; 84 SideOffer &#x3D; 85 Grant &#x3D; 86
4176
4286
  * @param enforceStrictOfferPhaseLongTextOutput Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
4177
4287
  * @param exportQuantityDetermination Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the &#39;QtyDeterm&#39; (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the &#39;QuantityComponents&#39; property of positions. Please see the entry for &#39;Quantity Determination&#39; in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the &#39;QuantityComponents&#39; property.
4178
4288
  * @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
@@ -4187,7 +4297,7 @@ export declare class SiaConversionApi {
4187
4297
  /**
4188
4298
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4189
4299
  */
4190
- siaConversionConvertToOenormWithRequestObject(siaFile: FileParameter, options: {
4300
+ siaConversionConvertToOenormWithRequestObject(siaFile: FileParameter, options?: {
4191
4301
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
4192
4302
  tryRepairProjectStructure?: boolean;
4193
4303
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -4259,7 +4369,7 @@ export declare class UglConversionApi {
4259
4369
  /**
4260
4370
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4261
4371
  */
4262
- uglConversionConvertToAvaWithRequestObject(uglFile: FileParameter, options: {
4372
+ uglConversionConvertToAvaWithRequestObject(uglFile: FileParameter, options?: {
4263
4373
  removePlainTextLongTexts?: boolean;
4264
4374
  removeHtmlLongTexts?: boolean;
4265
4375
  options?: any;
@@ -4300,7 +4410,7 @@ export declare class ValidationApi {
4300
4410
  /**
4301
4411
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4302
4412
  */
4303
- validationValidateFileWithRequestObject(avaFile: FileParameter, options: {
4413
+ validationValidateFileWithRequestObject(avaFile: FileParameter, options?: {
4304
4414
  fileValidationSourceType?: 'Gaeb' | 'Oenorm';
4305
4415
  options?: any;
4306
4416
  }): Promise<{