tencentcloud-sdk-ess 3.0.636 → 3.0.637

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20201111/models.rb +211 -87
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 55a3bb5e9f6dbf24486fe545bd56b3edab7a8efe
4
- data.tar.gz: 706173f428ed9fab52e63b019721b504b032128c
3
+ metadata.gz: 8ad6b94d19c4211fd5988ea1e722b134b3fdc111
4
+ data.tar.gz: 791ce989540d126ea75c6d5e2b4ce278ba84ac6b
5
5
  SHA512:
6
- metadata.gz: 4e623f8ab962bfc24e1d3029671562b36c507510dc96abeeb096a071f99788eb6d8c35e107fc2574e481741bc19e168119d714a91fce131f8cdafa4fae49a565
7
- data.tar.gz: d4ebde332b7ae4520e9766dc2f5e7a1034485ca30b24652213b240375a5d30df3cb83eb13207da1fd982b86acad7c70286dcfbd309a19bdd8e276b1abe6d91cc
6
+ metadata.gz: 5215b9b8b4330c7b81c6978f6bfb3022de6bb009e30720d0e3694135b3bacce02e487495ad0fb8181dd0e2896ced2bf402a7aed586abbcbc4ffac464a2adce5a
7
+ data.tar.gz: aa19d4bf07c9568e7ef6ce743ced56f563bdc75fa429a9d7749309b591344e9309cb07090744fc550657a59db0ae6bd451ee1f16b99801736e91dcf7790a0826
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.636
1
+ 3.0.637
@@ -76,63 +76,116 @@ module TencentCloud
76
76
 
77
77
  # 参与者信息
78
78
  class ApproverInfo < TencentCloud::Common::AbstractModel
79
- # @param ApproverType: 参与者类型:
79
+ # @param ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
80
80
  # 0:企业
81
81
  # 1:个人
82
82
  # 3:企业静默签署
83
83
  # 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
84
84
  # 7: 个人自动签署,适用于个人自动签场景。
85
- # 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
85
+ # 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
86
86
  # @type ApproverType: Integer
87
- # @param ApproverName: 签署人的姓名
87
+ # @param ApproverName: 签署方经办人的姓名。
88
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
88
89
  # @type ApproverName: String
89
- # @param ApproverMobile: 签署人的手机号,11位数字
90
+ # @param ApproverMobile: 本企业的签署方经办人的员工UserId
91
+
92
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
93
+
94
+ # 注: 若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。
90
95
  # @type ApproverMobile: String
91
- # @param OrganizationName: 如果签署方是企业签署方(approverType = 1 或者 approverType = 3),
96
+ # @param OrganizationName: 组织机构名称。
97
+ # 如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
92
98
 
93
- # 则企业名称必填
99
+ # 注: 请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。
94
100
  # @type OrganizationName: String
95
- # @param SignComponents: 签署人的签署控件列表
101
+ # @param SignComponents: 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
102
+ # - 个人签名/印章
103
+ # - 企业印章
104
+ # - 骑缝章等签署控件
96
105
  # @type SignComponents: Array
97
- # @param ApproverIdCardType: 签署人的证件类型
98
- # ID_CARD 身份证
99
- # HONGKONG_AND_MACAO 港澳居民来往内地通行证
100
- # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
101
- # OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
106
+ # @param ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
107
+ # - ID_CARD 居民身份证 (默认值)
108
+ # - HONGKONG_AND_MACAO 港澳居民来往内地通行证
109
+ # - HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
110
+ # - OTHER_CARD_TYPE 其他证件
111
+
112
+ # 注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
102
113
  # @type ApproverIdCardType: String
103
- # @param ApproverIdCardNumber: 签署人证件号(长度不超过18位)
114
+ # @param ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
115
+ # - 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
116
+ # - 港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。
117
+ # - 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
104
118
  # @type ApproverIdCardNumber: String
105
- # @param NotifyType: 签署通知类型:sms--短信,none--不通知
119
+ # @param NotifyType: 通知签署方经办人的方式, 有以下途径:
120
+
121
+ # - sms: (默认)短信
122
+ # - none: 不通知
106
123
  # @type NotifyType: String
107
- # @param ApproverRole: 签署人角色类型:1--收款人、2--开具人、3--见证人
124
+ # @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下类型:
125
+ # - 1:收款人
126
+ # - 2:开具人
127
+ # - 3:见证人
128
+
129
+ # 注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
108
130
  # @type ApproverRole: Integer
109
131
  # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
132
+
133
+ # 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
110
134
  # @type VerifyChannel: Array
111
- # @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
135
+ # @param PreReadTime: 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
136
+
137
+ # 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
138
+
139
+ # - 合同页数少于等于2页,阅读时间为3秒;
140
+ # - 合同页数为3到5页,阅读时间为5秒;
141
+ # - 合同页数大于等于6页,阅读时间为10秒。
112
142
  # @type PreReadTime: Integer
113
143
  # @param UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
114
144
 
115
145
  # 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
116
146
  # @type UserId: String
117
- # @param ApproverSource: 签署人用户来源,此参数仅针对企微用户开放
118
-
119
- # 企微侧用户请传入:WEWORKAPP
147
+ # @param ApproverSource: 在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
120
148
  # @type ApproverSource: String
121
- # @param CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
149
+ # @param CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
150
+ # 所有参与或签的人员均需具备该标识。
151
+ # 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
152
+ # 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
122
153
  # @type CustomApproverTag: String
123
- # @param ApproverOption: 签署人个性化能力值
154
+ # @param ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
155
+ # 详细操作可以参考开发者中心的ApproverOption结构体。
124
156
  # @type ApproverOption: :class:`Tencentcloud::Ess.v20201111.models.ApproverOption`
125
- # @param ApproverVerifyTypes: 签署人查看合同时认证方式,
126
- # 1-实名查看 2-短信验证码查看(企业签署方不支持该方式)
127
- # 如果不传默认为1
128
- # 模板发起的时候,认证方式以模板配置为主
157
+ # @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
158
+
159
+ # - 1 : (默认)人脸识别,人脸识别后才能合同内容
160
+ # - 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
161
+
162
+ # 注:
163
+
164
+ # - 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
165
+ # - 此字段不可传多个校验方式
129
166
  # @type ApproverVerifyTypes: Array
130
- # @param ApproverSignTypes: 签署人签署合同时的认证方式
131
- # 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
132
- # 合同签署认证方式的优先级 verifyChannel>approverSignTypes
133
- # 模板发起的时候,认证方式以模板配置为主
167
+ # @param ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
168
+
169
+ # - 1:人脸认证,需进行人脸识别成功后才能签署合同;
170
+ # - 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
171
+ # - 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
172
+
173
+ # 注:
174
+
175
+ # - 默认情况下,认证校验方式为人脸认证和签署密码两种形式;
176
+ # - 您可以传递多种值,表示可用多种认证校验方式。
134
177
  # @type ApproverSignTypes: Array
135
- # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。
178
+ # @param ApproverNeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
179
+
180
+ # - false:(默认)不需要审批,直接签署。
181
+ # - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
182
+
183
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
184
+
185
+ # - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
186
+ # - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
187
+
188
+ # 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
136
189
  # @type ApproverNeedSignReview: Boolean
137
190
 
138
191
  attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview
@@ -192,9 +245,15 @@ module TencentCloud
192
245
 
193
246
  # 签署人个性化能力信息
194
247
  class ApproverOption < TencentCloud::Common::AbstractModel
195
- # @param NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
248
+ # @param NoRefuse: 签署方是否可以拒签
249
+
250
+ # - false: ( 默认)可以拒签
251
+ # - true:不可以拒签
196
252
  # @type NoRefuse: Boolean
197
- # @param NoTransfer: 是否可以转发 默认false-可以转发 true-不可以转发
253
+ # @param NoTransfer: 签署方是否可以转他人处理
254
+
255
+ # - false: ( 默认)可以转他人处理
256
+ # - true:不可以转他人处理
198
257
  # @type NoTransfer: Boolean
199
258
 
200
259
  attr_accessor :NoRefuse, :NoTransfer
@@ -574,19 +633,26 @@ module TencentCloud
574
633
 
575
634
  # 抄送信息
576
635
  class CcInfo < TencentCloud::Common::AbstractModel
