tencentcloud-sdk-nodejs-ess 4.0.723 → 4.0.724

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.
@@ -18,6 +18,7 @@
18
18
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
19
19
  import {
20
20
  DescribePersonCertificateResponse,
21
+ BillUsageDetail,
21
22
  CreateSealRequest,
22
23
  ModifyIntegrationDepartmentResponse,
23
24
  CancelFlowResponse,
@@ -79,6 +80,7 @@ import {
79
80
  BindEmployeeUserIdWithClientOpenIdRequest,
80
81
  CreateOrganizationInfoChangeUrlResponse,
81
82
  Permission,
83
+ DescribeFlowBriefsResponse,
82
84
  Staff,
83
85
  ComponentLimit,
84
86
  CreateIntegrationDepartmentResponse,
@@ -103,7 +105,7 @@ import {
103
105
  CreateFlowSignReviewRequest,
104
106
  UnbindEmployeeUserIdWithClientOpenIdRequest,
105
107
  CreateSchemeUrlResponse,
106
- CreateUserAutoSignEnableUrlResponse,
108
+ CreateFlowByFilesRequest,
107
109
  FlowGroupInfo,
108
110
  CreateFlowSignUrlResponse,
109
111
  RegisterInfo,
@@ -137,7 +139,6 @@ import {
137
139
  CreateIntegrationEmployeesResponse,
138
140
  FillError,
139
141
  DeleteIntegrationRoleUsersRequest,
140
- CreateFlowByFilesRequest,
141
142
  CreateFlowSignUrlRequest,
142
143
  CreateReleaseFlowRequest,
143
144
  CreateIntegrationUserRolesRequest,
@@ -191,10 +192,12 @@ import {
191
192
  UpdateIntegrationEmployeesRequest,
192
193
  DescribeFlowBriefsRequest,
193
194
  CreateFlowGroupByTemplatesRequest,
195
+ DescribeBillUsageDetailResponse,
196
+ CreateUserAutoSignEnableUrlResponse,
194
197
  SignUrl,
195
198
  VerifyPdfResponse,
196
199
  DeleteStaffsResult,
197
- DescribeFlowBriefsResponse,
200
+ DescribeBillUsageDetailRequest,
198
201
  Admin,
199
202
  Caller,
200
203
  DescribeFlowTemplatesResponse,
@@ -1119,6 +1122,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1119
1122
  return this.request("CancelUserAutoSignEnableUrl", req, cb)
1120
1123
  }
1121
1124
 
1125
+ /**
1126
+ * 查询企业使用情况
1127
+ */
1128
+ async DescribeBillUsageDetail(
1129
+ req: DescribeBillUsageDetailRequest,
1130
+ cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void
1131
+ ): Promise<DescribeBillUsageDetailResponse> {
1132
+ return this.request("DescribeBillUsageDetail", req, cb)
1133
+ }
1134
+
1122
1135
  /**
1123
1136
  * 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
1124
1137
  */
@@ -29,6 +29,70 @@ export interface DescribePersonCertificateResponse {
29
29
  RequestId?: string
30
30
  }
31
31
 
32
+ /**
33
+ * 用户计费使用情况详情
34
+ */
35
+ export interface BillUsageDetail {
36
+ /**
37
+ * 合同流程ID,为32位字符串。
38
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
39
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
40
+ 注意:此字段可能返回 null,表示取不到有效值。
41
+ */
42
+ FlowId?: string
43
+ /**
44
+ * 经办人名称
45
+ 注意:此字段可能返回 null,表示取不到有效值。
46
+ */
47
+ OperatorName?: string
48
+ /**
49
+ * 发起方组织机构名称
50
+ 注意:此字段可能返回 null,表示取不到有效值。
51
+ */
52
+ CreateOrganizationName?: string
53
+ /**
54
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
55
+ 该名称还将用于合同签署完成后的下载文件名。
56
+ 注意:此字段可能返回 null,表示取不到有效值。
57
+ */
58
+ FlowName?: string
59
+ /**
60
+ * 0 还没有发起 1等待签署 2部分签署 3拒签 4已签署 5已过期 6已撤销 7还没有预发起 8等待填写 9部分填写 10拒填 11已解除
61
+ 注意:此字段可能返回 null,表示取不到有效值。
62
+ */
63
+ Status?: number
64
+ /**
65
+ * 套餐类型
66
+ 注意:此字段可能返回 null,表示取不到有效值。
67
+ */
68
+ QuotaType?: string
69
+ /**
70
+ * 合同使用量
71
+ 注意:此字段可能返回 null,表示取不到有效值。
72
+ */
73
+ UseCount?: number
74
+ /**
75
+ * 消耗的时间戳
76
+ 注意:此字段可能返回 null,表示取不到有效值。
77
+ */
78
+ CostTime?: number
79
+ /**
80
+ * 套餐名称
81
+ 注意:此字段可能返回 null,表示取不到有效值。
82
+ */
83
+ QuotaName?: string
84
+ /**
85
+ * 消耗类型 1.扣费 2.撤销返还
86
+ 注意:此字段可能返回 null,表示取不到有效值。
87
+ */
88
+ CostType?: number
89
+ /**
90
+ * 备注
91
+ 注意:此字段可能返回 null,表示取不到有效值。
92
+ */
93
+ Remark?: string
94
+ }
95
+
32
96
  /**
33
97
  * CreateSeal请求参数结构体
34
98
  */
@@ -60,7 +124,7 @@ export interface CreateSealRequest {
60
124
  * 电子印章类型 , 可选类型如下:
61
125
  <ul><li>**OFFICIAL**: (默认)公章</li>
62
126
  <li>**CONTRACT**: 合同专用章;</li>
63
- <li>**FINANCE**: 合财务专用章;</li>
127
+ <li>**FINANCE**: 财务专用章;</li>
64
128
  <li>**PERSONNEL**: 人事专用章</li>
65
129
  </ul>
66
130
  注: `同企业下只能有一个公章, 重复创建会报错`
@@ -1485,6 +1549,7 @@ export interface DescribeIntegrationEmployeesRequest {
1485
1549
  <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
1486
1550
  <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
1487
1551
  <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
1552
+ <li>Key:**"RoleId"**,根据电子签角色ID查询员工,Values为指定的角色ID,满足其中任意一个角色即可:**["RoleId1","RoleId2",...]**</li>
1488
1553
  </ul>
1489
1554
  */
1490
1555
  Filters?: Array<Filter>
@@ -1931,6 +1996,21 @@ export interface Permission {
1931
1996
  Children?: Array<Permission>
1932
1997
  }
1933
1998
 
1999
+ /**
2000
+ * DescribeFlowBriefs返回参数结构体
2001
+ */
2002
+ export interface DescribeFlowBriefsResponse {
2003
+ /**
2004
+ * 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
2005
+ 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
2006
+ */
2007
+ FlowBriefs?: Array<FlowBrief>
2008
+ /**
2009
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2010
+ */
2011
+ RequestId?: string
2012
+ }
2013
+
1934
2014
  /**
1935
2015
  * 企业员工信息。
1936
2016
  */
@@ -2711,47 +2791,151 @@ export interface CreateSchemeUrlResponse {
2711
2791
  }
2712
2792
 
2713
2793
  /**
2714
- * CreateUserAutoSignEnableUrl返回参数结构体
2794
+ * CreateFlowByFiles请求参数结构体
2715
2795
  */
2716
- export interface CreateUserAutoSignEnableUrlResponse {
2796
+ export interface CreateFlowByFilesRequest {
2717
2797
  /**
2718
- * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
2798
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
2799
+ 支持填入集团子公司经办人 userId 代发合同。
2800
+
2801
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2719
2802
  */
2720
- Url?: string
2803
+ Operator: UserInfo
2721
2804
  /**
2722
- * 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2805
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
2723
2806
 
2724
- 注: `如果获取的是H5链接, 则不会返回此值`
2807
+ 该名称还将用于合同签署完成后的下载文件名。
2725
2808
  */
2726
- AppId?: string
2809
+ FlowName: string
2727
2810
  /**
2728
- * 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2811
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
2729
2812
 
2730
- 注: `如果获取的是H5链接, 则不会返回此值`
2813
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
2731
2814
  */
2732
- AppOriginalId?: string
2815
+ Approvers: Array<ApproverInfo>
2733
2816
  /**
2734
- * 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2817
+ * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
2735
2818
 
2736
- 注: `如果获取的是H5链接, 则不会返回此值`
2819
+ 注: `目前,此接口仅支持单个文件发起。`
2737
2820
  */
2738
- Path?: string
2821
+ FileIds: Array<string>
2739
2822
  /**
2740
- * base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
2823
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
2824
+ */
2825
+ FlowDescription?: string
2826
+ /**
2827
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
2828
+ */
2829
+ FlowType?: string
2830
+ /**
2831
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
2832
+ <ul><li> 单行文本控件 </li>
2833
+ <li> 多行文本控件 </li>
2834
+ <li> 勾选框控件 </li>
2835
+ <li> 数字控件 </li>
2836
+ <li> 图片控件 </li>
2837
+ <li> 动态表格等填写控件</li></ul>
2838
+ */
2839
+ Components?: Array<Component>
2840
+ /**
2841
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
2741
2842
 
2742
- 注: `如果获取的是H5链接, 则不会返回此二维码图片`
2743
2843
  */
2744
- QrCode?: string
2844
+ CcInfos?: Array<CcInfo>
2745
2845
  /**
2746
- * 返回的链接类型
2747
- <ul><li> 空: 默认小程序端链接</li>
2748
- <li> **H5SIGN** : h5端链接</li></ul>
2846
+ * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
2847
+ <ul><li> **0**:合同发起时通知(默认值)</li>
2848
+ <li> **1**:签署完成后通知</li></ul>
2749
2849
  */
2750
- UrlType?: string
2850
+ CcNotifyType?: number
2751
2851
  /**
2752
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2852
+ * 是否为预览模式,取值如下:
2853
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
2854
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
2753
2855
  */
2754
- RequestId?: string
2856
+ NeedPreview?: boolean
2857
+ /**
2858
+ * 预览模式下产生的预览链接类型
2859
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
2860
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
2861
+ 注: `此参数在NeedPreview 为true时有效`
2862
+
2863
+ */
2864
+ PreviewType?: number
2865
+ /**
2866
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
2867
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
2868
+ */
2869
+ Deadline?: number
2870
+ /**
2871
+ * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
2872
+
2873
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
2874
+ */
2875
+ RemindedOn?: number
2876
+ /**
2877
+ * 合同流程的签署顺序类型:
2878
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2879
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2880
+ */
2881
+ Unordered?: boolean
2882
+ /**
2883
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
2884
+ <ul><li>{合同名称} </li>
2885
+ <li>{发起方企业} </li>
2886
+ <li>{发起方姓名} </li>
2887
+ <li>{签署方N企业}</li>
2888
+ <li>{签署方N姓名}</li></ul>
2889
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
2890
+
2891
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
2892
+
2893
+ 合同名称:租房合同
2894
+ 发起方:腾讯公司(张三)
2895
+ 签署方:李四
2896
+
2897
+
2898
+ */
2899
+ CustomShowMap?: string
2900
+ /**
2901
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2902
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
2903
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2904
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2905
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2906
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2907
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2908
+ */
2909
+ NeedSignReview?: boolean
2910
+ /**
2911
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
2912
+
2913
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
2914
+ */
2915
+ UserData?: string
2916
+ /**
2917
+ * 指定个人签署方查看合同的校验方式
2918
+ <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
2919
+ <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
2920
+ */
2921
+ ApproverVerifyType?: string
2922
+ /**
2923
+ * 签署方签署控件(印章/签名等)的生成方式:
2924
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
2925
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
2926
+ */
2927
+ SignBeanTag?: number
2928
+ /**
2929
+ * 代理企业和员工的信息。
2930
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2931
+ */
2932
+ Agent?: Agent
2933
+ /**
2934
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
2935
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
2936
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
2937
+ */
2938
+ AutoSignScene?: string
2755
2939
  }
2756
2940
 
2757
2941
  /**
@@ -4092,154 +4276,6 @@ export interface DeleteIntegrationRoleUsersRequest {
4092
4276
  Agent?: Agent
4093
4277
  }
4094
4278
 
4095
- /**
4096
- * CreateFlowByFiles请求参数结构体
4097
- */
4098
- export interface CreateFlowByFilesRequest {
4099
- /**
4100
- * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
4101
- 支持填入集团子公司经办人 userId 代发合同。
4102
-
4103
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4104
- */
4105
- Operator: UserInfo
4106
- /**
4107
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
4108
-
4109
- 该名称还将用于合同签署完成后的下载文件名。
4110
- */
4111
- FlowName: string
4112
- /**
4113
- * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
4114
-
4115
- 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
4116
- */
4117
- Approvers: Array<ApproverInfo>
4118
- /**
4119
- * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
4120
-
4121
- 注: `目前,此接口仅支持单个文件发起。`
4122
- */
4123
- FileIds: Array<string>
4124
- /**
4125
- * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
4126
- */
4127
- FlowDescription?: string
4128
- /**
4129
- * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
4130
- */
4131
- FlowType?: string
4132
- /**
4133
- * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
4134
- <ul><li> 单行文本控件 </li>
4135
- <li> 多行文本控件 </li>
4136
- <li> 勾选框控件 </li>
4137
- <li> 数字控件 </li>
4138
- <li> 图片控件 </li>
4139
- <li> 动态表格等填写控件</li></ul>
4140
- */
4141
- Components?: Array<Component>
4142
- /**
4143
- * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
4144
-
4145
- */
4146
- CcInfos?: Array<CcInfo>
4147
- /**
4148
- * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
4149
- <ul><li> **0**:合同发起时通知(默认值)</li>
4150
- <li> **1**:签署完成后通知</li></ul>
4151
- */
4152
- CcNotifyType?: number
4153
- /**
4154
- * 是否为预览模式,取值如下:
4155
- <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
4156
- <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
4157
- */
4158
- NeedPreview?: boolean
4159
- /**
4160
- * 预览模式下产生的预览链接类型
4161
- <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
4162
- <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
4163
- 注: `此参数在NeedPreview 为true时有效`
4164
-
4165
- */
4166
- PreviewType?: number
4167
- /**
4168
- * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
4169
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
4170
- */
4171
- Deadline?: number
4172
- /**
4173
- * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
4174
-
4175
- 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
4176
- */
4177
- RemindedOn?: number
4178
- /**
4179
- * 合同流程的签署顺序类型:
4180
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
4181
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
4182
- */
4183
- Unordered?: boolean
4184
- /**
4185
- * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
4186
- <ul><li>{合同名称} </li>
4187
- <li>{发起方企业} </li>
4188
- <li>{发起方姓名} </li>
4189
- <li>{签署方N企业}</li>
4190
- <li>{签署方N姓名}</li></ul>
4191
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
4192
-
4193
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
4194
-
4195
- 合同名称:租房合同
4196
- 发起方:腾讯公司(张三)
4197
- 签署方:李四
4198
-
4199
-
4200
- */
4201
- CustomShowMap?: string
4202
- /**
4203
- * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
4204
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
4205
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
4206
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
4207
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
4208
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
4209
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4210
- */
4211
- NeedSignReview?: boolean
4212
- /**
4213
- * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
4214
-
4215
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4216
- */
4217
- UserData?: string
4218
- /**
4219
- * 指定个人签署方查看合同的校验方式
4220
- <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
4221
- <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
4222
- */
4223
- ApproverVerifyType?: string
4224
- /**
4225
- * 签署方签署控件(印章/签名等)的生成方式:
4226
- <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
4227
- <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
4228
- */
4229
- SignBeanTag?: number
4230
- /**
4231
- * 代理企业和员工的信息。
4232
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4233
- */
4234
- Agent?: Agent
4235
- /**
4236
- * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
4237
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
4238
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
4239
- */
4240
- AutoSignScene?: string
4241
- }
4242
-
4243
4279
  /**
4244
4280
  * CreateFlowSignUrl请求参数结构体
4245
4281
  */
@@ -6221,6 +6257,68 @@ export interface CreateFlowGroupByTemplatesRequest {
6221
6257
  FlowGroupOptions?: FlowGroupOptions
6222
6258
  }
6223
6259
 
6260
+ /**
6261
+ * DescribeBillUsageDetail返回参数结构体
6262
+ */
6263
+ export interface DescribeBillUsageDetailResponse {
6264
+ /**
6265
+ * 总数
6266
+ */
6267
+ Total?: number
6268
+ /**
6269
+ * 消耗详情
6270
+ */
6271
+ Details?: Array<BillUsageDetail>
6272
+ /**
6273
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6274
+ */
6275
+ RequestId?: string
6276
+ }
6277
+
6278
+ /**
6279
+ * CreateUserAutoSignEnableUrl返回参数结构体
6280
+ */
6281
+ export interface CreateUserAutoSignEnableUrlResponse {
6282
+ /**
6283
+ * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
6284
+ */
6285
+ Url?: string
6286
+ /**
6287
+ * 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
6288
+
6289
+ 注: `如果获取的是H5链接, 则不会返回此值`
6290
+ */
6291
+ AppId?: string
6292
+ /**
6293
+ * 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
6294
+
6295
+ 注: `如果获取的是H5链接, 则不会返回此值`
6296
+ */
6297
+ AppOriginalId?: string
6298
+ /**
6299
+ * 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
6300
+
6301
+ 注: `如果获取的是H5链接, 则不会返回此值`
6302
+ */
6303
+ Path?: string
6304
+ /**
6305
+ * base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
6306
+
6307
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
6308
+ */
6309
+ QrCode?: string
6310
+ /**
6311
+ * 返回的链接类型
6312
+ <ul><li> 空: 默认小程序端链接</li>
6313
+ <li> **H5SIGN** : h5端链接</li></ul>
6314
+ */
6315
+ UrlType?: string
6316
+ /**
6317
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6318
+ */
6319
+ RequestId?: string
6320
+ }
6321
+
6224
6322
  /**
6225
6323
  * 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
6226
6324
  通过链接,用户可直接访问电子签名小程序并签署合同。
@@ -6296,18 +6394,49 @@ export interface DeleteStaffsResult {
6296
6394
  }
6297
6395
 
6298
6396
  /**
6299
- * DescribeFlowBriefs返回参数结构体
6397
+ * DescribeBillUsageDetail请求参数结构体
6300
6398
  */
6301
- export interface DescribeFlowBriefsResponse {
6399
+ export interface DescribeBillUsageDetailRequest {
6302
6400
  /**
6303
- * 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
6304
- 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
6401
+ * 查询开始时间,时间跨度不能大于31天
6305
6402
  */
6306
- FlowBriefs?: Array<FlowBrief>
6403
+ StartTime: string
6307
6404
  /**
6308
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6405
+ * 查询结束时间,时间跨度不能大于31天
6309
6406
  */
6310
- RequestId?: string
6407
+ EndTime: string
6408
+ /**
6409
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
6410
+ */
6411
+ Offset: number
6412
+ /**
6413
+ * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
6414
+ */
6415
+ Limit?: number
6416
+ /**
6417
+ * 查询的套餐类型 (选填 )不传则查询所有套餐;
6418
+ 对应关系如下
6419
+ CloudEnterprise-企业版合同
6420
+ SingleSignature-单方签章
6421
+ CloudProve-签署报告
6422
+ CloudOnlineSign-腾讯会议在线签约
6423
+ ChannelWeCard-微工卡
6424
+ SignFlow-合同套餐
6425
+ SignFace-签署意愿(人脸识别)
6426
+ SignPassword-签署意愿(密码)
6427
+ SignSMS-签署意愿(短信)
6428
+ PersonalEssAuth-签署人实名(腾讯电子签认证)
6429
+ PersonalThirdAuth-签署人实名(信任第三方认证)
6430
+ OrgEssAuth-签署企业实名
6431
+ FlowNotify-短信通知
6432
+ AuthService-企业工商信息查询
6433
+ */
6434
+ QuotaType?: string
6435
+ /**
6436
+ * 非必填,查询某个渠道企业的消耗情况。
6437
+ 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6438
+ */
6439
+ Agent?: Agent
6311
6440
  }
6312
6441
 
6313
6442
  /**
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
2
+ import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeFlowBriefsResponse, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, VerifyPdfResponse, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
3
  /**
4
4
  * ess client
5
5
  * @class
@@ -536,6 +536,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
536
536
  <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li></ul>
537
537
  */
538
538
  CancelUserAutoSignEnableUrl(req: CancelUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CancelUserAutoSignEnableUrlResponse) => void): Promise<CancelUserAutoSignEnableUrlResponse>;
539
+ /**
540
+ * 查询企业使用情况
541
+ */
542
+ DescribeBillUsageDetail(req: DescribeBillUsageDetailRequest, cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void): Promise<DescribeBillUsageDetailResponse>;
539
543
  /**
540
544
  * 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
541
545
  */
@@ -677,6 +677,12 @@ class Client extends TencentCloudCommon.AbstractClient {
677
677
  async CancelUserAutoSignEnableUrl(req, cb) {
678
678
  return this.request("CancelUserAutoSignEnableUrl", req, cb);
679
679
  }
680
+ /**
681
+ * 查询企业使用情况
682
+ */
683
+ async DescribeBillUsageDetail(req, cb) {
684
+ return this.request("DescribeBillUsageDetail", req, cb);
685
+ }
680
686
  /**
681
687
  * 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
682
688
  */