tencentcloud-sdk-essbasic 3.0.692 → 3.0.694
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/v20210526/client.rb +42 -14
- data/lib/v20210526/models.rb +207 -128
- 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: f03e4987042c0a918a16d1893c49fa5be52603dc
|
|
4
|
+
data.tar.gz: 9f079cce878c38fa3f08190c4244418b02d9f0c2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 25e95c4ff85e82970488b1311ac7582a2f18d1249b7c14fad9252f077bb2dafe0f65b4b8afb06ec4c63cee40408bd3d7a231d11d6d5e0c3cb1cf2dc680548d12
|
|
7
|
+
data.tar.gz: 7f6f779ea99c5cc432d1a216370e57a5757c3613240bd85944fff6aa9acf43efe519f1c0be12e38b46af3fab01f85d6b9a377e91a24acbdd2dc5087265bc0119
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.694
|
data/lib/v20210526/client.rb
CHANGED
|
@@ -653,10 +653,14 @@ module TencentCloud
|
|
|
653
653
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
654
654
|
end
|
|
655
655
|
|
|
656
|
-
#
|
|
657
|
-
|
|
658
|
-
#
|
|
659
|
-
#
|
|
656
|
+
# 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
|
|
657
|
+
|
|
658
|
+
# `注意：`<br/>
|
|
659
|
+
# `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
|
|
660
|
+
# `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
|
|
661
|
+
# `3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接 。` <br/>
|
|
662
|
+
# `4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
|
|
663
|
+
# 跳转到小程序的实现，参考微信官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式），如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
660
664
|
|
|
661
665
|
# @param request: Request instance for ChannelCreateFlowSignUrl.
|
|
662
666
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
|
|
@@ -1351,12 +1355,13 @@ module TencentCloud
|
|
|
1351
1355
|
# 提交申请出证报告任务并返回报告ID。
|
|
1352
1356
|
|
|
1353
1357
|
# 注意：
|
|
1354
|
-
#
|
|
1355
|
-
#
|
|
1356
|
-
#
|
|
1357
|
-
#
|
|
1358
|
+
# - 使用此功能**需搭配出证套餐** ，使用前请联系对接的客户经理沟通。
|
|
1359
|
+
# - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
1360
|
+
# - 合同流程必须**所有参与方已经签署完成**。
|
|
1361
|
+
# - 出证过程需一定时间，建议在**提交出证任务后的24小时之后**，通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
1358
1362
|
|
|
1359
|
-
|
|
1363
|
+
|
|
1364
|
+
# 
|
|
1360
1365
|
|
|
1361
1366
|
# @param request: Request instance for CreateChannelFlowEvidenceReport.
|
|
1362
1367
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelFlowEvidenceReportRequest`
|
|
@@ -1639,7 +1644,14 @@ module TencentCloud
|
|
|
1639
1644
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1640
1645
|
end
|
|
1641
1646
|
|
|
1642
|
-
#
|
|
1647
|
+
# 获取出证报告任务执行结果，返回报告 URL。
|
|
1648
|
+
|
|
1649
|
+
# 注意：
|
|
1650
|
+
|
|
1651
|
+
# - 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
|
|
1652
|
+
# - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
|
|
1653
|
+
|
|
1654
|
+
# 
|
|
1643
1655
|
|
|
1644
1656
|
# @param request: Request instance for DescribeChannelFlowEvidenceReport.
|
|
1645
1657
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeChannelFlowEvidenceReportRequest`
|
|
@@ -1695,7 +1707,11 @@ module TencentCloud
|
|
|
1695
1707
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1696
1708
|
end
|
|
1697
1709
|
|
|
1698
|
-
#
|
|
1710
|
+
# 此接口用于查询合同或者合同组的详情信息，支持查询多个（数量不能超过100）。
|
|
1711
|
+
|
|
1712
|
+
# 适用场景：可用于主动查询某个合同或者合同组的详情信息。
|
|
1713
|
+
|
|
1714
|
+
# 注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
1699
1715
|
|
|
1700
1716
|
# @param request: Request instance for DescribeFlowDetailInfo.
|
|
1701
1717
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeFlowDetailInfoRequest`
|
|
@@ -1763,6 +1779,8 @@ module TencentCloud
|
|
|
1763
1779
|
# - 发起方和签署方的填写控件 Components
|
|
1764
1780
|
# - 签署方的签署控件 SignComponents
|
|
1765
1781
|
|
|
1782
|
+
# 
|
|
1783
|
+
|
|
1766
1784
|
# **适用场景**
|
|
1767
1785
|
# 该接口常用来配合<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>接口，作为创建合同的前置接口使用。
|
|
1768
1786
|
# 通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
|
|
@@ -1999,7 +2017,17 @@ module TencentCloud
|
|
|
1999
2017
|
end
|
|
2000
2018
|
|
|
2001
2019
|
# 此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。
|
|
2002
|
-
|
|
2020
|
+
|
|
2021
|
+
# - **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
2022
|
+
|
|
2023
|
+
# - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
2024
|
+
|
|
2025
|
+
# 
|
|
2026
|
+
|
|
2027
|
+
# **注**:
|
|
2028
|
+
# - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
2029
|
+
# - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
2030
|
+
# - 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
2003
2031
|
|
|
2004
2032
|
# @param request: Request instance for SyncProxyOrganizationOperators.
|
|
2005
2033
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationOperatorsRequest`
|
|
@@ -2030,8 +2058,8 @@ module TencentCloud
|
|
|
2030
2058
|
# 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
2031
2059
|
|
|
2032
2060
|
# 注:
|
|
2033
|
-
# 1.
|
|
2034
|
-
# 2.
|
|
2061
|
+
# 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
2062
|
+
# 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**，正式环境需要设置为**file.ess.tencent.cn**，代码示例
|
|
2035
2063
|
# ```
|
|
2036
2064
|
# HttpProfile httpProfile = new HttpProfile();
|
|
2037
2065
|
# httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
data/lib/v20210526/models.rb
CHANGED
|
@@ -460,6 +460,8 @@ module TencentCloud
|
|
|
460
460
|
# ChannelBatchCancelFlows返回参数结构体
|
|
461
461
|
class ChannelBatchCancelFlowsResponse < TencentCloud::Common::AbstractModel
|
|
462
462
|
# @param FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
|
|
463
|
+
|
|
464
|
+
# 注: `如果全部撤销成功, 此数组为空数组`
|
|
463
465
|
# @type FailMessages: Array
|
|
464
466
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
465
467
|
# @type RequestId: String
|
|
@@ -1741,17 +1743,30 @@ module TencentCloud
|
|
|
1741
1743
|
|
|
1742
1744
|
# ChannelCreateFlowSignUrl请求参数结构体
|
|
1743
1745
|
class ChannelCreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
|
|
1744
|
-
# @param Agent:
|
|
1746
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1747
|
+
|
|
1748
|
+
# 此接口下面信息必填。
|
|
1749
|
+
# <ul>
|
|
1750
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
1751
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1752
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1753
|
+
# </ul>
|
|
1754
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
1745
1755
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
1746
|
-
# @param FlowId:
|
|
1756
|
+
# @param FlowId: 合同流程ID，为32位字符串。
|
|
1757
|
+
# 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
|
|
1758
|
+
# 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
1747
1759
|
# @type FlowId: String
|
|
1748
|
-
# @param FlowApproverInfos:
|
|
1760
|
+
# @param FlowApproverInfos: 流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，其他可不传。
|
|
1761
|
+
# 注:
|
|
1762
|
+
# `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
|
|
1763
|
+
# `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
|
|
1749
1764
|
# @type FlowApproverInfos: Array
|
|
1750
1765
|
# @param Operator: 用户信息，暂未开放
|
|
1751
1766
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
1752
1767
|
# @param Organization: 机构信息，暂未开放
|
|
1753
1768
|
# @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
|
|
1754
|
-
# @param JumpUrl: 签署完之后的H5
|
|
1769
|
+
# @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
|
|
1755
1770
|
# @type JumpUrl: String
|
|
1756
1771
|
|
|
1757
1772
|
attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl
|
|
@@ -2363,7 +2378,7 @@ module TencentCloud
|
|
|
2363
2378
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
2364
2379
|
# @param Description: 角色描述，最大长度为50个字符
|
|
2365
2380
|
# @type Description: String
|
|
2366
|
-
# @param PermissionGroups: 权限树，权限树内容 PermissionGroups 可参考接口
|
|
2381
|
+
# @param PermissionGroups: 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
|
|
2367
2382
|
# @type PermissionGroups: Array
|
|
2368
2383
|
|
|
2369
2384
|
attr_accessor :Name, :Agent, :Description, :PermissionGroups
|
|
@@ -3518,7 +3533,7 @@ module TencentCloud
|
|
|
3518
3533
|
# @type RoleId: String
|
|
3519
3534
|
# @param Description: 角色描述，最大长度为50个字符
|
|
3520
3535
|
# @type Description: String
|
|
3521
|
-
# @param PermissionGroups: 权限树，权限树内容 PermissionGroups 可参考接口
|
|
3536
|
+
# @param PermissionGroups: 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
|
|
3522
3537
|
# @type PermissionGroups: Array
|
|
3523
3538
|
|
|
3524
3539
|
attr_accessor :Agent, :Name, :RoleId, :Description, :PermissionGroups
|
|
@@ -3669,10 +3684,16 @@ module TencentCloud
|
|
|
3669
3684
|
# ChannelVerifyPdf请求参数结构体
|
|
3670
3685
|
class ChannelVerifyPdfRequest < TencentCloud::Common::AbstractModel
|
|
3671
3686
|
# @param FlowId: 合同流程ID，为32位字符串。
|
|
3672
|
-
# 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
3673
3687
|
# @type FlowId: String
|
|
3674
|
-
# @param Agent:
|
|
3675
|
-
|
|
3688
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3689
|
+
|
|
3690
|
+
# 此接口下面信息必填。
|
|
3691
|
+
# <ul>
|
|
3692
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
3693
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3694
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3695
|
+
# </ul>
|
|
3696
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
3676
3697
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
3677
3698
|
# @param Operator: 暂未开放
|
|
3678
3699
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -3708,15 +3729,10 @@ module TencentCloud
|
|
|
3708
3729
|
# <ul><li>**1**：文件未被篡改，全部签名在腾讯电子签完成。</li>
|
|
3709
3730
|
# <li>**2**：文件未被篡改，部分签名在腾讯电子签完成。</li>
|
|
3710
3731
|
# <li>**3**：文件被篡改。</li>
|
|
3711
|
-
# <li>**4
|
|
3732
|
+
# <li>**4**：异常：文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
|
|
3712
3733
|
# <li>**5**：异常：文件签名格式错误。</li></ul>
|
|
3713
3734
|
# @type VerifyResult: Integer
|
|
3714
|
-
# @param PdfVerifyResults:
|
|
3715
|
-
# <ul><li> **1** :验签成功，在电子签签署</li>
|
|
3716
|
-
# <li> **2** :验签成功，在其他平台签署</li>
|
|
3717
|
-
# <li> **3** :验签失败</li>
|
|
3718
|
-
# <li> **4** :pdf文件没有签名域</li>
|
|
3719
|
-
# <li> **5** :文件签名格式错误</li></ul>
|
|
3735
|
+
# @param PdfVerifyResults: 验签结果详情，所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
|
|
3720
3736
|
# @type PdfVerifyResults: Array
|
|
3721
3737
|
# @param VerifySerialNo: 验签序列号, 为11为数组组成的字符串
|
|
3722
3738
|
# @type VerifySerialNo: String
|
|
@@ -4187,14 +4203,15 @@ module TencentCloud
|
|
|
4187
4203
|
|
|
4188
4204
|
# CreateChannelFlowEvidenceReport请求参数结构体
|
|
4189
4205
|
class CreateChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
|
|
4190
|
-
# @param Agent:
|
|
4206
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4191
4207
|
|
|
4192
4208
|
# 此接口下面信息必填。
|
|
4193
4209
|
# <ul>
|
|
4194
|
-
# <li>渠道应用标识: Agent.
|
|
4195
|
-
# <li>第三方平台子客企业标识: Agent.
|
|
4196
|
-
# <li>第三方平台子客企业中的员工标识: Agent.
|
|
4210
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
4211
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4212
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4197
4213
|
# </ul>
|
|
4214
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
4198
4215
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
4199
4216
|
# @param FlowId: 合同流程ID，为32位字符串。
|
|
4200
4217
|
# 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
|
|
@@ -4913,9 +4930,17 @@ module TencentCloud
|
|
|
4913
4930
|
|
|
4914
4931
|
# DescribeChannelFlowEvidenceReport请求参数结构体
|
|
4915
4932
|
class DescribeChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
|
|
4916
|
-
# @param Agent:
|
|
4933
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4934
|
+
|
|
4935
|
+
# 此接口下面信息必填。
|
|
4936
|
+
# <ul>
|
|
4937
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
4938
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4939
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4940
|
+
# </ul>
|
|
4941
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
4917
4942
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
4918
|
-
# @param ReportId:
|
|
4943
|
+
# @param ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
|
|
4919
4944
|
# @type ReportId: String
|
|
4920
4945
|
# @param Operator: 暂未开放
|
|
4921
4946
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -4946,14 +4971,14 @@ module TencentCloud
|
|
|
4946
4971
|
|
|
4947
4972
|
# DescribeChannelFlowEvidenceReport返回参数结构体
|
|
4948
4973
|
class DescribeChannelFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
|
|
4949
|
-
# @param ReportUrl:
|
|
4974
|
+
# @param ReportUrl: 出证报告PDF的下载 URL，有效期为5分钟，超过有效期后将无法再下载。
|
|
4950
4975
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
4951
4976
|
# @type ReportUrl: String
|
|
4952
|
-
# @param Status:
|
|
4977
|
+
# @param Status: 出证任务执行的状态, 状态含义如下：
|
|
4953
4978
|
|
|
4954
|
-
#
|
|
4955
|
-
#
|
|
4956
|
-
#
|
|
4979
|
+
# <ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
|
|
4980
|
+
# <li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
|
|
4981
|
+
# <li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
|
|
4957
4982
|
# @type Status: String
|
|
4958
4983
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4959
4984
|
# @type RequestId: String
|
|
@@ -5029,13 +5054,22 @@ module TencentCloud
|
|
|
5029
5054
|
|
|
5030
5055
|
# DescribeFlowDetailInfo请求参数结构体
|
|
5031
5056
|
class DescribeFlowDetailInfoRequest < TencentCloud::Common::AbstractModel
|
|
5032
|
-
# @param Agent:
|
|
5057
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5058
|
+
|
|
5059
|
+
# 此接口下面信息必填。
|
|
5060
|
+
# <ul>
|
|
5061
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
5062
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5063
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5064
|
+
# </ul>
|
|
5065
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
5033
5066
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
5034
|
-
# @param FlowIds:
|
|
5035
|
-
#
|
|
5067
|
+
# @param FlowIds: 需要查询的流程ID列表，最多可传入100个ID。
|
|
5068
|
+
# 如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
|
|
5036
5069
|
# @type FlowIds: Array
|
|
5037
|
-
# @param FlowGroupId:
|
|
5038
|
-
|
|
5070
|
+
# @param FlowGroupId: 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。
|
|
5071
|
+
|
|
5072
|
+
# 合同组由<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>等接口创建。
|
|
5039
5073
|
# @type FlowGroupId: String
|
|
5040
5074
|
# @param Operator: 暂未开放
|
|
5041
5075
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -5068,17 +5102,18 @@ module TencentCloud
|
|
|
5068
5102
|
|
|
5069
5103
|
# DescribeFlowDetailInfo返回参数结构体
|
|
5070
5104
|
class DescribeFlowDetailInfoResponse < TencentCloud::Common::AbstractModel
|
|
5071
|
-
# @param ApplicationId:
|
|
5105
|
+
# @param ApplicationId: 合同归属的第三方平台应用号ID
|
|
5072
5106
|
# @type ApplicationId: String
|
|
5073
|
-
# @param ProxyOrganizationOpenId:
|
|
5107
|
+
# @param ProxyOrganizationOpenId: 合同归属的第三方平台子客企业OpenId
|
|
5074
5108
|
# @type ProxyOrganizationOpenId: String
|
|
5075
|
-
# @param FlowInfo:
|
|
5109
|
+
# @param FlowInfo: 合同流程的详细信息。
|
|
5110
|
+
# 如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
|
|
5076
5111
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5077
5112
|
# @type FlowInfo: Array
|
|
5078
|
-
# @param FlowGroupId:
|
|
5113
|
+
# @param FlowGroupId: 合同组ID，只有在查询合同组信息时才会返回。
|
|
5079
5114
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5080
5115
|
# @type FlowGroupId: String
|
|
5081
|
-
# @param FlowGroupName:
|
|
5116
|
+
# @param FlowGroupName: 合同组名称，只有在查询合同组信息时才会返回。
|
|
5082
5117
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5083
5118
|
# @type FlowGroupName: String
|
|
5084
5119
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -5982,17 +6017,24 @@ module TencentCloud
|
|
|
5982
6017
|
end
|
|
5983
6018
|
end
|
|
5984
6019
|
|
|
5985
|
-
#
|
|
6020
|
+
# 签署人签署链接信息。
|
|
5986
6021
|
class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
|
|
5987
|
-
# @param SignUrl:
|
|
6022
|
+
# @param SignUrl: 签署短链接。</br>
|
|
6023
|
+
# 注意:
|
|
6024
|
+
# - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
|
|
6025
|
+
# - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
|
|
5988
6026
|
# @type SignUrl: String
|
|
5989
|
-
# @param ApproverType:
|
|
6027
|
+
# @param ApproverType: 签署人类型。
|
|
6028
|
+
# - **PERSON**: 个人
|
|
5990
6029
|
# @type ApproverType: String
|
|
5991
|
-
# @param Name:
|
|
6030
|
+
# @param Name: 签署人姓名。
|
|
5992
6031
|
# @type Name: String
|
|
5993
|
-
# @param Mobile:
|
|
6032
|
+
# @param Mobile: 签署人手机号。
|
|
5994
6033
|
# @type Mobile: String
|
|
5995
|
-
# @param LongUrl:
|
|
6034
|
+
# @param LongUrl: 签署长链接。</br>
|
|
6035
|
+
# 注意:
|
|
6036
|
+
# - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
|
|
6037
|
+
# - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
|
|
5996
6038
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5997
6039
|
# @type LongUrl: String
|
|
5998
6040
|
|
|
@@ -6017,36 +6059,38 @@ module TencentCloud
|
|
|
6017
6059
|
|
|
6018
6060
|
# 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
|
6019
6061
|
class FlowDetailInfo < TencentCloud::Common::AbstractModel
|
|
6020
|
-
# @param FlowId:
|
|
6062
|
+
# @param FlowId: 合同流程ID，为32位字符串。
|
|
6021
6063
|
# @type FlowId: String
|
|
6022
|
-
# @param FlowName:
|
|
6064
|
+
# @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
|
|
6023
6065
|
# @type FlowName: String
|
|
6024
|
-
# @param FlowType:
|
|
6066
|
+
# @param FlowType: 合同流程的类别分类（如销售合同/入职合同等）。
|
|
6025
6067
|
# @type FlowType: String
|
|
6026
|
-
# @param FlowStatus:
|
|
6027
|
-
|
|
6028
|
-
#
|
|
6029
|
-
#
|
|
6030
|
-
#
|
|
6031
|
-
#
|
|
6032
|
-
#
|
|
6033
|
-
#
|
|
6034
|
-
# RELIEVED 解除协议（已解除）
|
|
6068
|
+
# @param FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
|
|
6069
|
+
# <ul><li> **INIT** :合同创建</li>
|
|
6070
|
+
# <li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
|
|
6071
|
+
# <li> **REJECT** :合同拒签</li>
|
|
6072
|
+
# <li> **ALL** :合同签署完成</li>
|
|
6073
|
+
# <li> **DEADLINE** :合同流签(合同过期)</li>
|
|
6074
|
+
# <li> **CANCEL** :合同撤回</li>
|
|
6075
|
+
# <li> **RELIEVED** :解除协议（已解除）</li></ul>
|
|
6035
6076
|
|
|
6036
6077
|
# @type FlowStatus: String
|
|
6037
|
-
# @param FlowMessage:
|
|
6078
|
+
# @param FlowMessage: 当合同流程状态为已拒签（即 FlowStatus=REJECT）或已撤销（即 FlowStatus=CANCEL ）时，此字段 FlowMessage 为拒签或撤销原因。
|
|
6038
6079
|
# @type FlowMessage: String
|
|
6039
|
-
# @param CreateOn:
|
|
6080
|
+
# @param CreateOn: 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。
|
|
6040
6081
|
# @type CreateOn: Integer
|
|
6041
|
-
# @param DeadLine:
|
|
6082
|
+
# @param DeadLine: 签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
|
|
6042
6083
|
# @type DeadLine: Integer
|
|
6043
|
-
# @param CustomData:
|
|
6084
|
+
# @param CustomData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 1000长度。
|
|
6085
|
+
# 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
|
|
6044
6086
|
# @type CustomData: String
|
|
6045
|
-
# @param FlowApproverInfos:
|
|
6087
|
+
# @param FlowApproverInfos: 合同流程的签署方数组
|
|
6046
6088
|
# @type FlowApproverInfos: Array
|
|
6047
|
-
# @param CcInfos:
|
|
6089
|
+
# @param CcInfos: 合同流程的关注方信息数组
|
|
6048
6090
|
# @type CcInfos: Array
|
|
6049
|
-
# @param NeedCreateReview:
|
|
6091
|
+
# @param NeedCreateReview: 是否需要发起前审批
|
|
6092
|
+
# <ul><li>当NeedCreateReview为true，表明当前流程是需要发起前审核的合同，可能无法进行查看，签署操作，需要等审核完成后，才可以继续后续流程</li>
|
|
6093
|
+
# <li>当NeedCreateReview为false，不需要发起前审核的合同</li></ul>
|
|
6050
6094
|
# @type NeedCreateReview: Boolean
|
|
6051
6095
|
|
|
6052
6096
|
attr_accessor :FlowId, :FlowName, :FlowType, :FlowStatus, :FlowMessage, :CreateOn, :DeadLine, :CustomData, :FlowApproverInfos, :CcInfos, :NeedCreateReview
|
|
@@ -7062,25 +7106,41 @@ module TencentCloud
|
|
|
7062
7106
|
end
|
|
7063
7107
|
end
|
|
7064
7108
|
|
|
7065
|
-
#
|
|
7109
|
+
# 合同验签每个签署区的信息
|
|
7066
7110
|
class PdfVerifyResult < TencentCloud::Common::AbstractModel
|
|
7067
|
-
# @param VerifyResult:
|
|
7111
|
+
# @param VerifyResult: 验签结果详情，每个签名域对应的验签结果。状态值如下
|
|
7112
|
+
# <ul><li> **1** :验签成功，在电子签签署</li>
|
|
7113
|
+
# <li> **2** :验签成功，在其他平台签署</li>
|
|
7114
|
+
# <li> **3** :验签失败</li>
|
|
7115
|
+
# <li> **4** :pdf文件没有签名域</li>
|
|
7116
|
+
# <li> **5** :文件签名格式错误</li></ul>
|
|
7068
7117
|
# @type VerifyResult: Integer
|
|
7069
|
-
# @param SignPlatform:
|
|
7118
|
+
# @param SignPlatform: 签署平台
|
|
7119
|
+
# 如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
|
|
7120
|
+
# 如果文件不在腾讯电子签平台签署，则为**其他平台**。
|
|
7070
7121
|
# @type SignPlatform: String
|
|
7071
|
-
# @param SignerName:
|
|
7122
|
+
# @param SignerName: 申请证书的主体的名字
|
|
7123
|
+
|
|
7124
|
+
# 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
|
|
7125
|
+
# **企业**: ESS@企业名称@编码
|
|
7126
|
+
# **个人**: ESS@个人姓名@证件号@808854
|
|
7127
|
+
|
|
7128
|
+
# 如果在其他平台签署的, 主体的名字参考其他平台的说明
|
|
7072
7129
|
# @type SignerName: String
|
|
7073
|
-
# @param SignTime:
|
|
7130
|
+
# @param SignTime: 签署时间的Unix时间戳，单位毫秒
|
|
7074
7131
|
# @type SignTime: Integer
|
|
7075
|
-
# @param SignAlgorithm:
|
|
7132
|
+
# @param SignAlgorithm: 证书签名算法, 如SHA1withRSA等算法
|
|
7076
7133
|
# @type SignAlgorithm: String
|
|
7077
|
-
# @param CertSn:
|
|
7134
|
+
# @param CertSn: CA供应商下发给用户的证书编号
|
|
7135
|
+
|
|
7136
|
+
# 注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下`。
|
|
7078
7137
|
# @type CertSn: String
|
|
7079
|
-
# @param CertNotBefore:
|
|
7138
|
+
# @param CertNotBefore: 证书起始时间的Unix时间戳，单位毫秒
|
|
7080
7139
|
# @type CertNotBefore: Integer
|
|
7081
|
-
# @param CertNotAfter:
|
|
7140
|
+
# @param CertNotAfter: 证书过期时间的时间戳，单位毫秒
|
|
7082
7141
|
# @type CertNotAfter: Integer
|
|
7083
|
-
# @param SignType:
|
|
7142
|
+
# @param SignType: 签名类型, 保留字段, 现在全部为0
|
|
7143
|
+
|
|
7084
7144
|
# @type SignType: Integer
|
|
7085
7145
|
# @param ComponentPosX: 签名域横坐标，单位px
|
|
7086
7146
|
# @type ComponentPosX: Float
|
|
@@ -7307,25 +7367,24 @@ module TencentCloud
|
|
|
7307
7367
|
end
|
|
7308
7368
|
end
|
|
7309
7369
|
|
|
7310
|
-
#
|
|
7370
|
+
# 同步的员工的信息
|
|
7311
7371
|
class ProxyOrganizationOperator < TencentCloud::Common::AbstractModel
|
|
7312
|
-
# @param Id:
|
|
7372
|
+
# @param Id: 员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
|
7313
7373
|
# @type Id: String
|
|
7314
|
-
# @param Name:
|
|
7374
|
+
# @param Name: 员工的姓名，最大长度50个字符
|
|
7375
|
+
# 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为真实姓名，而非昵称等代名。
|
|
7315
7376
|
# @type Name: String
|
|
7316
|
-
# @param IdCardType:
|
|
7317
|
-
#
|
|
7318
|
-
#
|
|
7319
|
-
#
|
|
7377
|
+
# @param IdCardType: 签署方经办人的证件类型，支持以下类型
|
|
7378
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
7379
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
7380
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
7320
7381
|
# @type IdCardType: String
|
|
7321
7382
|
# @param IdCardNumber: 经办人证件号
|
|
7322
7383
|
# @type IdCardNumber: String
|
|
7323
|
-
# @param Mobile:
|
|
7384
|
+
# @param Mobile: 员工的手机号，支持国内手机号11位数字(无需加+86前缀或其他字符)，不支持海外手机号。
|
|
7324
7385
|
# @type Mobile: String
|
|
7325
|
-
# @param DefaultRole:
|
|
7326
|
-
#
|
|
7327
|
-
# 经办人：channel-normal-operator
|
|
7328
|
-
# 业务员：channel-sales-man
|
|
7386
|
+
# @param DefaultRole: 预先分配员工的角色, 可以分配的角色如下:
|
|
7387
|
+
# <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>
|
|
7329
7388
|
# @type DefaultRole: String
|
|
7330
7389
|
|
|
7331
7390
|
attr_accessor :Id, :Name, :IdCardType, :IdCardNumber, :Mobile, :DefaultRole
|
|
@@ -7445,58 +7504,68 @@ module TencentCloud
|
|
|
7445
7504
|
end
|
|
7446
7505
|
end
|
|
7447
7506
|
|
|
7448
|
-
#
|
|
7449
|
-
#
|
|
7450
|
-
#
|
|
7451
|
-
#
|
|
7507
|
+
# 解除协议的签署人，如不指定，默认使用待解除流程(原流程)中的签署人。</br>
|
|
7508
|
+
# `注意`:
|
|
7509
|
+
# - 不支持更换C端(个人身份类型)签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。
|
|
7510
|
+
# - 目前不支持替换C端(个人身份类型)签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。
|
|
7511
|
+
# - 当指定C端签署人的签署方自定义控件别名不空时，除参数ApproverNumber外，可以只传参数ApproverSignRole。
|
|
7452
7512
|
|
|
7453
|
-
# 如果需要指定B
|
|
7454
|
-
# ApproverNumber
|
|
7455
|
-
#
|
|
7456
|
-
# -
|
|
7457
|
-
# -
|
|
7513
|
+
# 如果需要指定B端(企业身份类型)签署人，其中ReleasedApprover需要传递的参数如下：
|
|
7514
|
+
# `ApproverNumber`, `OrganizationName`, `ApproverType`必传。</br>
|
|
7515
|
+
# 对于其他身份标识：
|
|
7516
|
+
# - **子客企业指定经办人**：OpenId必传，OrganizationOpenId必传；
|
|
7517
|
+
# - **非子客企业经办人**：Name、Mobile必传。
|
|
7458
7518
|
class ReleasedApprover < TencentCloud::Common::AbstractModel
|
|
7459
|
-
# @param
|
|
7460
|
-
#
|
|
7461
|
-
# @param ApproverNumber: 签署人在原流程中的签署人列表中的顺序序号（从0开始，按顺序依次递增），如果不清楚原流程中的签署人列表，可以通过DescribeFlows接口查看
|
|
7519
|
+
# @param ApproverNumber: 签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。</br>
|
|
7520
|
+
# 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
|
|
7462
7521
|
# @type ApproverNumber: Integer
|
|
7463
|
-
# @param ApproverType:
|
|
7464
|
-
# ORGANIZATION
|
|
7465
|
-
# ENTERPRISESERVER
|
|
7522
|
+
# @param ApproverType: 指定签署人类型，目前支持
|
|
7523
|
+
# <ul><li> **ORGANIZATION**：企业（默认值）</li>
|
|
7524
|
+
# <li> **ENTERPRISESERVER**：企业静默签</li></ul>
|
|
7466
7525
|
# @type ApproverType: String
|
|
7467
|
-
# @param Name: 签署人姓名，最大长度50
|
|
7526
|
+
# @param Name: 签署人姓名，最大长度50个字。
|
|
7468
7527
|
# @type Name: String
|
|
7469
|
-
# @param IdCardType:
|
|
7470
|
-
#
|
|
7471
|
-
#
|
|
7472
|
-
#
|
|
7528
|
+
# @param IdCardType: 签署方经办人的证件类型，支持以下类型
|
|
7529
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
7530
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
7531
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
7473
7532
|
# @type IdCardType: String
|
|
7474
|
-
# @param IdCardNumber:
|
|
7533
|
+
# @param IdCardNumber: 证件号码，应符合以下规则
|
|
7534
|
+
# <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
|
|
7535
|
+
# <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
|
|
7536
|
+
# <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
|
|
7475
7537
|
# @type IdCardNumber: String
|
|
7476
|
-
# @param Mobile:
|
|
7538
|
+
# @param Mobile: 签署人手机号。
|
|
7477
7539
|
# @type Mobile: String
|
|
7478
|
-
# @param
|
|
7540
|
+
# @param OrganizationName: 组织机构名称。
|
|
7541
|
+
# 请确认该名称与企业营业执照中注册的名称一致。
|
|
7542
|
+
# 如果名称中包含英文括号()，请使用中文括号（）代替。
|
|
7543
|
+
# 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
|
|
7544
|
+
# @type OrganizationName: String
|
|
7545
|
+
# @param OrganizationOpenId: 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br>
|
|
7546
|
+
# 当为子客企业指定经办人时，此OrganizationOpenId必传。
|
|
7479
7547
|
# @type OrganizationOpenId: String
|
|
7480
|
-
# @param OpenId:
|
|
7481
|
-
#
|
|
7548
|
+
# @param OpenId: 第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。</br>
|
|
7549
|
+
# 当签署方为同一第三方平台下的员工时，此OpenId必传。
|
|
7482
7550
|
# @type OpenId: String
|
|
7483
|
-
# @param ApproverSignComponentType:
|
|
7484
|
-
#
|
|
7485
|
-
#
|
|
7551
|
+
# @param ApproverSignComponentType: 签署控件类型，支持自定义企业签署方的签署控件类型
|
|
7552
|
+
# <ul><li> **SIGN_SEAL**：默认为印章控件类型(默认值)</li>
|
|
7553
|
+
# <li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
|
|
7486
7554
|
# @type ApproverSignComponentType: String
|
|
7487
|
-
# @param ApproverSignRole:
|
|
7555
|
+
# @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。</br>
|
|
7556
|
+
# 如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
|
|
7488
7557
|
# @type ApproverSignRole: String
|
|
7489
7558
|
|
|
7490
|
-
attr_accessor :
|
|
7559
|
+
attr_accessor :ApproverNumber, :ApproverType, :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :OrganizationOpenId, :OpenId, :ApproverSignComponentType, :ApproverSignRole
|
|
7491
7560
|
|
|
7492
|
-
def initialize(
|
|
7493
|
-
@OrganizationName = organizationname
|
|
7561
|
+
def initialize(approvernumber=nil, approvertype=nil, name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, organizationopenid=nil, openid=nil, approversigncomponenttype=nil, approversignrole=nil)
|
|
7494
7562
|
@ApproverNumber = approvernumber
|
|
7495
7563
|
@ApproverType = approvertype
|
|
7496
7564
|
@Name = name
|
|
7497
7565
|
@IdCardType = idcardtype
|
|
7498
7566
|
@IdCardNumber = idcardnumber
|
|
7499
7567
|
@Mobile = mobile
|
|
7568
|
+
@OrganizationName = organizationname
|
|
7500
7569
|
@OrganizationOpenId = organizationopenid
|
|
7501
7570
|
@OpenId = openid
|
|
7502
7571
|
@ApproverSignComponentType = approversigncomponenttype
|
|
@@ -7504,13 +7573,13 @@ module TencentCloud
|
|
|
7504
7573
|
end
|
|
7505
7574
|
|
|
7506
7575
|
def deserialize(params)
|
|
7507
|
-
@OrganizationName = params['OrganizationName']
|
|
7508
7576
|
@ApproverNumber = params['ApproverNumber']
|
|
7509
7577
|
@ApproverType = params['ApproverType']
|
|
7510
7578
|
@Name = params['Name']
|
|
7511
7579
|
@IdCardType = params['IdCardType']
|
|
7512
7580
|
@IdCardNumber = params['IdCardNumber']
|
|
7513
7581
|
@Mobile = params['Mobile']
|
|
7582
|
+
@OrganizationName = params['OrganizationName']
|
|
7514
7583
|
@OrganizationOpenId = params['OrganizationOpenId']
|
|
7515
7584
|
@OpenId = params['OpenId']
|
|
7516
7585
|
@ApproverSignComponentType = params['ApproverSignComponentType']
|
|
@@ -7828,12 +7897,11 @@ module TencentCloud
|
|
|
7828
7897
|
end
|
|
7829
7898
|
end
|
|
7830
7899
|
|
|
7831
|
-
#
|
|
7900
|
+
# 同步员工失败原因
|
|
7832
7901
|
class SyncFailReason < TencentCloud::Common::AbstractModel
|
|
7833
|
-
# @param Id:
|
|
7902
|
+
# @param Id: 企业员工标识(即OpenId)
|
|
7834
7903
|
# @type Id: String
|
|
7835
|
-
# @param Message:
|
|
7836
|
-
# 例如：Id不符合规范、证件号码不合法等
|
|
7904
|
+
# @param Message: 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
|
|
7837
7905
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
7838
7906
|
# @type Message: String
|
|
7839
7907
|
|
|
@@ -7852,11 +7920,21 @@ module TencentCloud
|
|
|
7852
7920
|
|
|
7853
7921
|
# SyncProxyOrganizationOperators请求参数结构体
|
|
7854
7922
|
class SyncProxyOrganizationOperatorsRequest < TencentCloud::Common::AbstractModel
|
|
7855
|
-
# @param Agent:
|
|
7923
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
7924
|
+
|
|
7925
|
+
# 此接口下面信息必填。
|
|
7926
|
+
# <ul>
|
|
7927
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
7928
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
7929
|
+
# </ul>
|
|
7930
|
+
# 第三方平台子客企业必须已经经过实名认证
|
|
7856
7931
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
7857
|
-
# @param OperatorType:
|
|
7932
|
+
# @param OperatorType: 操作类型，对应的操作
|
|
7933
|
+
# <ul><li> **CREATE** :新增员工</li>
|
|
7934
|
+
# <li> **UPDATE** :修改员工</li>
|
|
7935
|
+
# <li> **RESIGN** :离职员工</li></ul>
|
|
7858
7936
|
# @type OperatorType: String
|
|
7859
|
-
# @param ProxyOrganizationOperators:
|
|
7937
|
+
# @param ProxyOrganizationOperators: 员工信息列表，最多支持200个
|
|
7860
7938
|
# @type ProxyOrganizationOperators: Array
|
|
7861
7939
|
# @param Operator: 暂未开放
|
|
7862
7940
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -7896,12 +7974,13 @@ module TencentCloud
|
|
|
7896
7974
|
|
|
7897
7975
|
# SyncProxyOrganizationOperators返回参数结构体
|
|
7898
7976
|
class SyncProxyOrganizationOperatorsResponse < TencentCloud::Common::AbstractModel
|
|
7899
|
-
# @param Status:
|
|
7900
|
-
|
|
7901
|
-
#
|
|
7977
|
+
# @param Status: 同步的状态, 全部同步失败接口是接口会直接报错
|
|
7978
|
+
|
|
7979
|
+
# <ul><li> **1** :全部成功</li>
|
|
7980
|
+
# <li> **2** :部分成功</li></ul>
|
|
7902
7981
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
7903
7982
|
# @type Status: Integer
|
|
7904
|
-
# @param FailedList:
|
|
7983
|
+
# @param FailedList: 同步失败员工ID及其失败原因
|
|
7905
7984
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
7906
7985
|
# @type FailedList: Array
|
|
7907
7986
|
# @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.694
|
|
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-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|