tencentcloud-sdk-ess 3.0.653 → 3.0.654

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f16eb3b5eeb13b67e62d57e989b56cd406ab7f11
-  data.tar.gz: 0461dadb9b6bf8779fd38ec36f235c9494a3db61
+  metadata.gz: 90650f8b1eec263cc67d24f0ff357e4cd2e016f6
+  data.tar.gz: a10db0ff77eafecbfc95fa7c8466d39f31c493fd
 SHA512:
-  metadata.gz: 000b663298d001cacf6c24ab46f2719eb00991931c710f8e93c99b2fa7f448ce5927a9d7cb869f397d1d0204fc036914ccca8a0fab726ae5ad598a2cc5891612
-  data.tar.gz: f2becf9075c48f2a57720a3bc50268e7c65edbe6081b981d7961fb27140da1b0785d96860d28be1677aa97c0bf02e93938e8e886796aa97089c776fd6dc1b09e
+  metadata.gz: e4955ae8ef02e37a87975f409f59069096d1ecce298865676a6dcbad63b72c3260b762b042dd2985a6e91a2e893afe3a25cb4b8c4f629e0dc5a1af6af5b51944
+  data.tar.gz: 657cd55f59e9f092da384a2389af53f733a94d74645ecfadba743d4470add5d96e1ba6174a2fb04a698f1be2ce72f5b117a69ea633278bffcf37a3d7f17cff01

data/lib/VERSION

@@ -1 +1 @@
-3.0.653
+3.0.654

data/lib/v20201111/client.rb

@@ -53,9 +53,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 用于撤销签署流程
-        # 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
-        # 注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
+        # 用于撤销签署流程<br/>
+        # 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
+        # `注意：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。`
 
         # @param request: Request instance for CancelFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
@@ -79,7 +79,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
+        # 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+        # 该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
+        # 如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
 
         # @param request: Request instance for CancelMultiFlowSignQRCode.
         # @type request: :class:`Tencentcloud::ess::V20201111::CancelMultiFlowSignQRCodeRequest`
@@ -105,6 +107,8 @@ module TencentCloud
 
         # 此接口（CancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）
 
+        # 注: `在调用此接口时，请确保指定的用户已生成自动签开通链接并且未完成开通，否则无法撤销`
+
         # @param request: Request instance for CancelUserAutoSignEnableUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlResponse`
@@ -474,13 +478,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建个人H5签署链接，请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
-
-        # 该接口用于发起合同后，生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
+        # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
 
-        # 注意：该接口目前签署人类型仅支持个人签署方（PERSON） <br/>
-        # 注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
-        # 注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
+        # 注：
+        # `1. 该接口目前仅支持签署人类型是个人签署方的场景（PERSON）`
+        # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 `
+        # `3. 该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。跳转到小程序的实现，参考微信官方文档（分为<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>
 
         # @param request: Request instance for CreateFlowSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlRequest`
@@ -748,6 +751,13 @@ module TencentCloud
 
         # 发起解除协议，主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
 
+        # `注意：原合同必须签署完成后，才能发起解除协议。` <br/>
+        # `注意：只有原合同企业类型的参与人才能发起解除协议，个人不能发起解除协议。`<br/>
+        # `注意：原合同个人类型参与人必须是解除协议的参与人，不能更换其他第三方个人参与解除协议。`<br/>
+        # `注意：如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的企业员工代为处理。`<br/>
+        # `注意：发起解除协议同发起其他企业合同一样，也会参与合同扣费，扣费标准同其他类型合同。`<br/>
+        # `注意：在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均会转变为已解除状态。`<br/>
+
         # @param request: Request instance for CreateReleaseFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowResponse`
@@ -1108,7 +1118,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询出证报告，返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
+        # 查询签署报告，返回报告 URL。需调用创建并返回出证报告接口（CreateFlowEvidenceReport）获取报告编号后调用当前接口获取报告链接。
 
         # @param request: Request instance for DescribeFlowEvidenceReport.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest`

data/lib/v20201111/models.rb

@@ -483,13 +483,16 @@ module TencentCloud
 
       # CancelFlow请求参数结构体
       class CancelFlowRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowId: 签署流程id
+        # @param FlowId: 合同流程ID, 为32位字符串。
+        # 建议开发者保存此流程ID方便后续其他操作。
         # @type FlowId: String
-        # @param CancelMessage: 撤销原因，最长200个字符；
+        # @param CancelMessage: 撤销此合同(流程)的原因，最长200个字。
         # @type CancelMessage: String
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :FlowId, :CancelMessage, :Agent
@@ -533,11 +536,13 @@ module TencentCloud
 
       # CancelMultiFlowSignQRCode请求参数结构体
       class CancelMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param QrCodeId: 二维码id
+        # @param QrCodeId: 二维码ID，为32位字符串。
         # @type QrCodeId: String
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :QrCodeId, :Agent
@@ -579,19 +584,27 @@ module TencentCloud
 
       # CancelUserAutoSignEnableUrl请求参数结构体
       class CancelUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 操作人信息，UseId必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param SceneKey: 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
+        # @param SceneKey: 企业开通用户自动签场景，例如电子处方。
+        # <ul>
+        # <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
+        # </ul>
         # @type SceneKey: String
         # @param UserInfo: 指定撤销链接的用户指定撤销链接的用户信息，包含姓名、证件类型、证件号码。
         # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
-        attr_accessor :Operator, :SceneKey, :UserInfo
+        attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
 
-        def initialize(operator=nil, scenekey=nil, userinfo=nil)
+        def initialize(operator=nil, scenekey=nil, userinfo=nil, agent=nil)
           @Operator = operator
           @SceneKey = scenekey
           @UserInfo = userinfo
+          @Agent = agent
         end
 
         def deserialize(params)
@@ -604,6 +617,10 @@ module TencentCloud
             @UserInfo = UserThreeFactor.new
             @UserInfo.deserialize(params['UserInfo'])
           end
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
         end
       end
 
@@ -2107,19 +2124,25 @@ module TencentCloud
 
       # CreateFlowSignUrl请求参数结构体
       class CreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
-        # @param FlowId: 流程编号
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         # @type FlowId: String
-        # @param FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，ApproverType目前只支持个人类型的签署人。
+        # @param FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，
 
-        # 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。
+        # 注:
+        # `1. ApproverType目前只支持个人类型的签署人。`
+        # `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
         # @type FlowApproverInfos: Array
-        # @param Operator: 用户信息，此结构体UserId必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
         # @param Organization: 机构信息，暂未开放
         # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
-        # @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接支持http://和https://，最大长度1000个字符。
+        # @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
         # @type JumpUrl: String
 
         attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
@@ -2985,30 +3008,40 @@ module TencentCloud
 
       # CreateReleaseFlow请求参数结构体
       class CreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param NeedRelievedFlowId: 待解除的签署流程编号（即原签署流程的编号）
+        # @param NeedRelievedFlowId: 待解除的签署流程编号（即原签署流程的编号）。
         # @type NeedRelievedFlowId: String
-        # @param ReliveInfo: 解除协议内容
+        # @param ReliveInfo: 解除协议内容。
         # @type ReliveInfo: :class:`Tencentcloud::Ess.v20201111.models.RelieveInfo`
-        # @param ReleasedApprovers: 非必须，解除协议的本企业签署人列表，
-        # 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时（例如原流程签署人离职了），需要指定本企业其他已实名员工来替换原流程中的原签署人，注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
-        # 解除协议的签署人数量不能多于原流程的签署人数量
+        # @param Agent: 关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param ReleasedApprovers: 解除协议的签署人列表(如不指定该参数，默认使用原流程的签署人列表)。 <br/>
+        # 如需更换原合同中的签署人，可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
+        # 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
+
+        # `注意：只能更换同企业的签署人。`<br/>
+        # `注意：不支持更换个人类型的签署人。`<br/>
         # @type ReleasedApprovers: Array
-        # @param Deadline: 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
+        # @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
+        # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
         # @type Deadline: Integer
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
-        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param UserData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
+        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+        # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
+        # @type UserData: String
 
-        attr_accessor :Operator, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :Deadline, :Agent
+        attr_accessor :Operator, :NeedRelievedFlowId, :ReliveInfo, :Agent, :ReleasedApprovers, :Deadline, :UserData
 
-        def initialize(operator=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, deadline=nil, agent=nil)
+        def initialize(operator=nil, needrelievedflowid=nil, reliveinfo=nil, agent=nil, releasedapprovers=nil, deadline=nil, userdata=nil)
           @Operator = operator
           @NeedRelievedFlowId = needrelievedflowid
           @ReliveInfo = reliveinfo
+          @Agent = agent
           @ReleasedApprovers = releasedapprovers
           @Deadline = deadline
-          @Agent = agent
+          @UserData = userdata
         end
 
         def deserialize(params)
@@ -3021,6 +3054,10 @@ module TencentCloud
             @ReliveInfo = RelieveInfo.new
             @ReliveInfo.deserialize(params['ReliveInfo'])
           end
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
           unless params['ReleasedApprovers'].nil?
             @ReleasedApprovers = []
             params['ReleasedApprovers'].each do |i|
@@ -3030,16 +3067,14 @@ module TencentCloud
             end
           end
           @Deadline = params['Deadline']
-          unless params['Agent'].nil?
-            @Agent = Agent.new
-            @Agent.deserialize(params['Agent'])
-          end
+          @UserData = params['UserData']
         end
       end
 
       # CreateReleaseFlow返回参数结构体
       class CreateReleaseFlowResponse < TencentCloud::Common::AbstractModel
         # @param FlowId: 解除协议流程编号
+        # `注意：这里的流程编号对应的合同是本次发起的解除协议。`
         # @type FlowId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -4120,11 +4155,13 @@ module TencentCloud
 
       # DescribeFlowEvidenceReport请求参数结构体
       class DescribeFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param ReportId: 出证报告编号
+        # @param ReportId: 签署报告编号
         # @type ReportId: String
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :ReportId, :Agent
@@ -4153,11 +4190,12 @@ module TencentCloud
         # @param ReportUrl: 出证报告PDF的下载 URL
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReportUrl: String
-        # @param Status: 出证任务执行的状态, 分布表示下面的含义
-
-        # EvidenceStatusExecuting  出证任务在执行中
-        # EvidenceStatusSuccess  出证任务执行成功
-        # EvidenceStatusFailed  出证任务执行失败
+        # @param Status: 签署报告出证任务的状态
+        # <ul>
+        # <li>EvidenceStatusExecuting : 出证任务在执行中</li>
+        # <li>EvidenceStatusSuccess : 出证任务执行成功</li>
+        # <li>EvidenceStatusFailed : 出证任务执行失败</li>
+        # </ul>
         # @type Status: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -5451,10 +5489,14 @@ module TencentCloud
 
       # 签署链接信息
       class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
-        # @param SignUrl: 签署链接。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。
+        # @param SignUrl: 签署链接(短链形式呈现)。请注意保密，不要将其外泄给无关用户。
+        # 注: `注意该链接有效期为30分钟`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SignUrl: String
-        # @param ApproverType: 签署人类型 1-个人
+        # @param ApproverType: 签署参与人类型
+        # <ul><li> **1** :个人参与方</li></ul>
+
+        # 注: `现在仅支持个人参与方`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverType: Integer
         # @param ApproverName: 签署人姓名
@@ -5463,7 +5505,8 @@ module TencentCloud
         # @param ApproverMobile: 签署人手机号
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverMobile: String
-        # @param LongUrl: 签署长链接。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。
+        # @param LongUrl: 签署链接(长链形式呈现)。请注意保密，不要将其外泄给无关用户。
+        # 注: `注意该链接有效期为30分钟`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LongUrl: String
 
@@ -7965,14 +8008,18 @@ module TencentCloud
 
       # 用户的三要素：姓名，证件号，证件类型
       class UserThreeFactor < TencentCloud::Common::AbstractModel
-        # @param Name: 姓名
+        # @param Name: 签署方经办人的姓名。
+        # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
         # @type Name: String
-        # @param IdCardType: 证件类型:
-        # ID_CARD 身份证
-        # HONGKONG_AND_MACAO 港澳居民来往内地通行证
-        # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+        # @param IdCardType: 证件类型，支持以下类型
+        # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
+        # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+        # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
         # @type IdCardType: String
-        # @param IdCardNumber: 证件号，如果有 X 请大写
+        # @param IdCardNumber: 证件号码，应符合以下规则
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
 
         attr_accessor :Name, :IdCardType, :IdCardNumber

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.653
+  version: 3.0.654
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
@@ -33,8 +33,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/v20201111/client.rb
 - lib/v20201111/models.rb
+- lib/v20201111/client.rb
 - lib/tencentcloud-sdk-ess.rb
 - lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby