@dangl/avacloud-client-node 1.45.0-beta0010-avacloud-preview → 1.46.0-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.
- package/.swagger-codegen/VERSION +1 -1
- package/api.d.ts +515 -2
- package/api.js +1584 -75
- package/api.js.map +1 -1
- package/api.ts +1796 -117
- package/package.json +1 -1
package/.swagger-codegen/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
2.4.
|
|
1
|
+
2.4.37
|
package/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* AVACloud API 1.
|
|
2
|
+
* AVACloud API 1.46.0
|
|
3
3
|
* AVACloud API specification
|
|
4
4
|
*
|
|
5
|
-
* OpenAPI spec version: 1.
|
|
5
|
+
* OpenAPI spec version: 1.46.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by the swagger code generator program.
|
|
@@ -311,6 +311,22 @@ export declare class CatalogueTypeDto {
|
|
|
311
311
|
type: string;
|
|
312
312
|
}[];
|
|
313
313
|
}
|
|
314
|
+
export declare class ClaimGet {
|
|
315
|
+
'issuer'?: string;
|
|
316
|
+
'type'?: string;
|
|
317
|
+
'value'?: string;
|
|
318
|
+
static discriminator: string | undefined;
|
|
319
|
+
static attributeTypeMap: Array<{
|
|
320
|
+
name: string;
|
|
321
|
+
baseName: string;
|
|
322
|
+
type: string;
|
|
323
|
+
}>;
|
|
324
|
+
static getAttributeTypeMap(): {
|
|
325
|
+
name: string;
|
|
326
|
+
baseName: string;
|
|
327
|
+
type: string;
|
|
328
|
+
}[];
|
|
329
|
+
}
|
|
314
330
|
/**
|
|
315
331
|
* Indicates if this service specification item is commissioned (and therefore should be executed), postponed for later or undefined.
|
|
316
332
|
*/
|
|
@@ -600,6 +616,58 @@ export declare class FileValidationSourceType {
|
|
|
600
616
|
type: string;
|
|
601
617
|
}[];
|
|
602
618
|
}
|
|
619
|
+
/**
|
|
620
|
+
* This model contains a flattened represention of an AVA project, which makes it easy to use in systems that expect elements in a list form.
|
|
621
|
+
*/
|
|
622
|
+
export declare class FlatAvaProject {
|
|
623
|
+
/**
|
|
624
|
+
* The original project, including the service specification, but no elements.
|
|
625
|
+
*/
|
|
626
|
+
'project'?: ProjectDto;
|
|
627
|
+
/**
|
|
628
|
+
* The flattened elements of the project.
|
|
629
|
+
*/
|
|
630
|
+
'elements'?: Array<FlatElementDto>;
|
|
631
|
+
static discriminator: string | undefined;
|
|
632
|
+
static attributeTypeMap: Array<{
|
|
633
|
+
name: string;
|
|
634
|
+
baseName: string;
|
|
635
|
+
type: string;
|
|
636
|
+
}>;
|
|
637
|
+
static getAttributeTypeMap(): {
|
|
638
|
+
name: string;
|
|
639
|
+
baseName: string;
|
|
640
|
+
type: string;
|
|
641
|
+
}[];
|
|
642
|
+
}
|
|
643
|
+
/**
|
|
644
|
+
* This model contains a flattened represention of an AVA project, which
|
|
645
|
+
*/
|
|
646
|
+
export declare class FlatElementDto {
|
|
647
|
+
/**
|
|
648
|
+
* If this is not null, then this contains the id of the previous element in the hierarchy on the same level.
|
|
649
|
+
*/
|
|
650
|
+
'previousElementId'?: string;
|
|
651
|
+
/**
|
|
652
|
+
* If this is not null, then this contains the id of the parent element.
|
|
653
|
+
*/
|
|
654
|
+
'parentElementId'?: string;
|
|
655
|
+
/**
|
|
656
|
+
* The element itself.
|
|
657
|
+
*/
|
|
658
|
+
'element'?: IElementDto;
|
|
659
|
+
static discriminator: string | undefined;
|
|
660
|
+
static attributeTypeMap: Array<{
|
|
661
|
+
name: string;
|
|
662
|
+
baseName: string;
|
|
663
|
+
type: string;
|
|
664
|
+
}>;
|
|
665
|
+
static getAttributeTypeMap(): {
|
|
666
|
+
name: string;
|
|
667
|
+
baseName: string;
|
|
668
|
+
type: string;
|
|
669
|
+
}[];
|
|
670
|
+
}
|
|
603
671
|
export declare class ForgotPasswordPost {
|
|
604
672
|
'identifier': string;
|
|
605
673
|
'preferredLanguages'?: Array<string>;
|
|
@@ -2888,6 +2956,28 @@ export declare class UglDestinationVersion {
|
|
|
2888
2956
|
type: string;
|
|
2889
2957
|
}[];
|
|
2890
2958
|
}
|
|
2959
|
+
export declare class UserInfoGet {
|
|
2960
|
+
'userIsAuthenticated': boolean;
|
|
2961
|
+
'clientIsAuthenticated': boolean;
|
|
2962
|
+
'currentUserId'?: string;
|
|
2963
|
+
'currentUserIdenticonId'?: string;
|
|
2964
|
+
'currentUserName'?: string;
|
|
2965
|
+
'currentUserEmail'?: string;
|
|
2966
|
+
'currentClientId'?: string;
|
|
2967
|
+
'userClaims'?: Array<ClaimGet>;
|
|
2968
|
+
'clientClaims'?: Array<ClaimGet>;
|
|
2969
|
+
static discriminator: string | undefined;
|
|
2970
|
+
static attributeTypeMap: Array<{
|
|
2971
|
+
name: string;
|
|
2972
|
+
baseName: string;
|
|
2973
|
+
type: string;
|
|
2974
|
+
}>;
|
|
2975
|
+
static getAttributeTypeMap(): {
|
|
2976
|
+
name: string;
|
|
2977
|
+
baseName: string;
|
|
2978
|
+
type: string;
|
|
2979
|
+
}[];
|
|
2980
|
+
}
|
|
2891
2981
|
/**
|
|
2892
2982
|
* This class models the results of a single check performed during a validation action
|
|
2893
2983
|
*/
|
|
@@ -3150,6 +3240,16 @@ export declare class AslvConversionApi {
|
|
|
3150
3240
|
response: http.IncomingMessage;
|
|
3151
3241
|
body: Buffer;
|
|
3152
3242
|
}>;
|
|
3243
|
+
/**
|
|
3244
|
+
*
|
|
3245
|
+
* @summary Converts Aslv files to Dangl.AVA projects
|
|
3246
|
+
* @param aslvFile The input file
|
|
3247
|
+
* @param {*} [options] Override http request options.
|
|
3248
|
+
*/
|
|
3249
|
+
aslvConversionConvertToFlatAva(aslvFile: FileParameter, options?: any): Promise<{
|
|
3250
|
+
response: http.IncomingMessage;
|
|
3251
|
+
body: FlatAvaProject;
|
|
3252
|
+
}>;
|
|
3153
3253
|
/**
|
|
3154
3254
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3155
3255
|
*/
|
|
@@ -3308,6 +3408,27 @@ export declare class AvaConversionApi {
|
|
|
3308
3408
|
/**
|
|
3309
3409
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3310
3410
|
*/
|
|
3411
|
+
avaConversionConvertToFlatAvaWithRequestObject(avaProject: ProjectDto, options?: {
|
|
3412
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3413
|
+
options?: any;
|
|
3414
|
+
}): Promise<{
|
|
3415
|
+
response: http.IncomingMessage;
|
|
3416
|
+
body: FlatAvaProject;
|
|
3417
|
+
}>;
|
|
3418
|
+
/**
|
|
3419
|
+
*
|
|
3420
|
+
* @summary Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
|
|
3421
|
+
* @param avaProject The Dangl.AVA project
|
|
3422
|
+
* @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.
|
|
3423
|
+
* @param {*} [options] Override http request options.
|
|
3424
|
+
*/
|
|
3425
|
+
avaConversionConvertToFlatAva(avaProject: ProjectDto, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
|
|
3426
|
+
response: http.IncomingMessage;
|
|
3427
|
+
body: FlatAvaProject;
|
|
3428
|
+
}>;
|
|
3429
|
+
/**
|
|
3430
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3431
|
+
*/
|
|
3311
3432
|
avaConversionConvertToGaebWithRequestObject(avaProject: ProjectDto, options?: {
|
|
3312
3433
|
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3313
3434
|
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';
|
|
@@ -3479,6 +3600,14 @@ export declare class DanglIdentityApi {
|
|
|
3479
3600
|
setDefaultAuthentication(auth: Authentication): void;
|
|
3480
3601
|
setApiKey(key: DanglIdentityApiApiKeys, value: string): void;
|
|
3481
3602
|
set accessToken(token: string);
|
|
3603
|
+
/**
|
|
3604
|
+
*
|
|
3605
|
+
* @param {*} [options] Override http request options.
|
|
3606
|
+
*/
|
|
3607
|
+
danglIdentityGetUserInfo(options?: any): Promise<{
|
|
3608
|
+
response: http.IncomingMessage;
|
|
3609
|
+
body: UserInfoGet;
|
|
3610
|
+
}>;
|
|
3482
3611
|
/**
|
|
3483
3612
|
*
|
|
3484
3613
|
* @param model
|
|
@@ -3584,6 +3713,16 @@ export declare class DatanormConversionApi {
|
|
|
3584
3713
|
response: http.IncomingMessage;
|
|
3585
3714
|
body: ProjectDto;
|
|
3586
3715
|
}>;
|
|
3716
|
+
/**
|
|
3717
|
+
*
|
|
3718
|
+
* @summary Converts Datanorm files to Dangl.AVA projects
|
|
3719
|
+
* @param datanormFile The input file
|
|
3720
|
+
* @param {*} [options] Override http request options.
|
|
3721
|
+
*/
|
|
3722
|
+
datanormConversionConvertToFlatAva(datanormFile: FileParameter, options?: any): Promise<{
|
|
3723
|
+
response: http.IncomingMessage;
|
|
3724
|
+
body: FlatAvaProject;
|
|
3725
|
+
}>;
|
|
3587
3726
|
}
|
|
3588
3727
|
export declare enum ExcelConversionApiApiKeys {
|
|
3589
3728
|
}
|
|
@@ -3663,6 +3802,29 @@ export declare class ExcelConversionApi {
|
|
|
3663
3802
|
/**
|
|
3664
3803
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3665
3804
|
*/
|
|
3805
|
+
excelConversionConvertToFlatAvaWithRequestObject(excelFile: FileParameter, options?: {
|
|
3806
|
+
readNewElements?: boolean;
|
|
3807
|
+
rebuildItemNumberSchema?: boolean;
|
|
3808
|
+
options?: any;
|
|
3809
|
+
}): Promise<{
|
|
3810
|
+
response: http.IncomingMessage;
|
|
3811
|
+
body: FlatAvaProject;
|
|
3812
|
+
}>;
|
|
3813
|
+
/**
|
|
3814
|
+
*
|
|
3815
|
+
* @summary Converts Excel files to Dangl.AVA projects.
|
|
3816
|
+
* @param excelFile The input file
|
|
3817
|
+
* @param readNewElements Defaults to false
|
|
3818
|
+
* @param rebuildItemNumberSchema When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
|
|
3819
|
+
* @param {*} [options] Override http request options.
|
|
3820
|
+
*/
|
|
3821
|
+
excelConversionConvertToFlatAva(excelFile: FileParameter, readNewElements?: boolean, rebuildItemNumberSchema?: boolean, options?: any): Promise<{
|
|
3822
|
+
response: http.IncomingMessage;
|
|
3823
|
+
body: FlatAvaProject;
|
|
3824
|
+
}>;
|
|
3825
|
+
/**
|
|
3826
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3827
|
+
*/
|
|
3666
3828
|
excelConversionConvertToGaebWithRequestObject(excelFile: FileParameter, options?: {
|
|
3667
3829
|
readNewElements?: boolean;
|
|
3668
3830
|
rebuildItemNumberSchema?: boolean;
|
|
@@ -3729,6 +3891,278 @@ export declare class ExcelConversionApi {
|
|
|
3729
3891
|
body: Buffer;
|
|
3730
3892
|
}>;
|
|
3731
3893
|
}
|
|
3894
|
+
export declare enum FlatAvaConversionApiApiKeys {
|
|
3895
|
+
}
|
|
3896
|
+
export declare class FlatAvaConversionApi {
|
|
3897
|
+
protected _basePath: string;
|
|
3898
|
+
protected defaultHeaders: any;
|
|
3899
|
+
protected _useQuerystring: boolean;
|
|
3900
|
+
protected authentications: {
|
|
3901
|
+
default: Authentication;
|
|
3902
|
+
'Dangl.Identity': OAuth;
|
|
3903
|
+
};
|
|
3904
|
+
constructor(basePath?: string);
|
|
3905
|
+
set useQuerystring(value: boolean);
|
|
3906
|
+
set basePath(basePath: string);
|
|
3907
|
+
get basePath(): string;
|
|
3908
|
+
setDefaultAuthentication(auth: Authentication): void;
|
|
3909
|
+
setApiKey(key: FlatAvaConversionApiApiKeys, value: string): void;
|
|
3910
|
+
set accessToken(token: string);
|
|
3911
|
+
/**
|
|
3912
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3913
|
+
*/
|
|
3914
|
+
flatAvaConversionConvertToAvaWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
3915
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3916
|
+
removePlainTextLongTexts?: boolean;
|
|
3917
|
+
removeHtmlLongTexts?: boolean;
|
|
3918
|
+
options?: any;
|
|
3919
|
+
}): Promise<{
|
|
3920
|
+
response: http.IncomingMessage;
|
|
3921
|
+
body: ProjectDto;
|
|
3922
|
+
}>;
|
|
3923
|
+
/**
|
|
3924
|
+
*
|
|
3925
|
+
* @summary Converts flat Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
|
|
3926
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
3927
|
+
* @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.
|
|
3928
|
+
* @param removePlainTextLongTexts If set to true, plain text long texts will be removed from the output to reduce response sizes
|
|
3929
|
+
* @param removeHtmlLongTexts If set to true, html long texts will be removed from the output to reduce response sizes
|
|
3930
|
+
* @param {*} [options] Override http request options.
|
|
3931
|
+
*/
|
|
3932
|
+
flatAvaConversionConvertToAva(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, removePlainTextLongTexts?: boolean, removeHtmlLongTexts?: boolean, options?: any): Promise<{
|
|
3933
|
+
response: http.IncomingMessage;
|
|
3934
|
+
body: ProjectDto;
|
|
3935
|
+
}>;
|
|
3936
|
+
/**
|
|
3937
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3938
|
+
*/
|
|
3939
|
+
flatAvaConversionConvertToDatanormWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
3940
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3941
|
+
datanormDestinationVersion?: 'V4' | 'V5';
|
|
3942
|
+
options?: any;
|
|
3943
|
+
}): Promise<{
|
|
3944
|
+
response: http.IncomingMessage;
|
|
3945
|
+
body: Buffer;
|
|
3946
|
+
}>;
|
|
3947
|
+
/**
|
|
3948
|
+
*
|
|
3949
|
+
* @summary Converts flat Dangl.AVA projects to Datanorm
|
|
3950
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
3951
|
+
* @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.
|
|
3952
|
+
* @param datanormDestinationVersion The Datanorm version to convert to. Defaults to V4.
|
|
3953
|
+
* @param {*} [options] Override http request options.
|
|
3954
|
+
*/
|
|
3955
|
+
flatAvaConversionConvertToDatanorm(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, datanormDestinationVersion?: 'V4' | 'V5', options?: any): Promise<{
|
|
3956
|
+
response: http.IncomingMessage;
|
|
3957
|
+
body: Buffer;
|
|
3958
|
+
}>;
|
|
3959
|
+
/**
|
|
3960
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3961
|
+
*/
|
|
3962
|
+
flatAvaConversionConvertToExcelWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
3963
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3964
|
+
writePrices?: boolean;
|
|
3965
|
+
writeLongTexts?: boolean;
|
|
3966
|
+
conversionCulture?: string;
|
|
3967
|
+
includeArticleNumbers?: boolean;
|
|
3968
|
+
options?: any;
|
|
3969
|
+
}): Promise<{
|
|
3970
|
+
response: http.IncomingMessage;
|
|
3971
|
+
body: Buffer;
|
|
3972
|
+
}>;
|
|
3973
|
+
/**
|
|
3974
|
+
*
|
|
3975
|
+
* @summary Converts flat Dangl.AVA projects to Excel
|
|
3976
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
3977
|
+
* @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.
|
|
3978
|
+
* @param writePrices Defaults to true
|
|
3979
|
+
* @param writeLongTexts Defaults to true
|
|
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 'position.commerceProperties.articleNumber'
|
|
3982
|
+
* @param {*} [options] Override http request options.
|
|
3983
|
+
*/
|
|
3984
|
+
flatAvaConversionConvertToExcel(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, writePrices?: boolean, writeLongTexts?: boolean, conversionCulture?: string, includeArticleNumbers?: boolean, options?: any): Promise<{
|
|
3985
|
+
response: http.IncomingMessage;
|
|
3986
|
+
body: Buffer;
|
|
3987
|
+
}>;
|
|
3988
|
+
/**
|
|
3989
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3990
|
+
*/
|
|
3991
|
+
flatAvaConversionConvertToFlatAvaWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
3992
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
3993
|
+
options?: any;
|
|
3994
|
+
}): Promise<{
|
|
3995
|
+
response: http.IncomingMessage;
|
|
3996
|
+
body: FlatAvaProject;
|
|
3997
|
+
}>;
|
|
3998
|
+
/**
|
|
3999
|
+
*
|
|
4000
|
+
* @summary Converts flat Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
|
|
4001
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4002
|
+
* @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.
|
|
4003
|
+
* @param {*} [options] Override http request options.
|
|
4004
|
+
*/
|
|
4005
|
+
flatAvaConversionConvertToFlatAva(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, options?: any): Promise<{
|
|
4006
|
+
response: http.IncomingMessage;
|
|
4007
|
+
body: FlatAvaProject;
|
|
4008
|
+
}>;
|
|
4009
|
+
/**
|
|
4010
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4011
|
+
*/
|
|
4012
|
+
flatAvaConversionConvertToGaebWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
4013
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
4014
|
+
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';
|
|
4015
|
+
targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer';
|
|
4016
|
+
enforceStrictOfferPhaseLongTextOutput?: boolean;
|
|
4017
|
+
exportQuantityDetermination?: boolean;
|
|
4018
|
+
removeUnprintableCharactersFromTexts?: boolean;
|
|
4019
|
+
forceIncludeDescriptions?: boolean;
|
|
4020
|
+
treatNullItemNumberSchemaAsInvalid?: boolean;
|
|
4021
|
+
options?: any;
|
|
4022
|
+
}): Promise<{
|
|
4023
|
+
response: http.IncomingMessage;
|
|
4024
|
+
body: Buffer;
|
|
4025
|
+
}>;
|
|
4026
|
+
/**
|
|
4027
|
+
*
|
|
4028
|
+
* @summary Converts flat Dangl.AVA projects to GAEB
|
|
4029
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4030
|
+
* @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.
|
|
4031
|
+
* @param destinationGaebType Defaults to GAEB XML V3.2
|
|
4032
|
+
* @param targetExchangePhaseTransform Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
|
|
4033
|
+
* @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.
|
|
4034
|
+
* @param exportQuantityDetermination 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.
|
|
4035
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
4036
|
+
* @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.
|
|
4037
|
+
* @param treatNullItemNumberSchemaAsInvalid When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
|
|
4038
|
+
* @param {*} [options] Override http request options.
|
|
4039
|
+
*/
|
|
4040
|
+
flatAvaConversionConvertToGaeb(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationGaebType?: 'Gaeb90' | 'Gaeb2000' | 'Gaeb2000Commerce' | 'GaebXml_V3_1' | 'GaebXml_V3_2' | 'GaebXml_V3_2_Commerce' | 'GaebXml_V3_3' | 'GaebXml_V3_3_Commerce' | 'GaebXml_V3_3_2019' | 'GaebXml_V3_3_2019_Commerce', targetExchangePhaseTransform?: 'None' | 'Base' | 'OfferRequest' | 'Offer' | 'Grant' | 'CostEstimate' | 'SideOffer', enforceStrictOfferPhaseLongTextOutput?: boolean, exportQuantityDetermination?: boolean, removeUnprintableCharactersFromTexts?: boolean, forceIncludeDescriptions?: boolean, treatNullItemNumberSchemaAsInvalid?: boolean, options?: any): Promise<{
|
|
4041
|
+
response: http.IncomingMessage;
|
|
4042
|
+
body: Buffer;
|
|
4043
|
+
}>;
|
|
4044
|
+
/**
|
|
4045
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4046
|
+
*/
|
|
4047
|
+
flatAvaConversionConvertToIdsConnectWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
4048
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
4049
|
+
version?: 'V2_5';
|
|
4050
|
+
options?: any;
|
|
4051
|
+
}): Promise<{
|
|
4052
|
+
response: http.IncomingMessage;
|
|
4053
|
+
body: Buffer;
|
|
4054
|
+
}>;
|
|
4055
|
+
/**
|
|
4056
|
+
*
|
|
4057
|
+
* @summary Converts flat Dangl.AVA projects to IDS Connect files
|
|
4058
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4059
|
+
* @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.
|
|
4060
|
+
* @param version The IDS Connect version to convert to. Defaults to V2_5.
|
|
4061
|
+
* @param {*} [options] Override http request options.
|
|
4062
|
+
*/
|
|
4063
|
+
flatAvaConversionConvertToIdsConnect(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, version?: 'V2_5', options?: any): Promise<{
|
|
4064
|
+
response: http.IncomingMessage;
|
|
4065
|
+
body: Buffer;
|
|
4066
|
+
}>;
|
|
4067
|
+
/**
|
|
4068
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4069
|
+
*/
|
|
4070
|
+
flatAvaConversionConvertToOenormWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
4071
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
4072
|
+
destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021';
|
|
4073
|
+
tryRepairProjectStructure?: boolean;
|
|
4074
|
+
skipTryEnforceSchemaCompliantXmlOutput?: boolean;
|
|
4075
|
+
removeUnprintableCharactersFromTexts?: boolean;
|
|
4076
|
+
options?: any;
|
|
4077
|
+
}): Promise<{
|
|
4078
|
+
response: http.IncomingMessage;
|
|
4079
|
+
body: Buffer;
|
|
4080
|
+
}>;
|
|
4081
|
+
/**
|
|
4082
|
+
*
|
|
4083
|
+
* @summary Converts flat Dangl.AVA projects to Oenorm
|
|
4084
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4085
|
+
* @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.
|
|
4086
|
+
* @param destinationOenormType Defaults to Lv2015
|
|
4087
|
+
* @param tryRepairProjectStructure 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
|
|
4088
|
+
* @param skipTryEnforceSchemaCompliantXmlOutput 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.
|
|
4089
|
+
* @param removeUnprintableCharactersFromTexts If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
|
|
4090
|
+
* @param {*} [options] Override http request options.
|
|
4091
|
+
*/
|
|
4092
|
+
flatAvaConversionConvertToOenorm(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationOenormType?: 'Lv2015' | 'Lb2015' | 'B2063' | 'Lv2009' | 'Lb2009' | 'Lv2021' | 'Lb2021', tryRepairProjectStructure?: boolean, skipTryEnforceSchemaCompliantXmlOutput?: boolean, removeUnprintableCharactersFromTexts?: boolean, options?: any): Promise<{
|
|
4093
|
+
response: http.IncomingMessage;
|
|
4094
|
+
body: Buffer;
|
|
4095
|
+
}>;
|
|
4096
|
+
/**
|
|
4097
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4098
|
+
*/
|
|
4099
|
+
flatAvaConversionConvertToRebWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
4100
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
4101
|
+
destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33';
|
|
4102
|
+
options?: any;
|
|
4103
|
+
}): Promise<{
|
|
4104
|
+
response: http.IncomingMessage;
|
|
4105
|
+
body: Buffer;
|
|
4106
|
+
}>;
|
|
4107
|
+
/**
|
|
4108
|
+
*
|
|
4109
|
+
* @summary Converts flat Dangl.AVA projects to REB
|
|
4110
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4111
|
+
* @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.
|
|
4112
|
+
* @param destinationRebType Defaults to D11
|
|
4113
|
+
* @param {*} [options] Override http request options.
|
|
4114
|
+
*/
|
|
4115
|
+
flatAvaConversionConvertToReb(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, destinationRebType?: 'D11' | 'X31GaebXmlV32' | 'X31GaebXmlV33', options?: any): Promise<{
|
|
4116
|
+
response: http.IncomingMessage;
|
|
4117
|
+
body: Buffer;
|
|
4118
|
+
}>;
|
|
4119
|
+
/**
|
|
4120
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4121
|
+
*/
|
|
4122
|
+
flatAvaConversionConvertToSiaWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
4123
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
4124
|
+
siaDestinationType?: 'Sia451' | 'Ifa18';
|
|
4125
|
+
options?: any;
|
|
4126
|
+
}): Promise<{
|
|
4127
|
+
response: http.IncomingMessage;
|
|
4128
|
+
body: Buffer;
|
|
4129
|
+
}>;
|
|
4130
|
+
/**
|
|
4131
|
+
*
|
|
4132
|
+
* @summary Converts flat Dangl.AVA projects to SIA 451
|
|
4133
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4134
|
+
* @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.
|
|
4135
|
+
* @param siaDestinationType Defaults to Sia451
|
|
4136
|
+
* @param {*} [options] Override http request options.
|
|
4137
|
+
*/
|
|
4138
|
+
flatAvaConversionConvertToSia(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, siaDestinationType?: 'Sia451' | 'Ifa18', options?: any): Promise<{
|
|
4139
|
+
response: http.IncomingMessage;
|
|
4140
|
+
body: Buffer;
|
|
4141
|
+
}>;
|
|
4142
|
+
/**
|
|
4143
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4144
|
+
*/
|
|
4145
|
+
flatAvaConversionConvertToUglWithRequestObject(flatAvaProject: FlatAvaProject, options?: {
|
|
4146
|
+
tryAutoGenerateItemNumbersAndSchema?: boolean;
|
|
4147
|
+
uglDestinationVersion?: 'V4' | 'V5';
|
|
4148
|
+
options?: any;
|
|
4149
|
+
}): Promise<{
|
|
4150
|
+
response: http.IncomingMessage;
|
|
4151
|
+
body: Buffer;
|
|
4152
|
+
}>;
|
|
4153
|
+
/**
|
|
4154
|
+
*
|
|
4155
|
+
* @summary Converts flat Dangl.AVA projects to UGL
|
|
4156
|
+
* @param flatAvaProject The flat Dangl.AVA project
|
|
4157
|
+
* @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.
|
|
4158
|
+
* @param uglDestinationVersion The UGL version to convert to. Defaults to V1.
|
|
4159
|
+
* @param {*} [options] Override http request options.
|
|
4160
|
+
*/
|
|
4161
|
+
flatAvaConversionConvertToUgl(flatAvaProject: FlatAvaProject, tryAutoGenerateItemNumbersAndSchema?: boolean, uglDestinationVersion?: 'V4' | 'V5', options?: any): Promise<{
|
|
4162
|
+
response: http.IncomingMessage;
|
|
4163
|
+
body: Buffer;
|
|
4164
|
+
}>;
|
|
4165
|
+
}
|
|
3732
4166
|
export declare enum GaebConversionApiApiKeys {
|
|
3733
4167
|
}
|
|
3734
4168
|
export declare class GaebConversionApi {
|
|
@@ -3819,6 +4253,35 @@ export declare class GaebConversionApi {
|
|
|
3819
4253
|
/**
|
|
3820
4254
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
3821
4255
|
*/
|
|
4256
|
+
gaebConversionConvertToFlatAvaWithRequestObject(gaebFile: FileParameter, options?: {
|
|
4257
|
+
supportSkippedItemNumberLevelsInPositions?: boolean;
|
|
4258
|
+
outputHtmlAsXml?: boolean;
|
|
4259
|
+
keepEmptyHtmlText?: boolean;
|
|
4260
|
+
allowUpperCaseItemNumbers?: boolean;
|
|
4261
|
+
allowLumpSumItemsWithDifferingQuantities?: boolean;
|
|
4262
|
+
options?: any;
|
|
4263
|
+
}): Promise<{
|
|
4264
|
+
response: http.IncomingMessage;
|
|
4265
|
+
body: FlatAvaProject;
|
|
4266
|
+
}>;
|
|
4267
|
+
/**
|
|
4268
|
+
*
|
|
4269
|
+
* @summary Converts GAEB files to Dangl.AVA projects
|
|
4270
|
+
* @param gaebFile The input file
|
|
4271
|
+
* @param supportSkippedItemNumberLevelsInPositions Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
|
|
4272
|
+
* @param outputHtmlAsXml Defaults to 'false'. 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 '<br />' instead of '<br>'.
|
|
4273
|
+
* @param keepEmptyHtmlText Defaults to 'false'. 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.
|
|
4274
|
+
* @param allowUpperCaseItemNumbers Defaults to 'false'. 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.
|
|
4275
|
+
* @param allowLumpSumItemsWithDifferingQuantities Defaults to 'false'. By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then differing quantities will be kept during the import.
|
|
4276
|
+
* @param {*} [options] Override http request options.
|
|
4277
|
+
*/
|
|
4278
|
+
gaebConversionConvertToFlatAva(gaebFile: FileParameter, supportSkippedItemNumberLevelsInPositions?: boolean, outputHtmlAsXml?: boolean, keepEmptyHtmlText?: boolean, allowUpperCaseItemNumbers?: boolean, allowLumpSumItemsWithDifferingQuantities?: boolean, options?: any): Promise<{
|
|
4279
|
+
response: http.IncomingMessage;
|
|
4280
|
+
body: FlatAvaProject;
|
|
4281
|
+
}>;
|
|
4282
|
+
/**
|
|
4283
|
+
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4284
|
+
*/
|
|
3822
4285
|
gaebConversionConvertToGaebWithRequestObject(gaebFile: FileParameter, options?: {
|
|
3823
4286
|
supportSkippedItemNumberLevelsInPositions?: boolean;
|
|
3824
4287
|
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';
|
|
@@ -3937,6 +4400,16 @@ export declare class IdsConnectConversionApi {
|
|
|
3937
4400
|
response: http.IncomingMessage;
|
|
3938
4401
|
body: ProjectDto;
|
|
3939
4402
|
}>;
|
|
4403
|
+
/**
|
|
4404
|
+
*
|
|
4405
|
+
* @summary Converts IDS Connect files to Dangl.AVA projects
|
|
4406
|
+
* @param idsConnectFile The input file
|
|
4407
|
+
* @param {*} [options] Override http request options.
|
|
4408
|
+
*/
|
|
4409
|
+
idsConnectConversionConvertToFlatAva(idsConnectFile: FileParameter, options?: any): Promise<{
|
|
4410
|
+
response: http.IncomingMessage;
|
|
4411
|
+
body: FlatAvaProject;
|
|
4412
|
+
}>;
|
|
3940
4413
|
}
|
|
3941
4414
|
export declare enum OenormConversionApiApiKeys {
|
|
3942
4415
|
}
|
|
@@ -4005,6 +4478,16 @@ export declare class OenormConversionApi {
|
|
|
4005
4478
|
response: http.IncomingMessage;
|
|
4006
4479
|
body: Buffer;
|
|
4007
4480
|
}>;
|
|
4481
|
+
/**
|
|
4482
|
+
*
|
|
4483
|
+
* @summary Converts ÖNorm files to Dangl.AVA projects
|
|
4484
|
+
* @param oenormFile The input file
|
|
4485
|
+
* @param {*} [options] Override http request options.
|
|
4486
|
+
*/
|
|
4487
|
+
oenormConversionConvertToFlatAva(oenormFile: FileParameter, options?: any): Promise<{
|
|
4488
|
+
response: http.IncomingMessage;
|
|
4489
|
+
body: FlatAvaProject;
|
|
4490
|
+
}>;
|
|
4008
4491
|
/**
|
|
4009
4492
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4010
4493
|
*/
|
|
@@ -4133,6 +4616,16 @@ export declare class RebConversionApi {
|
|
|
4133
4616
|
response: http.IncomingMessage;
|
|
4134
4617
|
body: Buffer;
|
|
4135
4618
|
}>;
|
|
4619
|
+
/**
|
|
4620
|
+
*
|
|
4621
|
+
* @summary Converts REB files to Dangl.AVA projects
|
|
4622
|
+
* @param rebFile The input file
|
|
4623
|
+
* @param {*} [options] Override http request options.
|
|
4624
|
+
*/
|
|
4625
|
+
rebConversionConvertToFlatAva(rebFile: FileParameter, options?: any): Promise<{
|
|
4626
|
+
response: http.IncomingMessage;
|
|
4627
|
+
body: FlatAvaProject;
|
|
4628
|
+
}>;
|
|
4136
4629
|
/**
|
|
4137
4630
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4138
4631
|
*/
|
|
@@ -4261,6 +4754,16 @@ export declare class SiaConversionApi {
|
|
|
4261
4754
|
response: http.IncomingMessage;
|
|
4262
4755
|
body: Buffer;
|
|
4263
4756
|
}>;
|
|
4757
|
+
/**
|
|
4758
|
+
*
|
|
4759
|
+
* @summary Converts SIA 451 files to Dangl.AVA projects
|
|
4760
|
+
* @param siaFile The input file
|
|
4761
|
+
* @param {*} [options] Override http request options.
|
|
4762
|
+
*/
|
|
4763
|
+
siaConversionConvertToFlatAva(siaFile: FileParameter, options?: any): Promise<{
|
|
4764
|
+
response: http.IncomingMessage;
|
|
4765
|
+
body: FlatAvaProject;
|
|
4766
|
+
}>;
|
|
4264
4767
|
/**
|
|
4265
4768
|
* This is a generated method that accepts an options object, it simply calls the generated method with the parameter list
|
|
4266
4769
|
*/
|
|
@@ -4389,6 +4892,16 @@ export declare class UglConversionApi {
|
|
|
4389
4892
|
response: http.IncomingMessage;
|
|
4390
4893
|
body: ProjectDto;
|
|
4391
4894
|
}>;
|
|
4895
|
+
/**
|
|
4896
|
+
*
|
|
4897
|
+
* @summary Converts Ugl files to Dangl.AVA projects
|
|
4898
|
+
* @param uglFile The input file
|
|
4899
|
+
* @param {*} [options] Override http request options.
|
|
4900
|
+
*/
|
|
4901
|
+
uglConversionConvertToFlatAva(uglFile: FileParameter, options?: any): Promise<{
|
|
4902
|
+
response: http.IncomingMessage;
|
|
4903
|
+
body: FlatAvaProject;
|
|
4904
|
+
}>;
|
|
4392
4905
|
}
|
|
4393
4906
|
export declare enum ValidationApiApiKeys {
|
|
4394
4907
|
}
|