@dangl/avacloud-client-node 1.60.0-beta0009-avacloud-preview → 1.60.1-avacloud-preview

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 (4) hide show
  1. package/api.d.ts +60 -12
  2. package/api.js.map +1 -1
  3. package/api.ts +60 -12
  4. package/package.json +1 -1
package/api.d.ts CHANGED
@@ -2447,9 +2447,17 @@ export declare class PositionDto extends IElementDto implements IPositionDto {
2447
2447
  serviceType: ServiceTypeDto;
2448
2448
  /** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
2449
2449
  productData?: ProductDataDto | undefined;
2450
- /** Short description for this DescriptionBase element. */
2450
+ /** Short description for this DescriptionBase element.
2451
+ Please note that by default, this property takes precedence over the `HtmlShortText`
2452
+ property. If you want to convert from DTO objects, and you want to work with the
2453
+ `HtmlShortText` property, you need to set this property to null.
2454
+ */
2451
2455
  shortText?: string | undefined;
2452
- /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. */
2456
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
2457
+ This property is used to store the short text in HTML format. If you want to convert
2458
+ from DTO objects, and you want to use this property, then you need to ensure that
2459
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
2460
+ */
2453
2461
  htmlShortText?: string | undefined;
2454
2462
  /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2455
2463
  longText?: string | undefined;
@@ -2566,9 +2574,17 @@ export interface IPositionDto extends IIElementDto {
2566
2574
  serviceType: ServiceTypeDto;
2567
2575
  /** This property describes additional information about a product being used within this Position. For example, a pipe position, per length unit, could be composed of different pipe segments, fitting and other accessory articles. */
2568
2576
  productData?: IProductDataDto | undefined;
2569
- /** Short description for this DescriptionBase element. */
2577
+ /** Short description for this DescriptionBase element.
2578
+ Please note that by default, this property takes precedence over the `HtmlShortText`
2579
+ property. If you want to convert from DTO objects, and you want to work with the
2580
+ `HtmlShortText` property, you need to set this property to null.
2581
+ */
2570
2582
  shortText?: string | undefined;
2571
- /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. */
2583
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
2584
+ This property is used to store the short text in HTML format. If you want to convert
2585
+ from DTO objects, and you want to use this property, then you need to ensure that
2586
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
2587
+ */
2572
2588
  htmlShortText?: string | undefined;
2573
2589
  /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2574
2590
  longText?: string | undefined;
@@ -2735,9 +2751,17 @@ export declare class SubDescriptionDto implements ISubDescriptionDto {
2735
2751
  amountToBeEnteredByBidder: boolean;
2736
2752
  /** Identifier for this SubDescription. */
2737
2753
  identifier?: string | undefined;
2738
- /** Short description for this DescriptionBase element. */
2754
+ /** Short description for this DescriptionBase element.
2755
+ Please note that by default, this property takes precedence over the `HtmlShortText`
2756
+ property. If you want to convert from DTO objects, and you want to work with the
2757
+ `HtmlShortText` property, you need to set this property to null.
2758
+ */
2739
2759
  shortText?: string | undefined;
2740
- /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. */
2760
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
2761
+ This property is used to store the short text in HTML format. If you want to convert
2762
+ from DTO objects, and you want to use this property, then you need to ensure that
2763
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
2764
+ */
2741
2765
  htmlShortText?: string | undefined;
2742
2766
  /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2743
2767
  longText?: string | undefined;
@@ -2777,9 +2801,17 @@ export interface ISubDescriptionDto {
2777
2801
  amountToBeEnteredByBidder: boolean;
2778
2802
  /** Identifier for this SubDescription. */
2779
2803
  identifier?: string | undefined;
2780
- /** Short description for this DescriptionBase element. */
2804
+ /** Short description for this DescriptionBase element.
2805
+ Please note that by default, this property takes precedence over the `HtmlShortText`
2806
+ property. If you want to convert from DTO objects, and you want to work with the
2807
+ `HtmlShortText` property, you need to set this property to null.
2808
+ */
2781
2809
  shortText?: string | undefined;
2782
- /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. */
2810
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
2811
+ This property is used to store the short text in HTML format. If you want to convert
2812
+ from DTO objects, and you want to use this property, then you need to ensure that
2813
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
2814
+ */
2783
2815
  htmlShortText?: string | undefined;
2784
2816
  /** Detailed description for this DescriptionBase element. When the HtmlLongText is set, this is automatically overwritten and filled with the appropriate plain text representation of the Html text. Vice versa, setting this property overrides the HtmlLongText. */
2785
2817
  longText?: string | undefined;
@@ -3296,9 +3328,17 @@ export declare class NoteTextDto extends IElementDto implements INoteTextDto {
3296
3328
  isOpeningText: boolean;
3297
3329
  /** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
3298
3330
  isClosingText: boolean;
3299
- /** Short description for this DescriptionBase element. */
3331
+ /** Short description for this DescriptionBase element.
3332
+ Please note that by default, this property takes precedence over the `HtmlShortText`
3333
+ property. If you want to convert from DTO objects, and you want to work with the
3334
+ `HtmlShortText` property, you need to set this property to null.
3335
+ */
3300
3336
  shortText?: string | undefined;
3301
- /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. */
3337
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
3338
+ This property is used to store the short text in HTML format. If you want to convert
3339
+ from DTO objects, and you want to use this property, then you need to ensure that
3340
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
3341
+ */
3302
3342
  htmlShortText?: string | undefined;
3303
3343
  /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
3304
3344
  additionType: AdditionTypeDto;
@@ -3327,9 +3367,17 @@ export interface INoteTextDto extends IIElementDto {
3327
3367
  isOpeningText: boolean;
3328
3368
  /** If this is set to true, this text is meant to not be seen as part of the regular elements hierarchy but as a special closing text at the end of the project. For Example, in GAEB XML, this would map to the GAEB.AddText. Typically, such texts are used to describe project wide finishing descriptions. If this is set to true, this NoteText should be placed at the top of the elements hierarchy directly in the ServiceSpecification.Elements group, otherwise it will likely not be treated correctly when exporting to GAEB. You can only set IsOpeningText or IsClosingText to true. */
3329
3369
  isClosingText: boolean;
3330
- /** Short description for this DescriptionBase element. */
3370
+ /** Short description for this DescriptionBase element.
3371
+ Please note that by default, this property takes precedence over the `HtmlShortText`
3372
+ property. If you want to convert from DTO objects, and you want to work with the
3373
+ `HtmlShortText` property, you need to set this property to null.
3374
+ */
3331
3375
  shortText?: string | undefined;
3332
- /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts. */
3376
+ /** This contains the Html representation of the Shorttext. When the ShortText is set, this property will be set to contain the plain text representation of the Html text and vice versa. In practice, it's recommended to always use the plain text representations for short texts.
3377
+ This property is used to store the short text in HTML format. If you want to convert
3378
+ from DTO objects, and you want to use this property, then you need to ensure that
3379
+ `ShortText` is set to null, otherwise the plain text takes precedence over the HTML text.
3380
+ */
3333
3381
  htmlShortText?: string | undefined;
3334
3382
  /** Indicates if this DescriptionBase element contains Buyer or Bidder additions to the text. */
3335
3383
  additionType: AdditionTypeDto;