@dangl/avacloud-client-node 1.17.0 → 1.18.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 +393 -25
  2. package/api.js +525 -30
  3. package/api.js.map +1 -1
  4. package/api.ts +711 -45
  5. package/package.json +1 -1
package/api.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * AVACloud API 1.29.0
2
+ * AVACloud API 1.30.0
3
3
  * AVACloud API specification
4
4
  *
5
- * OpenAPI spec version: 1.29.0
5
+ * OpenAPI spec version: 1.30.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by the swagger code generator program.
@@ -791,6 +791,8 @@ export class IElementDto {
791
791
  * This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
792
792
  */
793
793
  'addendumNumber'?: string;
794
+ 'projectCatalogues'?: Array<CatalogueDto>;
795
+ 'catalogueReferences'?: Array<CatalogueReferenceDto>;
794
796
  'elementTypeDiscriminator': string;
795
797
 
796
798
  static discriminator: string | undefined = "elementTypeDiscriminator";
@@ -811,6 +813,16 @@ export class IElementDto {
811
813
  "baseName": "addendumNumber",
812
814
  "type": "string"
813
815
  },
816
+ {
817
+ "name": "projectCatalogues",
818
+ "baseName": "projectCatalogues",
819
+ "type": "Array<CatalogueDto>"
820
+ },
821
+ {
822
+ "name": "catalogueReferences",
823
+ "baseName": "catalogueReferences",
824
+ "type": "Array<CatalogueReferenceDto>"
825
+ },
814
826
  {
815
827
  "name": "elementTypeDiscriminator",
816
828
  "baseName": "elementTypeDiscriminator",
@@ -866,6 +878,21 @@ export class ExecutionDescriptionDto extends IElementDto {
866
878
  }
867
879
  }
868
880
 
881
+ /**
882
+ * This enum represents the source type for a file based validation operation
883
+ */
884
+ export class FileValidationSourceType {
885
+
886
+ static discriminator: string | undefined = undefined;
887
+
888
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
889
+ ];
890
+
891
+ static getAttributeTypeMap() {
892
+ return FileValidationSourceType.attributeTypeMap;
893
+ }
894
+ }
895
+
869
896
  export class ForgotPasswordPost {
870
897
  'identifier': string;
871
898
  'preferredLanguages'?: Array<string>;
@@ -1520,6 +1547,29 @@ export class NoteTextDto extends IElementDto {
1520
1547
  }
1521
1548
  }
1522
1549
 
1550
+ /**
1551
+ * Basic information about Object check validation details, commonly used when checking GAEB 2000 files
1552
+ */
1553
+ export class ObjectValidationCheckDetails {
1554
+ /**
1555
+ * The path under which the element with error was found.
1556
+ */
1557
+ 'elementPath'?: string;
1558
+
1559
+ static discriminator: string | undefined = undefined;
1560
+
1561
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
1562
+ {
1563
+ "name": "elementPath",
1564
+ "baseName": "elementPath",
1565
+ "type": "string"
1566
+ } ];
1567
+
1568
+ static getAttributeTypeMap() {
1569
+ return ObjectValidationCheckDetails.attributeTypeMap;
1570
+ }
1571
+ }
1572
+
1523
1573
  /**
1524
1574
  * This class models special properties that only apply to some exchange scenarios where ÖNorm is used. It is special for NoteTexts.
1525
1575
  */
