tencentcloud-sdk-nodejs-ess 4.0.649 → 4.0.651
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/CHANGELOG.md +553 -0
- package/SERVICE_CHANGELOG.md +657 -66
- package/package.json +1 -1
- package/products.md +26 -26
- package/src/services/ess/v20201111/ess_client.ts +57 -16
- package/src/services/ess/v20201111/ess_models.ts +273 -107
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +22 -7
- package/tencentcloud/services/ess/v20201111/ess_client.js +29 -8
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +265 -107
|
@@ -32,7 +32,11 @@ export interface CreateSealRequest {
|
|
|
32
32
|
*/
|
|
33
33
|
Agent?: Agent
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* 本接口支持上传图片印章及系统直接生成印章;如果要使用系统生成印章,此值传:SealGenerateSourceSystem;如果要使用图片上传请传字段 Image
|
|
36
|
+
*/
|
|
37
|
+
GenerateSource?: string
|
|
38
|
+
/**
|
|
39
|
+
* 电子印章类型,OFFICIAL-公章,CONTRACT-合同专用章
|
|
36
40
|
*/
|
|
37
41
|
SealType?: string
|
|
38
42
|
/**
|
|
@@ -61,16 +65,15 @@ export interface CreateSealRequest {
|
|
|
61
65
|
*/
|
|
62
66
|
Color?: string
|
|
63
67
|
/**
|
|
64
|
-
*
|
|
68
|
+
* 暂时不支持横向文字设置
|
|
65
69
|
*/
|
|
66
70
|
SealHorizontalText?: string
|
|
67
71
|
/**
|
|
68
|
-
*
|
|
72
|
+
* 暂时不支持下弦文字设置
|
|
69
73
|
*/
|
|
70
74
|
SealChordText?: string
|
|
71
75
|
/**
|
|
72
|
-
*
|
|
73
|
-
系统生成的印章只支持STAR
|
|
76
|
+
* 系统生成的印章只支持STAR
|
|
74
77
|
*/
|
|
75
78
|
SealCentralType?: string
|
|
76
79
|
/**
|
|
@@ -78,12 +81,6 @@ export interface CreateSealRequest {
|
|
|
78
81
|
|
|
79
82
|
*/
|
|
80
83
|
FileToken?: string
|
|
81
|
-
/**
|
|
82
|
-
* 印章生成来源方式
|
|
83
|
-
取值:
|
|
84
|
-
SealGenerateSourceSystem 表示系统生成企业印章
|
|
85
|
-
*/
|
|
86
|
-
GenerateSource?: string
|
|
87
84
|
}
|
|
88
85
|
|
|
89
86
|
/**
|
|
@@ -380,7 +377,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
380
377
|
*/
|
|
381
378
|
ApproverSource?: string
|
|
382
379
|
/**
|
|
383
|
-
*
|
|
380
|
+
* 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
|
|
384
381
|
*/
|
|
385
382
|
CustomApproverTag?: string
|
|
386
383
|
/**
|
|
@@ -422,6 +419,28 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
422
419
|
SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
|
|
423
420
|
*/
|
|
424
421
|
ComponentLimitType?: Array<string>
|
|
422
|
+
/**
|
|
423
|
+
* 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
|
|
424
|
+
*/
|
|
425
|
+
ApproverVerifyTypes?: Array<number>
|
|
426
|
+
/**
|
|
427
|
+
* 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
|
|
428
|
+
*/
|
|
429
|
+
ApproverSignTypes?: Array<number>
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
/**
|
|
433
|
+
* 关注方信息
|
|
434
|
+
*/
|
|
435
|
+
export interface ReviewerInfo {
|
|
436
|
+
/**
|
|
437
|
+
* 姓名
|
|
438
|
+
*/
|
|
439
|
+
Name?: string
|
|
440
|
+
/**
|
|
441
|
+
* 手机号
|
|
442
|
+
*/
|
|
443
|
+
Mobile?: string
|
|
425
444
|
}
|
|
426
445
|
|
|
427
446
|
/**
|
|
@@ -1366,6 +1385,16 @@ export interface CreateReleaseFlowResponse {
|
|
|
1366
1385
|
RequestId?: string
|
|
1367
1386
|
}
|
|
1368
1387
|
|
|
1388
|
+
/**
|
|
1389
|
+
* CreateWebThemeConfig返回参数结构体
|
|
1390
|
+
*/
|
|
1391
|
+
export interface CreateWebThemeConfigResponse {
|
|
1392
|
+
/**
|
|
1393
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1394
|
+
*/
|
|
1395
|
+
RequestId?: string
|
|
1396
|
+
}
|
|
1397
|
+
|
|
1369
1398
|
/**
|
|
1370
1399
|
* BindEmployeeUserIdWithClientOpenId请求参数结构体
|
|
1371
1400
|
*/
|
|
@@ -2722,6 +2751,38 @@ export interface DescribeOrganizationSealsResponse {
|
|
|
2722
2751
|
RequestId?: string
|
|
2723
2752
|
}
|
|
2724
2753
|
|
|
2754
|
+
/**
|
|
2755
|
+
* CreateEmbedWebUrl请求参数结构体
|
|
2756
|
+
*/
|
|
2757
|
+
export interface CreateEmbedWebUrlRequest {
|
|
2758
|
+
/**
|
|
2759
|
+
* 操作者信息
|
|
2760
|
+
*/
|
|
2761
|
+
Operator: UserInfo
|
|
2762
|
+
/**
|
|
2763
|
+
* WEB嵌入资源类型。
|
|
2764
|
+
<br/>CREATE_SEAL: 创建印章
|
|
2765
|
+
<br/>PREVIEW_SEAL_LIST:预览印章列表
|
|
2766
|
+
<br/>PREVIEW_SEAL_DETAIL:预览印章详情
|
|
2767
|
+
<br/>EXTEND_SERVICE:拓展服务
|
|
2768
|
+
|
|
2769
|
+
*/
|
|
2770
|
+
EmbedType: string
|
|
2771
|
+
/**
|
|
2772
|
+
* WEB嵌入的业务资源ID
|
|
2773
|
+
<br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
|
|
2774
|
+
*/
|
|
2775
|
+
BusinessId?: string
|
|
2776
|
+
/**
|
|
2777
|
+
* 代理相关应用信息,如集团主企业代子企业操作
|
|
2778
|
+
*/
|
|
2779
|
+
Agent?: Agent
|
|
2780
|
+
/**
|
|
2781
|
+
* 抄送方信息
|
|
2782
|
+
*/
|
|
2783
|
+
Reviewer?: ReviewerInfo
|
|
2784
|
+
}
|
|
2785
|
+
|
|
2725
2786
|
/**
|
|
2726
2787
|
* DeleteIntegrationEmployees请求参数结构体
|
|
2727
2788
|
*/
|
|
@@ -2888,6 +2949,110 @@ export interface DeleteIntegrationRoleUsersRequest {
|
|
|
2888
2949
|
Agent?: Agent
|
|
2889
2950
|
}
|
|
2890
2951
|
|
|
2952
|
+
/**
|
|
2953
|
+
* CreateFlowByFiles请求参数结构体
|
|
2954
|
+
*/
|
|
2955
|
+
export interface CreateFlowByFilesRequest {
|
|
2956
|
+
/**
|
|
2957
|
+
* 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
|
|
2958
|
+
*/
|
|
2959
|
+
Operator: UserInfo
|
|
2960
|
+
/**
|
|
2961
|
+
* 签署流程名称,最大长度200个字符
|
|
2962
|
+
*/
|
|
2963
|
+
FlowName: string
|
|
2964
|
+
/**
|
|
2965
|
+
* 签署参与者信息,最大限制50方
|
|
2966
|
+
*/
|
|
2967
|
+
Approvers: Array<ApproverInfo>
|
|
2968
|
+
/**
|
|
2969
|
+
* 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
|
|
2970
|
+
*/
|
|
2971
|
+
FileIds: Array<string>
|
|
2972
|
+
/**
|
|
2973
|
+
* 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
|
2974
|
+
*/
|
|
2975
|
+
FlowType?: string
|
|
2976
|
+
/**
|
|
2977
|
+
* 经办人内容控件配置
|
|
2978
|
+
*/
|
|
2979
|
+
Components?: Array<Component>
|
|
2980
|
+
/**
|
|
2981
|
+
* 被抄送人的信息列表。
|
|
2982
|
+
注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
|
2983
|
+
*/
|
|
2984
|
+
CcInfos?: Array<CcInfo>
|
|
2985
|
+
/**
|
|
2986
|
+
* 是否需要预览,true:预览模式,false:非预览(默认);
|
|
2987
|
+
预览链接有效期300秒;
|
|
2988
|
+
|
|
2989
|
+
注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
|
|
2990
|
+
*/
|
|
2991
|
+
NeedPreview?: boolean
|
|
2992
|
+
/**
|
|
2993
|
+
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
2994
|
+
*/
|
|
2995
|
+
PreviewType?: number
|
|
2996
|
+
/**
|
|
2997
|
+
* 签署流程的签署截止时间。
|
|
2998
|
+
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
2999
|
+
*/
|
|
3000
|
+
Deadline?: number
|
|
3001
|
+
/**
|
|
3002
|
+
* 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
|
|
3003
|
+
*/
|
|
3004
|
+
RemindedOn?: number
|
|
3005
|
+
/**
|
|
3006
|
+
* 发送类型:
|
|
3007
|
+
true:无序签
|
|
3008
|
+
false:有序签
|
|
3009
|
+
注:默认为false(有序签)
|
|
3010
|
+
*/
|
|
3011
|
+
Unordered?: boolean
|
|
3012
|
+
/**
|
|
3013
|
+
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
3014
|
+
*/
|
|
3015
|
+
CustomShowMap?: string
|
|
3016
|
+
/**
|
|
3017
|
+
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
3018
|
+
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
3019
|
+
|
|
3020
|
+
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
3021
|
+
*/
|
|
3022
|
+
NeedSignReview?: boolean
|
|
3023
|
+
/**
|
|
3024
|
+
* 用户自定义字段,回调的时候会进行透传,长度需要小于20480
|
|
3025
|
+
*/
|
|
3026
|
+
UserData?: string
|
|
3027
|
+
/**
|
|
3028
|
+
* 签署人校验方式
|
|
3029
|
+
VerifyCheck: 人脸识别(默认)
|
|
3030
|
+
MobileCheck:手机号验证
|
|
3031
|
+
参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
3032
|
+
*/
|
|
3033
|
+
ApproverVerifyType?: string
|
|
3034
|
+
/**
|
|
3035
|
+
* 签署流程描述,最大长度1000个字符
|
|
3036
|
+
*/
|
|
3037
|
+
FlowDescription?: string
|
|
3038
|
+
/**
|
|
3039
|
+
* 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
|
|
3040
|
+
*/
|
|
3041
|
+
SignBeanTag?: number
|
|
3042
|
+
/**
|
|
3043
|
+
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
3044
|
+
*/
|
|
3045
|
+
Agent?: Agent
|
|
3046
|
+
/**
|
|
3047
|
+
* 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
|
|
3048
|
+
*/
|
|
3049
|
+
CcNotifyType?: number
|
|
3050
|
+
/**
|
|
3051
|
+
* 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
3052
|
+
*/
|
|
3053
|
+
AutoSignScene?: string
|
|
3054
|
+
}
|
|
3055
|
+
|
|
2891
3056
|
/**
|
|
2892
3057
|
* CreateFlowSignUrl请求参数结构体
|
|
2893
3058
|
*/
|
|
@@ -3229,7 +3394,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
3229
3394
|
*/
|
|
3230
3395
|
ApproverSource?: string
|
|
3231
3396
|
/**
|
|
3232
|
-
*
|
|
3397
|
+
* 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
|
|
3233
3398
|
*/
|
|
3234
3399
|
CustomApproverTag?: string
|
|
3235
3400
|
/**
|
|
@@ -3365,6 +3530,24 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
|
|
|
3365
3530
|
Agent?: Agent
|
|
3366
3531
|
}
|
|
3367
3532
|
|
|
3533
|
+
/**
|
|
3534
|
+
* CreateOrganizationBatchSignUrl返回参数结构体
|
|
3535
|
+
*/
|
|
3536
|
+
export interface CreateOrganizationBatchSignUrlResponse {
|
|
3537
|
+
/**
|
|
3538
|
+
* 批量签署入口链接
|
|
3539
|
+
*/
|
|
3540
|
+
SignUrl?: string
|
|
3541
|
+
/**
|
|
3542
|
+
* 链接过期时间戳
|
|
3543
|
+
*/
|
|
3544
|
+
ExpiredTime?: number
|
|
3545
|
+
/**
|
|
3546
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3547
|
+
*/
|
|
3548
|
+
RequestId?: string
|
|
3549
|
+
}
|
|
3550
|
+
|
|
3368
3551
|
/**
|
|
3369
3552
|
* DescribeIntegrationMainOrganizationUser返回参数结构体
|
|
3370
3553
|
*/
|
|
@@ -3461,6 +3644,26 @@ export interface ApproverRestriction {
|
|
|
3461
3644
|
IdCardNumber?: string
|
|
3462
3645
|
}
|
|
3463
3646
|
|
|
3647
|
+
/**
|
|
3648
|
+
* CreateWebThemeConfig请求参数结构体
|
|
3649
|
+
*/
|
|
3650
|
+
export interface CreateWebThemeConfigRequest {
|
|
3651
|
+
/**
|
|
3652
|
+
* 操作人信息
|
|
3653
|
+
*/
|
|
3654
|
+
Operator: UserInfo
|
|
3655
|
+
/**
|
|
3656
|
+
* 主题类型
|
|
3657
|
+
<br/>EMBED_WEB_THEME:嵌入式主题
|
|
3658
|
+
<br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
|
|
3659
|
+
*/
|
|
3660
|
+
ThemeType: string
|
|
3661
|
+
/**
|
|
3662
|
+
* 主题配置
|
|
3663
|
+
*/
|
|
3664
|
+
WebThemeConfig: WebThemeConfig
|
|
3665
|
+
}
|
|
3666
|
+
|
|
3464
3667
|
/**
|
|
3465
3668
|
* DeleteSealPolicies请求参数结构体
|
|
3466
3669
|
*/
|
|
@@ -3488,107 +3691,33 @@ export interface DeleteSealPoliciesRequest {
|
|
|
3488
3691
|
}
|
|
3489
3692
|
|
|
3490
3693
|
/**
|
|
3491
|
-
*
|
|
3694
|
+
* CreateOrganizationBatchSignUrl请求参数结构体
|
|
3492
3695
|
*/
|
|
3493
|
-
export interface
|
|
3696
|
+
export interface CreateOrganizationBatchSignUrlRequest {
|
|
3494
3697
|
/**
|
|
3495
|
-
* 调用方用户信息,
|
|
3698
|
+
* 调用方用户信息,UserId 必填,支持填入集团子公司经办人UserId。
|
|
3496
3699
|
*/
|
|
3497
3700
|
Operator: UserInfo
|
|
3498
3701
|
/**
|
|
3499
|
-
*
|
|
3500
|
-
*/
|
|
3501
|
-
FlowName: string
|
|
3502
|
-
/**
|
|
3503
|
-
* 签署参与者信息,最大限制50方
|
|
3504
|
-
*/
|
|
3505
|
-
Approvers: Array<ApproverInfo>
|
|
3506
|
-
/**
|
|
3507
|
-
* 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
|
|
3508
|
-
*/
|
|
3509
|
-
FileIds: Array<string>
|
|
3510
|
-
/**
|
|
3511
|
-
* 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
|
3512
|
-
*/
|
|
3513
|
-
FlowType?: string
|
|
3514
|
-
/**
|
|
3515
|
-
* 经办人内容控件配置
|
|
3516
|
-
*/
|
|
3517
|
-
Components?: Array<Component>
|
|
3518
|
-
/**
|
|
3519
|
-
* 被抄送人的信息列表。
|
|
3520
|
-
注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
|
3521
|
-
*/
|
|
3522
|
-
CcInfos?: Array<CcInfo>
|
|
3523
|
-
/**
|
|
3524
|
-
* 是否需要预览,true:预览模式,false:非预览(默认);
|
|
3525
|
-
预览链接有效期300秒;
|
|
3526
|
-
|
|
3527
|
-
注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl。
|
|
3528
|
-
*/
|
|
3529
|
-
NeedPreview?: boolean
|
|
3530
|
-
/**
|
|
3531
|
-
* 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
|
|
3532
|
-
*/
|
|
3533
|
-
PreviewType?: number
|
|
3534
|
-
/**
|
|
3535
|
-
* 签署流程的签署截止时间。
|
|
3536
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
3537
|
-
*/
|
|
3538
|
-
Deadline?: number
|
|
3539
|
-
/**
|
|
3540
|
-
* 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
|
|
3541
|
-
*/
|
|
3542
|
-
RemindedOn?: number
|
|
3543
|
-
/**
|
|
3544
|
-
* 发送类型:
|
|
3545
|
-
true:无序签
|
|
3546
|
-
false:有序签
|
|
3547
|
-
注:默认为false(有序签)
|
|
3548
|
-
*/
|
|
3549
|
-
Unordered?: boolean
|
|
3550
|
-
/**
|
|
3551
|
-
* 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
|
3552
|
-
*/
|
|
3553
|
-
CustomShowMap?: string
|
|
3554
|
-
/**
|
|
3555
|
-
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
3556
|
-
若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
3557
|
-
|
|
3558
|
-
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
3559
|
-
*/
|
|
3560
|
-
NeedSignReview?: boolean
|
|
3561
|
-
/**
|
|
3562
|
-
* 用户自定义字段,回调的时候会进行透传,长度需要小于20480
|
|
3702
|
+
* 指定需要进行批量签署的流程id,数量1-100,填写后用户将通过链接对这些合同进行批量签署。
|
|
3563
3703
|
*/
|
|
3564
|
-
|
|
3565
|
-
/**
|
|
3566
|
-
* 签署人校验方式
|
|
3567
|
-
VerifyCheck: 人脸识别(默认)
|
|
3568
|
-
MobileCheck:手机号验证
|
|
3569
|
-
参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
3570
|
-
*/
|
|
3571
|
-
ApproverVerifyType?: string
|
|
3572
|
-
/**
|
|
3573
|
-
* 签署流程描述,最大长度1000个字符
|
|
3574
|
-
*/
|
|
3575
|
-
FlowDescription?: string
|
|
3704
|
+
FlowIds: Array<string>
|
|
3576
3705
|
/**
|
|
3577
|
-
*
|
|
3706
|
+
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
|
|
3578
3707
|
*/
|
|
3579
|
-
|
|
3708
|
+
Agent?: Agent
|
|
3580
3709
|
/**
|
|
3581
|
-
*
|
|
3710
|
+
* 员工的UserId,该UserId对应的员工必须已经加入企业并实名,Name和Mobile为空时该字段不能为空。(优先使用UserId对应的员工)
|
|
3582
3711
|
*/
|
|
3583
|
-
|
|
3712
|
+
UserId?: string
|
|
3584
3713
|
/**
|
|
3585
|
-
*
|
|
3714
|
+
* 员工姓名,该字段需要与Mobile组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
|
|
3586
3715
|
*/
|
|
3587
|
-
|
|
3716
|
+
Name?: string
|
|
3588
3717
|
/**
|
|
3589
|
-
*
|
|
3718
|
+
* 员工手机号码,该字段需要与Name组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
|
|
3590
3719
|
*/
|
|
3591
|
-
|
|
3720
|
+
Mobile?: string
|
|
3592
3721
|
}
|
|
3593
3722
|
|
|
3594
3723
|
/**
|
|
@@ -3710,6 +3839,24 @@ export interface DeleteIntegrationDepartmentRequest {
|
|
|
3710
3839
|
ReceiveDeptId?: string
|
|
3711
3840
|
}
|
|
3712
3841
|
|
|
3842
|
+
/**
|
|
3843
|
+
* 页面主题配置
|
|
3844
|
+
*/
|
|
3845
|
+
export interface WebThemeConfig {
|
|
3846
|
+
/**
|
|
3847
|
+
* 是否页面底部显示电子签logo
|
|
3848
|
+
<br/>true:允许在页面底部隐藏电子签logo
|
|
3849
|
+
<br/>false:不允许允许在页面底部隐藏电子签logo
|
|
3850
|
+
<br/>默认false,不隐藏logo
|
|
3851
|
+
*/
|
|
3852
|
+
DisplaySignBrandLogo?: boolean
|
|
3853
|
+
/**
|
|
3854
|
+
* 主题颜色
|
|
3855
|
+
<br/>支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
|
|
3856
|
+
*/
|
|
3857
|
+
WebEmbedThemeColor?: string
|
|
3858
|
+
}
|
|
3859
|
+
|
|
3713
3860
|
/**
|
|
3714
3861
|
* ModifyApplicationCallbackInfo请求参数结构体
|
|
3715
3862
|
*/
|
|
@@ -3830,6 +3977,10 @@ export interface CreatePrepareFlowRequest {
|
|
|
3830
3977
|
* 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
|
|
3831
3978
|
*/
|
|
3832
3979
|
IntelligentStatus?: string
|
|
3980
|
+
/**
|
|
3981
|
+
* 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
|
3982
|
+
*/
|
|
3983
|
+
Agent?: Agent
|
|
3833
3984
|
}
|
|
3834
3985
|
|
|
3835
3986
|
/**
|
|
@@ -3847,18 +3998,18 @@ export interface ApproverOption {
|
|
|
3847
3998
|
}
|
|
3848
3999
|
|
|
3849
4000
|
/**
|
|
3850
|
-
*
|
|
4001
|
+
* CreateEmbedWebUrl返回参数结构体
|
|
3851
4002
|
*/
|
|
3852
|
-
export interface
|
|
4003
|
+
export interface CreateEmbedWebUrlResponse {
|
|
3853
4004
|
/**
|
|
3854
|
-
*
|
|
4005
|
+
* 嵌入的web链接,有效期:5分钟
|
|
4006
|
+
EmbedType=PREVIEW_CC_FLOW,该url为h5链接
|
|
3855
4007
|
*/
|
|
3856
|
-
|
|
4008
|
+
WebUrl?: string
|
|
3857
4009
|
/**
|
|
3858
|
-
*
|
|
3859
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4010
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3860
4011
|
*/
|
|
3861
|
-
|
|
4012
|
+
RequestId?: string
|
|
3862
4013
|
}
|
|
3863
4014
|
|
|
3864
4015
|
/**
|
|
@@ -4804,6 +4955,21 @@ export interface FilledComponent {
|
|
|
4804
4955
|
ImageUrl?: string
|
|
4805
4956
|
}
|
|
4806
4957
|
|
|
4958
|
+
/**
|
|
4959
|
+
* 下载文件的URL信息
|
|
4960
|
+
*/
|
|
4961
|
+
export interface FileUrl {
|
|
4962
|
+
/**
|
|
4963
|
+
* 下载文件的URL,有效期为输入的UrlTtl,默认5分钟
|
|
4964
|
+
*/
|
|
4965
|
+
Url: string
|
|
4966
|
+
/**
|
|
4967
|
+
* 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
|
|
4968
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4969
|
+
*/
|
|
4970
|
+
Option: string
|
|
4971
|
+
}
|
|
4972
|
+
|
|
4807
4973
|
/**
|
|
4808
4974
|
* 流程信息摘要
|
|
4809
4975
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateChannelSubOrganizationModifyQrCodeRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateChannelSubOrganizationModifyQrCodeResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, DeleteSealPoliciesRequest,
|
|
2
|
+
import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateChannelSubOrganizationModifyQrCodeRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateChannelSubOrganizationModifyQrCodeResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
|
|
3
3
|
/**
|
|
4
4
|
* ess client
|
|
5
5
|
* @class
|
|
@@ -52,9 +52,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
52
52
|
*/
|
|
53
53
|
CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
|
|
56
56
|
*/
|
|
57
|
-
|
|
57
|
+
CreateEmbedWebUrl(req: CreateEmbedWebUrlRequest, cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void): Promise<CreateEmbedWebUrlResponse>;
|
|
58
58
|
/**
|
|
59
59
|
* 对流程的合同文件进行验证,判断文件是否合法。
|
|
60
60
|
*/
|
|
@@ -241,9 +241,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
241
241
|
*/
|
|
242
242
|
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
243
243
|
/**
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
244
|
+
* 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
|
|
245
|
+
如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
|
|
246
|
+
*/
|
|
247
|
+
CreateOrganizationBatchSignUrl(req: CreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: CreateOrganizationBatchSignUrlResponse) => void): Promise<CreateOrganizationBatchSignUrlResponse>;
|
|
247
248
|
/**
|
|
248
249
|
* 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
|
|
249
250
|
注意:
|
|
@@ -253,13 +254,23 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
253
254
|
*/
|
|
254
255
|
CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
|
|
255
256
|
/**
|
|
256
|
-
*
|
|
257
|
+
* 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
|
|
257
258
|
*/
|
|
259
|
+
DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
|
|
260
|
+
/**
|
|
261
|
+
* 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
|
|
262
|
+
|
|
263
|
+
通过子企业影子账号查询主企业员工账号
|
|
264
|
+
*/
|
|
258
265
|
DescribeIntegrationMainOrganizationUser(req: DescribeIntegrationMainOrganizationUserRequest, cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void): Promise<DescribeIntegrationMainOrganizationUserResponse>;
|
|
259
266
|
/**
|
|
260
267
|
* 通过AuthCode查询用户是否实名
|
|
261
268
|
*/
|
|
262
269
|
DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
|
|
270
|
+
/**
|
|
271
|
+
* 用来创建页面主题配置
|
|
272
|
+
*/
|
|
273
|
+
CreateWebThemeConfig(req: CreateWebThemeConfigRequest, cb?: (error: string, rep: CreateWebThemeConfigResponse) => void): Promise<CreateWebThemeConfigResponse>;
|
|
263
274
|
/**
|
|
264
275
|
* 查询企业印章的列表,需要操作者具有查询印章权限
|
|
265
276
|
客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
|
|
@@ -297,6 +308,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
297
308
|
此接口合同组中的子合同必须都是文件发起的合同
|
|
298
309
|
*/
|
|
299
310
|
CreateFlowGroupByFiles(req: CreateFlowGroupByFilesRequest, cb?: (error: string, rep: CreateFlowGroupByFilesResponse) => void): Promise<CreateFlowGroupByFilesResponse>;
|
|
311
|
+
/**
|
|
312
|
+
* 此API接口用户查询加入集团的成员企业
|
|
313
|
+
*/
|
|
314
|
+
DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
|
|
300
315
|
/**
|
|
301
316
|
* 创建员工,此接口会发送提醒员工实名的短信
|
|
302
317
|
*/
|
|
@@ -91,10 +91,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
91
91
|
return this.request("CreateSealPolicy", req, cb);
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
|
|
95
95
|
*/
|
|
96
|
-
async
|
|
97
|
-
return this.request("
|
|
96
|
+
async CreateEmbedWebUrl(req, cb) {
|
|
97
|
+
return this.request("CreateEmbedWebUrl", req, cb);
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
100
|
* 对流程的合同文件进行验证,判断文件是否合法。
|
|
@@ -350,10 +350,11 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
350
350
|
return this.request("UploadFiles", req, cb);
|
|
351
351
|
}
|
|
352
352
|
/**
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
353
|
+
* 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
|
|
354
|
+
如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
|
|
355
|
+
*/
|
|
356
|
+
async CreateOrganizationBatchSignUrl(req, cb) {
|
|
357
|
+
return this.request("CreateOrganizationBatchSignUrl", req, cb);
|
|
357
358
|
}
|
|
358
359
|
/**
|
|
359
360
|
* 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
|
|
@@ -366,8 +367,16 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
366
367
|
return this.request("CreateFlowReminds", req, cb);
|
|
367
368
|
}
|
|
368
369
|
/**
|
|
369
|
-
*
|
|
370
|
+
* 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
|
|
370
371
|
*/
|
|
372
|
+
async DescribeFlowComponents(req, cb) {
|
|
373
|
+
return this.request("DescribeFlowComponents", req, cb);
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
|
|
377
|
+
|
|
378
|
+
通过子企业影子账号查询主企业员工账号
|
|
379
|
+
*/
|
|
371
380
|
async DescribeIntegrationMainOrganizationUser(req, cb) {
|
|
372
381
|
return this.request("DescribeIntegrationMainOrganizationUser", req, cb);
|
|
373
382
|
}
|
|
@@ -377,6 +386,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
377
386
|
async DescribeThirdPartyAuthCode(req, cb) {
|
|
378
387
|
return this.request("DescribeThirdPartyAuthCode", req, cb);
|
|
379
388
|
}
|
|
389
|
+
/**
|
|
390
|
+
* 用来创建页面主题配置
|
|
391
|
+
*/
|
|
392
|
+
async CreateWebThemeConfig(req, cb) {
|
|
393
|
+
return this.request("CreateWebThemeConfig", req, cb);
|
|
394
|
+
}
|
|
380
395
|
/**
|
|
381
396
|
* 查询企业印章的列表,需要操作者具有查询印章权限
|
|
382
397
|
客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
|
|
@@ -426,6 +441,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
426
441
|
async CreateFlowGroupByFiles(req, cb) {
|
|
427
442
|
return this.request("CreateFlowGroupByFiles", req, cb);
|
|
428
443
|
}
|
|
444
|
+
/**
|
|
445
|
+
* 此API接口用户查询加入集团的成员企业
|
|
446
|
+
*/
|
|
447
|
+
async DescribeOrganizationGroupOrganizations(req, cb) {
|
|
448
|
+
return this.request("DescribeOrganizationGroupOrganizations", req, cb);
|
|
449
|
+
}
|
|
429
450
|
/**
|
|
430
451
|
* 创建员工,此接口会发送提醒员工实名的短信
|
|
431
452
|
*/
|