tencentcloud-sdk-essbasic 3.0.689 → 3.0.691

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8137a4e60a258742266b0b2aae0dc8e49e7a0cb0
-  data.tar.gz: fc1ccdf855324823e57267e4dd95532ca2638119
+  metadata.gz: 5c6ed753c0f6607f428e6e636db8671c21afd27d
+  data.tar.gz: 1d91782b479fd49f21e31ce8410467befb7966fc
 SHA512:
-  metadata.gz: 2998ddb2b75e6cf36301f0c8ad86c374d4964bb171ddfb892448baafaf35a62b5abc9a44328ec90e07b62529604cfebb42737b13dfe82795d1a3b8635d2b54b2
-  data.tar.gz: 7b2017efcbb87ab726f7b41e8ee1272c177605f5ad008eef4ddd2a509c789df1ce107bede8d04ded1b80d6be14535584b1b1f656aa79ba1140245edbf5486063
+  metadata.gz: 9088c1718b81faf0ac57e8cd755e890e8ff0f38f839d4ae222b8ed5bfb8f8ed1d338ff40c43484a195f5f5679051547d7a6bf58cd9c044f44f4ad23b5fdce42e
+  data.tar.gz: 1d8119f2f9a6135b1b34259cbd9952e9f0e06a77c48b2189b7959802d764429c363c96fecccdeaca991d939ba495764ca31d5f800a3d772e982a052a85648050

data/lib/VERSION

@@ -1 +1 @@
-3.0.689
+3.0.691

data/lib/tencentcloud-sdk-essbasic.rb

@@ -2,12 +2,12 @@
 
 require 'tencentcloud-sdk-common'
 
-require_relative 'v20210526/client'
-require_relative 'v20210526/models'
-
 require_relative 'v20201222/client'
 require_relative 'v20201222/models'
 
+require_relative 'v20210526/client'
+require_relative 'v20210526/models'
+
 module TencentCloud
   module Essbasic
   end

data/lib/v20210526/client.rb

@@ -181,6 +181,37 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
+        # `注意：`<br/>
+        # `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
+        # `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
+        # `3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。` <br/>
+        # `4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。` <br/>
+        # `5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`<br/>
+        # 跳转到小程序的实现，参考微信官方文档(分为<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 ChannelCreateBatchQuickSignUrl.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlResponse`
+        def ChannelCreateBatchQuickSignUrl(request)
+          body = send_request('ChannelCreateBatchQuickSignUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateBatchQuickSignUrlResponse.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
+
         # 通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。
         # 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
 
@@ -235,7 +266,14 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
+        # 此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
+        # 前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
+        # 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
+        # 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
+        # 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
+        # 注:
+        # 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
+        # 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
 
         # @param request: Request instance for ChannelCreateConvertTaskApi.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateConvertTaskApiRequest`
@@ -1199,8 +1237,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。
-        # 注意：大文件转换所需的时间可能会比较长。
+        # 此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
+        # 前提条件：已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
+
+        # 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。<br />
+        # 注：
+        # 1. `大文件转换所需的时间可能会比较长`
 
         # @param request: Request instance for ChannelGetTaskResultApi.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelGetTaskResultApiRequest`
@@ -1718,6 +1760,11 @@ module TencentCloud
         # >- 签署控件 SignComponents
         # >- 生成模板的文件基础信息 FileInfos
 
+        # 注意：
+
+        # >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
+        # >2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
+
         # @param request: Request instance for DescribeTemplates.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesResponse`
@@ -1888,7 +1935,7 @@ module TencentCloud
 
         # 该接口 (PrepareFlows) 用于创建待发起文件
         # 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-        # 目前该接口只支持B2C，不建议使用，将会废弃。
+        # 目前该接口只支持B2C，不建议使用，将会**废弃**。
 
         # @param request: Request instance for PrepareFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::PrepareFlowsRequest`

data/lib/v20210526/models.rb

@@ -116,6 +116,8 @@ module TencentCloud
 
       # 签署人个性化能力信息
       class ApproverOption < TencentCloud::Common::AbstractModel
+        # @param NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
+        # @type NoRefuse: Boolean
         # @param HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏
         # @type HideOneKeySign: Boolean
         # @param FillType: 签署人信息补充类型，默认无需补充。
@@ -133,15 +135,17 @@ module TencentCloud
         # </ul>
         # @type FlowReadLimit: String
 
-        attr_accessor :HideOneKeySign, :FillType, :FlowReadLimit
+        attr_accessor :NoRefuse, :HideOneKeySign, :FillType, :FlowReadLimit
 
-        def initialize(hideonekeysign=nil, filltype=nil, flowreadlimit=nil)
+        def initialize(norefuse=nil, hideonekeysign=nil, filltype=nil, flowreadlimit=nil)
+          @NoRefuse = norefuse
           @HideOneKeySign = hideonekeysign
           @FillType = filltype
           @FlowReadLimit = flowreadlimit
         end
 
         def deserialize(params)
+          @NoRefuse = params['NoRefuse']
           @HideOneKeySign = params['HideOneKeySign']
           @FillType = params['FillType']
           @FlowReadLimit = params['FlowReadLimit']
@@ -709,6 +713,86 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateBatchQuickSignUrl请求参数结构体
+      class ChannelCreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel
+        # @param FlowIds: 批量签署的合同流程ID数组。
+        # 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
+        # @type FlowIds: Array
+        # @param FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
+        # 注:
+        # `1. ApproverType目前只支持个人类型的签署人。`
+        # `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+        # `3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
+        # @type FlowApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverInfo`
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
+        # @type JumpUrl: String
+        # @param SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：
+        # <ul><li>**0**：手写签名(默认)</li>
+        # <li>**1**：OCR楷体</li></ul>
+        # 注：
+        # <ul><li>默认情况下，签名类型为手写签名</li>
+        # <li>您可以传递多种值，表示可用多种签名类型。</li></ul>
+        # @type SignatureTypes: Array
+        # @param ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
+        # <ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
+        # <li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
+        # 注：
+        # <ul><li>默认情况下，认证校验方式为人脸认证</li>
+        # <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
+        # @type ApproverSignTypes: Array
+
+        attr_accessor :FlowIds, :FlowApproverInfo, :Agent, :JumpUrl, :SignatureTypes, :ApproverSignTypes
+
+        def initialize(flowids=nil, flowapproverinfo=nil, agent=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil)
+          @FlowIds = flowids
+          @FlowApproverInfo = flowapproverinfo
+          @Agent = agent
+          @JumpUrl = jumpurl
+          @SignatureTypes = signaturetypes
+          @ApproverSignTypes = approversigntypes
+        end
+
+        def deserialize(params)
+          @FlowIds = params['FlowIds']
+          unless params['FlowApproverInfo'].nil?
+            @FlowApproverInfo = FlowApproverInfo.new
+            @FlowApproverInfo.deserialize(params['FlowApproverInfo'])
+          end
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @JumpUrl = params['JumpUrl']
+          @SignatureTypes = params['SignatureTypes']
+          @ApproverSignTypes = params['ApproverSignTypes']
+        end
+      end
+
+      # ChannelCreateBatchQuickSignUrl返回参数结构体
+      class ChannelCreateBatchQuickSignUrlResponse < TencentCloud::Common::AbstractModel
+        # @param FlowApproverUrlInfo: 签署人签署链接信息
+        # @type FlowApproverUrlInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverUrlInfo`
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :FlowApproverUrlInfo, :RequestId
+
+        def initialize(flowapproverurlinfo=nil, requestid=nil)
+          @FlowApproverUrlInfo = flowapproverurlinfo
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['FlowApproverUrlInfo'].nil?
+            @FlowApproverUrlInfo = FlowApproverUrlInfo.new
+            @FlowApproverUrlInfo.deserialize(params['FlowApproverUrlInfo'])
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateBatchSignUrl请求参数结构体
       class ChannelCreateBatchSignUrlRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -884,13 +968,35 @@ module TencentCloud
 
       # ChannelCreateConvertTaskApi请求参数结构体
       class ChannelCreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+        # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param ResourceType: 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
+        # @param ResourceType: 需要进行转换的资源文件类型
+        # 支持的文件类型如下：
+        # <ul><li>doc</li>
+        # <li>docx</li>
+        # <li>xls</li>
+        # <li>xlsx</li>
+        # <li>jpg</li>
+        # <li>jpeg</li>
+        # <li>png</li>
+        # <li>bmp</li>
+        # <li>txt</li></ul>
         # @type ResourceType: String
-        # @param ResourceName: 资源名称，长度限制为256字符
+        # @param ResourceName: 需要进行转换操作的文件资源名称，带资源后缀名。
+
+        # 注:  `资源名称长度限制为256个字符`
         # @type ResourceName: String
-        # @param ResourceId: 文件Id，通过UploadFiles获取
+        # @param ResourceId: 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
+
+        # 注:  `目前，此接口仅支持单个文件进行转换。`
         # @type ResourceId: String
         # @param Operator: 调用方用户信息，不用传
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -934,7 +1040,7 @@ module TencentCloud
 
       # ChannelCreateConvertTaskApi返回参数结构体
       class ChannelCreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
-        # @param TaskId: 任务id
+        # @param TaskId: 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
         # @type TaskId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3241,9 +3347,17 @@ module TencentCloud
 
       # ChannelGetTaskResultApi请求参数结构体
       class ChannelGetTaskResultApiRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+        # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param TaskId: 任务Id，通过ChannelCreateConvertTaskApi接口获得
+        # @param TaskId: 转换任务Id，通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
         # @type TaskId: String
         # @param Operator: 操作者的信息，不用传
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -3286,22 +3400,22 @@ module TencentCloud
         # @param TaskId: 任务Id
         # @type TaskId: String
         # @param TaskStatus: 任务状态，需要关注的状态
-        # 0  :NeedTranform   - 任务已提交
-        # 4  :Processing     - 文档转换中
-        # 8  :TaskEnd        - 任务处理完成
-        # -2 :DownloadFailed - 下载失败
-        # -6 :ProcessFailed  - 转换失败
-        # -13:ProcessTimeout - 转换文件超时
+        # <ul><li>**0**  :NeedTranform   - 任务已提交</li>
+        # <li>**4**  :Processing     - 文档转换中</li>
+        # <li>**8**  :TaskEnd        - 任务处理完成</li>
+        # <li>**-2** :DownloadFailed - 下载失败</li>
+        # <li>**-6** :ProcessFailed  - 转换失败</li>
+        # <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
         # @type TaskStatus: Integer
         # @param TaskMessage: 状态描述，需要关注的状态
-        # NeedTranform   - 任务已提交
-        # Processing     - 文档转换中
-        # TaskEnd        - 任务处理完成
-        # DownloadFailed - 下载失败
-        # ProcessFailed  - 转换失败
-        # ProcessTimeout - 转换文件超时
+        # <ul><li> **NeedTranform** : 任务已提交</li>
+        # <li> **Processing** : 文档转换中</li>
+        # <li> **TaskEnd** : 任务处理完成</li>
+        # <li> **DownloadFailed** : 下载失败</li>
+        # <li> **ProcessFailed** : 转换失败</li>
+        # <li> **ProcessTimeout** : 转换文件超时</li></ul>
         # @type TaskMessage: String
-        # @param ResourceId: 资源Id，也是FileId，用于文件发起使用
+        # @param ResourceId: 资源Id，也是FileId，用于文件发起时使用
         # @type ResourceId: String
         # @param PreviewUrl: 预览文件Url，有效期30分钟
         # 当前字段返回为空，发起的时候，将ResourceId 放入发起即可
@@ -5013,55 +5127,88 @@ module TencentCloud
 
       # DescribeTemplates请求参数结构体
       class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。
-        # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+        # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param TemplateId: 模板唯一标识，查询单个模板时使用
+        # @param TemplateId: 合同模板ID，为32位字符串。
+        # 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
         # @type TemplateId: String
-        # @param ContentType: 查询内容：
-        # 0-模板列表及详情（默认），
-        # 1-仅模板列表
+        # @param ContentType: 查询内容控制
+
+        # <ul><li>**0**：模板列表及详情（默认）</li>
+        # <li>**1**：仅模板列表</li></ul>
         # @type ContentType: Integer
-        # @param Limit: 指定每页多少条数据，如果不传默认为20，单页最大100。
+        # @param TemplateIds: 合同模板ID数组，每一个合同模板ID为32位字符串。
+        # 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+
+        # ```注意:
+        # 1. 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。
+        # 2. 请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。
+        # 3. 最多支持200个模板。
+        # 4. 若传递此参数，分页参数(Limit,Offset)无效```
+        # @type TemplateIds: Array
+        # @param Limit: 指定每页返回的数据条数，和Offset参数配合使用。
+
+        # 注：`1.默认值为20，单页做大值为200。`
         # @type Limit: Integer
-        # @param Offset: 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。
+        # @param Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
+
+        # 注：`1.offset从0开始，即第一页为0。`
+        # `2.默认从第一页返回。`
         # @type Offset: Integer
-        # @param QueryAllComponents: 是否返回所有组件信息。
-        # 默认false，只返回发起方控件；
-        # true，返回所有签署方控件
-        # @type QueryAllComponents: Boolean
-        # @param TemplateName: 模糊搜索模板名称，最大长度200
+        # @param TemplateName: 模糊搜索的模板名称，注意是模板名的连续部分，最大长度200
         # @type TemplateName: String
-        # @param WithPreviewUrl: 是否获取模板预览链接，
-        # 默认false-不获取
-        # true-获取
+        # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
+        # @type ChannelTemplateId: String
+        # @param QueryAllComponents: 是否返回所有控件信息。
+
+        # <ul><li>**false**：只返回发起方控件（默认）</li>
+        # <li>**true**：返回所有签署方控件</li></ul>
+        # @type QueryAllComponents: Boolean
+        # @param WithPreviewUrl: 是否获取模板预览链接。
+
+        # <ul><li>**false**：不获取（默认）</li>
+        # <li>**true**：获取</li></ul>
+
+        # 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,有效期5分钟。
+        # 可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+        # （此功能开放需要联系客户经理）
         # @type WithPreviewUrl: Boolean
         # @param WithPdfUrl: 是否获取模板的PDF文件链接。
-        # 默认false-不获取
-        # true-获取
-        # 请联系客户经理开白后使用。
+
+        # <ul><li>**false**：不获取（默认）</li>
+        # <li>**true**：获取</li></ul>
+
+        # 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟。
+        # （此功能开放需要联系客户经理）
         # @type WithPdfUrl: Boolean
-        # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID
-        # @type ChannelTemplateId: String
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId, :Operator
+        attr_accessor :Agent, :TemplateId, :ContentType, :TemplateIds, :Limit, :Offset, :TemplateName, :ChannelTemplateId, :QueryAllComponents, :WithPreviewUrl, :WithPdfUrl, :Operator
         extend Gem::Deprecate
         deprecate :Operator, :none, 2023, 11
         deprecate :Operator=, :none, 2023, 11
 
-        def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, withpreviewurl=nil, withpdfurl=nil, channeltemplateid=nil, operator=nil)
+        def initialize(agent=nil, templateid=nil, contenttype=nil, templateids=nil, limit=nil, offset=nil, templatename=nil, channeltemplateid=nil, queryallcomponents=nil, withpreviewurl=nil, withpdfurl=nil, operator=nil)
           @Agent = agent
           @TemplateId = templateid
           @ContentType = contenttype
+          @TemplateIds = templateids
           @Limit = limit
           @Offset = offset
-          @QueryAllComponents = queryallcomponents
           @TemplateName = templatename
+          @ChannelTemplateId = channeltemplateid
+          @QueryAllComponents = queryallcomponents
           @WithPreviewUrl = withpreviewurl
           @WithPdfUrl = withpdfurl
-          @ChannelTemplateId = channeltemplateid
           @Operator = operator
         end
 
@@ -5072,13 +5219,14 @@ module TencentCloud
           end
           @TemplateId = params['TemplateId']
           @ContentType = params['ContentType']
+          @TemplateIds = params['TemplateIds']
           @Limit = params['Limit']
           @Offset = params['Offset']
-          @QueryAllComponents = params['QueryAllComponents']
           @TemplateName = params['TemplateName']
+          @ChannelTemplateId = params['ChannelTemplateId']
+          @QueryAllComponents = params['QueryAllComponents']
           @WithPreviewUrl = params['WithPreviewUrl']
           @WithPdfUrl = params['WithPdfUrl']
-          @ChannelTemplateId = params['ChannelTemplateId']
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
@@ -5088,11 +5236,11 @@ module TencentCloud
 
       # DescribeTemplates返回参数结构体
       class DescribeTemplatesResponse < TencentCloud::Common::AbstractModel
-        # @param Templates: 模板列表
+        # @param Templates: 模板详情列表数据
         # @type Templates: Array
-        # @param TotalCount: 查询到的总数
+        # @param TotalCount: 查询到的模板总数
         # @type TotalCount: Integer
-        # @param Limit: 每页多少条数据
+        # @param Limit: 每页返回的数据条数
         # @type Limit: Integer
         # @param Offset: 查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
         # @type Offset: Integer
@@ -5632,9 +5780,13 @@ module TencentCloud
         # @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverOption`
         # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批，true 则为需要
         # @type ApproverNeedSignReview: Boolean
-        # @param ApproverVerifyTypes: 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
-        # 查看合同的认证方式 Flow层级的优先于approver层级的
-        # （当手写签名方式为OCR_ESIGN时，合同认证方式2无效，因为这种签名方式依赖实名认证）
+        # @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
+        # <ul><li>  **1**   : （默认）人脸识别,人脸识别后才能合同内容</li>
+        # <li>  **2**  : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
+        # </li></ul>
+        # 注:
+        # <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li>
+        # <li>此字段可传多个校验方式</li></ul>
         # @type ApproverVerifyTypes: Array
         # @param ApproverSignTypes: 签署人签署合同时的认证方式
         # <ul><li> **1** :人脸认证</li>
@@ -5659,7 +5811,9 @@ module TencentCloud
 
         # 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
         # @type AddSignComponentsLimits: Array
-        # @param ApproverRoleName: 自定义签署人角色名，如收款人、开具人、见证人等
+        # @param ApproverRoleName: 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
+
+        # 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
         # @type ApproverRoleName: String
 
         attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType, :AddSignComponentsLimits, :ApproverRoleName
@@ -6093,36 +6247,67 @@ module TencentCloud
       # | widthPercent   | Integer | 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35                    |
       # | content    | String  | 表头单元格内容，字数不超过100                         |
       class FlowInfo < TencentCloud::Common::AbstractModel
-        # @param FlowName: 合同名字，最大长度200个字符
+        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
         # @type FlowName: String
-        # @param Deadline: 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
+        # @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
+        # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
+        # 示例值：1604912664
         # @type Deadline: Integer
-        # @param TemplateId: 模板ID
+        # @param TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
+
+        # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
         # @type TemplateId: String
         # @param FlowApprovers: 多个签署人信息，最大支持50个签署方
         # @type FlowApprovers: Array
         # @param FormFields: 表单K-V对列表
         # @type FormFields: Array
-        # @param CallbackUrl: 回调地址，最大长度1000个字符
+        # @param CallbackUrl: 合同状态变动结的通知回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性，最大长度1000个字符。
+
+        # 腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
+        # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块
         # @type CallbackUrl: String
-        # @param FlowType: 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符
+        # @param FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
         # @type FlowType: String
-        # @param FlowDescription: 合同描述，最大长度1000个字符
+        # @param FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
         # @type FlowDescription: String
-        # @param CustomerData:  第三方应用平台的业务信息，最大长度1000个字符。
+        # @param CustomerData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
+
+        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
         # @type CustomerData: String
-        # @param CustomShowMap: 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+        # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
+        # <ul><li>{合同名称}   </li>
+        # <li>{发起方企业} </li>
+        # <li>{发起方姓名} </li>
+        # <li>{签署方N企业}</li>
+        # <li>{签署方N姓名}</li></ul>
+        # 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
+
+        # 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
+
+        # 合同名称：租房合同
+        # 发起方：腾讯公司(张三)
+        # 签署方：李四
+
         # @type CustomShowMap: String
-        # @param CcInfos: 被抄送人的信息列表，抄送功能暂不开放
-        # @type CcInfos: Array
-        # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。
-        # 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+        # @param CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
 
-        # 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+        # 注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。`
+        # @type CcInfos: Array
+        # @param NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
+        # <ul><li> **false**：（默认）不需要审批，直接签署。</li>
+        # <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
+        # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
+        # <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
+        # <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
+        # 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
         # @type NeedSignReview: Boolean
-        # @param CcNotifyType: 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
+        # @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
+        # <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
+        # <li> **1** : 签署完成后通知对方来查看合同</li></ul>
         # @type CcNotifyType: Integer
-        # @param AutoSignScene: 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+        # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
+        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）  </li></ul>
+        # 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
         # @type AutoSignScene: String
 
         attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos, :NeedSignReview, :CcNotifyType, :AutoSignScene

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.689
+  version: 3.0.691
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2023-11-01 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/v20210526/client.rb
-- lib/v20210526/models.rb
-- lib/v20201222/client.rb
 - lib/v20201222/models.rb
+- lib/v20201222/client.rb
 - lib/tencentcloud-sdk-essbasic.rb
+- lib/v20210526/models.rb
+- lib/v20210526/client.rb
 - lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
 licenses: