tencentcloud-sdk-ess 3.0.729 → 3.0.731
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.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +28 -8
- data/lib/v20201111/models.rb +15 -8
- 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: 584b703e8261178119eeeb6b0f21c182ff78a810
|
|
4
|
+
data.tar.gz: 3a850b34c552ebb14e7188f8cfcfc57fcfe11cef
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 83c06b057fd67fb0585c65e0c34247789508d9125b49cfdbd7f81ef20ff03d9ba870ed403504cb5bb1aa28db15d1a8e2edab4b4750aa6136e7b5046cbaa70003
|
|
7
|
+
data.tar.gz: 30a73494045269a4b6c679fe754b87864c513a96fcf2cef6797374520792d63148931eb66f38f88705d7ac7ae9c272b3eb664ac893fd957ff71ff4a1e410f760
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.731
|
data/lib/v20201111/client.rb
CHANGED
|
@@ -197,6 +197,7 @@ module TencentCloud
|
|
|
197
197
|
# 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
|
|
198
198
|
|
|
199
199
|
# 注：
|
|
200
|
+
# - 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
|
|
200
201
|
# - 参与人点击链接后需短信验证码才能查看合同内容。
|
|
201
202
|
# - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。
|
|
202
203
|
# - 个人批量签署，签名区`仅支持手写签名`。
|
|
@@ -258,7 +259,7 @@ module TencentCloud
|
|
|
258
259
|
|
|
259
260
|
# 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
|
|
260
261
|
|
|
261
|
-
#
|
|
262
|
+
# 
|
|
262
263
|
|
|
263
264
|
# @param request: Request instance for CreateDocument.
|
|
264
265
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateDocumentRequest`
|
|
@@ -345,7 +346,9 @@ module TencentCloud
|
|
|
345
346
|
|
|
346
347
|
# 注：配合<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>接口使用。整体的逻辑如下图
|
|
347
348
|
|
|
348
|
-
#
|
|
349
|
+
# 
|
|
350
|
+
|
|
351
|
+
# 注：**静默（自动）签署不支持合同签署方存在填写**功能
|
|
349
352
|
|
|
350
353
|
# @param request: Request instance for CreateFlow.
|
|
351
354
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest`
|
|
@@ -400,9 +403,16 @@ module TencentCloud
|
|
|
400
403
|
end
|
|
401
404
|
|
|
402
405
|
# 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
|
|
403
|
-
#
|
|
404
|
-
|
|
405
|
-
#
|
|
406
|
+
# 适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
|
|
407
|
+
|
|
408
|
+
# 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
|
|
409
|
+
|
|
410
|
+
# 
|
|
411
|
+
|
|
412
|
+
# 注：
|
|
413
|
+
# - 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明
|
|
414
|
+
# - 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
|
|
415
|
+
# - **静默（自动）签署不支持合同签署方存在填写**功能
|
|
406
416
|
|
|
407
417
|
# @param request: Request instance for CreateFlowByFiles.
|
|
408
418
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesRequest`
|
|
@@ -464,6 +474,8 @@ module TencentCloud
|
|
|
464
474
|
|
|
465
475
|
# 注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
|
|
466
476
|
|
|
477
|
+
# 注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
478
|
+
|
|
467
479
|
# @param request: Request instance for CreateFlowGroupByFiles.
|
|
468
480
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesRequest`
|
|
469
481
|
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesResponse`
|
|
@@ -490,6 +502,8 @@ module TencentCloud
|
|
|
490
502
|
|
|
491
503
|
# 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
|
|
492
504
|
|
|
505
|
+
# 注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
506
|
+
|
|
493
507
|
# @param request: Request instance for CreateFlowGroupByTemplates.
|
|
494
508
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByTemplatesRequest`
|
|
495
509
|
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByTemplatesResponse`
|
|
@@ -954,7 +968,9 @@ module TencentCloud
|
|
|
954
968
|
|
|
955
969
|
# 注：
|
|
956
970
|
# `1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署`
|
|
971
|
+
|
|
957
972
|
# `2. 签署链接的有效期为90天，超过有效期链接不可用`
|
|
973
|
+
|
|
958
974
|
# `3. 如果需跳转详情页（即PathType值为1）进行填写或签署合同，需指定签署方信息：姓名、手机号码、企业名称等，才能生成正确的跳转链接`
|
|
959
975
|
|
|
960
976
|
# 其中小程序的原始Id如下，或者查看小程序信息自助获取。
|
|
@@ -1857,7 +1873,11 @@ module TencentCloud
|
|
|
1857
1873
|
# 此接口用于启动流程。它是模板发起合同的最后一步。
|
|
1858
1874
|
# 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
|
|
1859
1875
|
|
|
1860
|
-
#
|
|
1876
|
+
# 
|
|
1877
|
+
|
|
1878
|
+
# 注：
|
|
1879
|
+
# - **合同发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
|
|
1880
|
+
# - **静默（自动）签署不支持合同签署方存在填写**功能
|
|
1861
1881
|
|
|
1862
1882
|
# @param request: Request instance for StartFlow.
|
|
1863
1883
|
# @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
|
|
@@ -1939,8 +1959,8 @@ module TencentCloud
|
|
|
1939
1959
|
# 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1940
1960
|
|
|
1941
1961
|
# 注:
|
|
1942
|
-
# 1.
|
|
1943
|
-
# 2.
|
|
1962
|
+
# 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
1963
|
+
# 2. 调用此接口时需要设置单独的Domain请求域名，<font color="red">联调开发环境为: file.test.ess.tencent.cn，正式环境需要设置为:file.ess.tencent.cn</font>，代码示例
|
|
1944
1964
|
# ```
|
|
1945
1965
|
# HttpProfile httpProfile = new HttpProfile();
|
|
1946
1966
|
# httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
data/lib/v20201111/models.rb
CHANGED
|
@@ -1348,7 +1348,7 @@ module TencentCloud
|
|
|
1348
1348
|
# <ul><li>默认情况下，认证校验方式为人脸和密码认证</li>
|
|
1349
1349
|
# <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
|
|
1350
1350
|
# @type ApproverSignTypes: Array
|
|
1351
|
-
# @param SignTypeSelector: 生成H5
|
|
1351
|
+
# @param SignTypeSelector: 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
|
|
1352
1352
|
# <ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li>
|
|
1353
1353
|
# <li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>
|
|
1354
1354
|
# 注：
|
|
@@ -2080,7 +2080,7 @@ module TencentCloud
|
|
|
2080
2080
|
# 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
|
2081
2081
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
|
2082
2082
|
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
2083
|
-
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
|
2083
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
|
|
2084
2084
|
# 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
2085
2085
|
# @type AutoSignScene: String
|
|
2086
2086
|
|
|
@@ -2279,7 +2279,7 @@ module TencentCloud
|
|
|
2279
2279
|
# CreateFlowGroupByFiles请求参数结构体
|
|
2280
2280
|
class CreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel
|
|
2281
2281
|
# @param Operator: 执行本接口操作的员工信息。
|
|
2282
|
-
# 注:
|
|
2282
|
+
# 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
|
2283
2283
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
|
2284
2284
|
# @param FlowGroupName: 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
|
|
2285
2285
|
# @type FlowGroupName: String
|
|
@@ -2633,7 +2633,7 @@ module TencentCloud
|
|
|
2633
2633
|
# @param CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
|
|
2634
2634
|
# @type CcInfos: Array
|
|
2635
2635
|
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
2636
|
-
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
|
2636
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
|
|
2637
2637
|
# 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
2638
2638
|
# @type AutoSignScene: String
|
|
2639
2639
|
# @param RelatedFlowId: 暂未开放
|
|
@@ -3601,6 +3601,8 @@ module TencentCloud
|
|
|
3601
3601
|
|
|
3602
3602
|
# 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
3603
3603
|
# @type UserData: String
|
|
3604
|
+
# @param CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
|
|
3605
|
+
# @type CcInfos: :class:`Tencentcloud::Ess.v20201111.models.CcInfo`
|
|
3604
3606
|
# @param FlowId: 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
|
|
3605
3607
|
# 注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
|
|
3606
3608
|
# @type FlowId: String
|
|
@@ -3610,9 +3612,9 @@ module TencentCloud
|
|
|
3610
3612
|
# @param InitiatorComponents: 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
|
|
3611
3613
|
# @type InitiatorComponents: Array
|
|
3612
3614
|
|
|
3613
|
-
attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :Agent, :InitiatorComponents
|
|
3615
|
+
attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :CcInfos, :FlowId, :Agent, :InitiatorComponents
|
|
3614
3616
|
|
|
3615
|
-
def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, agent=nil, initiatorcomponents=nil)
|
|
3617
|
+
def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, ccinfos=nil, flowid=nil, agent=nil, initiatorcomponents=nil)
|
|
3616
3618
|
@Operator = operator
|
|
3617
3619
|
@ResourceId = resourceid
|
|
3618
3620
|
@FlowName = flowname
|
|
@@ -3628,6 +3630,7 @@ module TencentCloud
|
|
|
3628
3630
|
@NeedSignReview = needsignreview
|
|
3629
3631
|
@NeedCreateReview = needcreatereview
|
|
3630
3632
|
@UserData = userdata
|
|
3633
|
+
@CcInfos = ccinfos
|
|
3631
3634
|
@FlowId = flowid
|
|
3632
3635
|
@Agent = agent
|
|
3633
3636
|
@InitiatorComponents = initiatorcomponents
|
|
@@ -3665,6 +3668,10 @@ module TencentCloud
|
|
|
3665
3668
|
@NeedSignReview = params['NeedSignReview']
|
|
3666
3669
|
@NeedCreateReview = params['NeedCreateReview']
|
|
3667
3670
|
@UserData = params['UserData']
|
|
3671
|
+
unless params['CcInfos'].nil?
|
|
3672
|
+
@CcInfos = CcInfo.new
|
|
3673
|
+
@CcInfos.deserialize(params['CcInfos'])
|
|
3674
|
+
end
|
|
3668
3675
|
@FlowId = params['FlowId']
|
|
3669
3676
|
unless params['Agent'].nil?
|
|
3670
3677
|
@Agent = Agent.new
|
|
@@ -7065,7 +7072,7 @@ module TencentCloud
|
|
|
7065
7072
|
# 注:
|
|
7066
7073
|
# `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
7067
7074
|
# @type ApproverSignTypes: Array
|
|
7068
|
-
# @param SignTypeSelector: 生成H5
|
|
7075
|
+
# @param SignTypeSelector: 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
|
|
7069
7076
|
# <ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li>
|
|
7070
7077
|
# <li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>
|
|
7071
7078
|
# 注：
|
|
@@ -7712,7 +7719,7 @@ module TencentCloud
|
|
|
7712
7719
|
# <li> **ProcessFailed** : 转换失败</li>
|
|
7713
7720
|
# <li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
7714
7721
|
# @type TaskMessage: String
|
|
7715
|
-
# @param ResourceId: 资源Id
|
|
7722
|
+
# @param ResourceId: 资源Id（即FileId），用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)
|
|
7716
7723
|
# @type ResourceId: String
|
|
7717
7724
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
7718
7725
|
# @type RequestId: String
|
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.731
|
|
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-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|