577
- # @param Mobile: 被抄送人手机号,11位数字
636
+ # @param Mobile: 被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
637
+ # 请确认手机号所有方为此业务通知方。
578
638
  # @type Mobile: String
579
- # @param Name: 被抄送人姓名
639
+ # @param Name: 被抄送方姓名。
640
+ # 抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。
580
641
  # @type Name: String
581
- # @param CcType: 被抄送人类型,
582
- # 0--个人
583
- # 1--员工
642
+ # @param CcType: 被抄送方类型, 可设置以下类型:
643
+
644
+ # - 0:个人抄送方
645
+ # - 1:企业员工抄送方
584
646
  # @type CcType: Integer
585
- # @param CcPermission: 被抄送人权限
586
- # 0--可查看
587
- # 1--可查看也可下载
647
+ # @param CcPermission: 被抄送方权限, 可设置如下权限:
648
+
649
+ # - 0:可查看合同内容
650
+ # - 1:可查看合同内容也可下载原文
588
651
  # @type CcPermission: Integer
589
- # @param NotifyType: 关注方通知类型:sms--短信,none--不通知
652
+ # @param NotifyType: 通知签署方经办人的方式, 有以下途径:
653
+
654
+ # - sms: (默认)短信
655
+ # - none: 不通知
590
656
  # @type NotifyType: String
591
657
 
592
658
  attr_accessor :Mobile, :Name, :CcType, :CcPermission, :NotifyType
@@ -1155,7 +1221,7 @@ module TencentCloud
1155
1221
  # @type EmbedType: String
1156
1222
  # @param BusinessId: WEB嵌入的业务资源ID
1157
1223
  # <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
1158
- # <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模版id
1224
+ # <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
1159
1225
  # <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
1160
1226
  # @type BusinessId: String
1161
1227
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作
@@ -1283,73 +1349,131 @@ module TencentCloud
1283
1349
 
1284
1350
  # CreateFlowByFiles请求参数结构体
1285
1351
  class CreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
1286
- # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
1352
+ # @param Operator: 执行本接口操作的员工信息。
1353
+ # 使用此接口时,必须填写userId。
1354
+ # 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1355
+ # 支持填入集团子公司经办人 userId 代发合同。
1287
1356
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1288
- # @param FlowName: 签署流程名称,最大长度200个字符
1357
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1358
+ # 该名称还将用于合同签署完成后的下载文件名。
1289
1359
  # @type FlowName: String
1290
- # @param Approvers: 签署参与者信息,最大限制50
1360
+ # @param Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
1361
+ # 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
1291
1362
  # @type Approvers: Array
1292
- # @param FileIds: 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
1363
+ # @param FileIds: 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。目前,此接口仅支持单个文件发起。
1293
1364
  # @type FileIds: Array
1294
- # @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1365
+ # @param FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1366
+ # @type FlowDescription: String
1367
+ # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
1295
1368
  # @type FlowType: String
1296
- # @param Components: 经办人内容控件配置
1369
+ # @param Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
1370
+ # - 单行文本控件
1371
+ # - 多行文本控件
1372
+ # - 勾选框控件
1373
+ # - 数字控件
1374
+ # - 图片控件
1375
+ # - 动态表格等填写控件
1297
1376
  # @type Components: Array
1298
- # @param CcInfos: 被抄送人的信息列表。
1299
- # 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
1377
+ # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1378
+ # 注:此功能为白名单功能,使用前请联系对接的客户经理沟通。
1300
1379
  # @type CcInfos: Array
1301
- # @param NeedPreview: 是否需要预览,true:预览模式,false:非预览(默认);
1302
- # 预览链接有效期300秒;
1380
+ # @param CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
1381
+
1382
+ # - 0:合同发起时通知(默认值)
1383
+ # - 1:签署完成后通知
1384
+ # @type CcNotifyType: Integer
1385
+ # @param NeedPreview: 是否为预览模式,取值如下:
1386
+
1387
+ # false:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。
1303
1388
 
1304
- # 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl
1389
+ # true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
1305
1390
  # @type NeedPreview: Boolean
