tencentcloud-sdk-ess 3.0.731 → 3.0.732
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +64 -4
- data/lib/v20201111/models.rb +31 -31
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3fd679ee714f6c038d6cf98cc67d7ac2705a9054
|
4
|
+
data.tar.gz: 812cb23e63b89a7e15c13a3a29689fb8ad26e8fd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fb7ebcae6ab01a8f2c10e3b25604ac8490847ec93bb24f7d2b5aedf97c609003ea23188a80d1eac6fd44785df9f586a55e7800053c329000f34feb9b6b6ac925
|
7
|
+
data.tar.gz: af7946b5287de78ad8cf0f545122a1fec56a373a46ca6c30f14dc60e3d3847fe9ed9a6f0b31ab34357a22ffbc8cae0ab5ee3e9450343a269ec23c45248784f1f
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.732
|
data/lib/v20201111/client.rb
CHANGED
@@ -343,6 +343,33 @@ module TencentCloud
|
|
343
343
|
|
344
344
|
# 通过模板创建签署流程<br/>
|
345
345
|
# 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
346
|
+
# <table>
|
347
|
+
# <thead>
|
348
|
+
# <tr>
|
349
|
+
# <th>签署人类别</th>
|
350
|
+
# <th>需要提前准备的信息</th>
|
351
|
+
# </tr>
|
352
|
+
# </thead>
|
353
|
+
# <tbody>
|
354
|
+
# <tr>
|
355
|
+
# <td>自己企业的员工签署(未认证加入或已认证加入)</td>
|
356
|
+
# <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
|
357
|
+
# </tr>
|
358
|
+
# <tr>
|
359
|
+
# <td>自己企业的员工签署(已认证加入)</td>
|
360
|
+
# <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
|
361
|
+
# </tr>
|
362
|
+
# <tr>
|
363
|
+
# <td>其他企业的员工签署</td>
|
364
|
+
# <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
|
365
|
+
# </tr>
|
366
|
+
# <tr>
|
367
|
+
# <td>个人(自然人)签署</td>
|
368
|
+
# <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
|
369
|
+
# </tr>
|
370
|
+
# </tbody>
|
371
|
+
# </table>
|
372
|
+
|
346
373
|
|
347
374
|
# 注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
|
348
375
|
|
@@ -405,8 +432,38 @@ module TencentCloud
|
|
405
432
|
# 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
|
406
433
|
# 适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
|
407
434
|
|
435
|
+
# <table>
|
436
|
+
# <thead>
|
437
|
+
# <tr>
|
438
|
+
# <th>签署人类别</th>
|
439
|
+
# <th>需要提前准备的信息</th>
|
440
|
+
# </tr>
|
441
|
+
# </thead>
|
442
|
+
# <tbody>
|
443
|
+
# <tr>
|
444
|
+
# <td>自己企业的员工签署(未认证加入或已认证加入)</td>
|
445
|
+
# <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
|
446
|
+
# </tr>
|
447
|
+
# <tr>
|
448
|
+
# <td>自己企业的员工签署(已认证加入)</td>
|
449
|
+
# <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
|
450
|
+
# </tr>
|
451
|
+
# <tr>
|
452
|
+
# <td>其他企业的员工签署</td>
|
453
|
+
# <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
|
454
|
+
# </tr>
|
455
|
+
# <tr>
|
456
|
+
# <td>个人(自然人)签署</td>
|
457
|
+
# <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
|
458
|
+
# </tr>
|
459
|
+
# </tbody>
|
460
|
+
# </table>
|
461
|
+
|
462
|
+
|
463
|
+
|
408
464
|
# 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
|
409
465
|
|
466
|
+
|
410
467
|
# ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
|
411
468
|
|
412
469
|
# 注:
|
@@ -528,11 +585,14 @@ module TencentCloud
|
|
528
585
|
|
529
586
|
# 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
|
530
587
|
|
531
|
-
# 1.
|
532
|
-
# 2.
|
533
|
-
# 3.
|
588
|
+
# 1. 发起合同时,**签署人的NotifyType需设置为sms**
|
589
|
+
# 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
590
|
+
# 3. **每个合同只能催办一次**
|
591
|
+
|
592
|
+
# **催办的效果**: 对方会收到如下的短信通知
|
593
|
+
# ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
|
534
594
|
|
535
|
-
#
|
595
|
+
# 注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
|
536
596
|
|
537
597
|
# @param request: Request instance for CreateFlowReminds.
|
538
598
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRemindsRequest`
|
data/lib/v20201111/models.rb
CHANGED
@@ -2033,14 +2033,26 @@ module TencentCloud
|
|
2033
2033
|
# @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
2034
2034
|
# 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
2035
2035
|
# @type Deadline: Integer
|
2036
|
-
# @param RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
2037
|
-
|
2038
|
-
# 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
2039
|
-
# @type RemindedOn: Integer
|
2040
2036
|
# @param Unordered: 合同流程的签署顺序类型:
|
2041
2037
|
# <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
2042
2038
|
# <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
2043
2039
|
# @type Unordered: Boolean
|
2040
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
2041
|
+
|
2042
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
2043
|
+
# @type UserData: String
|
2044
|
+
# @param RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
2045
|
+
|
2046
|
+
# 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
2047
|
+
# @type RemindedOn: Integer
|
2048
|
+
# @param ApproverVerifyType: 指定个人签署方查看合同的校验方式
|
2049
|
+
# <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
|
2050
|
+
# <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
|
2051
|
+
# @type ApproverVerifyType: String
|
2052
|
+
# @param SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
|
2053
|
+
# <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
2054
|
+
# <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
2055
|
+
# @type SignBeanTag: Integer
|
2044
2056
|
# @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
2045
2057
|
# <ul><li>{合同名称} </li>
|
2046
2058
|
# <li>{发起方企业} </li>
|
@@ -2056,6 +2068,13 @@ module TencentCloud
|
|
2056
2068
|
# 签署方:李四
|
2057
2069
|
|
2058
2070
|
# @type CustomShowMap: String
|
2071
|
+
# @param Agent: 代理企业和员工的信息。
|
2072
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
2073
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2074
|
+
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
2075
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
2076
|
+
# 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
2077
|
+
# @type AutoSignScene: String
|
2059
2078
|
# @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
2060
2079
|
# <ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
2061
2080
|
# <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
@@ -2064,29 +2083,10 @@ module TencentCloud
|
|
2064
2083
|
# <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
2065
2084
|
# 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
2066
2085
|
# @type NeedSignReview: Boolean
|
2067
|
-
# @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
2068
|
-
|
2069
|
-
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
2070
|
-
# @type UserData: String
|
2071
|
-
# @param ApproverVerifyType: 指定个人签署方查看合同的校验方式
|
2072
|
-
# <ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
|
2073
|
-
# <li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
|
2074
|
-
# @type ApproverVerifyType: String
|
2075
|
-
# @param SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
|
2076
|
-
# <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
2077
|
-
# <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
2078
|
-
# @type SignBeanTag: Integer
|
2079
|
-
# @param Agent: 代理企业和员工的信息。
|
2080
|
-
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
2081
|
-
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2082
|
-
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
2083
|
-
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
|
2084
|
-
# 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
2085
|
-
# @type AutoSignScene: String
|
2086
2086
|
|
2087
|
-
attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowDescription, :FlowType, :Components, :CcInfos, :CcNotifyType, :NeedPreview, :PreviewType, :Deadline, :
|
2087
|
+
attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowDescription, :FlowType, :Components, :CcInfos, :CcNotifyType, :NeedPreview, :PreviewType, :Deadline, :Unordered, :UserData, :RemindedOn, :ApproverVerifyType, :SignBeanTag, :CustomShowMap, :Agent, :AutoSignScene, :NeedSignReview
|
2088
2088
|
|
2089
|
-
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,
|
2089
|
+
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, unordered=nil, userdata=nil, remindedon=nil, approververifytype=nil, signbeantag=nil, customshowmap=nil, agent=nil, autosignscene=nil, needsignreview=nil)
|
2090
2090
|
@Operator = operator
|
2091
2091
|
@FlowName = flowname
|
2092
2092
|
@Approvers = approvers
|
@@ -2099,15 +2099,15 @@ module TencentCloud
|
|
2099
2099
|
@NeedPreview = needpreview
|
2100
2100
|
@PreviewType = previewtype
|
2101
2101
|
@Deadline = deadline
|
2102
|
-
@RemindedOn = remindedon
|
2103
2102
|
@Unordered = unordered
|
2104
|
-
@CustomShowMap = customshowmap
|
2105
|
-
@NeedSignReview = needsignreview
|
2106
2103
|
@UserData = userdata
|
2104
|
+
@RemindedOn = remindedon
|
2107
2105
|
@ApproverVerifyType = approververifytype
|
2108
2106
|
@SignBeanTag = signbeantag
|
2107
|
+
@CustomShowMap = customshowmap
|
2109
2108
|
@Agent = agent
|
2110
2109
|
@AutoSignScene = autosignscene
|
2110
|
+
@NeedSignReview = needsignreview
|
2111
2111
|
end
|
2112
2112
|
|
2113
2113
|
def deserialize(params)
|
@@ -2147,18 +2147,18 @@ module TencentCloud
|
|
2147
2147
|
@NeedPreview = params['NeedPreview']
|
2148
2148
|
@PreviewType = params['PreviewType']
|
2149
2149
|
@Deadline = params['Deadline']
|
2150
|
-
@RemindedOn = params['RemindedOn']
|
2151
2150
|
@Unordered = params['Unordered']
|
2152
|
-
@CustomShowMap = params['CustomShowMap']
|
2153
|
-
@NeedSignReview = params['NeedSignReview']
|
2154
2151
|
@UserData = params['UserData']
|
2152
|
+
@RemindedOn = params['RemindedOn']
|
2155
2153
|
@ApproverVerifyType = params['ApproverVerifyType']
|
2156
2154
|
@SignBeanTag = params['SignBeanTag']
|
2155
|
+
@CustomShowMap = params['CustomShowMap']
|
2157
2156
|
unless params['Agent'].nil?
|
2158
2157
|
@Agent = Agent.new
|
2159
2158
|
@Agent.deserialize(params['Agent'])
|
2160
2159
|
end
|
2161
2160
|
@AutoSignScene = params['AutoSignScene']
|
2161
|
+
@NeedSignReview = params['NeedSignReview']
|
2162
2162
|
end
|
2163
2163
|
end
|
2164
2164
|
|
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.
|
4
|
+
version: 3.0.732
|
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-12-
|
11
|
+
date: 2023-12-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|