@dangl/avacloud-client-node 1.25.0 → 1.26.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.
Files changed (5) hide show
  1. package/api.d.ts +138 -48
  2. package/api.js +167 -50
  3. package/api.js.map +1 -1
  4. package/api.ts +259 -86
  5. package/package.json +1 -1
package/api.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * AVACloud API 1.42.0
2
+ * AVACloud API 1.44.0
3
3
  * AVACloud API specification
4
4
  *
5
- * OpenAPI spec version: 1.42.0
5
+ * OpenAPI spec version: 1.44.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;
@@ -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,10 @@ 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;
1492
1505
  static discriminator: string | undefined;
1493
1506
  static attributeTypeMap: Array<{
1494
1507
  name: string;
@@ -1694,6 +1707,50 @@ export declare class PostOenormDestinationOptions {
1694
1707
  }[];
1695
1708
  }
1696
1709
  /**
1710
+ * Price catalogue data represents assumed or estimated prices from a catalogue source
1711
+ */
1712
+ export declare class PriceCatalogueDataDto {
1713
+ /**
1714
+ * Elements GUID identifier.
1715
+ */
1716
+ 'id': string;
1717
+ /**
1718
+ * The lower bound of the unit price
1719
+ */
1720
+ 'unitPriceFrom'?: number;
1721
+ /**
1722
+ * The upper bound of the unit price
1723
+ */
1724
+ 'unitPriceTo'?: number;
1725
+ /**
1726
+ * The average unit price
1727
+ */
1728
+ 'unitPriceAverage'?: number;
1729
+ /**
1730
+ * The lower bound of the wage price
1731
+ */
1732
+ 'wagePriceFrom'?: number;
1733
+ /**
1734
+ * The upper bound of the wage price
1735
+ */
1736
+ 'wagePriceTo'?: number;
1737
+ /**
1738
+ * The average wage price
1739
+ */
1740
+ 'wagePriceAverage'?: number;
1741
+ static discriminator: string | undefined;
1742
+ static attributeTypeMap: Array<{
1743
+ name: string;
1744
+ baseName: string;
1745
+ type: string;
1746
+ }>;
1747
+ static getAttributeTypeMap(): {
1748
+ name: string;
1749
+ baseName: string;
1750
+ type: string;
1751
+ }[];
1752
+ }
1753
+ /**
1697
1754
  * 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
1755
  */
1699
1756
  export declare class PriceComponentDto {
@@ -2044,6 +2101,7 @@ export declare class RegisterPost {
2044
2101
  'email': string;
2045
2102
  'password': string;
2046
2103
  'preferredLanguages'?: Array<string>;
2104
+ 'serviceLoginRedirectUri'?: string;
2047
2105
  static discriminator: string | undefined;
2048
2106
  static attributeTypeMap: Array<{
2049
2107
  name: string;
@@ -2567,6 +2625,22 @@ export declare class ServiceTypeDto {
2567
2625
  }[];
2568
2626
  }
2569
2627
  /**
2628
+ * Represents valid SIA destination types
2629
+ */
2630
+ export declare class SiaDestinationType {
2631
+ static discriminator: string | undefined;
2632
+ static attributeTypeMap: Array<{
2633
+ name: string;
2634
+ baseName: string;
2635
+ type: string;
2636
+ }>;
2637
+ static getAttributeTypeMap(): {
2638
+ name: string;
2639
+ baseName: string;
2640
+ type: string;
2641
+ }[];
2642
+ }
2643
+ /**
2570
2644
  * 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
2645
  */
2572
2646
  export declare class SpecialAwardKindDto {
@@ -3017,7 +3091,7 @@ export declare class AslvConversionApi {
3017
3091
  /**
3018
3092
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3019
3093
  */
3020
- aslvConversionConvertToAvaWithRequestObject(aslvFile: FileParameter, options: {
3094
+ aslvConversionConvertToAvaWithRequestObject(aslvFile: FileParameter, options?: {
3021
3095
  removePlainTextLongTexts?: boolean;
3022
3096
  removeHtmlLongTexts?: boolean;
3023
3097
  options?: any;
@@ -3040,10 +3114,11 @@ export declare class AslvConversionApi {
3040
3114
  /**
3041
3115
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3042
3116
  */
3043
- aslvConversionConvertToExcelWithRequestObject(aslvFile: FileParameter, options: {
3117
+ aslvConversionConvertToExcelWithRequestObject(aslvFile: FileParameter, options?: {
3044
3118
  writePrices?: boolean;
3045
3119
  writeLongTexts?: boolean;
3046
3120
  conversionCulture?: string;
3121
+ includeArticleNumbers?: boolean;
3047
3122
  options?: any;
3048
3123
  }): Promise<{
3049
3124
  response: http.IncomingMessage;
@@ -3056,16 +3131,17 @@ export declare class AslvConversionApi {
3056
3131
  * @param writePrices Defaults to true
3057
3132
  * @param writeLongTexts Defaults to true
3058
3133
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3134
+ * @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
3135
  * @param {*} [options] Override http request options.
3060
3136
  */
3061
- aslvConversionConvertToExcel(aslvFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3137
+ aslvConversionConvertToExcel(aslvFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3062
3138
  response: http.IncomingMessage;
3063
3139
  body: Buffer;
3064
3140
  }>;
3065
3141
  /**
3066
3142
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3067
3143
  */
3068
- aslvConversionConvertToGaebWithRequestObject(aslvFile: FileParameter, options: {
3144
+ aslvConversionConvertToGaebWithRequestObject(aslvFile: FileParameter, options?: {
3069
3145
  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
3146
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
3071
3147
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -3098,7 +3174,7 @@ export declare class AslvConversionApi {
3098
3174
  /**
3099
3175
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3100
3176
  */
3101
- aslvConversionConvertToOenormWithRequestObject(aslvFile: FileParameter, options: {
3177
+ aslvConversionConvertToOenormWithRequestObject(aslvFile: FileParameter, options?: {
3102
3178
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3103
3179
  tryRepairProjectStructure?: boolean;
3104
3180
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -3143,7 +3219,7 @@ export declare class AvaConversionApi {
3143
3219
  /**
3144
3220
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3145
3221
  */
3146
- avaConversionConvertToAvaWithRequestObject(avaProject: ProjectDto, options: {
3222
+ avaConversionConvertToAvaWithRequestObject(avaProject: ProjectDto, options?: {
3147
3223
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3148
3224
  removePlainTextLongTexts?: boolean;
3149
3225
  removeHtmlLongTexts?: boolean;
@@ -3168,7 +3244,7 @@ export declare class AvaConversionApi {
3168
3244
  /**
3169
3245
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3170
3246
  */
3171
- avaConversionConvertToDatanormWithRequestObject(avaProject: ProjectDto, options: {
3247
+ avaConversionConvertToDatanormWithRequestObject(avaProject: ProjectDto, options?: {
3172
3248
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3173
3249
  datanormDestinationVersion?: 'V4' | 'V5';
3174
3250
  options?: any;
@@ -3191,11 +3267,12 @@ export declare class AvaConversionApi {
3191
3267
  /**
3192
3268
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3193
3269
  */
3194
- avaConversionConvertToExcelWithRequestObject(avaProject: ProjectDto, options: {
3270
+ avaConversionConvertToExcelWithRequestObject(avaProject: ProjectDto, options?: {
3195
3271
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3196
3272
  writePrices?: boolean;
3197
3273
  writeLongTexts?: boolean;
3198
3274
  conversionCulture?: string;
3275
+ includeArticleNumbers?: boolean;
3199
3276
  options?: any;
3200
3277
  }): Promise<{
3201
3278
  response: http.IncomingMessage;
@@ -3209,16 +3286,17 @@ export declare class AvaConversionApi {
3209
3286
  * @param writePrices Defaults to true
3210
3287
  * @param writeLongTexts Defaults to true
3211
3288
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3289
+ * @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
3290
  * @param {*} [options] Override http request options.
3213
3291
  */
3214
- avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3292
+ avaConversionConvertToExcel(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3215
3293
  response: http.IncomingMessage;
3216
3294
  body: Buffer;
3217
3295
  }>;
3218
3296
  /**
3219
3297
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3220
3298
  */
3221
- avaConversionConvertToGaebWithRequestObject(avaProject: ProjectDto, options: {
3299
+ avaConversionConvertToGaebWithRequestObject(avaProject: ProjectDto, options?: {
3222
3300
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3223
3301
  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
3302
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
@@ -3253,7 +3331,7 @@ export declare class AvaConversionApi {
3253
3331
  /**
3254
3332
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3255
3333
  */
3256
- avaConversionConvertToIdsConnectWithRequestObject(avaProject: ProjectDto, options: {
3334
+ avaConversionConvertToIdsConnectWithRequestObject(avaProject: ProjectDto, options?: {
3257
3335
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3258
3336
  version?: 'V2_5';
3259
3337
  options?: any;
@@ -3276,7 +3354,7 @@ export declare class AvaConversionApi {
3276
3354
  /**
3277
3355
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3278
3356
  */
3279
- avaConversionConvertToOenormWithRequestObject(avaProject: ProjectDto, options: {
3357
+ avaConversionConvertToOenormWithRequestObject(avaProject: ProjectDto, options?: {
3280
3358
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3281
3359
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3282
3360
  tryRepairProjectStructure?: boolean;
@@ -3305,7 +3383,7 @@ export declare class AvaConversionApi {
3305
3383
  /**
3306
3384
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3307
3385
  */
3308
- avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options: {
3386
+ avaConversionConvertToRebWithRequestObject(avaProject: ProjectDto, options?: {
3309
3387
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3310
3388
  destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33';
3311
3389
  options?: any;
@@ -3328,8 +3406,9 @@ export declare class AvaConversionApi {
3328
3406
  /**
3329
3407
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3330
3408
  */
3331
- avaConversionConvertToSiaWithRequestObject(avaProject: ProjectDto, options: {
3409
+ avaConversionConvertToSiaWithRequestObject(avaProject: ProjectDto, options?: {
3332
3410
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3411
+ siaDestinationType?: 'Sia451' | 'Ifa18';
3333
3412
  options?: any;
3334
3413
  }): Promise<{
3335
3414
  response: http.IncomingMessage;
@@ -3340,16 +3419,17 @@ export declare class AvaConversionApi {
3340
3419
  * @summary Converts Dangl.AVA projects to SIA 451
3341
3420
  * @param avaProject The Dangl.AVA project
3342
3421
  * @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.
3422
+ * @param siaDestinationType Defaults to Sia451
3343
3423
  * @param {*} [options] Override http request options.
3344
3424
  */
3345
- avaConversionConvertToSia(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
3425
+ avaConversionConvertToSia(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, siaDestinationType?: 'Sia451' | 'Ifa18', options?: any): Promise<{
3346
3426
  response: http.IncomingMessage;
3347
3427
  body: Buffer;
3348
3428
  }>;
3349
3429
  /**
3350
3430
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3351
3431
  */
3352
- avaConversionConvertToUglWithRequestObject(avaProject: ProjectDto, options: {
3432
+ avaConversionConvertToUglWithRequestObject(avaProject: ProjectDto, options?: {
3353
3433
  tryAutoGenerateItemNumbersAndSchema?: boolean;
3354
3434
  uglDestinationVersion?: 'V4' | 'V5';
3355
3435
  options?: any;
@@ -3399,7 +3479,7 @@ export declare class DanglIdentityApi {
3399
3479
  /**
3400
3480
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3401
3481
  */
3402
- danglIdentityLoginWithCookieWithRequestObject(model: LoginPost, options: {
3482
+ danglIdentityLoginWithCookieWithRequestObject(model: LoginPost, options?: {
3403
3483
  redirectUrl?: string;
3404
3484
  options?: any;
3405
3485
  }): Promise<{
@@ -3472,7 +3552,7 @@ export declare class DatanormConversionApi {
3472
3552
  /**
3473
3553
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3474
3554
  */
3475
- datanormConversionConvertToAvaWithRequestObject(datanormFile: FileParameter, options: {
3555
+ datanormConversionConvertToAvaWithRequestObject(datanormFile: FileParameter, options?: {
3476
3556
  removePlainTextLongTexts?: boolean;
3477
3557
  removeHtmlLongTexts?: boolean;
3478
3558
  options?: any;
@@ -3513,7 +3593,7 @@ export declare class ExcelConversionApi {
3513
3593
  /**
3514
3594
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3515
3595
  */
3516
- excelConversionConvertToAvaWithRequestObject(excelFile: FileParameter, options: {
3596
+ excelConversionConvertToAvaWithRequestObject(excelFile: FileParameter, options?: {
3517
3597
  readNewElements?: boolean;
3518
3598
  rebuildItemNumberSchema?: boolean;
3519
3599
  removePlainTextLongTexts?: boolean;
@@ -3540,12 +3620,13 @@ export declare class ExcelConversionApi {
3540
3620
  /**
3541
3621
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3542
3622
  */
3543
- excelConversionConvertToExcelWithRequestObject(excelFile: FileParameter, options: {
3623
+ excelConversionConvertToExcelWithRequestObject(excelFile: FileParameter, options?: {
3544
3624
  readNewElements?: boolean;
3545
3625
  rebuildItemNumberSchema?: boolean;
3546
3626
  writePrices?: boolean;
3547
3627
  writeLongTexts?: boolean;
3548
3628
  conversionCulture?: string;
3629
+ includeArticleNumbers?: boolean;
3549
3630
  options?: any;
3550
3631
  }): Promise<{
3551
3632
  response: http.IncomingMessage;
@@ -3560,16 +3641,17 @@ export declare class ExcelConversionApi {
3560
3641
  * @param writePrices Defaults to true
3561
3642
  * @param writeLongTexts Defaults to true
3562
3643
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3644
+ * @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
3645
  * @param {*} [options] Override http request options.
3564
3646
  */
3565
- excelConversionConvertToExcel(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3647
+ excelConversionConvertToExcel(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3566
3648
  response: http.IncomingMessage;
3567
3649
  body: Buffer;
3568
3650
  }>;
3569
3651
  /**
3570
3652
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3571
3653
  */
3572
- excelConversionConvertToGaebWithRequestObject(excelFile: FileParameter, options: {
3654
+ excelConversionConvertToGaebWithRequestObject(excelFile: FileParameter, options?: {
3573
3655
  readNewElements?: boolean;
3574
3656
  rebuildItemNumberSchema?: boolean;
3575
3657
  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';
@@ -3606,7 +3688,7 @@ export declare class ExcelConversionApi {
3606
3688
  /**
3607
3689
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3608
3690
  */
3609
- excelConversionConvertToOenormWithRequestObject(excelFile: FileParameter, options: {
3691
+ excelConversionConvertToOenormWithRequestObject(excelFile: FileParameter, options?: {
3610
3692
  readNewElements?: boolean;
3611
3693
  rebuildItemNumberSchema?: boolean;
3612
3694
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
@@ -3655,7 +3737,7 @@ export declare class GaebConversionApi {
3655
3737
  /**
3656
3738
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3657
3739
  */
3658
- gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options: {
3740
+ gaebConversionConvertToAvaWithRequestObject(gaebFile: FileParameter, options?: {
3659
3741
  supportSkippedItemNumberLevelsInPositions?: boolean;
3660
3742
  removePlainTextLongTexts?: boolean;
3661
3743
  removeHtmlLongTexts?: boolean;
@@ -3686,11 +3768,12 @@ export declare class GaebConversionApi {
3686
3768
  /**
3687
3769
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3688
3770
  */
3689
- gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options: {
3771
+ gaebConversionConvertToExcelWithRequestObject(gaebFile: FileParameter, options?: {
3690
3772
  supportSkippedItemNumberLevelsInPositions?: boolean;
3691
3773
  writePrices?: boolean;
3692
3774
  writeLongTexts?: boolean;
3693
3775
  conversionCulture?: string;
3776
+ includeArticleNumbers?: boolean;
3694
3777
  outputHtmlAsXml?: boolean;
3695
3778
  keepEmptyHtmlText?: boolean;
3696
3779
  allowUpperCaseItemNumbers?: boolean;
@@ -3707,19 +3790,20 @@ export declare class GaebConversionApi {
3707
3790
  * @param writePrices Defaults to true
3708
3791
  * @param writeLongTexts Defaults to true
3709
3792
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3793
+ * @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
3794
  * @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
3795
  * @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
3796
  * @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.
3713
3797
  * @param {*} [options] Override http request options.
3714
3798
  */
3715
- gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
3799
+ gaebConversionConvertToExcel(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, options?: any): Promise<{
3716
3800
  response: http.IncomingMessage;
3717
3801
  body: Buffer;
3718
3802
  }>;
3719
3803
  /**
3720
3804
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3721
3805
  */
3722
- gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options: {
3806
+ gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options?: {
3723
3807
  supportSkippedItemNumberLevelsInPositions?: boolean;
3724
3808
  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
3809
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
@@ -3760,7 +3844,7 @@ export declare class GaebConversionApi {
3760
3844
  /**
3761
3845
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3762
3846
  */
3763
- gaebConversionConvertToOenormWithRequestObject(gaebFile: FileParameter, options: {
3847
+ gaebConversionConvertToOenormWithRequestObject(gaebFile: FileParameter, options?: {
3764
3848
  supportSkippedItemNumberLevelsInPositions?: boolean;
3765
3849
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3766
3850
  tryRepairProjectStructure?: boolean;
@@ -3813,7 +3897,7 @@ export declare class IdsConnectConversionApi {
3813
3897
  /**
3814
3898
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3815
3899
  */
3816
- idsConnectConversionConvertToAvaWithRequestObject(idsConnectFile: FileParameter, options: {
3900
+ idsConnectConversionConvertToAvaWithRequestObject(idsConnectFile: FileParameter, options?: {
3817
3901
  removePlainTextLongTexts?: boolean;
3818
3902
  removeHtmlLongTexts?: boolean;
3819
3903
  options?: any;
@@ -3854,7 +3938,7 @@ export declare class OenormConversionApi {
3854
3938
  /**
3855
3939
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3856
3940
  */
3857
- oenormConversionConvertToAvaWithRequestObject(oenormFile: FileParameter, options: {
3941
+ oenormConversionConvertToAvaWithRequestObject(oenormFile: FileParameter, options?: {
3858
3942
  removePlainTextLongTexts?: boolean;
3859
3943
  removeHtmlLongTexts?: boolean;
3860
3944
  options?: any;
@@ -3877,10 +3961,11 @@ export declare class OenormConversionApi {
3877
3961
  /**
3878
3962
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3879
3963
  */
3880
- oenormConversionConvertToExcelWithRequestObject(oenormFile: FileParameter, options: {
3964
+ oenormConversionConvertToExcelWithRequestObject(oenormFile: FileParameter, options?: {
3881
3965
  writePrices?: boolean;
3882
3966
  writeLongTexts?: boolean;
3883
3967
  conversionCulture?: string;
3968
+ includeArticleNumbers?: boolean;
3884
3969
  options?: any;
3885
3970
  }): Promise<{
3886
3971
  response: http.IncomingMessage;
@@ -3893,16 +3978,17 @@ export declare class OenormConversionApi {
3893
3978
  * @param writePrices Defaults to true
3894
3979
  * @param writeLongTexts Defaults to true
3895
3980
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
3981
+ * @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
3982
  * @param {*} [options] Override http request options.
3897
3983
  */
3898
- oenormConversionConvertToExcel(oenormFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
3984
+ oenormConversionConvertToExcel(oenormFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
3899
3985
  response: http.IncomingMessage;
3900
3986
  body: Buffer;
3901
3987
  }>;
3902
3988
  /**
3903
3989
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3904
3990
  */
3905
- oenormConversionConvertToGaebWithRequestObject(oenormFile: FileParameter, options: {
3991
+ oenormConversionConvertToGaebWithRequestObject(oenormFile: FileParameter, options?: {
3906
3992
  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
3993
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
3908
3994
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -3935,7 +4021,7 @@ export declare class OenormConversionApi {
3935
4021
  /**
3936
4022
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3937
4023
  */
3938
- oenormConversionConvertToOenormWithRequestObject(oenormFile: FileParameter, options: {
4024
+ oenormConversionConvertToOenormWithRequestObject(oenormFile: FileParameter, options?: {
3939
4025
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
3940
4026
  tryRepairProjectStructure?: boolean;
3941
4027
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -3980,7 +4066,7 @@ export declare class RebConversionApi {
3980
4066
  /**
3981
4067
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
3982
4068
  */
3983
- rebConversionConvertToAvaWithRequestObject(rebFile: FileParameter, options: {
4069
+ rebConversionConvertToAvaWithRequestObject(rebFile: FileParameter, options?: {
3984
4070
  removePlainTextLongTexts?: boolean;
3985
4071
  removeHtmlLongTexts?: boolean;
3986
4072
  options?: any;
@@ -4003,10 +4089,11 @@ export declare class RebConversionApi {
4003
4089
  /**
4004
4090
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4005
4091
  */
4006
- rebConversionConvertToExcelWithRequestObject(rebFile: FileParameter, options: {
4092
+ rebConversionConvertToExcelWithRequestObject(rebFile: FileParameter, options?: {
4007
4093
  writePrices?: boolean;
4008
4094
  writeLongTexts?: boolean;
4009
4095
  conversionCulture?: string;
4096
+ includeArticleNumbers?: boolean;
4010
4097
  options?: any;
4011
4098
  }): Promise<{
4012
4099
  response: http.IncomingMessage;
@@ -4019,16 +4106,17 @@ export declare class RebConversionApi {
4019
4106
  * @param writePrices Defaults to true
4020
4107
  * @param writeLongTexts Defaults to true
4021
4108
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
4109
+ * @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
4110
  * @param {*} [options] Override http request options.
4023
4111
  */
4024
- rebConversionConvertToExcel(rebFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
4112
+ rebConversionConvertToExcel(rebFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
4025
4113
  response: http.IncomingMessage;
4026
4114
  body: Buffer;
4027
4115
  }>;
4028
4116
  /**
4029
4117
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4030
4118
  */
4031
- rebConversionConvertToGaebWithRequestObject(rebFile: FileParameter, options: {
4119
+ rebConversionConvertToGaebWithRequestObject(rebFile: FileParameter, options?: {
4032
4120
  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
4121
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
4034
4122
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -4061,7 +4149,7 @@ export declare class RebConversionApi {
4061
4149
  /**
4062
4150
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4063
4151
  */
4064
- rebConversionConvertToOenormWithRequestObject(rebFile: FileParameter, options: {
4152
+ rebConversionConvertToOenormWithRequestObject(rebFile: FileParameter, options?: {
4065
4153
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
4066
4154
  tryRepairProjectStructure?: boolean;
4067
4155
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -4106,7 +4194,7 @@ export declare class SiaConversionApi {
4106
4194
  /**
4107
4195
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4108
4196
  */
4109
- siaConversionConvertToAvaWithRequestObject(siaFile: FileParameter, options: {
4197
+ siaConversionConvertToAvaWithRequestObject(siaFile: FileParameter, options?: {
4110
4198
  removePlainTextLongTexts?: boolean;
4111
4199
  removeHtmlLongTexts?: boolean;
4112
4200
  options?: any;
@@ -4129,10 +4217,11 @@ export declare class SiaConversionApi {
4129
4217
  /**
4130
4218
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4131
4219
  */
4132
- siaConversionConvertToExcelWithRequestObject(siaFile: FileParameter, options: {
4220
+ siaConversionConvertToExcelWithRequestObject(siaFile: FileParameter, options?: {
4133
4221
  writePrices?: boolean;
4134
4222
  writeLongTexts?: boolean;
4135
4223
  conversionCulture?: string;
4224
+ includeArticleNumbers?: boolean;
4136
4225
  options?: any;
4137
4226
  }): Promise<{
4138
4227
  response: http.IncomingMessage;
@@ -4145,16 +4234,17 @@ export declare class SiaConversionApi {
4145
4234
  * @param writePrices Defaults to true
4146
4235
  * @param writeLongTexts Defaults to true
4147
4236
  * @param conversionCulture The culture that should be used for the conversion process, to have localized Excel files
4237
+ * @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
4238
  * @param {*} [options] Override http request options.
4149
4239
  */
4150
- siaConversionConvertToExcel(siaFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, options?: any): Promise<{
4240
+ siaConversionConvertToExcel(siaFile: FileParameter, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
4151
4241
  response: http.IncomingMessage;
4152
4242
  body: Buffer;
4153
4243
  }>;
4154
4244
  /**
4155
4245
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4156
4246
  */
4157
- siaConversionConvertToGaebWithRequestObject(siaFile: FileParameter, options: {
4247
+ siaConversionConvertToGaebWithRequestObject(siaFile: FileParameter, options?: {
4158
4248
  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
4249
  targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
4160
4250
  enforceStrictOfferPhaseLongTextOutput?: boolean;
@@ -4187,7 +4277,7 @@ export declare class SiaConversionApi {
4187
4277
  /**
4188
4278
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4189
4279
  */
4190
- siaConversionConvertToOenormWithRequestObject(siaFile: FileParameter, options: {
4280
+ siaConversionConvertToOenormWithRequestObject(siaFile: FileParameter, options?: {
4191
4281
  destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
4192
4282
  tryRepairProjectStructure?: boolean;
4193
4283
  skipTryEnforceSchemaCompliantXmlOutput?: boolean;
@@ -4259,7 +4349,7 @@ export declare class UglConversionApi {
4259
4349
  /**
4260
4350
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4261
4351
  */
4262
- uglConversionConvertToAvaWithRequestObject(uglFile: FileParameter, options: {
4352
+ uglConversionConvertToAvaWithRequestObject(uglFile: FileParameter, options?: {
4263
4353
  removePlainTextLongTexts?: boolean;
4264
4354
  removeHtmlLongTexts?: boolean;
4265
4355
  options?: any;
@@ -4300,7 +4390,7 @@ export declare class ValidationApi {
4300
4390
  /**
4301
4391
  * This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
4302
4392
  */
4303
- validationValidateFileWithRequestObject(avaFile: FileParameter, options: {
4393
+ validationValidateFileWithRequestObject(avaFile: FileParameter, options?: {
4304
4394
  fileValidationSourceType?: 'Gaeb' | 'Oenorm';
4305
4395
  options?: any;
4306
4396
  }): Promise<{