tencentcloud-sdk-essbasic 3.0.694 → 3.0.696

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f03e4987042c0a918a16d1893c49fa5be52603dc
4
- data.tar.gz: 9f079cce878c38fa3f08190c4244418b02d9f0c2
3
+ metadata.gz: 3ea8e6ad5e15aace85688d1231f715b40a3fc00b
4
+ data.tar.gz: e325aef8a281af1e089869641399fb5e0ea9f026
5
5
  SHA512:
6
- metadata.gz: 25e95c4ff85e82970488b1311ac7582a2f18d1249b7c14fad9252f077bb2dafe0f65b4b8afb06ec4c63cee40408bd3d7a231d11d6d5e0c3cb1cf2dc680548d12
7
- data.tar.gz: 7f6f779ea99c5cc432d1a216370e57a5757c3613240bd85944fff6aa9acf43efe519f1c0be12e38b46af3fab01f85d6b9a377e91a24acbdd2dc5087265bc0119
6
+ metadata.gz: 2e293fce82d53d64603943b7fe2050362ba00daea9e8c98d9bf03fdbec3ae1edc961687d5af196bb388ef5c8e233149e96f2b06ce4540608825a9222da2345fd
7
+ data.tar.gz: 94435e3ac7f28bb7b617b79f4e2c8294cf3e6899f5926b1e928e80cdf6903e7fc2cdbf6f38e03bce45bd74952f8e29c8e4f77e3afc7b6b248b5c7a03d9e3341d
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.694
1
+ 3.0.696
@@ -596,12 +596,15 @@ module TencentCloud
596
596
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
597
597
  end
598
598
 
599
- # 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
599
+ # 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办
600
+ # 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
601
+ # 2. **每个合同只能催办一次**
600
602
 
601
- # 1. 合同中当前状态为“待签署”的签署人是催办的对象
602
- # 2. 每个合同只能催办一次
603
+ # **催办的效果**: 对方会受到如下的短信通知
604
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
603
605
 
604
- # 注意:该接口无法直接调用,请联系客户经理申请使用。
606
+
607
+ # **注**:`合同催办是白名单功能,请联系客户经理申请开白后使用`
605
608
 
606
609
  # @param request: Request instance for ChannelCreateFlowReminds.
607
610
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowRemindsRequest`
@@ -723,12 +726,12 @@ module TencentCloud
723
726
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
724
727
  end
725
728
 
726
- # 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
729
+ # 通过此接口,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
727
730
 
728
731
  # 注:
729
732
  # - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
730
733
  # - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
731
- # - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
734
+ # - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
732
735
 
733
736
  # @param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
734
737
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlRequest`
@@ -1093,7 +1096,9 @@ module TencentCloud
1093
1096
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1094
1097
  end
1095
1098
 
1096
- # 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
1099
+ # 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
1100
+
1101
+ # **注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
1097
1102
 
1098
1103
  # @param request: Request instance for ChannelDescribeEmployees.
1099
1104
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeEmployeesRequest`
@@ -1476,6 +1481,9 @@ module TencentCloud
1476
1481
  # 1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。
1477
1482
  # 2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
1478
1483
 
1484
+ # 系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
1485
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
1486
+
1479
1487
  # @param request: Request instance for CreateConsoleLoginUrl.
1480
1488
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlRequest`
1481
1489
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlResponse`
@@ -1644,6 +1652,30 @@ module TencentCloud
1644
1652
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1645
1653
  end
1646
1654
 
1655
+ # 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1656
+
1657
+ # @param request: Request instance for DescribeBillUsageDetail.
1658
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeBillUsageDetailRequest`
1659
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeBillUsageDetailResponse`
1660
+ def DescribeBillUsageDetail(request)
1661
+ body = send_request('DescribeBillUsageDetail', request.serialize)
1662
+ response = JSON.parse(body)
1663
+ if response['Response'].key?('Error') == false
1664
+ model = DescribeBillUsageDetailResponse.new
1665
+ model.deserialize(response['Response'])
1666
+ model
1667
+ else
1668
+ code = response['Response']['Error']['Code']
1669
+ message = response['Response']['Error']['Message']
1670
+ reqid = response['Response']['RequestId']
1671
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1672
+ end
1673
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1674
+ raise e
1675
+ rescue StandardError => e
1676
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1677
+ end
1678
+
1647
1679
  # 获取出证报告任务执行结果,返回报告 URL。
1648
1680
 
1649
1681
  # 注意:
@@ -1743,10 +1775,10 @@ module TencentCloud
1743
1775
  # **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
1744
1776
  # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
1745
1777
 
1746
- # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
1778
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
1747
1779
 
1748
1780
  # **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
1749
- # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
1781
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
1750
1782
 
1751
1783
  # @param request: Request instance for DescribeResourceUrlsByFlows.
1752
1784
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeResourceUrlsByFlowsRequest`
@@ -1772,6 +1804,15 @@ module TencentCloud
1772
1804
 
1773
1805
  # 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
1774
1806
 
1807
+ # **适用场景**
1808
+ # 该接口常用来配合<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>接口,作为创建合同的前置接口使用。
1809
+ # 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
1810
+
1811
+ # **模版的来源**
1812
+ # 子客企业的模板有两种途径获取
1813
+ # - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
1814
+ # - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
1815
+
1775
1816
  # **一个模板通常会包含以下结构信息**
1776
1817
 
1777
1818
  # - 模板模版ID, 模板名字等基本信息
@@ -1781,14 +1822,8 @@ module TencentCloud
1781
1822
 
1782
1823
  # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
1783
1824
 
1784
- # **适用场景**
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>接口,作为创建合同的前置接口使用。
1786
- # 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
1787
-
1788
- # **模版的来源**
1789
- # 子客企业的模板有两种途径获取
1790
- # - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
1791
- # - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
1825
+ # 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
1826
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
1792
1827
 
1793
1828
 
1794
1829
  # **注意**
@@ -1990,9 +2025,20 @@ module TencentCloud
1990
2025
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1991
2026
  end
1992
2027
 
1993
- # 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
1994
- # 1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
1995
- # 2. 如果您同时传递了营业执照信息和企业名称等信息,在认证过程中将以营业执照中的企业信息为准,请注意企业信息需要和营业执照信息对应。
2028
+ # 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
2029
+
2030
+ # 注意:
2031
+
2032
+ # - **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
2033
+ # - **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
2034
+
2035
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png)
2036
+
2037
+
2038
+ # - **企业统一社会信用代码**: 对应上图中的**1**
2039
+ # - **第三方平台子客企业名称**: 对应上图中的**2**
2040
+ # - **企业法定代表人的名字**:对应上图中的**3**
2041
+ # - **企业详细住所**:对应上图中的**4**
1996
2042
 
1997
2043
  # @param request: Request instance for SyncProxyOrganization.
1998
2044
  # @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationRequest`
@@ -2018,7 +2064,7 @@ module TencentCloud
2018
2064
 
2019
2065
  # 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
2020
2066
 
2021
- # - **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
2067
+ # - **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
2022
2068
 
2023
2069
  # - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
2024
2070
 
@@ -2027,7 +2073,7 @@ module TencentCloud
2027
2073
  # **注**:
2028
2074
  # - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
2029
2075
  # - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
2030
- # - 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
2076
+ # - 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
2031
2077
 
2032
2078
  # @param request: Request instance for SyncProxyOrganizationOperators.
2033
2079
  # @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationOperatorsRequest`
@@ -17,15 +17,20 @@
17
17
  module TencentCloud
18
18
  module Essbasic
19
19
  module V20210526
20
- # 应用相关信息
20
+ # 应用相关信息, 整体应用的层级图如下
21
+
22
+ # 注:
23
+ # 1. `不同的业务系统可以采用不同的应用,不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`
21
24
  class Agent < TencentCloud::Common::AbstractModel
22
- # @param AppId: 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
25
+ # @param AppId: 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
26
+
27
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)
23
28
  # @type AppId: String
24
29
  # @param ProxyOrganizationOpenId: 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
25
30
  # @type ProxyOrganizationOpenId: String
26
31
  # @param ProxyOperator: 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
27
32
  # @type ProxyOperator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
28
- # @param ProxyAppId: 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
33
+ # @param ProxyAppId: **不用填写**,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
29
34
  # @type ProxyAppId: String
30
35
  # @param ProxyOrganizationId: 内部参数,暂未开放使用
31
36
  # @type ProxyOrganizationId: String