@@ -1990,14 +2040,6 @@ export class PositionDto extends IElementDto {
1990
2040
  * This identifier can be used to point to the Id of a position in the same ServiceSpecification that acts as a base position. It matches \"Bezugsposition\" in GAEB. This can be used for positions that repeat partially or are linked together
1991
2041
  */
1992
2042
  'repetitionTo'?: string;
1993
- /**
1994
- * These are Catalogues that are used within this Position. Catalogues are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves. They are propagate to all child elements, e.g. other containers and QuantityAssignments. In the context of a ServiceSpecification, all elements share the same instance of the collection.
1995
- */
1996
- 'projectCatalogues'?: Array<CatalogueDto>;
1997
- /**
1998
- * Referenced catalogues for this Position.
1999
- */
2000
- 'catalogueReferences'?: Array<CatalogueReferenceDto>;
2001
2043
  'type'?: string;
2002
2044
  /**
2003
2045
  * This represents a standardized description. This means that instead of solely relying on texts to describe a service, external standards and definitions are referenced for a common understanding.
@@ -2226,16 +2268,6 @@ export class PositionDto extends IElementDto {
2226
2268
  "baseName": "repetitionTo",
2227
2269
  "type": "string"
2228
2270
  },
2229
- {
2230
- "name": "projectCatalogues",
2231
- "baseName": "projectCatalogues",
2232
- "type": "Array<CatalogueDto>"
2233
- },
2234
- {
2235
- "name": "catalogueReferences",
2236
- "baseName": "catalogueReferences",
2237
- "type": "Array<CatalogueReferenceDto>"
2238
- },
2239
2271
  {
2240
2272
  "name": "type",
2241
2273
  "baseName": "type",
@@ -2307,6 +2339,224 @@ export class PositionTypeDto {
2307
2339
  }
2308
2340
  }
2309
2341
 
2342
+ /**
2343
+ * Options for validating an AVA project
2344
+ */
2345
+ export class PostAvaProjectValidationSourceOptions {
2346
+ /**
2347
+ * The project that should be validated
2348
+ */
2349
+ 'avaProject': ProjectDto;
2350
+ /**
2351
+ * The index of the ServiceSpecification that should be validated. If not given, will default to the first one in the project.
2352
+ */
2353
+ 'serviceSpecificationIndex'?: number;
2354
+ /**
2355
+ * This can optionally be specified to simulate a conversion to a specific target.
2356
+ */
2357
+ 'validationType': ValidationType;
2358
+ /**
2359
+ * This can optionally be supplied to test for a specific exchange phase. For example, missing prices will only trigger errors in some specific exchange phases. Please note: If a conversion to a specific format, e.g. GAEB or ÖNorm, is given, this parameter is not applied to the internal conversion. The converter options must be set in the appropriate properties as well.
2360
+ */
2361
+ 'exchangePhase'?: ExchangePhaseDto;
2362
+ /**
2363
+ * Options for importing the AVA project
2364
+ */
2365
+ 'avaSourceOptions'?: PostAvaSourceOptions;
2366
+ /**
2367
+ * Options for conversion to Oenorm. Should be given if ValidationType is set to Oenorm.
2368
+ */
2369
+ 'oenormDestinationOptions'?: PostOenormDestinationOptions;
2370
+ /**
2371
+ * Options for conversion to GAEB. Should be given if ValidationType is set to GAEB.
2372
+ */
2373
+ 'gaebDestinationOptions'?: PostGaebDestinationOptions;
2374
+
2375
+ static discriminator: string | undefined = undefined;
2376
+
2377
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
2378
+ {
2379
+ "name": "avaProject",
2380
+ "baseName": "avaProject",
2381
+ "type": "ProjectDto"
2382
+ },
2383
+ {
2384
+ "name": "serviceSpecificationIndex",
2385
+ "baseName": "serviceSpecificationIndex",
2386
+ "type": "number"
2387
+ },
2388
+ {
2389
+ "name": "validationType",
2390
+ "baseName": "validationType",
2391
+ "type": "ValidationType"
2392
+ },
2393
+ {
2394
+ "name": "exchangePhase",
2395
+ "baseName": "exchangePhase",
2396
+ "type": "ExchangePhaseDto"
2397
+ },
2398
+ {
2399
+ "name": "avaSourceOptions",
2400
+ "baseName": "avaSourceOptions",
2401
+ "type": "PostAvaSourceOptions"
2402
+ },
2403
+ {
2404
+ "name": "oenormDestinationOptions",
2405
+ "baseName": "oenormDestinationOptions",
2406
+ "type": "PostOenormDestinationOptions"
2407
+ },
2408
+ {
2409
+ "name": "gaebDestinationOptions",
2410
+ "baseName": "gaebDestinationOptions",
2411
+ "type": "PostGaebDestinationOptions"
2412
+ } ];
2413
+
2414
+ static getAttributeTypeMap() {
2415
+ return PostAvaProjectValidationSourceOptions.attributeTypeMap;
2416
+ }
2417
+ }
2418
+
2419
+ /**
2420
+ * Options for conversions from AVA
2421
+ */
2422
+ export class PostAvaSourceOptions {
2423
+ /**
2424
+ * 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.
2425
+ */
2426
+ 'tryAutoGenerateItemNumbersAndSchema': boolean;
2427
+
2428
+ static discriminator: string | undefined = undefined;
2429
+
2430
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
2431
+ {
2432
+ "name": "tryAutoGenerateItemNumbersAndSchema",
2433
+ "baseName": "tryAutoGenerateItemNumbersAndSchema",
2434
+ "type": "boolean"
2435
+ } ];
2436
+
2437
+ static getAttributeTypeMap() {
2438
+ return PostAvaSourceOptions.attributeTypeMap;
2439
+ }
2440
+ }
2441
+
2442
+ /**
2443
+ * Options for conversions to GAEB
2444
+ */
2445
+ export class PostGaebDestinationOptions {
2446
+ /**
2447
+ * Defaults to GAEB XML V3.2
2448
+ */
2449
+ 'destinationGaebType': DestinationGaebType;
2450
+ /**
2451
+ * Defaults to none, meaning no transformation will be done
2452
+ */
2453
+ 'targetExchangePhaseTransform': DestinationGaebExchangePhase;
2454
+ /**
2455
+ * 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.
2456
+ */
2457
+ 'enforceStrictOfferPhaseLongTextOutput': boolean;
2458
+ /**
2459
+ * Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
2460
+ */
2461
+ 'exportQuantityDetermination': boolean;
2462
+ /**
2463
+ * 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.
2464
+ */
2465
+ 'removeUnprintableCharactersFromTexts': boolean;
2466
+ /**
2467
+ * If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
2468
+ */
2469
+ 'forceIncludeDescriptions': boolean;
2470
+
2471
+ static discriminator: string | undefined = undefined;
2472
+
2473
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
2474
+ {
2475
+ "name": "destinationGaebType",
2476
+ "baseName": "destinationGaebType",
2477
+ "type": "DestinationGaebType"
2478
+ },
2479
+ {
2480
+ "name": "targetExchangePhaseTransform",
2481
+ "baseName": "targetExchangePhaseTransform",
2482
+ "type": "DestinationGaebExchangePhase"
2483
+ },
2484
+ {
2485
+ "name": "enforceStrictOfferPhaseLongTextOutput",
2486
+ "baseName": "enforceStrictOfferPhaseLongTextOutput",
2487
+ "type": "boolean"
2488
+ },
2489
+ {
2490
+ "name": "exportQuantityDetermination",
2491
+ "baseName": "exportQuantityDetermination",
2492
+ "type": "boolean"
2493
+ },
2494
+ {
2495
+ "name": "removeUnprintableCharactersFromTexts",
2496
+ "baseName": "removeUnprintableCharactersFromTexts",
2497
+ "type": "boolean"
2498
+ },
2499
+ {
2500
+ "name": "forceIncludeDescriptions",
2501
+ "baseName": "forceIncludeDescriptions",
2502
+ "type": "boolean"
2503
+ } ];
2504
+
2505
+ static getAttributeTypeMap() {
2506
+ return PostGaebDestinationOptions.attributeTypeMap;
2507
+ }
2508
+ }
2509
+
2510
+ /**
2511
+ * Options for conversions to Oenorm
2512
+ */
2513
+ export class PostOenormDestinationOptions {
2514
+ /**
2515
+ * Defaults to Lv2015
2516
+ */
2517
+ 'destinationOenormType': DestinationOenormType;
2518
+ /**
2519
+ * Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
2520
+ */
2521
+ 'tryRepairProjectStructure': boolean;
2522
+ /**
2523
+ * If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
2524
+ */
2525
+ 'skipTryEnforceSchemaCompliantXmlOutput': boolean;
2526
+ /**
2527
+ * 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.
2528
+ */
2529
+ 'removeUnprintableCharactersFromTexts': boolean;
2530
+
2531
+ static discriminator: string | undefined = undefined;
2532
+
2533
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
2534
+ {
2535
+ "name": "destinationOenormType",
2536
+ "baseName": "destinationOenormType",
2537
+ "type": "DestinationOenormType"
2538
+ },
2539
+ {
2540
+ "name": "tryRepairProjectStructure",
2541
+ "baseName": "tryRepairProjectStructure",
2542
+ "type": "boolean"
2543
+ },
2544
+ {
2545
+ "name": "skipTryEnforceSchemaCompliantXmlOutput",
2546
+ "baseName": "skipTryEnforceSchemaCompliantXmlOutput",
2547
+ "type": "boolean"
2548
+ },
2549
+ {
2550
+ "name": "removeUnprintableCharactersFromTexts",
2551
+ "baseName": "removeUnprintableCharactersFromTexts",
2552
+ "type": "boolean"
2553
+ } ];
2554
+
2555
+ static getAttributeTypeMap() {
2556
+ return PostOenormDestinationOptions.attributeTypeMap;
2557
+ }
2558
+ }
2559
+
2310
2560
  /**
2311
2561
  * 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.
2312
2562
  */
@@ -2764,6 +3014,29 @@ export class ProjectInformationDto {
2764
3014
  }
2765
3015
  }
2766
3016
 
3017
+ /**
3018
+ * Check details specificly for checking ProjectDto objects
3019
+ */
3020
+ export class ProjectValidationCheckDetails {
3021
+ /**
3022
+ * The id of the element
3023
+ */
3024
+ 'elementId': string;
3025
+
3026
+ static discriminator: string | undefined = undefined;
3027
+
3028
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
3029
+ {
3030
+ "name": "elementId",
3031
+ "baseName": "elementId",
3032
+ "type": "string"
3033
+ } ];
3034
+
3035
+ static getAttributeTypeMap() {
3036
+ return ProjectValidationCheckDetails.attributeTypeMap;
3037
+ }
3038
+ }
3039
+
2767
3040
  /**
2768
3041
  * Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position. For example, it could be categorized by cost group - e.g. a Position describing concrete walls could follow the German DIN 276 Cost Groups Standard and specify that of the total 1.000m² wall, 500m² are classified as exterior walls and 500m² are classified as interior walls. They would then have different cost groups associated, e.g. for accounting purposes.
2769
3042
  */
@@ -3501,14 +3774,6 @@ export class ServiceSpecificationGroupDto extends IElementDto {
3501
3774
  'alternativeTo'?: string;
3502
3775
  'type'?: string;
3503
3776
  /**
3504
- * These are Catalogue that are used within this ElementContainerBase. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves.
3505
- */
3506
- 'projectCatalogues'?: Array<CatalogueDto>;
3507
- /**
3508
- * Referenced catalogues for this ElementContainerBase.
3509
- */
3510
- 'catalogueReferences'?: Array<CatalogueReferenceDto>;
3511
- /**
3512
3777
  * This class models special properties that only apply to some exchange scenarios where ÖNorm is used.
3513
3778
  */
3514
3779
  'oenormProperties'?: OenormPropertiesDto;
@@ -3654,16 +3919,6 @@ export class ServiceSpecificationGroupDto extends IElementDto {
3654
3919
  "baseName": "type",
3655
3920
  "type": "string"
3656
3921
  },
3657
- {
3658
- "name": "projectCatalogues",
3659
- "baseName": "projectCatalogues",
3660
- "type": "Array<CatalogueDto>"
3661
- },
3662
- {
3663
- "name": "catalogueReferences",
3664
- "baseName": "catalogueReferences",
3665
- "type": "Array<CatalogueReferenceDto>"
3666
- },
3667
3922
  {
3668
3923
  "name": "oenormProperties",
3669
3924
  "baseName": "oenormProperties",
@@ -4066,6 +4321,169 @@ export class TradeDiscountDto {
4066
4321
  }
4067
4322
  }
4068
4323
 
4324
+ /**
4325
+ * This class models the results of a single check performed during a validation action
4326
+ */
4327
+ export class ValidationCheckResult {
4328
+ /**
4329
+ * The severity for this check. Usually, low severity checks do not impact data exchange with third party applications
4330
+ */
4331
+ 'severity': ValidationSeverity;
4332
+ /**
4333
+ * The actual check that is represented by this result. Additional information may be found in other properties of this class, depending on the check.
4334
+ */
4335
+ 'checkType': ValidationCheckType;
4336
+ /**
4337
+ * A human readable message describing the result of the check.
4338
+ */
4339
+ 'message'?: string;
4340
+ /**
4341
+ * For CheckType of types ObjectValidation
4342
+ */
4343
+ 'objectValidationCheckDetails'?: ObjectValidationCheckDetails;
4344
+ /**
4345
+ * For CheckType of types XmlSchemaCheck
4346
+ */
4347
+ 'xmlSchemaValidationCheckDetails'?: XmlSchemaValidationCheckDetails;
4348
+ /**
4349
+ * For CheckType of types ProjectValidation
4350
+ */
4351
+ 'projectValidationCheckDetails'?: ProjectValidationCheckDetails;
4352
+
4353
+ static discriminator: string | undefined = undefined;
4354
+
4355
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4356
+ {
4357
+ "name": "severity",
4358
+ "baseName": "severity",
4359
+ "type": "ValidationSeverity"
4360
+ },
4361
+ {
4362
+ "name": "checkType",
4363
+ "baseName": "checkType",
4364
+ "type": "ValidationCheckType"
4365
+ },
4366
+ {
4367
+ "name": "message",
4368
+ "baseName": "message",
4369
+ "type": "string"
4370
+ },
4371
+ {
4372
+ "name": "objectValidationCheckDetails",
4373
+ "baseName": "objectValidationCheckDetails",
4374
+ "type": "ObjectValidationCheckDetails"
4375
+ },
4376
+ {
4377
+ "name": "xmlSchemaValidationCheckDetails",
4378
+ "baseName": "xmlSchemaValidationCheckDetails",
4379
+ "type": "XmlSchemaValidationCheckDetails"
4380
+ },
4381
+ {
4382
+ "name": "projectValidationCheckDetails",
4383
+ "baseName": "projectValidationCheckDetails",
4384
+ "type": "ProjectValidationCheckDetails"
4385
+ } ];
4386
+
4387
+ static getAttributeTypeMap() {
4388
+ return ValidationCheckResult.attributeTypeMap;
4389
+ }
4390
+ }
4391
+
4392
+ /**
4393
+ * Enumeration for the different types of checks performed
4394
+ */
4395
+ export class ValidationCheckType {
4396
+
4397
+ static discriminator: string | undefined = undefined;
4398
+
4399
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4400
+ ];
4401
+
4402
+ static getAttributeTypeMap() {
4403
+ return ValidationCheckType.attributeTypeMap;
4404
+ }
4405
+ }
4406
+
4407
+ /**
4408
+ * This class represents the result of a validation operation
4409
+ */
4410
+ export class ValidationResult {
4411
+ /**
4412
+ * Indicates if the validation produced no errors
4413
+ */
4414
+ 'isSchemaCompliant': boolean;
4415
+ /**
4416
+ * List of validation check results, which are usually errors
4417
+ */
4418
+ 'checkResults'?: Array<ValidationCheckResult>;
4419
+ /**
4420
+ * The type of the validation that was performed
4421
+ */
4422
+ 'validationType': ValidationType;
4423
+ /**
4424
+ * Name of the validated file
4425
+ */
4426
+ 'fileName'?: string;
4427
+
4428
+ static discriminator: string | undefined = undefined;
4429
+
4430
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4431
+ {
4432
+ "name": "isSchemaCompliant",
4433
+ "baseName": "isSchemaCompliant",
4434
+ "type": "boolean"
4435
+ },
4436
+ {
4437
+ "name": "checkResults",
4438
+ "baseName": "checkResults",
4439
+ "type": "Array<ValidationCheckResult>"
4440
+ },
4441
+ {
4442
+ "name": "validationType",
4443
+ "baseName": "validationType",
4444
+ "type": "ValidationType"
4445
+ },
4446
+ {
4447
+ "name": "fileName",
4448
+ "baseName": "fileName",
4449
+ "type": "string"
4450
+ } ];
4451
+
4452
+ static getAttributeTypeMap() {
4453
+ return ValidationResult.attributeTypeMap;
4454
+ }
4455
+ }
4456
+
4457
+ /**
4458
+ * Indicates the severity of a check
4459
+ */
4460
+ export class ValidationSeverity {
4461
+
4462
+ static discriminator: string | undefined = undefined;
4463
+
4464
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4465
+ ];
4466
+
4467
+ static getAttributeTypeMap() {
4468
+ return ValidationSeverity.attributeTypeMap;
4469
+ }
4470
+ }
4471
+
4472
+ /**
4473
+ * This enumeration represents the possible conversion targets when performing a validation
4474
+ */
4475
+ export class ValidationType {
4476
+
4477
+ static discriminator: string | undefined = undefined;
4478
+
4479
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4480
+ ];
4481
+
4482
+ static getAttributeTypeMap() {
4483
+ return ValidationType.attributeTypeMap;
4484
+ }
4485
+ }
4486
+
4069
4487
  /**
4070
4488
  * This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months
4071
4489
  */