1306
- # @param PreviewType: 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
1391
+ # @param PreviewType: 预览模式下产生的预览链接类型
1392
+
1393
+ # - 0 :(默认) 文件流 ,点开后后下载预览的合同PDF文件
1394
+
1395
+ # - 1 :H5链接 ,点开后在浏览器中展示合同的样子
1396
+
1397
+ # 注意: 此参数在NeedPreview 为true时有效
1307
1398
  # @type PreviewType: Integer
1308
- # @param Deadline: 签署流程的签署截止时间。
1309
- # 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1399
+ # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
1400
+ # 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1310
1401
  # @type Deadline: Integer
1311
- # @param RemindedOn: 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
1402
+ # @param RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
1403
+ # 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
1312
1404
  # @type RemindedOn: Integer
1313
- # @param Unordered: 发送类型:
1314
- # true:无序签
1315
- # false:有序签
1316
- # 注:默认为false(有序签)
1405
+ # @param Unordered: 合同流程的签署顺序类型:
1406
+ # - false:(默认)有序签署, 本合同多个参与人需要依次签署
1407
+ # - true:无序签署, 本合同多个参与人没有先后签署限制
1317
1408
  # @type Unordered: Boolean
1318
- # @param CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1409
+ # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
1410
+
1411
+ # - {合同名称}
1412
+ # - {发起方企业}
1413
+ # - {发起方姓名}
1414
+ # - {签署方N企业}
1415
+ # - {签署方N姓名}
1416
+
1417
+ # 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
1418
+
1419
+ # 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:
1420
+ # 合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
1421
+
1422
+ # 则小程序中列表页展示此合同为以下样子
1423
+ # ```
1424
+ # 合同名称:租房合同
1425
+ # 发起方:腾讯公司(张三)
1426
+ # 签署方:李四
1427
+ # ```
1319
1428
  # @type CustomShowMap: String
1320
- # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1321
- # 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1429
+ # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1322
1430
 
1323
- # 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1431
+ # - false:(默认)不需要审批,直接签署。
1432
+ # - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
1433
+
1434
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1435
+
1436
+ # - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
1437
+ # - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
1438
+
1439
+ # 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
1324
1440
  # @type NeedSignReview: Boolean
1325
- # @param UserData: 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1441
+ # @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
1442
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
1443
+ # 回调的相关说明可参考开发者中心的"回调通知"模块。
1326
1444
  # @type UserData: String
1327
- # @param ApproverVerifyType: 签署人校验方式
1328
- # VerifyCheck: 人脸识别(默认)
1329
- # MobileCheck:手机号验证
1330
- # 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
1445
+ # @param ApproverVerifyType: 指定个人签署方查看合同的校验方式
1446
+
1447
+ # - VerifyCheck :(默认)人脸识别,人脸识别后才能合同内容
1448
+ # - MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
1331
1449
  # @type ApproverVerifyType: String
1332
- # @param FlowDescription: 签署流程描述,最大长度1000个字符
1333
- # @type FlowDescription: String
1334
- # @param SignBeanTag: 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
1450
+ # @param SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
1451
+
1452
+ # - 0:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
1453
+ # - 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
1335
1454
  # @type SignBeanTag: Integer
1336
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1455
+ # @param Agent: 代理企业和员工的信息。
1456
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1337
1457
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1338
- # @param CcNotifyType: 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
1339
- # @type CcNotifyType: Integer
1340
- # @param AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1458
+ # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
1459
+
1460
+ # - E_PRESCRIPTION_AUTO_SIGN:处方单(医疗自动签)
1461
+
1462
+ # 注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
1341
1463
  # @type AutoSignScene: String
1342
1464
 
1343
- attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowType, :Components, :CcInfos, :NeedPreview, :PreviewType, :Deadline, :RemindedOn, :Unordered, :CustomShowMap, :NeedSignReview, :UserData, :ApproverVerifyType, :FlowDescription, :SignBeanTag, :Agent, :CcNotifyType, :AutoSignScene
1465
+ attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowDescription, :FlowType, :Components, :CcInfos, :CcNotifyType, :NeedPreview, :PreviewType, :Deadline, :RemindedOn, :Unordered, :CustomShowMap, :NeedSignReview, :UserData, :ApproverVerifyType, :SignBeanTag, :Agent, :AutoSignScene
1344
1466
 
1345
- def initialize(operator=nil, flowname=nil, approvers=nil, fileids=nil, flowtype=nil, components=nil, ccinfos=nil, needpreview=nil, previewtype=nil, deadline=nil, remindedon=nil, unordered=nil, customshowmap=nil, needsignreview=nil, userdata=nil, approververifytype=nil, flowdescription=nil, signbeantag=nil, agent=nil, ccnotifytype=nil, autosignscene=nil)
1467
+ def initialize(operator=nil, flowname=nil, approvers=nil, fileids=nil, flowdescription=nil, flowtype=nil, components=nil, ccinfos=nil, ccnotifytype=nil, needpreview=nil, previewtype=nil, deadline=nil, remindedon=nil, unordered=nil, customshowmap=nil, needsignreview=nil, userdata=nil, approververifytype=nil, signbeantag=nil, agent=nil, autosignscene=nil)
1346
1468
  @Operator = operator
1347
1469
  @FlowName = flowname
1348
1470
  @Approvers = approvers
1349
1471
  @FileIds = fileids
1472
+ @FlowDescription = flowdescription
1350
1473
  @FlowType = flowtype
1351
1474
  @Components = components
1352
1475
  @CcInfos = ccinfos
1476
+ @CcNotifyType = ccnotifytype
1353
1477
  @NeedPreview = needpreview
1354
1478
  @PreviewType = previewtype
1355
1479
  @Deadline = deadline
@@ -1359,10 +1483,8 @@ module TencentCloud
1359
1483
  @NeedSignReview = needsignreview
1360
1484
  @UserData = userdata
1361
1485
  @ApproverVerifyType = approververifytype
1362
- @FlowDescription = flowdescription
1363
1486
  @SignBeanTag = signbeantag
1364
1487
  @Agent = agent
1365
- @CcNotifyType = ccnotifytype
1366
1488
  @AutoSignScene = autosignscene
1367
1489
  end
1368
1490
 
@@ -1381,6 +1503,7 @@ module TencentCloud
1381
1503
  end
1382
1504
  end
1383
1505
  @FileIds = params['FileIds']
1506
+ @FlowDescription = params['FlowDescription']
1384
1507
  @FlowType = params['FlowType']
1385
1508
  unless params['Components'].nil?
1386
1509
  @Components = []
@@ -1398,6 +1521,7 @@ module TencentCloud
1398
1521
  @CcInfos << ccinfo_tmp
1399
1522
  end
1400
1523
  end
1524
+ @CcNotifyType = params['CcNotifyType']
1401
1525
  @NeedPreview = params['NeedPreview']
1402
1526
  @PreviewType = params['PreviewType']
1403
1527
  @Deadline = params['Deadline']
@@ -1407,26 +1531,26 @@ module TencentCloud
1407
1531
  @NeedSignReview = params['NeedSignReview']
1408
1532
  @UserData = params['UserData']
1409
1533
  @ApproverVerifyType = params['ApproverVerifyType']
1410
- @FlowDescription = params['FlowDescription']
1411
1534
  @SignBeanTag = params['SignBeanTag']
1412
1535
  unless params['Agent'].nil?
1413
1536
  @Agent = Agent.new
1414
1537
  @Agent.deserialize(params['Agent'])
1415
1538
  end
1416
- @CcNotifyType = params['CcNotifyType']
1417
1539
  @AutoSignScene = params['AutoSignScene']
1418
1540
  end
1419
1541
  end
1420
1542
 
1421
1543
  # CreateFlowByFiles返回参数结构体
1422
1544
  class CreateFlowByFilesResponse < TencentCloud::Common::AbstractModel
1423
- # @param FlowId: 签署流程编号。
1545
+ # @param FlowId: 合同流程ID,为32位字符串。
1546
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1547
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1424
1548
 
1425
- # 注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
1549
+ # 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
1426
1550
  # @type FlowId: String
1427
- # @param PreviewUrl: 合同预览链接。
1551
+ # @param PreviewUrl: 合同预览链接URL。
1428
1552
 
1429
- # 注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
1553
+ # 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
1430
1554
  # 注意:此字段可能返回 null,表示取不到有效值。
1431
1555
  # @type PreviewUrl: String
1432
1556
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
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.636
4
+ version: 3.0.637
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-15 00:00:00.000000000 Z
11
+ date: 2023-08-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common