@@ -365,6 +370,104 @@ module TencentCloud
365
370
  end
366
371
  end
367
372
 
373
+ # 用户计费使用情况详情
374
+ class BillUsageDetail < TencentCloud::Common::AbstractModel
375
+ # @param FlowId: 合同流程ID,为32位字符串。
376
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
377
+ # 注意:此字段可能返回 null,表示取不到有效值。
378
+ # @type FlowId: String
379
+ # @param OperatorName: 合同经办人名称
380
+ # 如果有多个经办人用分号隔开。
381
+ # 注意:此字段可能返回 null,表示取不到有效值。
382
+ # @type OperatorName: String
383
+ # @param CreateOrganizationName: 发起方组织机构名称
384
+ # 注意:此字段可能返回 null,表示取不到有效值。
385
+ # @type CreateOrganizationName: String
386
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
387
+ # 该名称还将用于合同签署完成后的下载文件名。
388
+ # 注意:此字段可能返回 null,表示取不到有效值。
389
+ # @type FlowName: String
390
+ # @param Status: 当前合同状态,如下是状态码对应的状态。
391
+ # 0-还没有发起
392
+ # 1-等待签署
393
+ # 2-部分签署
394
+ # 3-拒签
395
+ # 4-已签署
396
+ # 5-已过期
397
+ # 6-已撤销
398
+ # 7-还没有预发起
399
+ # 8-等待填写
400
+ # 9-部分填写
401
+ # 10-拒填
402
+ # 11-已解除
403
+ # 注意:此字段可能返回 null,表示取不到有效值。
404
+ # @type Status: Integer
405
+ # @param QuotaType: 套餐类型
406
+ # 对应关系如下
407
+ # CloudEnterprise-企业版合同
408
+ # SingleSignature-单方签章
409
+ # CloudProve-签署报告
410
+ # CloudOnlineSign-腾讯会议在线签约
411
+ # ChannelWeCard-微工卡
412
+ # SignFlow-合同套餐
413
+ # SignFace-签署意愿(人脸识别)
414
+ # SignPassword-签署意愿(密码)
415
+ # SignSMS-签署意愿(短信)
416
+ # PersonalEssAuth-签署人实名(腾讯电子签认证)
417
+ # PersonalThirdAuth-签署人实名(信任第三方认证)
418
+ # OrgEssAuth-签署企业实名
419
+ # FlowNotify-短信通知
420
+ # AuthService-企业工商信息查询
421
+ # 注意:此字段可能返回 null,表示取不到有效值。
422
+ # @type QuotaType: String
423
+ # @param UseCount: 合同使用量
424
+ # 注意:此字段可能返回 null,表示取不到有效值。
425
+ # @type UseCount: Integer
426
+ # @param CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。
427
+ # 注意:此字段可能返回 null,表示取不到有效值。
428
+ # @type CostTime: Integer
429
+ # @param QuotaName: 消耗的套餐名称
430
+ # 注意:此字段可能返回 null,表示取不到有效值。
431
+ # @type QuotaName: String
432
+ # @param CostType: 消耗类型
433
+ # 1.扣费 2.撤销返还
434
+ # 注意:此字段可能返回 null,表示取不到有效值。
435
+ # @type CostType: Integer
436
+ # @param Remark: 备注
437
+ # 注意:此字段可能返回 null,表示取不到有效值。
438
+ # @type Remark: String
439
+
440
+ attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
441
+
442
+ def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, status=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil)
443
+ @FlowId = flowid
444
+ @OperatorName = operatorname
445
+ @CreateOrganizationName = createorganizationname
446
+ @FlowName = flowname
447
+ @Status = status
448
+ @QuotaType = quotatype
449
+ @UseCount = usecount
450
+ @CostTime = costtime
451
+ @QuotaName = quotaname
452
+ @CostType = costtype
453
+ @Remark = remark
454
+ end
455
+
456
+ def deserialize(params)
457
+ @FlowId = params['FlowId']
458
+ @OperatorName = params['OperatorName']
459
+ @CreateOrganizationName = params['CreateOrganizationName']
460
+ @FlowName = params['FlowName']
461
+ @Status = params['Status']
462
+ @QuotaType = params['QuotaType']
463
+ @UseCount = params['UseCount']
464
+ @CostTime = params['CostTime']
465
+ @QuotaName = params['QuotaName']
466
+ @CostType = params['CostType']
467
+ @Remark = params['Remark']
468
+ end
469
+ end
470
+
368
471
  # 抄送信息