@@ -4098,6 +4516,38 @@ export class WarrantyDurationDto {
4098
4516
  }
4099
4517
  }
4100
4518
 
4519
+ /**
4520
+ * Check details for an XML schema validation result
4521
+ */
4522
+ export class XmlSchemaValidationCheckDetails {
4523
+ /**
4524
+ * The line number on which the validation happened
4525
+ */
4526
+ 'lineNumber': number;
4527
+ /**
4528
+ * The position in the line
4529
+ */
4530
+ 'linePosition': number;
4531
+
4532
+ static discriminator: string | undefined = undefined;
4533
+
4534
+ static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
4535
+ {
4536
+ "name": "lineNumber",
4537
+ "baseName": "lineNumber",
4538
+ "type": "number"
4539
+ },
4540
+ {
4541
+ "name": "linePosition",
4542
+ "baseName": "linePosition",
4543
+ "type": "number"
4544
+ } ];
4545
+
4546
+ static getAttributeTypeMap() {
4547
+ return XmlSchemaValidationCheckDetails.attributeTypeMap;
4548
+ }
4549
+ }
4550
+
4101
4551
 
4102
4552
  let enumsMap: {[index: string]: any} = {
4103
4553
  }
@@ -4123,6 +4573,7 @@ let typeMap: {[index: string]: any} = {
4123
4573
  "DurationUnitDto": DurationUnitDto,
4124
4574
  "ExchangePhaseDto": ExchangePhaseDto,
4125
4575
  "ExecutionDescriptionDto": ExecutionDescriptionDto,
4576
+ "FileValidationSourceType": FileValidationSourceType,
4126
4577
  "ForgotPasswordPost": ForgotPasswordPost,
4127
4578
  "GetStatus": GetStatus,
4128
4579
  "GrossPriceComponentDto": GrossPriceComponentDto,
@@ -4136,6 +4587,7 @@ let typeMap: {[index: string]: any} = {
4136
4587
  "LabourPriceComponentDto": LabourPriceComponentDto,
4137
4588
  "LoginPost": LoginPost,
4138
4589
  "NoteTextDto": NoteTextDto,
4590
+ "ObjectValidationCheckDetails": ObjectValidationCheckDetails,
4139
4591
  "OenormNoteTextPropertiesDto": OenormNoteTextPropertiesDto,
4140
4592
  "OenormOriginCodeDto": OenormOriginCodeDto,
4141
4593
  "OenormPositionPropertiesDto": OenormPositionPropertiesDto,
@@ -4144,6 +4596,10 @@ let typeMap: {[index: string]: any} = {
4144
4596
  "PartyInformationDto": PartyInformationDto,
4145
4597
  "PositionDto": PositionDto,
4146
4598
  "PositionTypeDto": PositionTypeDto,
4599
+ "PostAvaProjectValidationSourceOptions": PostAvaProjectValidationSourceOptions,
4600
+ "PostAvaSourceOptions": PostAvaSourceOptions,
4601
+ "PostGaebDestinationOptions": PostGaebDestinationOptions,
4602
+ "PostOenormDestinationOptions": PostOenormDestinationOptions,
4147
4603
  "PriceComponentDto": PriceComponentDto,
4148
4604
  "PriceComponentTypeDto": PriceComponentTypeDto,
4149
4605
  "PriceInformationDto": PriceInformationDto,
@@ -4152,6 +4608,7 @@ let typeMap: {[index: string]: any} = {
4152
4608
  "ProductDataDto": ProductDataDto,
4153
4609
  "ProjectDto": ProjectDto,
4154
4610
  "ProjectInformationDto": ProjectInformationDto,
4611
+ "ProjectValidationCheckDetails": ProjectValidationCheckDetails,
4155
4612
  "QuantityAssignmentDto": QuantityAssignmentDto,
4156
4613
  "RegisterPost": RegisterPost,
4157
4614
  "ResponseErrorType": ResponseErrorType,
@@ -4168,7 +4625,13 @@ let typeMap: {[index: string]: any} = {
4168
4625
  "TokenRefreshPost": TokenRefreshPost,
4169
4626
  "TokenResponseGet": TokenResponseGet,
4170
4627
  "TradeDiscountDto": TradeDiscountDto,
4628
+ "ValidationCheckResult": ValidationCheckResult,
4629
+ "ValidationCheckType": ValidationCheckType,
4630
+ "ValidationResult": ValidationResult,
4631
+ "ValidationSeverity": ValidationSeverity,
4632
+ "ValidationType": ValidationType,
4171
4633
  "WarrantyDurationDto": WarrantyDurationDto,
4634
+ "XmlSchemaValidationCheckDetails": XmlSchemaValidationCheckDetails,
4172
4635
  }
4173
4636
 
4174
4637
  export interface Authentication {
@@ -4418,9 +4881,10 @@ export class AslvConversionApi {
4418
4881
  * @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.
4419
4882
  * @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.
4420
4883
  * @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.
4884
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
4421
4885
  * @param {*} [options] Override http request options.
4422
4886
  */
4423
- public aslvConversionConvertToGaeb (aslvFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
4887
+ public aslvConversionConvertToGaeb (aslvFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
4424
4888
  const localVarPath = this.basePath + '/conversion/aslv/gaeb';
4425
4889
  let localVarQueryParameters: any = {};
4426
4890
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -4446,6 +4910,10 @@ export class AslvConversionApi {
4446
4910
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
4447
4911
  }
4448
4912
 
4913
+ if (forceIncludeDescriptions !== undefined) {
4914
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
4915
+ }
4916
+
4449
4917
  (<any>Object).assign(localVarHeaderParams, options.headers);
4450
4918
 
4451
4919
  let localVarUseFormData = false;
@@ -4776,9 +5244,10 @@ export class AvaConversionApi {
4776
5244
  * @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.
4777
5245
  * @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.
4778
5246
  * @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.
5247
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
4779
5248
  * @param {*} [options] Override http request options.
4780
5249
  */
4781
- public avaConversionConvertToGaeb (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
5250
+ public avaConversionConvertToGaeb (avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
4782
5251
  const localVarPath = this.basePath + '/conversion/ava/gaeb';
4783
5252
  let localVarQueryParameters: any = {};
4784
5253
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -4813,6 +5282,10 @@ export class AvaConversionApi {
4813
5282
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
4814
5283
  }
4815
5284
 
5285
+ if (forceIncludeDescriptions !== undefined) {
5286
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
5287
+ }
5288
+
4816
5289
  (<any>Object).assign(localVarHeaderParams, options.headers);
4817
5290
 
4818
5291
  let localVarUseFormData = false;
@@ -5666,9 +6139,10 @@ export class ExcelConversionApi {
5666
6139
  * @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.
5667
6140
  * @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.
5668
6141
  * @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.
6142
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
5669
6143
  * @param {*} [options] Override http request options.
5670
6144
  */
5671
- public excelConversionConvertToGaeb (excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6145
+ public excelConversionConvertToGaeb (excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
5672
6146
  const localVarPath = this.basePath + '/conversion/excel/gaeb';
5673
6147
  let localVarQueryParameters: any = {};
5674
6148
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -5702,6 +6176,10 @@ export class ExcelConversionApi {
5702
6176
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
5703
6177
  }
5704
6178
 
6179
+ if (forceIncludeDescriptions !== undefined) {
6180
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
6181
+ }
6182
+
5705
6183
  (<any>Object).assign(localVarHeaderParams, options.headers);
5706
6184
 
5707
6185
  let localVarUseFormData = false;
@@ -6039,9 +6517,10 @@ export class GaebConversionApi {
6039
6517
  * @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.
6040
6518
  * @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.
6041
6519
  * @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.
6520
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
6042
6521
  * @param {*} [options] Override http request options.
6043
6522
  */
6044
- public gaebConversionConvertToGaeb (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6523
+ public gaebConversionConvertToGaeb (gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6045
6524
  const localVarPath = this.basePath + '/conversion/gaeb/gaeb';
6046
6525
  let localVarQueryParameters: any = {};
6047
6526
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -6071,6 +6550,10 @@ export class GaebConversionApi {
6071
6550
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
6072
6551
  }
6073
6552
 
6553
+ if (forceIncludeDescriptions !== undefined) {
6554
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
6555
+ }
6556
+
6074
6557
  (<any>Object).assign(localVarHeaderParams, options.headers);
6075
6558
 
6076
6559
  let localVarUseFormData = false;
@@ -6392,9 +6875,10 @@ export class OenormConversionApi {
6392
6875
  * @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.
6393
6876
  * @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.
6394
6877
  * @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.
6878
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
6395
6879
  * @param {*} [options] Override http request options.
6396
6880
  */
6397
- public oenormConversionConvertToGaeb (oenormFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6881
+ public oenormConversionConvertToGaeb (oenormFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6398
6882
  const localVarPath = this.basePath + '/conversion/oenorm/gaeb';
6399
6883
  let localVarQueryParameters: any = {};
6400
6884
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -6420,6 +6904,10 @@ export class OenormConversionApi {
6420
6904
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
6421
6905
  }
6422
6906
 
6907
+ if (forceIncludeDescriptions !== undefined) {
6908
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
6909
+ }
6910
+
6423
6911
  (<any>Object).assign(localVarHeaderParams, options.headers);
6424
6912
 
6425
6913
  let localVarUseFormData = false;
@@ -6736,9 +7224,10 @@ export class RebConversionApi {
6736
7224
  * @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.
6737
7225
  * @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.
6738
7226
  * @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.
7227
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
6739
7228
  * @param {*} [options] Override http request options.
6740
7229
  */
6741
- public rebConversionConvertToGaeb (rebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
7230
+ public rebConversionConvertToGaeb (rebFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
6742
7231
  const localVarPath = this.basePath + '/conversion/reb/gaeb';
6743
7232
  let localVarQueryParameters: any = {};
6744
7233
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -6764,6 +7253,10 @@ export class RebConversionApi {
6764
7253
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
6765
7254
  }
6766
7255
 
7256
+ if (forceIncludeDescriptions !== undefined) {
7257
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
7258
+ }
7259
+
6767
7260
  (<any>Object).assign(localVarHeaderParams, options.headers);
6768
7261
 
6769
7262
  let localVarUseFormData = false;
@@ -7080,9 +7573,10 @@ export class SiaConversionApi {
7080
7573
  * @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.
7081
7574
  * @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.
7082
7575
  * @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.
7576
+ * @param forceIncludeDescriptions If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
7083
7577
  * @param {*} [options] Override http request options.
7084
7578
  */
7085
- public siaConversionConvertToGaeb (siaFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
7579
+ public siaConversionConvertToGaeb (siaFile: FileParameter, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, options: any = {}) : Promise<{ response: http.IncomingMessage; body: Buffer; }> {
7086
7580
  const localVarPath = this.basePath + '/conversion/sia/gaeb';
7087
7581
  let localVarQueryParameters: any = {};
7088
7582
  let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
@@ -7108,6 +7602,10 @@ export class SiaConversionApi {
7108
7602
  localVarQueryParameters['RemoveUnprintableCharactersFromTexts'] = ObjectSerializer.serialize(removeUnprintableCharactersFromTexts, "boolean");
7109
7603
  }
7110
7604
 
7605
+ if (forceIncludeDescriptions !== undefined) {
7606
+ localVarQueryParameters['ForceIncludeDescriptions'] = ObjectSerializer.serialize(forceIncludeDescriptions, "boolean");
7607
+ }
7608
+
7111
7609
  (<any>Object).assign(localVarHeaderParams, options.headers);
7112
7610
 
7113
7611
  let localVarUseFormData = false;
@@ -7329,6 +7827,174 @@ export class StatusApi {
7329
7827
  });
7330
7828
  }
7331
7829
  }
7830
+ export enum ValidationApiApiKeys {
7831
+ }
7832
+
7833
+ export class ValidationApi {
7834
+ protected _basePath = defaultBasePath;
7835
+ protected defaultHeaders : any = {};
7836
+ protected _useQuerystring : boolean = false;
7837
+
7838
+ protected authentications = {
7839
+ 'default': <Authentication>new VoidAuth(),
7840
+ 'Dangl.Identity': new OAuth(),
7841
+ }
7842
+
7843
+ constructor(basePath?: string);
7844
+ constructor(basePathOrUsername: string, password?: string, basePath?: string) {
7845
+ if (password) {
7846
+ if (basePath) {
7847
+ this.basePath = basePath;
7848
+ }
7849
+ } else {
7850
+ if (basePathOrUsername) {
7851
+ this.basePath = basePathOrUsername
7852
+ }
7853
+ }
7854
+ }
7855
+
7856
+ set useQuerystring(value: boolean) {
7857
+ this._useQuerystring = value;
7858
+ }
7859
+
7860
+ set basePath(basePath: string) {
7861
+ this._basePath = basePath;
7862
+ }
7863
+
7864
+ get basePath() {
7865
+ return this._basePath;
7866
+ }
7867
+
7868
+ public setDefaultAuthentication(auth: Authentication) {
7869
+ this.authentications.default = auth;
7870
+ }
7871
+
7872
+ public setApiKey(key: ValidationApiApiKeys, value: string) {
7873
+ (this.authentications as any)[ValidationApiApiKeys[key]].apiKey = value;
7874
+ }
7875
+
7876
+ set accessToken(token: string) {
7877
+ this.authentications['Dangl.Identity'].accessToken = token;
7878
+ }
7879
+ /**
7880
+ *
7881
+ * @summary This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided as a query parameter, since there is no auto detection of the uploaded file type.
7882
+ * @param avaFile The file to validate
7883
+ * @param fileValidationSourceType You need to indicate which type of file is being provided, there is no auto detection mechanism
7884
+ * @param {*} [options] Override http request options.
7885
+ */
7886
+ public validationValidateFile (avaFile: FileParameter, fileValidationSourceType?: 'Gaeb' | 'Oenorm', options: any = {}) : Promise<{ response: http.IncomingMessage; body: ValidationResult; }> {
7887
+ const localVarPath = this.basePath + '/validation/file';
7888
+ let localVarQueryParameters: any = {};
7889
+ let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
7890
+ let localVarFormParams: any = {};
7891
+
7892
+ if (fileValidationSourceType !== undefined) {
7893
+ localVarQueryParameters['fileValidationSourceType'] = ObjectSerializer.serialize(fileValidationSourceType, "'Gaeb' | 'Oenorm'");
7894
+ }
7895
+
7896
+ (<any>Object).assign(localVarHeaderParams, options.headers);
7897
+
7898
+ let localVarUseFormData = false;
7899
+
7900
+ if (avaFile !== undefined) {
7901
+ localVarFormParams['avaFile'] = avaFile;
7902
+ }
7903
+ localVarUseFormData = true;
7904
+
7905
+ let localVarRequestOptions: localVarRequest.Options = {
7906
+ method: 'POST',
7907
+ qs: localVarQueryParameters,
7908
+ headers: localVarHeaderParams,
7909
+ uri: localVarPath,
7910
+ useQuerystring: this._useQuerystring,
7911
+ json: true,
7912
+ };
7913
+
7914
+ this.authentications['Dangl.Identity'].applyToRequest(localVarRequestOptions);
7915
+
7916
+ this.authentications.default.applyToRequest(localVarRequestOptions);
7917
+
7918
+ if (Object.keys(localVarFormParams).length) {
7919
+ if (localVarUseFormData) {
7920
+ (<any>localVarRequestOptions).formData = localVarFormParams;
7921
+ } else {
7922
+ localVarRequestOptions.form = localVarFormParams;
7923
+ }
7924
+ }
7925
+ return new Promise<{ response: http.IncomingMessage; body: ValidationResult; }>((resolve, reject) => {
7926
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
7927
+ if (error) {
7928
+ reject(error);
7929
+ } else {
7930
+ body = ObjectSerializer.deserialize(body, "ValidationResult");
7931
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
7932
+ resolve({ response: response, body: body });
7933
+ } else {
7934
+ reject({ response: response, body: body });
7935
+ }
7936
+ }
7937
+ });
7938
+ });
7939
+ }
7940
+ /**
7941
+ *
7942
+ * @summary This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase into account and do some general project validation. Optionally, a conversion to a desired target can also be done, in which case the target file will also be validated.
7943
+ * @param avaProjectValidationSourceOptions The options used for the validation operation
7944
+ * @param {*} [options] Override http request options.
7945
+ */
7946
+ public validationValidateProject (avaProjectValidationSourceOptions: PostAvaProjectValidationSourceOptions, options: any = {}) : Promise<{ response: http.IncomingMessage; body: ValidationResult; }> {
7947
+ const localVarPath = this.basePath + '/validation/project';
7948
+ let localVarQueryParameters: any = {};
7949
+ let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
7950
+ let localVarFormParams: any = {};
7951
+
7952
+ // verify required parameter 'avaProjectValidationSourceOptions' is not null or undefined
7953
+ if (avaProjectValidationSourceOptions === null || avaProjectValidationSourceOptions === undefined) {
7954
+ throw new Error('Required parameter avaProjectValidationSourceOptions was null or undefined when calling validationValidateProject.');
7955
+ }
7956
+
7957
+ (<any>Object).assign(localVarHeaderParams, options.headers);
7958
+
7959
+ let localVarUseFormData = false;
7960
+
7961
+ let localVarRequestOptions: localVarRequest.Options = {
7962
+ method: 'POST',
7963
+ qs: localVarQueryParameters,
7964
+ headers: localVarHeaderParams,
7965
+ uri: localVarPath,
7966
+ useQuerystring: this._useQuerystring,
7967
+ json: true,
7968
+ body: ObjectSerializer.serialize(avaProjectValidationSourceOptions, "PostAvaProjectValidationSourceOptions")
7969
+ };
7970
+
7971
+ this.authentications['Dangl.Identity'].applyToRequest(localVarRequestOptions);
7972
+
7973
+ this.authentications.default.applyToRequest(localVarRequestOptions);
7974
+
7975
+ if (Object.keys(localVarFormParams).length) {
7976
+ if (localVarUseFormData) {
7977
+ (<any>localVarRequestOptions).formData = localVarFormParams;
7978
+ } else {
7979
+ localVarRequestOptions.form = localVarFormParams;
7980
+ }
7981
+ }
7982
+ return new Promise<{ response: http.IncomingMessage; body: ValidationResult; }>((resolve, reject) => {
7983
+ localVarRequest(localVarRequestOptions, (error, response, body) => {
7984
+ if (error) {
7985
+ reject(error);
7986
+ } else {
7987
+ body = ObjectSerializer.deserialize(body, "ValidationResult");
7988
+ if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
7989
+ resolve({ response: response, body: body });
7990
+ } else {
7991
+ reject({ response: response, body: body });
7992
+ }
7993
+ }
7994
+ });
7995
+ });
7996
+ }
7997
+ }
7332
7998
 
7333
7999
 
7334
8000
  export interface FileParameter {