tencentcloud-sdk-essbasic 3.0.695 → 3.0.696

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30a5ceb47a62b7f419bd84e3dee631d20f0f3529
-  data.tar.gz: 520be7505e717ec39c30b3750a2a733c2e7cb695
+  metadata.gz: 3ea8e6ad5e15aace85688d1231f715b40a3fc00b
+  data.tar.gz: e325aef8a281af1e089869641399fb5e0ea9f026
 SHA512:
-  metadata.gz: c98753e5e97c5fcb0470273ceac46d96e3588e273b071bc678acf7afd213fea41171769483d01166c96ba9af04f721840c833c9ce5deb123265b16d2c0eed3cc
-  data.tar.gz: 367ac848a05c75fa14507716fc86657df91a9b874c704ff354ad1c14cfea0c4f756642c23ffd02908f808198017225d246b169ea1f430fa74474ec8efb63822c
+  metadata.gz: 2e293fce82d53d64603943b7fe2050362ba00daea9e8c98d9bf03fdbec3ae1edc961687d5af196bb388ef5c8e233149e96f2b06ce4540608825a9222da2345fd
+  data.tar.gz: 94435e3ac7f28bb7b617b79f4e2c8294cf3e6899f5926b1e928e80cdf6903e7fc2cdbf6f38e03bce45bd74952f8e29c8e4f77e3afc7b6b248b5c7a03d9e3341d

data/lib/VERSION

@@ -1 +1 @@
-3.0.695
+3.0.696

data/lib/v20210526/client.rb

@@ -596,12 +596,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+        # 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办
+        # 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
+        # 2. **每个合同只能催办一次**
 
-        # 1. 合同中当前状态为“待签署”的签署人是催办的对象
-        # 2. 每个合同只能催办一次
+        # **催办的效果**: 对方会受到如下的短信通知
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
 
-        # 注意：该接口无法直接调用，请联系客户经理申请使用。
+
+        # **注**：`合同催办是白名单功能，请联系客户经理申请开白后使用`
 
         # @param request: Request instance for ChannelCreateFlowReminds.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowRemindsRequest`
@@ -723,12 +726,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 通过此接口，创建小程序批量签署链接，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
+        # 通过此接口，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
 
         # 注：
         # - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。
         # - 仅支持传入待签署或者待领取的合同，待填写暂不支持。
-        # - 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章，暂不支持签批控件
+        # - 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
 
         # @param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlRequest`
@@ -1478,6 +1481,9 @@ module TencentCloud
         # 1. 若在激活过程中，**更换用户OpenID重新生成链接，之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作，会导致认证过程互相影响。
         # 2. 若您认证中发现信息有误需要重新认证，**可通过更换用户OpenID重新生成链接的方式，来清理掉已有的流程**。
 
+        # 系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
+
         # @param request: Request instance for CreateConsoleLoginUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlResponse`
@@ -1646,6 +1652,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 通过此接口（DescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
+
+        # @param request: Request instance for DescribeBillUsageDetail.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeBillUsageDetailRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeBillUsageDetailResponse`
+        def DescribeBillUsageDetail(request)
+          body = send_request('DescribeBillUsageDetail', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeBillUsageDetailResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 获取出证报告任务执行结果，返回报告 URL。
 
         # 注意：
@@ -1745,10 +1775,10 @@ module TencentCloud
         # **第一种**:   需第三方应用的子企业登录控制台进行授权,  授权在**企业中心**的**授权管理**区域,  界面如下图
         # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
 
-        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
 
         # **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
-        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
 
         # @param request: Request instance for DescribeResourceUrlsByFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeResourceUrlsByFlowsRequest`
@@ -1774,6 +1804,15 @@ module TencentCloud
 
         # 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
 
+        # **适用场景**
+        #  该接口常用来配合<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>接口，作为创建合同的前置接口使用。
+        # 通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
+
+        # **模版的来源**
+        # 子客企业的模板有两种途径获取
+        # - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
+        # - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
+
         # **一个模板通常会包含以下结构信息**
 
         # - 模板模版ID, 模板名字等基本信息
@@ -1783,14 +1822,8 @@ module TencentCloud
 
         # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
 
-        # **适用场景**
-        #  该接口常用来配合<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>接口，作为创建合同的前置接口使用。
-        # 通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
-
-        # **模版的来源**
-        # 子客企业的模板有两种途径获取
-        # - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
-        # - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
+        # 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
 
 
         # **注意**

data/lib/v20210526/models.rb

@@ -17,15 +17,20 @@
 module TencentCloud
   module Essbasic
     module V20210526
-      # 应用相关信息
+      # 应用相关信息, 整体应用的层级图如下
+
+      # 注:
+      #   1. `不同的业务系统可以采用不同的应用，不同应用下的数据是隔离的,  应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`
       class Agent < TencentCloud::Common::AbstractModel
-        # @param AppId: 应用的唯一标识。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
+        # @param AppId: 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
+
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png)
         # @type AppId: String
         # @param ProxyOrganizationOpenId: 第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串
         # @type ProxyOrganizationOpenId: String
         # @param ProxyOperator: 第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。
         # @type ProxyOperator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-        # @param ProxyAppId: 非必需参数，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
