tencentcloud-sdk-essbasic 3.0.691 → 3.0.693
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/v20210526/client.rb +71 -44
- data/lib/v20210526/models.rb +248 -157
- 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: 92122df741bad1ea9f788e2ae1cb6c6472745879
|
4
|
+
data.tar.gz: f1efbb685b40827eae5b25856dd6f19c29255d6c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e88a6ba347e69dcab1080753b7365246212eaadf481b5a52c45da80dd59527dcd02116ea56bafeede50a84493462eab74d2a85e1bd4fd536773c2dd854eb0341
|
7
|
+
data.tar.gz: 8f834d517c5955c554e08b3c315cee2678978c53d9c7429ec94136c06ac3e4a8de59fd4b3ac69f0e8fa1d214b895cba7fa8c3638ec9546899cd9a3b04b6c15d3
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.693
|
data/lib/v20210526/client.rb
CHANGED
@@ -29,22 +29,16 @@ module TencentCloud
|
|
29
29
|
end
|
30
30
|
|
31
31
|
|
32
|
-
#
|
33
|
-
|
34
|
-
#
|
35
|
-
|
36
|
-
# -
|
37
|
-
# -
|
38
|
-
|
39
|
-
# - 已撤回
|
40
|
-
# - 拒绝填写
|
41
|
-
# - 已解除
|
42
|
-
|
43
|
-
# <br/>
|
44
|
-
# 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
|
45
|
-
# <br/><br/>
|
32
|
+
# 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
|
33
|
+
|
34
|
+
# 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
35
|
+
|
36
|
+
# - **可撤回合同状态**:未全部签署完成
|
37
|
+
# - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
38
|
+
|
46
39
|
# 注:
|
47
|
-
#
|
40
|
+
# - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
41
|
+
# - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
48
42
|
|
49
43
|
# @param request: Request instance for ChannelBatchCancelFlows.
|
50
44
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
|
@@ -71,11 +65,13 @@ module TencentCloud
|
|
71
65
|
# 撤销签署流程接口
|
72
66
|
|
73
67
|
# 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
74
|
-
|
75
|
-
#
|
68
|
+
|
69
|
+
# - **可撤回合同状态**:未全部签署完成
|
70
|
+
# - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
71
|
+
|
76
72
|
# 注:
|
77
|
-
# <
|
78
|
-
#
|
73
|
+
# - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
74
|
+
# - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
79
75
|
|
80
76
|
# @param request: Request instance for ChannelCancelFlow.
|
81
77
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelFlowRequest`
|
@@ -149,15 +145,15 @@ module TencentCloud
|
|
149
145
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
150
146
|
end
|
151
147
|
|
152
|
-
#
|
153
|
-
# 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
|
154
|
-
# 接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
|
148
|
+
# 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
|
155
149
|
|
156
|
-
#
|
157
|
-
# 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
150
|
+
# 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
158
151
|
|
159
|
-
#
|
160
|
-
#
|
152
|
+
# - **可撤回合同状态**:未全部签署完成
|
153
|
+
# - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
154
|
+
|
155
|
+
# 注:
|
156
|
+
# - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
161
157
|
|
162
158
|
# @param request: Request instance for ChannelCreateBatchCancelFlowUrl.
|
163
159
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchCancelFlowUrlRequest`
|
@@ -828,8 +824,16 @@ module TencentCloud
|
|
828
824
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
829
825
|
end
|
830
826
|
|
831
|
-
#
|
832
|
-
#
|
827
|
+
# 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
828
|
+
# 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
|
829
|
+
|
830
|
+
# 注意:
|
831
|
+
# <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
832
|
+
# <li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
|
833
|
+
# <li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
|
834
|
+
# <li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
|
835
|
+
# <li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
|
836
|
+
# <li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
|
833
837
|
|
834
838
|
# @param request: Request instance for ChannelCreateReleaseFlow.
|
835
839
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateReleaseFlowRequest`
|
@@ -905,7 +909,9 @@ module TencentCloud
|
|
905
909
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
906
910
|
end
|
907
911
|
|
908
|
-
#
|
912
|
+
# 获取个人用户自动签的开通链接。
|
913
|
+
|
914
|
+
# 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
909
915
|
|
910
916
|
# @param request: Request instance for ChannelCreateUserAutoSignEnableUrl.
|
911
917
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserAutoSignEnableUrlRequest`
|
@@ -1689,7 +1695,11 @@ module TencentCloud
|
|
1689
1695
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1690
1696
|
end
|
1691
1697
|
|
1692
|
-
#
|
1698
|
+
# 此接口用于查询合同或者合同组的详情信息,支持查询多个(数量不能超过100)。
|
1699
|
+
|
1700
|
+
# 适用场景:可用于主动查询某个合同或者合同组的详情信息。
|
1701
|
+
|
1702
|
+
# 注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
1693
1703
|
|
1694
1704
|
# @param request: Request instance for DescribeFlowDetailInfo.
|
1695
1705
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeFlowDetailInfoRequest`
|
@@ -1750,17 +1760,24 @@ module TencentCloud
|
|
1750
1760
|
|
1751
1761
|
# 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
|
1752
1762
|
|
1753
|
-
#
|
1754
|
-
|
1755
|
-
#
|
1756
|
-
#
|
1757
|
-
#
|
1758
|
-
#
|
1759
|
-
|
1760
|
-
#
|
1761
|
-
#
|
1763
|
+
# **一个模板通常会包含以下结构信息**
|
1764
|
+
|
1765
|
+
# - 模板模版ID, 模板名字等基本信息
|
1766
|
+
# - 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
1767
|
+
# - 发起方和签署方的填写控件 Components
|
1768
|
+
# - 签署方的签署控件 SignComponents
|
1769
|
+
|
1770
|
+
# **适用场景**
|
1771
|
+
# 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
|
1772
|
+
# 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
|
1773
|
+
|
1774
|
+
# **模版的来源**
|
1775
|
+
# 子客企业的模板有两种途径获取
|
1776
|
+
# - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
|
1777
|
+
# - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
|
1762
1778
|
|
1763
|
-
|
1779
|
+
|
1780
|
+
# **注意**
|
1764
1781
|
|
1765
1782
|
# >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
|
1766
1783
|
# >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
|
@@ -1935,7 +1952,7 @@ module TencentCloud
|
|
1935
1952
|
|
1936
1953
|
# 该接口 (PrepareFlows) 用于创建待发起文件
|
1937
1954
|
# 用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
1938
|
-
# 目前该接口只支持B2C
|
1955
|
+
# 目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
|
1939
1956
|
|
1940
1957
|
# @param request: Request instance for PrepareFlows.
|
1941
1958
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::PrepareFlowsRequest`
|
@@ -1986,7 +2003,17 @@ module TencentCloud
|
|
1986
2003
|
end
|
1987
2004
|
|
1988
2005
|
# 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
1989
|
-
|
2006
|
+
|
2007
|
+
# - **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
2008
|
+
|
2009
|
+
# - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
2010
|
+
|
2011
|
+
# ![image](https://dyn.ess.tencent.cn/guide/capi/channel_SyncProxyOrganizationOperators.png)
|
2012
|
+
|
2013
|
+
# **注**:
|
2014
|
+
# - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
2015
|
+
# - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
2016
|
+
# - 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
1990
2017
|
|
1991
2018
|
# @param request: Request instance for SyncProxyOrganizationOperators.
|
1992
2019
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationOperatorsRequest`
|
@@ -2017,8 +2044,8 @@ module TencentCloud
|
|
2017
2044
|
# 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
2018
2045
|
|
2019
2046
|
# 注:
|
2020
|
-
# 1.
|
2021
|
-
# 2.
|
2047
|
+
# 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
2048
|
+
# 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
|
2022
2049
|
# ```
|
2023
2050
|
# HttpProfile httpProfile = new HttpProfile();
|
2024
2051
|
# httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
data/lib/v20210526/models.rb
CHANGED
@@ -398,25 +398,33 @@ module TencentCloud
|
|
398
398
|
|
399
399
|
# ChannelBatchCancelFlows请求参数结构体
|
400
400
|
class ChannelBatchCancelFlowsRequest < TencentCloud::Common::AbstractModel
|
401
|
-
# @param Agent:
|
401
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
402
|
+
|
403
|
+
# 此接口下面信息必填。
|
404
|
+
# <ul>
|
405
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
406
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
407
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
408
|
+
# </ul>
|
409
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
402
410
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
403
|
-
# @param FlowIds:
|
411
|
+
# @param FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
|
404
412
|
# @type FlowIds: Array
|
405
|
-
# @param CancelMessage:
|
413
|
+
# @param CancelMessage: 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
|
414
|
+
|
415
|
+
# 备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"`
|
406
416
|
# @type CancelMessage: String
|
407
|
-
# @param CancelMessageFormat:
|
408
|
-
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
|
414
|
-
#
|
415
|
-
|
416
|
-
#
|
417
|
-
|
418
|
-
|
419
|
-
# 备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
|
417
|
+
# @param CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
|
418
|
+
|
419
|
+
# **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
420
|
+
# **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
421
|
+
# **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
422
|
+
# **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
423
|
+
|
424
|
+
# 注: `CancelMessage为撤销当前合同的理由`
|
425
|
+
|
426
|
+
# ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
|
427
|
+
|
420
428
|
# @type CancelMessageFormat: Integer
|
421
429
|
# @param Operator: 暂未开放
|
422
430
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
@@ -451,7 +459,7 @@ module TencentCloud
|
|
451
459
|
|
452
460
|
# ChannelBatchCancelFlows返回参数结构体
|
453
461
|
class ChannelBatchCancelFlowsResponse < TencentCloud::Common::AbstractModel
|
454
|
-
# @param FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id
|
462
|
+
# @param FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
|
455
463
|
# @type FailMessages: Array
|
456
464
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
457
465
|
# @type RequestId: String
|
@@ -654,9 +662,17 @@ module TencentCloud
|
|
654
662
|
|
655
663
|
# ChannelCreateBatchCancelFlowUrl请求参数结构体
|
656
664
|
class ChannelCreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
|
657
|
-
# @param Agent:
|
665
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
666
|
+
|
667
|
+
# 此接口下面信息必填。
|
668
|
+
# <ul>
|
669
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
670
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
671
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
672
|
+
# </ul>
|
673
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
658
674
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
659
|
-
# @param FlowIds:
|
675
|
+
# @param FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
|
660
676
|
# @type FlowIds: Array
|
661
677
|
# @param Operator: 暂未开放
|
662
678
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
@@ -687,11 +703,12 @@ module TencentCloud
|
|
687
703
|
|
688
704
|
# ChannelCreateBatchCancelFlowUrl返回参数结构体
|
689
705
|
class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
|
690
|
-
# @param BatchCancelFlowUrl:
|
706
|
+
# @param BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
|
691
707
|
# @type BatchCancelFlowUrl: String
|
692
|
-
# @param FailMessages:
|
708
|
+
# @param FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
|
693
709
|
# @type FailMessages: Array
|
694
|
-
# @param UrlExpireOn:
|
710
|
+
# @param UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
|
711
|
+
|
695
712
|
# @type UrlExpireOn: String
|
696
713
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
697
714
|
# @type RequestId: String
|
@@ -2226,13 +2243,28 @@ module TencentCloud
|
|
2226
2243
|
|
2227
2244
|
# ChannelCreateReleaseFlow请求参数结构体
|
2228
2245
|
class ChannelCreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
|
2229
|
-
# @param Agent:
|
2246
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
2247
|
+
|
2248
|
+
# 此接口下面信息必填。
|
2249
|
+
# <ul>
|
2250
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
2251
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
2252
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
2253
|
+
# </ul>
|
2254
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
2230
2255
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
2231
|
-
# @param NeedRelievedFlowId:
|
2256
|
+
# @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
|
2232
2257
|
# @type NeedRelievedFlowId: String
|
2233
|
-
# @param ReliveInfo:
|
2258
|
+
# @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
|
2234
2259
|
# @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
|
2235
|
-
# @param ReleasedApprovers:
|
2260
|
+
# @param ReleasedApprovers: 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
|
2261
|
+
# 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
2262
|
+
|
2263
|
+
# 注意:
|
2264
|
+
# <ul>
|
2265
|
+
# <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
|
2266
|
+
# <li>可以不指定替换签署人, 使用原流程的签署人</li>
|
2267
|
+
# </ul>
|
2236
2268
|
# @type ReleasedApprovers: Array
|
2237
2269
|
# @param CallbackUrl: 签署完回调url,最大长度1000个字符
|
2238
2270
|
# @type CallbackUrl: String
|
@@ -2240,17 +2272,26 @@ module TencentCloud
|
|
2240
2272
|
# @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
|
2241
2273
|
# @param Operator: 暂未开放
|
2242
2274
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
2243
|
-
# @param Deadline:
|
2275
|
+
# @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
|
2276
|
+
# 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
2244
2277
|
# @type Deadline: Integer
|
2278
|
+
# @param UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
|
2279
|
+
|
2280
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
2281
|
+
|
2282
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
2283
|
+
# @type UserData: String
|
2245
2284
|
|
2246
|
-
attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline
|
2285
|
+
attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline, :UserData
|
2247
2286
|
extend Gem::Deprecate
|
2287
|
+
deprecate :CallbackUrl, :none, 2023, 11
|
2288
|
+
deprecate :CallbackUrl=, :none, 2023, 11
|
2248
2289
|
deprecate :Organization, :none, 2023, 11
|
2249
2290
|
deprecate :Organization=, :none, 2023, 11
|
2250
2291
|
deprecate :Operator, :none, 2023, 11
|
2251
2292
|
deprecate :Operator=, :none, 2023, 11
|
2252
2293
|
|
2253
|
-
def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil)
|
2294
|
+
def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil, userdata=nil)
|
2254
2295
|
@Agent = agent
|
2255
2296
|
@NeedRelievedFlowId = needrelievedflowid
|
2256
2297
|
@ReliveInfo = reliveinfo
|
@@ -2259,6 +2300,7 @@ module TencentCloud
|
|
2259
2300
|
@Organization = organization
|
2260
2301
|
@Operator = operator
|
2261
2302
|
@Deadline = deadline
|
2303
|
+
@UserData = userdata
|
2262
2304
|
end
|
2263
2305
|
|
2264
2306
|
def deserialize(params)
|
@@ -2289,6 +2331,7 @@ module TencentCloud
|
|
2289
2331
|
@Operator.deserialize(params['Operator'])
|
2290
2332
|
end
|
2291
2333
|
@Deadline = params['Deadline']
|
2334
|
+
@UserData = params['UserData']
|
2292
2335
|
end
|
2293
2336
|
end
|
2294
2337
|
|
@@ -2440,22 +2483,29 @@ module TencentCloud
|
|
2440
2483
|
|
2441
2484
|
# ChannelCreateUserAutoSignEnableUrl请求参数结构体
|
2442
2485
|
class ChannelCreateUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
|
2443
|
-
# @param Agent:
|
2486
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
2444
2487
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
2445
|
-
# @param SceneKey:
|
2446
|
-
# E_PRESCRIPTION_AUTO_SIGN
|
2488
|
+
# @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
2489
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
2490
|
+
|
2491
|
+
# 注: `现在仅支持电子处方场景`
|
2447
2492
|
# @type SceneKey: String
|
2448
|
-
# @param Operator:
|
2493
|
+
# @param Operator: 执行本接口操作的员工信息。
|
2494
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2449
2495
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
2450
|
-
# @param AutoSignConfig:
|
2496
|
+
# @param AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
|
2451
2497
|
# @type AutoSignConfig: :class:`Tencentcloud::Essbasic.v20210526.models.AutoSignConfig`
|
2452
|
-
# @param UrlType:
|
2498
|
+
# @param UrlType: 生成的链接类型:
|
2499
|
+
# <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
2500
|
+
# <li> **H5SIGN** : 生成H5端开通链接</li></ul>
|
2453
2501
|
# @type UrlType: String
|
2454
|
-
# @param NotifyType:
|
2502
|
+
# @param NotifyType: 是否通知开通方,通知类型:
|
2503
|
+
# <ul><li>默认不设置为不通知开通方</li>
|
2504
|
+
# <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
|
2455
2505
|
# @type NotifyType: String
|
2456
|
-
# @param NotifyAddress:
|
2506
|
+
# @param NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
|
2457
2507
|
# @type NotifyAddress: String
|
2458
|
-
# @param ExpiredTime: 链接的过期时间,格式为Unix
|
2508
|
+
# @param ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
|
2459
2509
|
# @type ExpiredTime: Integer
|
2460
2510
|
|
2461
2511
|
attr_accessor :Agent, :SceneKey, :Operator, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress, :ExpiredTime
|
@@ -2494,17 +2544,27 @@ module TencentCloud
|
|
2494
2544
|
|
2495
2545
|
# ChannelCreateUserAutoSignEnableUrl返回参数结构体
|
2496
2546
|
class ChannelCreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
|
2497
|
-
# @param Url:
|
2547
|
+
# @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
|
2498
2548
|
# @type Url: String
|
2499
|
-
# @param AppId:
|
2549
|
+
# @param AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
2550
|
+
|
2551
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
2500
2552
|
# @type AppId: String
|
2501
|
-
# @param AppOriginalId:
|
2553
|
+
# @param AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
2554
|
+
|
2555
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
2502
2556
|
# @type AppOriginalId: String
|
2503
|
-
# @param Path:
|
2557
|
+
# @param Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
2558
|
+
|
2559
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
2504
2560
|
# @type Path: String
|
2505
|
-
# @param QrCode: base64
|
2561
|
+
# @param QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
2562
|
+
|
2563
|
+
# 注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
2506
2564
|
# @type QrCode: String
|
2507
|
-
# @param UrlType:
|
2565
|
+
# @param UrlType: 返回的链接类型
|
2566
|
+
# <ul><li> 空: 默认小程序端链接</li>
|
2567
|
+
# <li> **H5SIGN** : h5端链接</li></ul>
|
2508
2568
|
# @type UrlType: String
|
2509
2569
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
2510
2570
|
# @type RequestId: String
|
@@ -4969,13 +5029,22 @@ module TencentCloud
|
|
4969
5029
|
|
4970
5030
|
# DescribeFlowDetailInfo请求参数结构体
|
4971
5031
|
class DescribeFlowDetailInfoRequest < TencentCloud::Common::AbstractModel
|
4972
|
-
# @param Agent:
|
5032
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
5033
|
+
|
5034
|
+
# 此接口下面信息必填。
|
5035
|
+
# <ul>
|
5036
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
5037
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
5038
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
5039
|
+
# </ul>
|
5040
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
4973
5041
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
4974
|
-
# @param FlowIds:
|
4975
|
-
#
|
5042
|
+
# @param FlowIds: 需要查询的流程ID列表,最多可传入100个ID。
|
5043
|
+
# 如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。
|
4976
5044
|
# @type FlowIds: Array
|
4977
|
-
# @param FlowGroupId:
|
4978
|
-
|
5045
|
+
# @param FlowGroupId: 需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。
|
5046
|
+
|
5047
|
+
# 合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
|
4979
5048
|
# @type FlowGroupId: String
|
4980
5049
|
# @param Operator: 暂未开放
|
4981
5050
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
@@ -5008,17 +5077,18 @@ module TencentCloud
|
|
5008
5077
|
|
5009
5078
|
# DescribeFlowDetailInfo返回参数结构体
|
5010
5079
|
class DescribeFlowDetailInfoResponse < TencentCloud::Common::AbstractModel
|
5011
|
-
# @param ApplicationId:
|
5080
|
+
# @param ApplicationId: 合同归属的第三方平台应用号ID
|
5012
5081
|
# @type ApplicationId: String
|
5013
|
-
# @param ProxyOrganizationOpenId:
|
5082
|
+
# @param ProxyOrganizationOpenId: 合同归属的第三方平台子客企业OpenId
|
5014
5083
|
# @type ProxyOrganizationOpenId: String
|
5015
|
-
# @param FlowInfo:
|
5084
|
+
# @param FlowInfo: 合同流程的详细信息。
|
5085
|
+
# 如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。
|
5016
5086
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5017
5087
|
# @type FlowInfo: Array
|
5018
|
-
# @param FlowGroupId:
|
5088
|
+
# @param FlowGroupId: 合同组ID,只有在查询合同组信息时才会返回。
|
5019
5089
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5020
5090
|
# @type FlowGroupId: String
|
5021
|
-
# @param FlowGroupName:
|
5091
|
+
# @param FlowGroupName: 合同组名称,只有在查询合同组信息时才会返回。
|
5022
5092
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5023
5093
|
# @type FlowGroupName: String
|
5024
5094
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
@@ -5138,21 +5208,20 @@ module TencentCloud
|
|
5138
5208
|
# 第三方平台子客企业和员工必须已经经过实名认证
|
5139
5209
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
5140
5210
|
# @param TemplateId: 合同模板ID,为32位字符串。
|
5141
|
-
|
5211
|
+
|
5212
|
+
# 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
5142
5213
|
# @type TemplateId: String
|
5143
|
-
# @param ContentType:
|
5214
|
+
# @param ContentType: 查询模版的内容
|
5144
5215
|
|
5145
|
-
# <ul><li>**0
|
5146
|
-
# <li>**1
|
5216
|
+
# <ul><li>**0**:(默认)模板列表及详情</li>
|
5217
|
+
# <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
5147
5218
|
# @type ContentType: Integer
|
5148
|
-
# @param TemplateIds: 合同模板ID数组,每一个合同模板ID为32
|
5149
|
-
# 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
5219
|
+
# @param TemplateIds: 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
|
5150
5220
|
|
5151
|
-
#
|
5152
|
-
# 1
|
5153
|
-
# 2.
|
5154
|
-
#
|
5155
|
-
# 4. 若传递此参数,分页参数(Limit,Offset)无效```
|
5221
|
+
# 注意:
|
5222
|
+
# 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
|
5223
|
+
# 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
|
5224
|
+
# 4. `若传递此参数,分页参数(Limit,Offset)无效`
|
5156
5225
|
# @type TemplateIds: Array
|
5157
5226
|
# @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
|
5158
5227
|
|
@@ -5163,31 +5232,32 @@ module TencentCloud
|
|
5163
5232
|
# 注:`1.offset从0开始,即第一页为0。`
|
5164
5233
|
# `2.默认从第一页返回。`
|
5165
5234
|
# @type Offset: Integer
|
5166
|
-
# @param TemplateName:
|
5235
|
+
# @param TemplateName: 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
|
5167
5236
|
# @type TemplateName: String
|
5168
5237
|
# @param ChannelTemplateId: 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
|
5169
5238
|
# @type ChannelTemplateId: String
|
5170
|
-
# @param QueryAllComponents:
|
5239
|
+
# @param QueryAllComponents: 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
5171
5240
|
|
5172
|
-
# <ul><li>**false
|
5173
|
-
# <li>**true
|
5241
|
+
# <ul><li>**false**:(默认)只返回发起方控件</li>
|
5242
|
+
# <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
|
5174
5243
|
# @type QueryAllComponents: Boolean
|
5175
5244
|
# @param WithPreviewUrl: 是否获取模板预览链接。
|
5176
5245
|
|
5177
5246
|
# <ul><li>**false**:不获取(默认)</li>
|
5178
5247
|
# <li>**true**:获取</li></ul>
|
5179
5248
|
|
5180
|
-
# 设置为true之后, 返回参数PreviewUrl,为模板的H5
|
5181
|
-
|
5182
|
-
#
|
5249
|
+
# 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
5250
|
+
|
5251
|
+
# 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
5183
5252
|
# @type WithPreviewUrl: Boolean
|
5184
5253
|
# @param WithPdfUrl: 是否获取模板的PDF文件链接。
|
5185
5254
|
|
5186
5255
|
# <ul><li>**false**:不获取(默认)</li>
|
5187
5256
|
# <li>**true**:获取</li></ul>
|
5188
5257
|
|
5189
|
-
# 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5
|
5190
|
-
|
5258
|
+
# 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
5259
|
+
|
5260
|
+
# 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
5191
5261
|
# @type WithPdfUrl: Boolean
|
5192
5262
|
# @param Operator: 操作者的信息
|
5193
5263
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
@@ -5957,36 +6027,38 @@ module TencentCloud
|
|
5957
6027
|
|
5958
6028
|
# 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
5959
6029
|
class FlowDetailInfo < TencentCloud::Common::AbstractModel
|
5960
|
-
# @param FlowId:
|
6030
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
5961
6031
|
# @type FlowId: String
|
5962
|
-
# @param FlowName:
|
6032
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
5963
6033
|
# @type FlowName: String
|
5964
|
-
# @param FlowType:
|
6034
|
+
# @param FlowType: 合同流程的类别分类(如销售合同/入职合同等)。
|
5965
6035
|
# @type FlowType: String
|
5966
|
-
# @param FlowStatus:
|
5967
|
-
|
5968
|
-
#
|
5969
|
-
#
|
5970
|
-
#
|
5971
|
-
#
|
5972
|
-
#
|
5973
|
-
#
|
5974
|
-
# RELIEVED 解除协议(已解除)
|
6036
|
+
# @param FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
|
6037
|
+
# <ul><li> **INIT** :合同创建</li>
|
6038
|
+
# <li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
|
6039
|
+
# <li> **REJECT** :合同拒签</li>
|
6040
|
+
# <li> **ALL** :合同签署完成</li>
|
6041
|
+
# <li> **DEADLINE** :合同流签(合同过期)</li>
|
6042
|
+
# <li> **CANCEL** :合同撤回</li>
|
6043
|
+
# <li> **RELIEVED** :解除协议(已解除)</li></ul>
|
5975
6044
|
|
5976
6045
|
# @type FlowStatus: String
|
5977
|
-
# @param FlowMessage:
|
6046
|
+
# @param FlowMessage: 当合同流程状态为已拒签(即 FlowStatus=REJECT)或已撤销(即 FlowStatus=CANCEL )时,此字段 FlowMessage 为拒签或撤销原因。
|
5978
6047
|
# @type FlowMessage: String
|
5979
|
-
# @param CreateOn:
|
6048
|
+
# @param CreateOn: 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
|
5980
6049
|
# @type CreateOn: Integer
|
5981
|
-
# @param DeadLine:
|
6050
|
+
# @param DeadLine: 签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
|
5982
6051
|
# @type DeadLine: Integer
|
5983
|
-
# @param CustomData:
|
6052
|
+
# @param CustomData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 1000长度。
|
6053
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
5984
6054
|
# @type CustomData: String
|
5985
|
-
# @param FlowApproverInfos:
|
6055
|
+
# @param FlowApproverInfos: 合同流程的签署方数组
|
5986
6056
|
# @type FlowApproverInfos: Array
|
5987
|
-
# @param CcInfos:
|
6057
|
+
# @param CcInfos: 合同流程的关注方信息数组
|
5988
6058
|
# @type CcInfos: Array
|
5989
|
-
# @param NeedCreateReview:
|
6059
|
+
# @param NeedCreateReview: 是否需要发起前审批
|
6060
|
+
# <ul><li>当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程</li>
|
6061
|
+
# <li>当NeedCreateReview为false,不需要发起前审核的合同</li></ul>
|
5990
6062
|
# @type NeedCreateReview: Boolean
|
5991
6063
|
|
5992
6064
|
attr_accessor :FlowId, :FlowName, :FlowType, :FlowStatus, :FlowMessage, :CreateOn, :DeadLine, :CustomData, :FlowApproverInfos, :CcInfos, :NeedCreateReview
|
@@ -7247,25 +7319,24 @@ module TencentCloud
|
|
7247
7319
|
end
|
7248
7320
|
end
|
7249
7321
|
|
7250
|
-
#
|
7322
|
+
# 同步的员工的信息
|
7251
7323
|
class ProxyOrganizationOperator < TencentCloud::Common::AbstractModel
|
7252
|
-
# @param Id:
|
7324
|
+
# @param Id: 员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
7253
7325
|
# @type Id: String
|
7254
|
-
# @param Name:
|
7326
|
+
# @param Name: 员工的姓名,最大长度50个字符
|
7327
|
+
# 员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
|
7255
7328
|
# @type Name: String
|
7256
|
-
# @param IdCardType:
|
7257
|
-
#
|
7258
|
-
#
|
7259
|
-
#
|
7329
|
+
# @param IdCardType: 签署方经办人的证件类型,支持以下类型
|
7330
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
7331
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
7332
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
7260
7333
|
# @type IdCardType: String
|
7261
7334
|
# @param IdCardNumber: 经办人证件号
|
7262
7335
|
# @type IdCardNumber: String
|
7263
|
-
# @param Mobile:
|
7336
|
+
# @param Mobile: 员工的手机号,支持国内手机号11位数字(无需加+86前缀或其他字符),不支持海外手机号。
|
7264
7337
|
# @type Mobile: String
|
7265
|
-
# @param DefaultRole:
|
7266
|
-
#
|
7267
|
-
# 经办人:channel-normal-operator
|
7268
|
-
# 业务员:channel-sales-man
|
7338
|
+
# @param DefaultRole: 预先分配员工的角色, 可以分配的角色如下:
|
7339
|
+
# <table> <thead> <tr> <th>可以分配的角色</th> <th>角色名称</th> <th>角色描述</th> </tr> </thead> <tbody> <tr> <td>admin</td> <td>业务管理员(IT 系统负责人,e.g. CTO)</td> <td>有企业合同模块、印章模块、模板模块等全量功能及数据权限。</td> </tr> <tr> <td>channel-normal-operator</td> <td>经办人(企业法务负责人)</td> <td>有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。</td> </tr> <tr> <td>channel-sales-man</td> <td>业务员(一般为销售员、采购员)</td> <td>有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。</td> </tr> </tbody> </table>
|
7269
7340
|
# @type DefaultRole: String
|
7270
7341
|
|
7271
7342
|
attr_accessor :Id, :Name, :IdCardType, :IdCardNumber, :Mobile, :DefaultRole
|
@@ -7289,18 +7360,18 @@ module TencentCloud
|
|
7289
7360
|
end
|
7290
7361
|
end
|
7291
7362
|
|
7292
|
-
#
|
7363
|
+
# 流程中签署方和填写方(如果有填写控件存证时)的信息
|
7293
7364
|
class Recipient < TencentCloud::Common::AbstractModel
|
7294
|
-
# @param RecipientId:
|
7365
|
+
# @param RecipientId: 合同参与方的角色ID
|
7295
7366
|
# @type RecipientId: String
|
7296
|
-
# @param RecipientType:
|
7297
|
-
# ENTERPRISE
|
7298
|
-
# INDIVIDUAL
|
7299
|
-
# PROMOTER
|
7367
|
+
# @param RecipientType: 参与者类型, 可以选择的类型如下:
|
7368
|
+
# <ul><li> **ENTERPRISE** :此角色为企业参与方</li>
|
7369
|
+
# <li> **INDIVIDUAL** :此角色为个人参与方</li>
|
7370
|
+
# <li> **PROMOTER** :此角色是发起方</li></ul>
|
7300
7371
|
# @type RecipientType: String
|
7301
|
-
# @param Description:
|
7372
|
+
# @param Description: 合同参与方的角色描述,长度不能超过100,只能由中文、字母、数字和下划线组成。
|
7302
7373
|
# @type Description: String
|
7303
|
-
# @param RoleName:
|
7374
|
+
# @param RoleName: 合同参与方的角色名字,长度不能超过20,只能由中文、字母、数字和下划线组成。
|
7304
7375
|
# @type RoleName: String
|
7305
7376
|
# @param RequireValidation: 是否需要校验,
|
7306
7377
|
# true-是,
|
@@ -7385,58 +7456,68 @@ module TencentCloud
|
|
7385
7456
|
end
|
7386
7457
|
end
|
7387
7458
|
|
7388
|
-
#
|
7389
|
-
#
|
7390
|
-
#
|
7391
|
-
#
|
7459
|
+
# 解除协议的签署人,如不指定,默认使用待解除流程(原流程)中的签署人。</br>
|
7460
|
+
# `注意`:
|
7461
|
+
# - 不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
|
7462
|
+
# - 目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
|
7463
|
+
# - 当指定C端签署人的签署方自定义控件别名不空时,除参数ApproverNumber外,可以只传参数ApproverSignRole。
|
7392
7464
|
|
7393
|
-
# 如果需要指定B
|
7394
|
-
# ApproverNumber
|
7395
|
-
#
|
7396
|
-
# -
|
7397
|
-
# -
|
7465
|
+
# 如果需要指定B端(企业身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
|
7466
|
+
# `ApproverNumber`, `OrganizationName`, `ApproverType`必传。</br>
|
7467
|
+
# 对于其他身份标识:
|
7468
|
+
# - **子客企业指定经办人**:OpenId必传,OrganizationOpenId必传;
|
7469
|
+
# - **非子客企业经办人**:Name、Mobile必传。
|
7398
7470
|
class ReleasedApprover < TencentCloud::Common::AbstractModel
|
7399
|
-
# @param
|
7400
|
-
#
|
7401
|
-
# @param ApproverNumber: 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
|
7471
|
+
# @param ApproverNumber: 签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。</br>
|
7472
|
+
# 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
|
7402
7473
|
# @type ApproverNumber: Integer
|
7403
|
-
# @param ApproverType:
|
7404
|
-
# ORGANIZATION
|
7405
|
-
# ENTERPRISESERVER
|
7474
|
+
# @param ApproverType: 指定签署人类型,目前支持
|
7475
|
+
# <ul><li> **ORGANIZATION**:企业(默认值)</li>
|
7476
|
+
# <li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
7406
7477
|
# @type ApproverType: String
|
7407
|
-
# @param Name: 签署人姓名,最大长度50
|
7478
|
+
# @param Name: 签署人姓名,最大长度50个字。
|
7408
7479
|
# @type Name: String
|
7409
|
-
# @param IdCardType:
|
7410
|
-
#
|
7411
|
-
#
|
7412
|
-
#
|
7480
|
+
# @param IdCardType: 签署方经办人的证件类型,支持以下类型
|
7481
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
7482
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
7483
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
7413
7484
|
# @type IdCardType: String
|
7414
|
-
# @param IdCardNumber:
|
7485
|
+
# @param IdCardNumber: 证件号码,应符合以下规则
|
7486
|
+
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
7487
|
+
# <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
7488
|
+
# <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
7415
7489
|
# @type IdCardNumber: String
|
7416
|
-
# @param Mobile:
|
7490
|
+
# @param Mobile: 签署人手机号。
|
7417
7491
|
# @type Mobile: String
|
7418
|
-
# @param
|
7492
|
+
# @param OrganizationName: 组织机构名称。
|
7493
|
+
# 请确认该名称与企业营业执照中注册的名称一致。
|
7494
|
+
# 如果名称中包含英文括号(),请使用中文括号()代替。
|
7495
|
+
# 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
7496
|
+
# @type OrganizationName: String
|
7497
|
+
# @param OrganizationOpenId: 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br>
|
7498
|
+
# 当为子客企业指定经办人时,此OrganizationOpenId必传。
|
7419
7499
|
# @type OrganizationOpenId: String
|
7420
|
-
# @param OpenId:
|
7421
|
-
#
|
7500
|
+
# @param OpenId: 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。</br>
|
7501
|
+
# 当签署方为同一第三方平台下的员工时,此OpenId必传。
|
7422
7502
|
# @type OpenId: String
|
7423
|
-
# @param ApproverSignComponentType:
|
7424
|
-
#
|
7425
|
-
#
|
7503
|
+
# @param ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
|
7504
|
+
# <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
|
7505
|
+
# <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
7426
7506
|
# @type ApproverSignComponentType: String
|
7427
|
-
# @param ApproverSignRole:
|
7507
|
+
# @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。</br>
|
7508
|
+
# 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
|
7428
7509
|
# @type ApproverSignRole: String
|
7429
7510
|
|
7430
|
-
attr_accessor :
|
7511
|
+
attr_accessor :ApproverNumber, :ApproverType, :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :OrganizationOpenId, :OpenId, :ApproverSignComponentType, :ApproverSignRole
|
7431
7512
|
|
7432
|
-
def initialize(
|
7433
|
-
@OrganizationName = organizationname
|
7513
|
+
def initialize(approvernumber=nil, approvertype=nil, name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, organizationopenid=nil, openid=nil, approversigncomponenttype=nil, approversignrole=nil)
|
7434
7514
|
@ApproverNumber = approvernumber
|
7435
7515
|
@ApproverType = approvertype
|
7436
7516
|
@Name = name
|
7437
7517
|
@IdCardType = idcardtype
|
7438
7518
|
@IdCardNumber = idcardnumber
|
7439
7519
|
@Mobile = mobile
|
7520
|
+
@OrganizationName = organizationname
|
7440
7521
|
@OrganizationOpenId = organizationopenid
|
7441
7522
|
@OpenId = openid
|
7442
7523
|
@ApproverSignComponentType = approversigncomponenttype
|
@@ -7444,13 +7525,13 @@ module TencentCloud
|
|
7444
7525
|
end
|
7445
7526
|
|
7446
7527
|
def deserialize(params)
|
7447
|
-
@OrganizationName = params['OrganizationName']
|
7448
7528
|
@ApproverNumber = params['ApproverNumber']
|
7449
7529
|
@ApproverType = params['ApproverType']
|
7450
7530
|
@Name = params['Name']
|
7451
7531
|
@IdCardType = params['IdCardType']
|
7452
7532
|
@IdCardNumber = params['IdCardNumber']
|
7453
7533
|
@Mobile = params['Mobile']
|
7534
|
+
@OrganizationName = params['OrganizationName']
|
7454
7535
|
@OrganizationOpenId = params['OrganizationOpenId']
|
7455
7536
|
@OpenId = params['OpenId']
|
7456
7537
|
@ApproverSignComponentType = params['ApproverSignComponentType']
|
@@ -7768,12 +7849,11 @@ module TencentCloud
|
|
7768
7849
|
end
|
7769
7850
|
end
|
7770
7851
|
|
7771
|
-
#
|
7852
|
+
# 同步员工失败原因
|
7772
7853
|
class SyncFailReason < TencentCloud::Common::AbstractModel
|
7773
|
-
# @param Id:
|
7854
|
+
# @param Id: 企业员工标识(即OpenId)
|
7774
7855
|
# @type Id: String
|
7775
|
-
# @param Message:
|
7776
|
-
# 例如:Id不符合规范、证件号码不合法等
|
7856
|
+
# @param Message: 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
|
7777
7857
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7778
7858
|
# @type Message: String
|
7779
7859
|
|
@@ -7792,11 +7872,21 @@ module TencentCloud
|
|
7792
7872
|
|
7793
7873
|
# SyncProxyOrganizationOperators请求参数结构体
|
7794
7874
|
class SyncProxyOrganizationOperatorsRequest < TencentCloud::Common::AbstractModel
|
7795
|
-
# @param Agent:
|
7875
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
7876
|
+
|
7877
|
+
# 此接口下面信息必填。
|
7878
|
+
# <ul>
|
7879
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
7880
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
7881
|
+
# </ul>
|
7882
|
+
# 第三方平台子客企业必须已经经过实名认证
|
7796
7883
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
7797
|
-
# @param OperatorType:
|
7884
|
+
# @param OperatorType: 操作类型,对应的操作
|
7885
|
+
# <ul><li> **CREATE** :新增员工</li>
|
7886
|
+
# <li> **UPDATE** :修改员工</li>
|
7887
|
+
# <li> **RESIGN** :离职员工</li></ul>
|
7798
7888
|
# @type OperatorType: String
|
7799
|
-
# @param ProxyOrganizationOperators:
|
7889
|
+
# @param ProxyOrganizationOperators: 员工信息列表,最多支持200个
|
7800
7890
|
# @type ProxyOrganizationOperators: Array
|
7801
7891
|
# @param Operator: 暂未开放
|
7802
7892
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
@@ -7836,12 +7926,13 @@ module TencentCloud
|
|
7836
7926
|
|
7837
7927
|
# SyncProxyOrganizationOperators返回参数结构体
|
7838
7928
|
class SyncProxyOrganizationOperatorsResponse < TencentCloud::Common::AbstractModel
|
7839
|
-
# @param Status:
|
7840
|
-
|
7841
|
-
#
|
7929
|
+
# @param Status: 同步的状态, 全部同步失败接口是接口会直接报错
|
7930
|
+
|
7931
|
+
# <ul><li> **1** :全部成功</li>
|
7932
|
+
# <li> **2** :部分成功</li></ul>
|
7842
7933
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7843
7934
|
# @type Status: Integer
|
7844
|
-
# @param FailedList:
|
7935
|
+
# @param FailedList: 同步失败员工ID及其失败原因
|
7845
7936
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7846
7937
|
# @type FailedList: Array
|
7847
7938
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tencentcloud-sdk-essbasic
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.693
|
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-11-
|
11
|
+
date: 2023-11-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|