369
472
  class CcInfo < TencentCloud::Common::AbstractModel
370
473
  # @param Mobile: 被抄送人手机号,大陆11位手机号
@@ -1627,12 +1730,13 @@ module TencentCloud
1627
1730
 
1628
1731
  # 此接口下面信息必填。
1629
1732
  # <ul>
1630
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1631
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1632
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1733
+ # <li>渠道应用标识: Agent.AppId</li>
1734
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1735
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1633
1736
  # </ul>
1737
+ # 第三方平台子客企业和员工必须已经经过实名认证
1634
1738
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1635
- # @param FlowIds: 需执行催办的签署流程ID数组,最多包含100个。
1739
+ # @param FlowIds: 需执行催办的合同流程ID数组,最多支持100个。
1636
1740
  # @type FlowIds: Array
1637
1741
 
1638
1742
  attr_accessor :Agent, :FlowIds
@@ -2176,19 +2280,31 @@ module TencentCloud
2176
2280
 
2177
2281
  # ChannelCreatePreparedPersonalEsign请求参数结构体
2178
2282
  class ChannelCreatePreparedPersonalEsignRequest < TencentCloud::Common::AbstractModel
2179
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
2283
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2180
2284
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2181
2285
  # @param UserName: 个人用户姓名
2182
2286
  # @type UserName: String
2183
- # @param IdCardNumber: 身份证件号码
2287
+ # @param IdCardNumber: 证件号码, 应符合以下规则
2288
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
2289
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
2290
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
2184
2291
  # @type IdCardNumber: String
2185
- # @param SealName: 印章名称
2292
+ # @param SealName: 电子印章名字,1-50个中文字符
2293
+ # 注:`同一企业下电子印章名字不能相同`
2186
2294
  # @type SealName: String
2187
- # @param SealImage: 印章图片的base64,最大不超过 8M
2295
+ # @param SealImage: 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。
2296
+
2188
2297
  # @type SealImage: String
2189
- # @param Operator: 操作者信息
2298
+ # @param Operator: 执行本接口操作的员工信息。
2299
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2190
2300
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
2191
- # @param IdCardType: 身份证件类型
2301
+ # @param IdCardType: 证件类型,支持以下类型
2302
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
2303
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
2304
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
2305
+ # <li>OTHER_CARD_TYPE : 其他</li></ul>
2306
+
2307
+ # 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
2192
2308
  # @type IdCardType: String
2193
2309
  # @param SealImageCompress: 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。
2194
2310
  # @type SealImageCompress: Boolean
@@ -2238,7 +2354,9 @@ module TencentCloud
2238
2354
 
2239
2355
  # ChannelCreatePreparedPersonalEsign返回参数结构体
2240
2356
  class ChannelCreatePreparedPersonalEsignResponse < TencentCloud::Common::AbstractModel
2241
- # @param SealId: 导入的印章 ID
2357
+ # @param SealId: 电子印章ID,为32位字符串。
2358
+ # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
2359
+ # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
2242
2360
  # @type SealId: String
2243
2361
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2244
2362
  # @type RequestId: String
@@ -2272,13 +2390,13 @@ module TencentCloud
2272
2390
  # @type NeedRelievedFlowId: String
2273
2391
  # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
2274
2392
  # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
2275
- # @param ReleasedApprovers: 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
2276
- # 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
2393
+ # @param ReleasedApprovers: 指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>
2394
+ # 如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
2277
2395
 
2278
2396
  # 注意:
2279
2397
  # <ul>
2280
- # <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
2281
- # <li>可以不指定替换签署人, 使用原流程的签署人</li>
2398
+ # <li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>
2399
+ # <li>可以不指定替换签署人,使用原流程的签署人</li>
2282
2400
  # </ul>
2283
2401
  # @type ReleasedApprovers: Array
2284
2402
  # @param CallbackUrl: 签署完回调url,最大长度1000个字符
@@ -2430,11 +2548,24 @@ module TencentCloud
2430
2548
 
2431
2549
  # ChannelCreateSealPolicy请求参数结构体
2432
2550
  class ChannelCreateSealPolicyRequest < TencentCloud::Common::AbstractModel
2433
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
2551
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2552
+
2553
+ # 此接口下面信息必填。
2554
+
2555
+ # 渠道应用标识: Agent.AppId
2556
+ # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
2557
+ # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
2558
+ # 第三方平台子客企业和员工必须已经经过实名认证。
2434
2559
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2435
- # @param SealId: 指定印章ID
2560
+ # @param SealId: 电子印章ID,为32位字符串。
2561
+ # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
2562
+ # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
2436
2563
  # @type SealId: String
2437
- # @param UserIds: 指定待授权的用户ID数组,电子签的用户ID
2564
+ # @param UserIds: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2565
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2566
+ # 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
2567
+ # 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
2568
+ # 指定待授权的用户ID数组,电子签的用户ID
2438
2569
  # 可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
2439
2570
  # @type UserIds: Array
2440
2571
  # @param Operator: 操作人(用户)信息,不用传
@@ -2982,12 +3113,14 @@ module TencentCloud
2982
3113
  # @type Limit: Integer
2983
3114
  # @param Filters: 查询的关键字段,支持Key-Values查询。可选键值如下:
2984
3115
  # <ul>
2985
- # <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
2986
- # <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
2987
- # <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3116
+ # <li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
3117
+ # <li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
3118
+ # <li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
2988
3119
  # </ul>
3120
+ # 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
2989
3121
  # @type Filters: Array
2990
- # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。
3122
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。
3123
+ # 页码从 0 开始,即首页为 0,最大20000。
2991
3124
  # @type Offset: Integer
2992
3125
  # @param Operator: 暂未开放
2993
3126
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -4928,6 +5061,91 @@ module TencentCloud
4928
5061
  end
4929
5062
  end
4930
5063
 
5064
+ # DescribeBillUsageDetail请求参数结构体
5065
+ class DescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
5066
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5067
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
5068
+ # @param StartTime: 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
5069
+ # @type StartTime: String
5070
+ # @param EndTime: 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
5071
+ # @type EndTime: String
5072
+ # @param QuotaType: 查询的套餐类型 (选填 )不传则查询所有套餐;
5073
+ # 对应关系如下
5074
+ # CloudEnterprise-企业版合同
5075
+ # SingleSignature-单方签章
5076
+ # CloudProve-签署报告
5077
+ # CloudOnlineSign-腾讯会议在线签约
5078
+ # ChannelWeCard-微工卡
5079
+ # SignFlow-合同套餐
5080
+ # SignFace-签署意愿(人脸识别)
5081
+ # SignPassword-签署意愿(密码)
5082
+ # SignSMS-签署意愿(短信)
5083
+ # PersonalEssAuth-签署人实名(腾讯电子签认证)
5084
+ # PersonalThirdAuth-签署人实名(信任第三方认证)
5085
+ # OrgEssAuth-签署企业实名
5086
+ # FlowNotify-短信通知
5087
+ # AuthService-企业工商信息查询
5088
+ # @type QuotaType: String
5089
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
5090
+ # @type Offset: Integer
5091
+ # @param Limit: 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
5092
+ # @type Limit: Integer
5093
+
5094
+ attr_accessor :Agent, :StartTime, :EndTime, :QuotaType, :Offset, :Limit
5095
+
5096
+ def initialize(agent=nil, starttime=nil, endtime=nil, quotatype=nil, offset=nil, limit=nil)
5097
+ @Agent = agent
5098
+ @StartTime = starttime
5099
+ @EndTime = endtime
5100
+ @QuotaType = quotatype
5101
+ @Offset = offset
5102
+ @Limit = limit
5103
+ end
5104
+
5105
+ def deserialize(params)
5106
+ unless params['Agent'].nil?
5107
+ @Agent = Agent.new
5108
+ @Agent.deserialize(params['Agent'])
5109
+ end
5110
+ @StartTime = params['StartTime']
5111
+ @EndTime = params['EndTime']
5112
+ @QuotaType = params['QuotaType']
5113
+ @Offset = params['Offset']
5114
+ @Limit = params['Limit']
5115
+ end
5116
+ end
5117
+
5118
+ # DescribeBillUsageDetail返回参数结构体
5119
+ class DescribeBillUsageDetailResponse < TencentCloud::Common::AbstractModel
5120
+ # @param Total: 返回查询记录总数
5121
+ # @type Total: Integer
5122
+ # @param Details: 消耗记录详情
5123
+ # @type Details: Array
5124
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5125
+ # @type RequestId: String
5126
+
5127
+ attr_accessor :Total, :Details, :RequestId
5128
+
5129
+ def initialize(total=nil, details=nil, requestid=nil)
5130
+ @Total = total
5131
+ @Details = details
5132
+ @RequestId = requestid
5133
+ end
5134
+
5135
+ def deserialize(params)
5136
+ @Total = params['Total']
5137
+ unless params['Details'].nil?
5138
+ @Details = []
5139
+ params['Details'].each do |i|
5140
+ billusagedetail_tmp = BillUsageDetail.new
5141
+ billusagedetail_tmp.deserialize(i)
5142
+ @Details << billusagedetail_tmp
5143
+ end
5144
+ end
5145
+ @RequestId = params['RequestId']
5146
+ end
5147
+ end
5148
+
4931
5149
  # DescribeChannelFlowEvidenceReport请求参数结构体
4932
5150
  class DescribeChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
4933
5151
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -5658,49 +5876,49 @@ module TencentCloud
5658
5876
 
5659
5877
  # 签署人的流程信息明细
5660
5878
  class FlowApproverDetail < TencentCloud::Common::AbstractModel
5661
- # @param ReceiptId: 模板配置时候的签署人id,与控件绑定
5879
+ # @param ReceiptId: 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
5662
5880
  # @type ReceiptId: String
5663
- # @param ProxyOrganizationOpenId: 平台企业的第三方id
5881
+ # @param ProxyOrganizationOpenId: 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
5664
5882
  # 注意:此字段可能返回 null,表示取不到有效值。
5665
5883
  # @type ProxyOrganizationOpenId: String
5666
- # @param ProxyOperatorOpenId: 平台企业操作人的第三方id
5884
+ # @param ProxyOperatorOpenId: 第三方平台子客企业员工的唯一标识
5667
5885
  # @type ProxyOperatorOpenId: String
5668
- # @param ProxyOrganizationName: 平台企业名称
5886
+ # @param ProxyOrganizationName: 第三方平台子客企业名称,与企业营业执照中注册的名称一致。
5669
5887
  # @type ProxyOrganizationName: String
5670
5888
  # @param Mobile: 签署人手机号
5671
5889
  # @type Mobile: String
5672
- # @param SignOrder: 签署人签署顺序
5890
+ # @param SignOrder: 签署顺序,如果是有序签署,签署顺序从小到大
5673
5891
  # @type SignOrder: Integer
5674
- # @param ApproveName: 签署人姓名
5892
+ # @param ApproveName: 签署方经办人的姓名。
5893
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
5675
5894
  # 注意:此字段可能返回 null,表示取不到有效值。
5676
5895
  # @type ApproveName: String
5677
5896
  # @param ApproveStatus: 当前签署人的状态, 状态如下
5678
- # <br/>PENDING 待签署
5679
- # <br/>FILLPENDING 待填写
5680
- # <br/>FILLACCEPT 填写完成
5681
- # <br/>FILLREJECT 拒绝填写
5682
- # <br/>WAITPICKUP 待领取
5683
- # <br/>ACCEPT 已签署
5684
- # <br/>REJECT 拒签
5685
- # <br/>DEADLINE 过期没人处理
5686
- # <br/>CANCEL 流程已撤回
5687
- # <br/>FORWARD 已经转他人处理
5688
- # <br/>STOP 流程已终止
5689
- # <br/>RELIEVED 解除协议(已解除)
5690
-
5897
+ # <ul><li> **PENDING** :待签署</li>
5898
+ # <li> **FILLPENDING** :待填写</li>
5899
+ # <li> **FILLACCEPT** :填写完成</li>
5900
+ # <li> **FILLREJECT** :拒绝填写</li>
5901
+ # <li> **WAITPICKUP** :待领取</li>
5902
+ # <li> **ACCEPT** :已签署</li>
5903
+ # <li> **REJECT** :拒签</li>
5904
+ # <li> **DEADLINE** :过期没人处理</li>
5905
+ # <li> **CANCEL** :流程已撤回</li>
5906
+ # <li> **FORWARD** :已经转他人处理</li>
5907
+ # <li> **STOP** :流程已终止</li>
5908
+ # <li> **RELIEVED** :解除协议(已解除)</li></ul>
5691
5909
  # 注意:此字段可能返回 null,表示取不到有效值。