+        # @param ProxyAppId: **不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
         # @type ProxyAppId: String
         # @param ProxyOrganizationId: 内部参数，暂未开放使用
         # @type ProxyOrganizationId: String
@@ -365,6 +370,104 @@ module TencentCloud
         end
       end
 
+      # 用户计费使用情况详情
+      class BillUsageDetail < TencentCloud::Common::AbstractModel
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowId: String
+        # @param OperatorName: 合同经办人名称
+        # 如果有多个经办人用分号隔开。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type OperatorName: String
+        # @param CreateOrganizationName: 发起方组织机构名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CreateOrganizationName: String
+        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+        # 该名称还将用于合同签署完成后的下载文件名。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowName: String
+        # @param Status: 当前合同状态,如下是状态码对应的状态。
+        # 0-还没有发起
+        # 1-等待签署
+        # 2-部分签署
+        # 3-拒签
+        # 4-已签署
+        # 5-已过期
+        # 6-已撤销
+        # 7-还没有预发起
+        # 8-等待填写
+        # 9-部分填写
+        # 10-拒填
+        # 11-已解除
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Status: Integer
+        # @param QuotaType: 套餐类型
+        # 对应关系如下
+        # CloudEnterprise-企业版合同
+        # SingleSignature-单方签章
+        # CloudProve-签署报告
+        # CloudOnlineSign-腾讯会议在线签约
+        # ChannelWeCard-微工卡
+        # SignFlow-合同套餐
+        # SignFace-签署意愿（人脸识别）
+        # SignPassword-签署意愿（密码）
+        # SignSMS-签署意愿（短信）
+        # PersonalEssAuth-签署人实名（腾讯电子签认证）
+        # PersonalThirdAuth-签署人实名（信任第三方认证）
+        # OrgEssAuth-签署企业实名
+        # FlowNotify-短信通知
+        # AuthService-企业工商信息查询
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type QuotaType: String
+        # @param UseCount: 合同使用量
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type UseCount: Integer
+        # @param CostTime: 消耗的时间戳，格式为Unix标准时间戳（秒）。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CostTime: Integer
+        # @param QuotaName: 消耗的套餐名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type QuotaName: String
+        # @param CostType: 消耗类型
+        # 1.扣费 2.撤销返还
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CostType: Integer
+        # @param Remark: 备注
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Remark: String
+
+        attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
+
+        def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, status=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil)
+          @FlowId = flowid
+          @OperatorName = operatorname
+          @CreateOrganizationName = createorganizationname
+          @FlowName = flowname
+          @Status = status
+          @QuotaType = quotatype
+          @UseCount = usecount
+          @CostTime = costtime
+          @QuotaName = quotaname
+          @CostType = costtype
+          @Remark = remark
+        end
+
+        def deserialize(params)
+          @FlowId = params['FlowId']
+          @OperatorName = params['OperatorName']
+          @CreateOrganizationName = params['CreateOrganizationName']
+          @FlowName = params['FlowName']
+          @Status = params['Status']
+          @QuotaType = params['QuotaType']
+          @UseCount = params['UseCount']
+          @CostTime = params['CostTime']
+          @QuotaName = params['QuotaName']
+          @CostType = params['CostType']
+          @Remark = params['Remark']
+        end
+      end
+
       # 抄送信息
       class CcInfo < TencentCloud::Common::AbstractModel
         # @param Mobile: 被抄送人手机号，大陆11位手机号
@@ -1627,12 +1730,13 @@ module TencentCloud
 
         # 此接口下面信息必填。
         # <ul>
-        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
-        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
-        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
         # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowIds: 需执行催办的签署流程ID数组，最多包含100个。
+        # @param FlowIds: 需执行催办的合同流程ID数组，最多支持100个。
         # @type FlowIds: Array
 
         attr_accessor :Agent, :FlowIds
@@ -2176,19 +2280,31 @@ module TencentCloud
 
       # ChannelCreatePreparedPersonalEsign请求参数结构体
       class ChannelCreatePreparedPersonalEsignRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param UserName: 个人用户姓名
         # @type UserName: String
-        # @param IdCardNumber: 身份证件号码
+        # @param IdCardNumber: 证件号码, 应符合以下规则
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
-        # @param SealName: 印章名称
+        # @param SealName: 电子印章名字，1-50个中文字符
+        # 注:`同一企业下电子印章名字不能相同`
         # @type SealName: String
-        # @param SealImage: 印章图片的base64，最大不超过 8M
+        # @param SealImage: 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。
+
         # @type SealImage: String
-        # @param Operator: 操作者信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-        # @param IdCardType: 身份证件类型
+        # @param IdCardType: 证件类型，支持以下类型
+        # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
+        # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+        # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
+        # <li>OTHER_CARD_TYPE : 其他</li></ul>
+
+        # 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
         # @type IdCardType: String
         # @param SealImageCompress: 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
         # @type SealImageCompress: Boolean
@@ -2238,7 +2354,9 @@ module TencentCloud
 
       # ChannelCreatePreparedPersonalEsign返回参数结构体
       class ChannelCreatePreparedPersonalEsignResponse < TencentCloud::Common::AbstractModel
-        # @param SealId: 导入的印章 ID
+        # @param SealId: 电子印章ID，为32位字符串。
+        # 建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
+        # 可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
         # @type SealId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -2272,13 +2390,13 @@ module TencentCloud
         # @type NeedRelievedFlowId: String
         # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
         # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
-        # @param ReleasedApprovers: 替换解除协议的签署人， 如不指定替换签署人,  则使用原流程的签署人。 <br/>
-        # 如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
+        # @param ReleasedApprovers: 指定解除协议的签署人，如不指定，则默认使用原流程的签署人。 <br/>
+        # 如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号，默认从0开始，顺序递增)<br/>
 
         # 注意：
         # <ul>
-        # <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
-        # <li>可以不指定替换签署人, 使用原流程的签署人</li>
+        # <li>只能更换自己企业的签署人，不支持更换个人类型或者其他企业的签署人</li>
+        # <li>可以不指定替换签署人，使用原流程的签署人</li>
         # </ul>
         # @type ReleasedApprovers: Array
         # @param CallbackUrl: 签署完回调url，最大长度1000个字符
@@ -2430,11 +2548,24 @@ module TencentCloud
 
       # ChannelCreateSealPolicy请求参数结构体
       class ChannelCreateSealPolicyRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+
+        # 渠道应用标识: Agent.AppId
+        # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
+        # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
+        # 第三方平台子客企业和员工必须已经经过实名认证。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param SealId: 指定印章ID
+        # @param SealId: 电子印章ID，为32位字符串。
+        # 建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
+        # 可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
         # @type SealId: String
-        # @param UserIds: 指定待授权的用户ID数组,电子签的用户ID
+        # @param UserIds: 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+        # 可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
+        # 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
+        # 该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
+        # 指定待授权的用户ID数组,电子签的用户ID
         # 可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权。
         # @type UserIds: Array
         # @param Operator: 操作人（用户）信息，不用传
@@ -4930,6 +5061,91 @@ module TencentCloud
         end
       end
 
+      # DescribeBillUsageDetail请求参数结构体
+      class DescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param StartTime: 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
+        # @type StartTime: String
+        # @param EndTime: 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
+        # @type EndTime: String
+        # @param QuotaType: 查询的套餐类型 （选填 ）不传则查询所有套餐；
+        # 对应关系如下
+        # CloudEnterprise-企业版合同
+        # SingleSignature-单方签章
+        # CloudProve-签署报告
+        # CloudOnlineSign-腾讯会议在线签约
+        # ChannelWeCard-微工卡
+        # SignFlow-合同套餐
+        # SignFace-签署意愿（人脸识别）
+        # SignPassword-签署意愿（密码）
+        # SignSMS-签署意愿（短信）
+        # PersonalEssAuth-签署人实名（腾讯电子签认证）
+        # PersonalThirdAuth-签署人实名（信任第三方认证）
+        # OrgEssAuth-签署企业实名
+        # FlowNotify-短信通知
+        # AuthService-企业工商信息查询
+        # @type QuotaType: String
+        # @param Offset: 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
+        # @type Offset: Integer
+        # @param Limit: 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
+        # @type Limit: Integer
+
+        attr_accessor :Agent, :StartTime, :EndTime, :QuotaType, :Offset, :Limit
+
+        def initialize(agent=nil, starttime=nil, endtime=nil, quotatype=nil, offset=nil, limit=nil)
+          @Agent = agent
+          @StartTime = starttime
+          @EndTime = endtime
+          @QuotaType = quotatype
+          @Offset = offset
+          @Limit = limit
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @StartTime = params['StartTime']
+          @EndTime = params['EndTime']
+          @QuotaType = params['QuotaType']
+          @Offset = params['Offset']
+          @Limit = params['Limit']
+        end
+      end
+
+      # DescribeBillUsageDetail返回参数结构体
+      class DescribeBillUsageDetailResponse < TencentCloud::Common::AbstractModel
+        # @param Total: 返回查询记录总数
+        # @type Total: Integer
+        # @param Details: 消耗记录详情
+        # @type Details: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :Total, :Details, :RequestId
+
+        def initialize(total=nil, details=nil, requestid=nil)
+          @Total = total
+          @Details = details
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Total = params['Total']
+          unless params['Details'].nil?
+            @Details = []
+            params['Details'].each do |i|
+              billusagedetail_tmp = BillUsageDetail.new
+              billusagedetail_tmp.deserialize(i)
+              @Details << billusagedetail_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeChannelFlowEvidenceReport请求参数结构体
       class DescribeChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -5660,49 +5876,49 @@ module TencentCloud
 
       # 签署人的流程信息明细
       class FlowApproverDetail < TencentCloud::Common::AbstractModel
-        # @param ReceiptId: 模板配置时候的签署人id,与控件绑定
+        # @param ReceiptId: 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
         # @type ReceiptId: String
-        # @param ProxyOrganizationOpenId: 平台企业的第三方id
+        # @param ProxyOrganizationOpenId: 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ProxyOrganizationOpenId: String
-        # @param ProxyOperatorOpenId: 平台企业操作人的第三方id
+        # @param ProxyOperatorOpenId: 第三方平台子客企业员工的唯一标识
         # @type ProxyOperatorOpenId: String
-        # @param ProxyOrganizationName: 平台企业名称
+        # @param ProxyOrganizationName: 第三方平台子客企业名称，与企业营业执照中注册的名称一致。
         # @type ProxyOrganizationName: String
         # @param Mobile: 签署人手机号
         # @type Mobile: String
-        # @param SignOrder: 签署人签署顺序
+        # @param SignOrder: 签署顺序，如果是有序签署，签署顺序从小到大
         # @type SignOrder: Integer
-        # @param ApproveName: 签署人姓名
+        # @param ApproveName: 签署方经办人的姓名。
+        # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproveName: String
         # @param ApproveStatus: 当前签署人的状态, 状态如下
-        # <br/>PENDING 待签署
-        # <br/>FILLPENDING 待填写
-        # <br/>FILLACCEPT 填写完成
-        # <br/>FILLREJECT 拒绝填写
-        # <br/>WAITPICKUP 待领取
-        # <br/>ACCEPT 已签署
-        # <br/>REJECT 拒签
-        # <br/>DEADLINE 过期没人处理
-        # <br/>CANCEL 流程已撤回
-        # <br/>FORWARD 已经转他人处理
-        # <br/>STOP 流程已终止
-        # <br/>RELIEVED 解除协议（已解除）
-
+        # <ul><li> **PENDING** :待签署</li>
+        # <li> **FILLPENDING** :待填写</li>
+        # <li> **FILLACCEPT** :填写完成</li>
+        # <li> **FILLREJECT** :拒绝填写</li>
+        # <li> **WAITPICKUP** :待领取</li>
+        # <li> **ACCEPT** :已签署</li>
+        # <li> **REJECT** :拒签</li>
+        # <li> **DEADLINE** :过期没人处理</li>
+        # <li> **CANCEL** :流程已撤回</li>
+        # <li> **FORWARD** :已经转他人处理</li>
+        # <li> **STOP** :流程已终止</li>
+        # <li> **RELIEVED** :解除协议（已解除）</li></ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproveStatus: String
-        # @param ApproveMessage: 签署人自定义信息
+        # @param ApproveMessage: 签署人拒签等情况的时候填写的原因
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproveMessage: String
         # @param ApproveTime: 签署人签署时间戳，单位秒
         # @type ApproveTime: Integer
         # @param ApproveType: 参与者类型
-        # <br/>ORGANIZATION：企业签署人
-        # <br/>PERSON：个人签署人
+        # <ul><li> **ORGANIZATION** :企业签署人</li>
+        # <li> **PERSON** :个人签署人</li></ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproveType: String
-        # @param ApproverRoleName: 自定义签署人角色
+        # @param ApproverRoleName: 自定义签署人的角色名, 如: 收款人、开具人、见证人等
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverRoleName: String
 
@@ -7522,19 +7738,19 @@ module TencentCloud
         # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
         # @type ApproverNumber: Integer
         # @param ApproverType: 指定签署人类型，目前支持
-        # <ul><li> **ORGANIZATION**：企业（默认值）</li>
+        # <ul><li> **ORGANIZATION**：企业(默认值)</li>
         # <li> **ENTERPRISESERVER**：企业静默签</li></ul>
         # @type ApproverType: String
         # @param Name: 签署人姓名，最大长度50个字。
         # @type Name: String
         # @param IdCardType: 签署方经办人的证件类型，支持以下类型
-        # <ul><li>ID_CARD : 居民身份证  (默认值)</li>
+        # <ul><li>ID_CARD : 居民身份证(默认值)</li>
         # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
         # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
-        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
+        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
         # @param Mobile: 签署人手机号。
@@ -8036,7 +8252,7 @@ module TencentCloud
         # 注: `现在仅支持ID_CARD居民身份证类型`
         # @type ProxyLegalIdCardType: String
         # @param ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
-        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li></ul>
         # @type ProxyLegalIdCardNumber: String
         # @param ProxyAddress: 第三方平台子客企业详细住所，最大长度500个字符
 
@@ -8388,9 +8604,16 @@ module TencentCloud
         end
       end
 
-      # 接口调用者信息
+      # 接口调用的员工信息
       class UserInfo < TencentCloud::Common::AbstractModel
-        # @param OpenId: 第三方应用平台自定义，对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工，不可在其他子客企业内重复使用。（例如，可以使用经办人企业名+员工身份证的hash值，需要第三方应用平台保存），最大64位字符串
+        # @param OpenId: 第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。
+
+
+        # 注意:
+        # 1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串
+        # 2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
+        # 3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/bb67fb66c926759df3a0af5838fdafd5.png)
         # @type OpenId: String
         # @param Channel: 内部参数，暂未开放使用
         # @type Channel: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.695
+  version: 3.0.696
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
@@ -33,11 +33,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/v20201222/models.rb
-- lib/v20201222/client.rb
-- lib/tencentcloud-sdk-essbasic.rb
-- lib/v20210526/models.rb
 - lib/v20210526/client.rb
+- lib/v20210526/models.rb
+- lib/tencentcloud-sdk-essbasic.rb
+- lib/v20201222/client.rb
+- lib/v20201222/models.rb
 - lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
 licenses: