tencentcloud-sdk-ess 3.0.638 → 3.0.639

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bdde2b3c56c3fffcf140370488d2979d29f4f96f
4
- data.tar.gz: ef6f6ef6c90e0719b05548d826f66d746f2afbd3
3
+ metadata.gz: d1048d1b8079483db8064cb3806ddd48e6c79ca6
4
+ data.tar.gz: 616c8eddc1efecc40261658b0d3b231b55d73cad
5
5
  SHA512:
6
- metadata.gz: 07951ac097744f7563d16e8b061f457eb3de99b7b5f025f206248d66c616f33647af2b57d57ba2603980c65af5ba47276eeebc37ce561fe7e7264662b8711ed6
7
- data.tar.gz: 13300779e58e694df608e784a7694cc7546d1b50dfb8d35d80f8a35d4e9bb30419890c93ff514d37096fe039832e11ecfd32f5c3b43b460f2623231299090d19
6
+ metadata.gz: cdb4a7288442c961e49a1a319b2bcf4e906bf4bed1d16135f6877db24218077a5aedcf5cd6af0710b385695bb62f93ee68b0bff3fc040c484b0a9e01aba3b031
7
+ data.tar.gz: c862ceccd1cca01cc2988ce8d9cbb8cdccd472a2b3b1f22e5587c2b7836e5360f12c55c2a0cfa8fdbc8daa83167ebb28a99a95d23713d5f0304698b0deda82a6
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.638
1
+ 3.0.639
@@ -1035,7 +1035,6 @@ module TencentCloud
1035
1035
  end
1036
1036
 
1037
1037
  # 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
1038
- # 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
1039
1038
 
1040
1039
  # @param request: Request instance for DescribeFlowComponents.
1041
1040
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsRequest`
@@ -77,56 +77,53 @@ module TencentCloud
77
77
  # 参与者信息
78
78
  class ApproverInfo < TencentCloud::Common::AbstractModel
79
79
  # @param ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
80
- # 0:企业
81
- # 1:个人
82
- # 3:企业静默签署
83
- # 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
84
- # 7: 个人自动签署,适用于个人自动签场景。
85
- # 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
80
+ # **0**:企业
81
+ # **1**:个人
82
+ # **3**:企业静默签署
83
+ # 注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
84
+ # **7**: 个人自动签署,适用于个人自动签场景。
85
+ # 注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
86
86
  # @type ApproverType: Integer
87
87
  # @param ApproverName: 签署方经办人的姓名。
88
88
  # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
89
89
  # @type ApproverName: String
90
90
  # @param ApproverMobile: 本企业的签署方经办人的员工UserId
91
-
92
91
  # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
93
92
 
94
- # 注: 若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。
93
+ # 注: `若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。`
95
94
  # @type ApproverMobile: String
96
95
  # @param OrganizationName: 组织机构名称。
97
96
  # 如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
98
97
 
99
- # 注: 请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。
98
+ # 注: `请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。`
100
99
  # @type OrganizationName: String
101
100
  # @param SignComponents: 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
102
- # - 个人签名/印章
103
- # - 企业印章
104
- # - 骑缝章等签署控件
101
+ # <ul><li> 个人签名/印章</li>
102
+ # <li> 企业印章</li>
103
+ # <li> 骑缝章等签署控件</li><ul>
105
104
  # @type SignComponents: Array
106
105
  # @param ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
107
- # - ID_CARD 居民身份证 (默认值)
108
- # - HONGKONG_AND_MACAO 港澳居民来往内地通行证
109
- # - HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
110
- # - OTHER_CARD_TYPE 其他证件
106
+ # <ul><li>ID_CARD 居民身份证 (默认值)</li>
107
+ # <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
108
+ # <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
109
+ # <li>OTHER_CARD_TYPE 其他证件</li></ul>
111
110
 
112
- # 注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
111
+ # 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
113
112
  # @type ApproverIdCardType: String
114
113
  # @param ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
115
- # - 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
116
- # - 港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。
117
- # - 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
114
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
115
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
116
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
118
117
  # @type ApproverIdCardNumber: String
119
118
  # @param NotifyType: 通知签署方经办人的方式, 有以下途径:
120
-
121
- # - sms: (默认)短信
122
- # - none: 不通知
119
+ # <ul><li> **sms** : (默认)短信</li>
120
+ # <li> **none** : 不通知</li></ul>
123
121
  # @type NotifyType: String
124
- # @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下类型:
125
- # - 1:收款人
126
- # - 2:开具人
127
- # - 3:见证人
128
-
129
- # 注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
122
+ # @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下****类型****:
123
+ # <ul><li> **1** :收款人</li>
124
+ # <li> **2** :开具人</li>
125
+ # <li> **3** :见证人</li></ul>
126
+ # 注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
130
127
  # @type ApproverRole: Integer
131
128
  # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
132
129
 
@@ -135,16 +132,15 @@ module TencentCloud
135
132
  # @param PreReadTime: 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
136
133
 
137
134
  # 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
138
-
139
- # - 合同页数少于等于2页,阅读时间为3秒;
140
- # - 合同页数为3到5页,阅读时间为5秒;
141
- # - 合同页数大于等于6页,阅读时间为10秒。
135
+ # <ul><li>合同页数少于等于2页,阅读时间为3秒;</li>
136
+ # <li>合同页数为3到5页,阅读时间为5秒;</li>
137
+ # <li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
142
138
  # @type PreReadTime: Integer
143
139
  # @param UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
144
140
 
145
- # 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
141
+ # 注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
146
142
  # @type UserId: String
147
- # @param ApproverSource: 在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
143
+ # @param ApproverSource: 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
148
144
  # @type ApproverSource: String
149
145
  # @param CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
150
146
  # 所有参与或签的人员均需具备该标识。
@@ -155,37 +151,28 @@ module TencentCloud
155
151
  # 详细操作可以参考开发者中心的ApproverOption结构体。
156
152
  # @type ApproverOption: :class:`Tencentcloud::Ess.v20201111.models.ApproverOption`
157
153
  # @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
158
-
159
- # - 1 : (默认)人脸识别,人脸识别后才能合同内容
160
- # - 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
161
-
154
+ # <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
155
+ # <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
162
156
  # 注:
163
-
164
- # - 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
165
- # - 此字段不可传多个校验方式
157
+ # <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
158
+ # <li>此字段不可传多个校验方式</li></ul>
166
159
  # @type ApproverVerifyTypes: Array
167
160
  # @param ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
168
-
169
- # - 1:人脸认证,需进行人脸识别成功后才能签署合同;
170
- # - 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
171
- # - 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
172
-
161
+ # <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
162
+ # <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
163
+ # <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
173
164
  # 注:
174
-
175
- # - 默认情况下,认证校验方式为人脸认证和签署密码两种形式;
176
- # - 您可以传递多种值,表示可用多种认证校验方式。
165
+ # <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
166
+ # <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
177
167
  # @type ApproverSignTypes: Array
178
168
  # @param ApproverNeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
179
-
180
- # - false:(默认)不需要审批,直接签署。
181
- # - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
182
-
169
+ # <ul><li>**false**:(默认)不需要审批,直接签署。</li>
170
+ # <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
183
171
  # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
172
+ # <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
173
+ # <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
184
174
 
185
- # - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
186
- # - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
187
-
188
- # 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
175
+ # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
189
176
  # @type ApproverNeedSignReview: Boolean
190
177
 
191
178
  attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview
@@ -247,13 +234,13 @@ module TencentCloud
247
234
  class ApproverOption < TencentCloud::Common::AbstractModel
248
235
  # @param NoRefuse: 签署方是否可以拒签
249
236
 
250
- # - false: ( 默认)可以拒签
251
- # - true:不可以拒签
237
+ # <ul><li> **false** : ( 默认)可以拒签</li>
238
+ # <li> **true** :不可以拒签</li></ul>
252
239
  # @type NoRefuse: Boolean
253
240
  # @param NoTransfer: 签署方是否可以转他人处理
254
241
 
255
- # - false: ( 默认)可以转他人处理
256
- # - true:不可以转他人处理
242
+ # <ul><li> **false** : ( 默认)可以转他人处理</li>
243
+ # <li> **true** :不可以转他人处理</li></ul>
257
244
  # @type NoTransfer: Boolean
258
245
 
259
246
  attr_accessor :NoRefuse, :NoTransfer
@@ -640,19 +627,16 @@ module TencentCloud
640
627
  # 抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。
641
628
  # @type Name: String
642
629
  # @param CcType: 被抄送方类型, 可设置以下类型:
643
-
644
- # - 0:个人抄送方
645
- # - 1:企业员工抄送方
630
+ # <ul><li> **0** :个人抄送方</li>
631
+ # <li> **1** :企业员工抄送方</li></ul>
646
632
  # @type CcType: Integer
647
633
  # @param CcPermission: 被抄送方权限, 可设置如下权限:
648
-
649
- # - 0:可查看合同内容
650
- # - 1:可查看合同内容也可下载原文
634
+ # <ul><li> **0** :可查看合同内容</li>
635
+ # <li> **1** :可查看合同内容也可下载原文</li></ul>
651
636
  # @type CcPermission: Integer
652
637
  # @param NotifyType: 通知签署方经办人的方式, 有以下途径:
653
-
654
- # - sms: (默认)短信
655
- # - none: 不通知
638
+ # <ul><li> **sms** : (默认)短信</li>
639
+ # <li> **none** : 不通知</li></ul>
656
640
  # @type NotifyType: String
657
641
 
658
642
  attr_accessor :Mobile, :Name, :CcType, :CcPermission, :NotifyType
@@ -1053,7 +1037,7 @@ module TencentCloud
1053
1037
  # @type ResourceType: String
1054
1038
  # @param ResourceName: 资源名称,长度限制为256字符
1055
1039
  # @type ResourceName: String
1056
- # @param ResourceId: 资源Id,通过UploadFiles获取
1040
+ # @param ResourceId: 文件Id,通过UploadFiles获取
1057
1041
  # @type ResourceId: String
1058
1042
  # @param Operator: 调用方用户信息,userId 必填
1059
1043
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
@@ -1349,117 +1333,104 @@ module TencentCloud
1349
1333
 
1350
1334
  # CreateFlowByFiles请求参数结构体
1351
1335
  class CreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
1352
- # @param Operator: 执行本接口操作的员工信息。
1353
- # 使用此接口时,必须填写userId。
1354
- # 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1336
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId。
1355
1337
  # 支持填入集团子公司经办人 userId 代发合同。
1338
+
1339
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1356
1340
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1357
1341
  # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1342
+
1358
1343
  # 该名称还将用于合同签署完成后的下载文件名。
1359
1344
  # @type FlowName: String
1360
1345
  # @param Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
1346
+
1361
1347
  # 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
1362
1348
  # @type Approvers: Array
1363
- # @param FileIds: 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。目前,此接口仅支持单个文件发起。
1349
+ # @param FileIds: 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
1350
+
1351
+ # 注: `目前,此接口仅支持单个文件发起。`
1364
1352
  # @type FileIds: Array
1365
1353
  # @param FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1366
1354
  # @type FlowDescription: String
1367
1355
  # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
1368
1356
  # @type FlowType: String
1369
1357
  # @param Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
1370
- # - 单行文本控件
1371
- # - 多行文本控件
1372
- # - 勾选框控件
1373
- # - 数字控件
1374
- # - 图片控件
1375
- # - 动态表格等填写控件
1358
+ # <ul><li> 单行文本控件 </li>
1359
+ # <li> 多行文本控件 </li>
1360
+ # <li> 勾选框控件 </li>
1361
+ # <li> 数字控件 </li>
1362
+ # <li> 图片控件 </li>
1363
+ # <li> 动态表格等填写控件</li></ul>
1376
1364
  # @type Components: Array
1377
1365
  # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1378
- # 注:此功能为白名单功能,使用前请联系对接的客户经理沟通。
1366
+
1367
+ # 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
1379
1368
  # @type CcInfos: Array
1380
1369
  # @param CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
1381
-
1382
- # - 0:合同发起时通知(默认值)
1383
- # - 1:签署完成后通知
1370
+ # <ul><li> **0**:合同发起时通知(默认值)</li>
1371
+ # <li> **1**:签署完成后通知</li></ul>
1384
1372
  # @type CcNotifyType: Integer
1385
1373
  # @param NeedPreview: 是否为预览模式,取值如下:
1386
-
1387
- # false:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId
1388
-
1389
- # true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
1374
+ # <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
1375
+ # <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
1390
1376
  # @type NeedPreview: Boolean
1391
1377
  # @param PreviewType: 预览模式下产生的预览链接类型
1392
-
1393
- # - 0 :(默认) 文件流 ,点开后后下载预览的合同PDF文件
1394
-
1395
- # - 1 :H5链接 ,点开后在浏览器中展示合同的样子
1396
-
1397
- # 注意: 此参数在NeedPreview 为true时有效
1378
+ # <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
1379
+ # <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
1380
+ # 注: `此参数在NeedPreview 为true时有效`
1398
1381
  # @type PreviewType: Integer
1399
1382
  # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
1400
1383
  # 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1401
1384
  # @type Deadline: Integer
1402
1385
  # @param RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
1386
+
1403
1387
  # 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
1404
1388
  # @type RemindedOn: Integer
1405
1389
  # @param Unordered: 合同流程的签署顺序类型:
1406
- # - false(默认)有序签署, 本合同多个参与人需要依次签署
1407
- # - true:无序签署, 本合同多个参与人没有先后签署限制
1390
+ # <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1391
+ # <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1408
1392
  # @type Unordered: Boolean
1409
1393
  # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
1410
-
1411
- # - {合同名称}
1412
- # - {发起方企业}
1413
- # - {发起方姓名}
1414
- # - {签署方N企业}
1415
- # - {签署方N姓名}
1416
-
1394
+ # <ul><li>{合同名称} </li>
1395
+ # <li>{发起方企业} </li>
1396
+ # <li>{发起方姓名} </li>
1397
+ # <li>{签署方N企业}</li>
1398
+ # <li>{签署方N姓名}</li></ul>
1417
1399
  # 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
1418
1400
 
1419
- # 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:
1420
- # 合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
1401
+ # 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
1421
1402
 
1422
- # 则小程序中列表页展示此合同为以下样子
1423
- # ```
1424
1403
  # 合同名称:租房合同
1425
1404
  # 发起方:腾讯公司(张三)
1426
1405
  # 签署方:李四
1427
- # ```
1406
+
1428
1407
  # @type CustomShowMap: String
1429
1408
  # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1430
-
1431
- # - false:(默认)不需要审批,直接签署。
1432
- # - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
1433
-
1409
+ # <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1410
+ # <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1434
1411
  # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1435
-
1436
- # - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
1437
- # - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
1438
-
1439
- # 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
1412
+ # <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1413
+ # <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1414
+ # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1440
1415
  # @type NeedSignReview: Boolean
1441
1416
  # @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
1442
- # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
1443
- # 回调的相关说明可参考开发者中心的"回调通知"模块。
1417
+
1418
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
1444
1419
  # @type UserData: String
1445
1420
  # @param ApproverVerifyType: 指定个人签署方查看合同的校验方式
1446
-
1447
- # - VerifyCheck :(默认)人脸识别,人脸识别后才能合同内容
1448
- # - MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
1421
+ # <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
1422
+ # <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
1449
1423
  # @type ApproverVerifyType: String
1450
1424
  # @param SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
1451
-
1452
- # - 0:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
1453
- # - 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
1425
+ # <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
1426
+ # <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
1454
1427
  # @type SignBeanTag: Integer
1455
1428
  # @param Agent: 代理企业和员工的信息。
1456
1429
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1457
1430
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1458
1431
  # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
1459
-
1460
- # - E_PRESCRIPTION_AUTO_SIGN:处方单(医疗自动签)
1461
-
1462
- # 注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
1432
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
1433
+ # 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
1463
1434
  # @type AutoSignScene: String
1464
1435
 
1465
1436
  attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowDescription, :FlowType, :Components, :CcInfos, :CcNotifyType, :NeedPreview, :PreviewType, :Deadline, :RemindedOn, :Unordered, :CustomShowMap, :NeedSignReview, :UserData, :ApproverVerifyType, :SignBeanTag, :Agent, :AutoSignScene
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.638
4
+ version: 3.0.639
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-17 00:00:00.000000000 Z
11
+ date: 2023-08-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common