5692
5910
  # @type ApproveStatus: String
5693
- # @param ApproveMessage: 签署人自定义信息
5911
+ # @param ApproveMessage: 签署人拒签等情况的时候填写的原因
5694
5912
  # 注意:此字段可能返回 null,表示取不到有效值。
5695
5913
  # @type ApproveMessage: String
5696
5914
  # @param ApproveTime: 签署人签署时间戳,单位秒
5697
5915
  # @type ApproveTime: Integer
5698
5916
  # @param ApproveType: 参与者类型
5699
- # <br/>ORGANIZATION:企业签署人
5700
- # <br/>PERSON:个人签署人
5917
+ # <ul><li> **ORGANIZATION** :企业签署人</li>
5918
+ # <li> **PERSON** :个人签署人</li></ul>
5701
5919
  # 注意:此字段可能返回 null,表示取不到有效值。
5702
5920
  # @type ApproveType: String
5703
- # @param ApproverRoleName: 自定义签署人角色
5921
+ # @param ApproverRoleName: 自定义签署人的角色名, 如: 收款人、开具人、见证人等
5704
5922
  # 注意:此字段可能返回 null,表示取不到有效值。
5705
5923
  # @type ApproverRoleName: String
5706
5924
 
@@ -7122,8 +7340,8 @@ module TencentCloud
7122
7340
  # @param SignerName: 申请证书的主体的名字
7123
7341
 
7124
7342
  # 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
7125
- # **企业**: ESS@企业名称@编码
7126
- # **个人**: ESS@个人姓名@证件号@808854
7343
+ # **企业**: ESS@企业名称@平台生成的数字编码
7344
+ # **个人**: ESS@个人姓名@证件号@平台生成的数字编码
7127
7345
 
7128
7346
  # 如果在其他平台签署的, 主体的名字参考其他平台的说明
7129
7347
  # @type SignerName: String
@@ -7520,19 +7738,19 @@ module TencentCloud
7520
7738
  # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
7521
7739
  # @type ApproverNumber: Integer
7522
7740
  # @param ApproverType: 指定签署人类型,目前支持
7523
- # <ul><li> **ORGANIZATION**:企业(默认值)</li>
7741
+ # <ul><li> **ORGANIZATION**:企业(默认值)</li>
7524
7742
  # <li> **ENTERPRISESERVER**:企业静默签</li></ul>
7525
7743
  # @type ApproverType: String
7526
7744
  # @param Name: 签署人姓名,最大长度50个字。
7527
7745
  # @type Name: String
7528
7746
  # @param IdCardType: 签署方经办人的证件类型,支持以下类型
7529
- # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
7747
+ # <ul><li>ID_CARD : 居民身份证(默认值)</li>
7530
7748
  # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
7531
7749
  # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
7532
7750
  # @type IdCardType: String
7533
7751
  # @param IdCardNumber: 证件号码,应符合以下规则
7534
- # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
7535
- # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
7752
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
7753
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
7536
7754
  # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
7537
7755
  # @type IdCardNumber: String
7538
7756
  # @param Mobile: 签署人手机号。
@@ -8010,30 +8228,43 @@ module TencentCloud
8010
8228
 
8011
8229
  # SyncProxyOrganization请求参数结构体
8012
8230
  class SyncProxyOrganizationRequest < TencentCloud::Common::AbstractModel
8013
- # @param Agent: 应用信息
8014
- # 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
8231
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
8232
+
8233
+ # 此接口下面信息必填。
8234
+ # <ul>
8235
+ # <li>渠道应用标识: Agent.AppId</li>
8236
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
8237
+ # </ul>
8015
8238
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
8016
- # @param ProxyOrganizationName: 第三方平台子客企业名称,最大长度64个字符
8239
+ # @param ProxyOrganizationName: 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
8240
+ # 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
8017
8241
  # @type ProxyOrganizationName: String
8018
8242
  # @param BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
8019
8243
  # @type BusinessLicense: String
8020
8244
  # @param UniformSocialCreditCode: 第三方平台子客企业统一社会信用代码,最大长度200个字符
8021
8245
  # @type UniformSocialCreditCode: String
8022
- # @param ProxyLegalName: 第三方平台子客企业法人/负责人姓名
8246
+ # @param ProxyLegalName: 第三方平台子客企业法定代表人的名字
8023
8247
  # @type ProxyLegalName: String
8024
8248
  # @param Operator: 暂未开放
8025
8249
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
8026
- # @param ProxyLegalIdCardType: 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
8250
+ # @param ProxyLegalIdCardType: 第三方平台子客企业法定代表人的证件类型,支持以下类型
8251
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
8252
+ # 注: `现在仅支持ID_CARD居民身份证类型`
8027
8253
  # @type ProxyLegalIdCardType: String
8028
- # @param ProxyLegalIdCardNumber: 第三方平台子客企业法人/负责人证件号
8254
+ # @param ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
8255
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
8029
8256
  # @type ProxyLegalIdCardNumber: String
8257
+ # @param ProxyAddress: 第三方平台子客企业详细住所,最大长度500个字符
8030
8258
 
8031
- attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator, :ProxyLegalIdCardType, :ProxyLegalIdCardNumber
8259
+ # 注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
8260
+ # @type ProxyAddress: String
8261
+
8262
+ attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator, :ProxyLegalIdCardType, :ProxyLegalIdCardNumber, :ProxyAddress
8032
8263
  extend Gem::Deprecate
8033
8264
  deprecate :Operator, :none, 2023, 11
8034
8265
  deprecate :Operator=, :none, 2023, 11
8035
8266
 
8036
- def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil, proxylegalidcardtype=nil, proxylegalidcardnumber=nil)
8267
+ def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil, proxylegalidcardtype=nil, proxylegalidcardnumber=nil, proxyaddress=nil)
8037
8268
  @Agent = agent
8038
8269
  @ProxyOrganizationName = proxyorganizationname
8039
8270
  @BusinessLicense = businesslicense
@@ -8042,6 +8273,7 @@ module TencentCloud
8042
8273
  @Operator = operator
8043
8274
  @ProxyLegalIdCardType = proxylegalidcardtype
8044
8275
  @ProxyLegalIdCardNumber = proxylegalidcardnumber
8276
+ @ProxyAddress = proxyaddress
8045
8277
  end
8046
8278
 
8047
8279
  def deserialize(params)
@@ -8059,6 +8291,7 @@ module TencentCloud
8059
8291
  end
8060
8292
  @ProxyLegalIdCardType = params['ProxyLegalIdCardType']
8061
8293
  @ProxyLegalIdCardNumber = params['ProxyLegalIdCardNumber']
8294
+ @ProxyAddress = params['ProxyAddress']
8062
8295
  end
8063
8296
  end
8064
8297
 
@@ -8371,9 +8604,16 @@ module TencentCloud
8371
8604
  end
8372
8605
  end
8373
8606
 
8374
- # 接口调用者信息
8607
+ # 接口调用的员工信息
8375
8608
  class UserInfo < TencentCloud::Common::AbstractModel
8376
- # @param OpenId: 第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
8609
+ # @param OpenId: 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
8610
+
8611
+
8612
+ # 注意:
8613
+ # 1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
8614
+ # 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
8615
+ # 3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
8616
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/bb67fb66c926759df3a0af5838fdafd5.png)
8377
8617
  # @type OpenId: String
8378
8618
  # @param Channel: 内部参数,暂未开放使用
8379
8619
  # @type Channel: String
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.694
4
+ version: 3.0.696
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-06 00:00:00.000000000 Z
11
+ date: 2023-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,11 +33,11 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/v20201222/models.rb
37
- - lib/v20201222/client.rb
38
- - lib/tencentcloud-sdk-essbasic.rb
39
- - lib/v20210526/models.rb
40
36
  - lib/v20210526/client.rb
37
+ - lib/v20210526/models.rb
38
+ - lib/tencentcloud-sdk-essbasic.rb
39
+ - lib/v20201222/client.rb
40
+ - lib/v20201222/models.rb
41
41
  - lib/VERSION
42
42
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
43
43
  licenses: