tencentcloud-sdk-essbasic 3.0.682 → 3.0.684

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca015d516ccb9bbd41d8adb152c8e716e5086e59
-  data.tar.gz: 66bbf0e964b45f54f2f75001ec76f970e3b68918
+  metadata.gz: 3d6b11486486589d1f6823b08f88d3e5d58d5ab1
+  data.tar.gz: 8068e127238d00e87bbfb09d86c996fd238ea69c
 SHA512:
-  metadata.gz: 5efc2318277a187e629d13e1f55254031ba809115600d17f01d620176aeceb6078c4247dca264de204775c954035bcc476a25444f98d8b0fc128fac3a9c8c52a
-  data.tar.gz: 5a2b7fc92f329643fd82729510275ac494df4f674e4034cf70c177a8e92a8166748f33e15a6ac1e448d6bea410649733d7d174b3846cb1bd224a00dc7cdd42bd
+  metadata.gz: 9abe0c1282c42804c27c0442eca1ac3e824c513d3c3e8ddeb15896866cc88fe593f1906f8c70d01adfd3034bc276bd08718539eb21ab672469233873805c12c8
+  data.tar.gz: b9def31407450f8b5d73471dd5f62bb12db1e5ff088f6f21e375f89a6109c9f4f6daf3c8f061e084606541cccf00d6c7b6db5d6f0350d039de77d4977d37af95

data/lib/VERSION

@@ -1 +1 @@
-3.0.682
+3.0.684

data/lib/v20210526/client.rb

@@ -90,7 +90,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
+        # 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+        # 该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+        # 如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
 
         # @param request: Request instance for ChannelCancelMultiFlowSignQRCode.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelMultiFlowSignQRCodeRequest`
@@ -384,7 +386,66 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
+        # 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
+
+        # 合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+        # 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+
+
+        # **注**:
+        # <ul>
+        # <li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+        # <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。</li>
+        # </ul>
+
+        # **可以作为发起方和签署方的角色列表**
+        # <table>
+        # <thead>
+        # <tr>
+        # <th>场景编号</th>
+        # <th>可作为发起方类型</th>
+        # <th>可作为签署方的类型</th>
+        # </tr>
+        # </thead>
+
+        # <tbody>
+        # <tr>
+        # <td>场景一</td>
+        # <td>第三方子企业A员工</td>
+        # <td>第三方子企业A员工</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景二</td>
+        # <td>第三方子企业A员工</td>
+        # <td>第三方子企业B(不指定经办人)</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景三</td>
+        # <td>第三方子企业A员工</td>
+        # <td>第三方子企业B员工</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景四</td>
+        # <td>第三方子企业A员工</td>
+        # <td>个人/自然人</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景五</td>
+        # <td>第三方子企业A员工</td>
+        # <td>SaaS平台企业员工</td>
+        # </tr>
+        # </tbody>
+        # </table>
+
+        # **注**:
+        # `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+        # `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
 
         # @param request: Request instance for ChannelCreateFlowGroupByFiles.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByFilesRequest`
@@ -410,6 +471,64 @@ module TencentCloud
 
         # 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
 
+        # 合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+        # 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+        # **注**:
+        # <ul>
+        # <li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+        # <li>合同组暂不支持抄送功能</li>
+        # </ul>
+
+        # **可以作为发起方和签署方的角色列表**
+        # <table>
+        # <thead>
+        # <tr>
+        # <th>场景编号</th>
+        # <th>可作为发起方类型</th>
+        # <th>可作为签署方的类型</th>
+        # </tr>
+        # </thead>
+
+        # <tbody>
+        # <tr>
+        # <td>场景一</td>
+        # <td>第三方子企业A员工</td>
+        # <td>第三方子企业A员工</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景二</td>
+        # <td>第三方子企业A员工</td>
+        # <td>第三方子企业B(不指定经办人)</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景三</td>
+        # <td>第三方子企业A员工</td>
+        # <td>第三方子企业B员工</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景四</td>
+        # <td>第三方子企业A员工</td>
+        # <td>个人/自然人</td>
+        # </tr>
+
+        # <tr>
+        # <td>场景五</td>
+        # <td>第三方子企业A员工</td>
+        # <td>SaaS平台企业员工</td>
+        # </tr>
+        # </tbody>
+        # </table>
+
+        # **注**:
+        # `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+
+        # `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
+
         # @param request: Request instance for ChannelCreateFlowGroupByTemplates.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByTemplatesRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByTemplatesResponse`
@@ -432,10 +551,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
-        # 注意:
-        # 该接口不可直接调用，请联系客户经理申请使用
-        # 仅能催办当前状态为“待签署”的签署人，且只能催办一次
+        # 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+
+        # 1. 合同中当前状态为“待签署”的签署人是催办的对象
+        # 2. 每个合同只能催办一次
+
+        # 注意：该接口无法直接调用，请联系客户经理申请使用。
 
         # @param request: Request instance for ChannelCreateFlowReminds.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowRemindsRequest`
@@ -515,7 +636,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+        # 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+        # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
+        # 常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
         # **本接口适用于发起方没有填写控件的 B2C或者单C模板**
 
@@ -1465,6 +1588,7 @@ module TencentCloud
         # 3. 使用手机号验证签署方身份
         # 4. 骑缝章
         # 5. 拓宽签署方年龄限制
+        # 6. 下载企业合同/文件
 
         # 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
 

data/lib/v20210526/models.rb

@@ -178,7 +178,9 @@ module TencentCloud
 
       # 授权出错信息
       class AuthFailMessage < TencentCloud::Common::AbstractModel
-        # @param ProxyOrganizationOpenId: 第三方应用平台的子客企业OpenId
+        # @param ProxyOrganizationOpenId: 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
+
+        # 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
         # @type ProxyOrganizationOpenId: String
         # @param Message: 错误信息
         # @type Message: String
@@ -504,9 +506,16 @@ module TencentCloud
 
       # ChannelCancelMultiFlowSignQRCode请求参数结构体
       class ChannelCancelMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # </ul>
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param QrCodeId: 二维码id
+        # @param QrCodeId: 二维码ID，为32位字符串。
         # @type QrCodeId: String
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1274,18 +1283,29 @@ module TencentCloud
 
       # ChannelCreateFlowGroupByFiles请求参数结构体
       class ChannelCreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel
-        # @param FlowFileInfos: 每个子合同的发起所需的信息，数量限制2-50
+        # @param FlowFileInfos: 合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
         # @type FlowFileInfos: Array
-        # @param FlowGroupName: 合同组名称，长度不超过200个字符
+        # @param FlowGroupName: 合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
         # @type FlowGroupName: String
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # </ul>
+
+        # 子客企业和子客企业中的员工比较走完创建和实名过程
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param ApproverVerifyType: 签署人校验方式
-        # VerifyCheck: 人脸识别（默认）
-        # MobileCheck：手机号验证
-        # 参数说明：若选择后者，未实名的个人签署方查看合同时，无需进行人脸识别实名认证（但签署合同时仍然需要人脸实名），该能力仅适用于个人签署方。
+        # @param ApproverVerifyType: 合同组中签署人校验和认证的方式：
+        # <ul><li>**VerifyCheck**：人脸识别（默认）</li>
+        # <li>**MobileCheck**：手机号验证</li></ul>
+        # 注意：
+        # `1. MobileCheck 方式，未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同（但签署合同时仍然需要人脸实名），企业签署方需经过人脸认证。`
+        # `2. 合同组的校验和认证的方式会优先使用，会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`
         # @type ApproverVerifyType: String
-        # @param FlowGroupOptions: 合同组的配置项信息包括：在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。
+        # @param FlowGroupOptions: 合同组的签署配置项信息，例如在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。
         # @type FlowGroupOptions: :class:`Tencentcloud::Essbasic.v20210526.models.FlowGroupOptions`
         # @param Operator: 操作者的信息，此参数不用传
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1332,10 +1352,14 @@ module TencentCloud
 
       # ChannelCreateFlowGroupByFiles返回参数结构体
       class ChannelCreateFlowGroupByFilesResponse < TencentCloud::Common::AbstractModel
-        # @param FlowGroupId: 合同组ID
+        # @param FlowGroupId: 合同组ID，为32位字符串。
+        # 建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowGroupId: String
-        # @param FlowIds: 子合同ID列表
+        # @param FlowIds: 合同组中每个合同流程ID，每个ID均为32位字符串。
+
+        # 注:
+        # `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowIds: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1358,11 +1382,20 @@ module TencentCloud
 
       # ChannelCreateFlowGroupByTemplates请求参数结构体
       class ChannelCreateFlowGroupByTemplatesRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # </ul>
+
+        # 子客企业和子客企业中的员工比较走完创建和实名过程
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowInfos: 每个子合同的发起所需的信息，数量限制2-50（合同组暂不支持抄送功能）
+        # @param FlowInfos: 合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
         # @type FlowInfos: Array
-        # @param FlowGroupName: 合同组名称，长度不超过200个字符
+        # @param FlowGroupName: 合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
         # @type FlowGroupName: String
 
         attr_accessor :Agent, :FlowInfos, :FlowGroupName
@@ -1392,9 +1425,13 @@ module TencentCloud
 
       # ChannelCreateFlowGroupByTemplates返回参数结构体
       class ChannelCreateFlowGroupByTemplatesResponse < TencentCloud::Common::AbstractModel
-        # @param FlowGroupId: 合同组ID
+        # @param FlowGroupId: 合同组ID，为32位字符串。
+        # 建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
         # @type FlowGroupId: String
-        # @param FlowIds: 子合同ID列表
+        # @param FlowIds: 合同组中每个合同流程ID，每个ID均为32位字符串。
+
+        # 注:
+        # `此数组的顺序和入参中的FlowInfos顺序回不一致`
         # @type FlowIds: Array
         # @param TaskInfos: 复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
         # 如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
@@ -1428,9 +1465,16 @@ module TencentCloud
 
       # ChannelCreateFlowReminds请求参数结构体
       class ChannelCreateFlowRemindsRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # </ul>
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowIds: 签署流程Id数组，最多100个，超过100不处理
+        # @param FlowIds: 需执行催办的签署流程ID数组，最多包含100个。
         # @type FlowIds: Array
 
         attr_accessor :Agent, :FlowIds
@@ -1451,7 +1495,7 @@ module TencentCloud
 
       # ChannelCreateFlowReminds返回参数结构体
       class ChannelCreateFlowRemindsResponse < TencentCloud::Common::AbstractModel
-        # @param RemindFlowRecords: 合同催办详情信息
+        # @param RemindFlowRecords: 合同催办结果的详细信息列表。
         # @type RemindFlowRecords: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -1625,24 +1669,30 @@ module TencentCloud
 
       # ChannelCreateMultiFlowSignQRCode请求参数结构体
       class ChannelCreateMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。
-        # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # </ul>
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param TemplateId: 模版ID
+        # @param TemplateId: 合同模板ID，为32位字符串。
+        # 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
         # @type TemplateId: String
-        # @param FlowName: 签署流程名称，最大长度200个字符。
+        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
         # @type FlowName: String
-        # @param MaxFlowNum: 最大可发起签署流程份数
-        # <br/>默认5份
-        # <br/>备注：发起签署流程数量超过此上限后，二维码自动失效。
+        # @param MaxFlowNum: 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。
         # @type MaxFlowNum: Integer
-        # @param FlowEffectiveDay: 签署流程有效天数 默认7天 最高设置不超过30天
+        # @param FlowEffectiveDay: 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。 最长设定期限不得超过30天。
         # @type FlowEffectiveDay: Integer
-        # @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
+        # @param QrEffectiveDay: 二维码的有效期限，默认为7天，最高设定不得超过90天。 一旦超过二维码的有效期限，该二维码将自动失效。
         # @type QrEffectiveDay: Integer
-        # @param Restrictions: 指定的签署二维码签署人
-        # <br/>指定后，只允许知道的人操作和签署
+        # @param Restrictions: 指定签署人信息。 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
         # @type Restrictions: Array
+        # @param ApproverComponentLimitTypes: 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
+        # @type ApproverComponentLimitTypes: Array
         # @param CallbackUrl: 已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
         # <br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
         # <br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
@@ -1651,10 +1701,8 @@ module TencentCloud
         # @type ApproverRestrictions: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverRestriction`
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-        # @param ApproverComponentLimitTypes: 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
-        # @type ApproverComponentLimitTypes: Array
 
-        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :CallbackUrl, :ApproverRestrictions, :Operator, :ApproverComponentLimitTypes
+        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :ApproverComponentLimitTypes, :CallbackUrl, :ApproverRestrictions, :Operator
         extend Gem::Deprecate
         deprecate :CallbackUrl, :none, 2023, 10
         deprecate :CallbackUrl=, :none, 2023, 10
@@ -1663,7 +1711,7 @@ module TencentCloud
         deprecate :Operator, :none, 2023, 10
         deprecate :Operator=, :none, 2023, 10
 
-        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, callbackurl=nil, approverrestrictions=nil, operator=nil, approvercomponentlimittypes=nil)
+        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, approvercomponentlimittypes=nil, callbackurl=nil, approverrestrictions=nil, operator=nil)
           @Agent = agent
           @TemplateId = templateid
           @FlowName = flowname
@@ -1671,10 +1719,10 @@ module TencentCloud
           @FlowEffectiveDay = floweffectiveday
           @QrEffectiveDay = qreffectiveday
           @Restrictions = restrictions
+          @ApproverComponentLimitTypes = approvercomponentlimittypes
           @CallbackUrl = callbackurl
           @ApproverRestrictions = approverrestrictions
           @Operator = operator
-          @ApproverComponentLimitTypes = approvercomponentlimittypes
         end
 
         def deserialize(params)
@@ -1695,6 +1743,14 @@ module TencentCloud
               @Restrictions << approverrestriction_tmp
             end
           end
+          unless params['ApproverComponentLimitTypes'].nil?
+            @ApproverComponentLimitTypes = []
+            params['ApproverComponentLimitTypes'].each do |i|
+              approvercomponentlimittype_tmp = ApproverComponentLimitType.new
+              approvercomponentlimittype_tmp.deserialize(i)
+              @ApproverComponentLimitTypes << approvercomponentlimittype_tmp
+            end
+          end
           @CallbackUrl = params['CallbackUrl']
           unless params['ApproverRestrictions'].nil?
             @ApproverRestrictions = ApproverRestriction.new
@@ -1704,22 +1760,14 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
-          unless params['ApproverComponentLimitTypes'].nil?
-            @ApproverComponentLimitTypes = []
-            params['ApproverComponentLimitTypes'].each do |i|
-              approvercomponentlimittype_tmp = ApproverComponentLimitType.new
-              approvercomponentlimittype_tmp.deserialize(i)
-              @ApproverComponentLimitTypes << approvercomponentlimittype_tmp
-            end
-          end
         end
       end
 
       # ChannelCreateMultiFlowSignQRCode返回参数结构体
       class ChannelCreateMultiFlowSignQRCodeResponse < TencentCloud::Common::AbstractModel
-        # @param QrCode: 签署二维码对象
+        # @param QrCode: 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
         # @type QrCode: :class:`Tencentcloud::Essbasic.v20210526.models.SignQrCode`
-        # @param SignUrls: 签署链接对象
+        # @param SignUrls: 流程签署二维码的签署信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
         # @type SignUrls: :class:`Tencentcloud::Essbasic.v20210526.models.SignUrl`
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3587,7 +3635,7 @@ module TencentCloud
       # 在通过文件发起合同时，对应的component有三种定位方式
       # 1. 绝对定位方式
       # 2. 表单域(FIELD)定位方式
-      # 3. 关键字(KEYWORD)定位方式
+      # 3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
       # 可以参考官网说明
       # https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
       class Component < TencentCloud::Common::AbstractModel
@@ -3637,7 +3685,7 @@ module TencentCloud
         # @param GenerateMode: 控件生成的方式：
         # NORMAL - 普通控件
         # FIELD - 表单域
-        # KEYWORD - 关键字
+        # KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）
         # @type GenerateMode: String
         # @param ComponentWidth: 参数控件宽度，默认100，单位px
         # 表单域和关键字转换控件不用填
@@ -4351,7 +4399,7 @@ module TencentCloud
         # @type SealImage: String
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-        # @param GenerateSource: 本接口支持上传图片印章及系统直接生成印章； 如果要使用系统生成印章，此值传：SealGenerateSourceSystem； 如果要使用图片上传请传字段 SealImage
+        # @param GenerateSource: 本接口支持上传图片印章及系统直接生成印章； 如果要使用系统生成印章，此值传：SealGenerateSourceSystem； 如果要使用图片上传，此字段置空并且传字段 SealImage
         # @type GenerateSource: String
         # @param SealType: 电子印章类型：
         # <ul><li>OFFICIAL-公章</li>
@@ -5361,21 +5409,21 @@ module TencentCloud
       # <td>场景一</td>
       # <td>第三方子企业A员工</td>
       # <td>第三方子企业A员工</td>
-      # <td>OpenId、OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
+      # <td>OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
       # </tr>
 
       # <tr>
       # <td>场景二</td>
       # <td>第三方子企业A员工</td>
       # <td>第三方子企业B(不指定经办人)</td>
-      # <td>OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
+      # <td>OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
       # </tr>
 
       # <tr>
       # <td>场景三</td>
       # <td>第三方子企业A员工</td>
       # <td>第三方子企业B员工</td>
-      # <td>OpenId、OrgName、OrgOpenId必传, ApproverType设置为ORGANIZATION</td>
+      # <td>OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION</td>
       # </tr>
 
       # <tr>
@@ -5389,7 +5437,7 @@ module TencentCloud
       # <td>场景五</td>
       # <td>第三方子企业A员工</td>
       # <td>SaaS平台企业员工</td>
-      # <td>Name、Mobile、OrgName必传，且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
+      # <td>Name、Mobile、OrganizationName必传，且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
       # </tr>
       # </tbody>
       # </table>
@@ -5798,15 +5846,13 @@ module TencentCloud
 
       # 合同组的配置项信息包括：在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。
       class FlowGroupOptions < TencentCloud::Common::AbstractModel
-        # @param SelfOrganizationApproverSignEach: 发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认：
-        # fasle：发起方企业经办人签署时对所有子合同进行统一的意愿确认
-        # true：发起方企业经办人签署时需要对子合同进行独立的意愿确认
-        # 默认为fasle。
+        # @param SelfOrganizationApproverSignEach: 发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认
+        # <ul><li>**false**（默认）：发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
+        # <li>**true**：发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
         # @type SelfOrganizationApproverSignEach: Boolean
-        # @param OtherApproverSignEach: 非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认：
-        # fasle：非发起方企业经办人签署时对所有子合同进行统一的意愿确认
-        # true：非发起方企业经办人签署时需要对子合同进行独立的意愿确认
-        # 默认为false。
+        # @param OtherApproverSignEach: 非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认
+        # <ul><li>**false**（默认）：非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
+        # <li>**true**：非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
         # @type OtherApproverSignEach: Boolean
 
         attr_accessor :SelfOrganizationApproverSignEach, :OtherApproverSignEach
@@ -6467,28 +6513,41 @@ module TencentCloud
 
       # OperateChannelTemplate请求参数结构体
       class OperateChannelTemplateRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。
-        # 此接口Agent.AppId必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+        # </ul>
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param OperateType: 操作类型，
-        # 查询:"SELECT"，
-        # 删除:"DELETE"，
-        # 更新:"UPDATE"
+        # <ul>
+        # <li>查询:"SELECT"</li>
+        # <li>删除:"DELETE"</li>
+        # <li>更新:"UPDATE"</li>
+        # </ul>
         # @type OperateType: String
-        # @param TemplateId: 第三方应用平台模板库模板唯一标识
+        # @param TemplateId: 合同模板ID，为32位字符串。此处为第三方应用平台模板库模板ID，非子客模板ID。
         # @type TemplateId: String
-        # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据.
-        # 支持多个， 用","进行分隔
+        # @param ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
+
+        # 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
         # @type ProxyOrganizationOpenIds: String
         # @param AuthTag: 模板可见性,
-        # 全部可见-"all",
-        #  部分可见-"part"
+        # <ul>
+        # <li>全部可见-"all"</li>
+        # <li>部分可见-"part"</li>
+        # </ul>
         # @type AuthTag: String
         # @param Available: 当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。
-        # 若此字段值为0，则不会修改模板Available，
-        # 1为启用模板，
-        # 2为停用模板。
-        # 启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。
+        # <ul>
+        # <li>若此字段值为0，则不会修改模板Available</li>
+        # <li>1为启用模板</li>
+        # <li>2为停用模板</li>
+        # </ul>
+        # 启用后模板可以正常领取。
+        # 停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
+        # 如果Available更新失败，会直接返回错误。
         # @type Available: Integer
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -6530,21 +6589,27 @@ module TencentCloud
         # @param AppId: 腾讯电子签颁发给第三方应用平台的应用ID
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type AppId: String
-        # @param TemplateId: 第三方应用平台模板库模板唯一标识
+        # @param TemplateId: 合同模板ID，为32位字符串。此处为第三方应用平台模板库模板ID，非子客模板ID。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type TemplateId: String
         # @param OperateResult: 描述模板可见性更改的结果，和参数中Available无关。
-        # 全部成功-"all-success",
-        # 部分成功-"part-success",
-        # 全部失败-"fail"，失败的会在FailMessageList中展示。
+        # <ul>
+        # <li>全部成功-"all-success"</li>
+        # <li>部分成功-"part-success"</li>
+        # <li>全部失败-"fail"，失败的会在FailMessageList中展示</li>
+        # </ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OperateResult: String
         # @param AuthTag: 模板可见性,
-        # 全部可见-"all",
-        # 部分可见-"part"
+        # <ul>
+        # <li>全部可见-"all"</li>
+        # <li>部分可见-"part"</li>
+        # </ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type AuthTag: String
-        # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据
+        # @param ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
+
+        # 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ProxyOrganizationOpenIds: Array
         # @param FailMessageList: 操作失败信息数组
@@ -7108,13 +7173,13 @@ module TencentCloud
         end
       end
 
-      # 催办接口返回详细信息
+      # 催办接口返回的详细信息。
       class RemindFlowRecords < TencentCloud::Common::AbstractModel
-        # @param CanRemind: 是否能够催办，true-是，false-否
+        # @param CanRemind: 合同流程是否可以催办： true - 可以，false - 不可以。 若无法催办，将返回RemindMessage以解释原因。
         # @type CanRemind: Boolean
-        # @param FlowId: 合同id
+        # @param FlowId: 合同流程ID，为32位字符串。
         # @type FlowId: String
-        # @param RemindMessage: 催办详情信息
+        # @param RemindMessage: 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
         # @type RemindMessage: String
 
         attr_accessor :CanRemind, :FlowId, :RemindMessage
@@ -7159,13 +7224,13 @@ module TencentCloud
         end
       end
 
-      # 一码多扫签署二维码对象
+      # 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
       class SignQrCode < TencentCloud::Common::AbstractModel
-        # @param QrCodeId: 二维码id
+        # @param QrCodeId: 二维码ID，为32位字符串。
         # @type QrCodeId: String
-        # @param QrCodeUrl: 二维码url
+        # @param QrCodeUrl: 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
         # @type QrCodeUrl: String
-        # @param ExpiredTime: 二维码过期时间
+        # @param ExpiredTime: 二维码的有截止时间，格式为Unix标准时间戳（秒）。 一旦超过二维码的有效期限，该二维码将自动失效。
         # @type ExpiredTime: Integer
 
         attr_accessor :QrCodeId, :QrCodeUrl, :ExpiredTime
@@ -7183,13 +7248,13 @@ module TencentCloud
         end
       end
 
-      # 一码多扫签署二维码签署信息
+      # 流程签署二维码的签署信息，适用于客户系统整合二维码功能。 通过链接，用户可直接访问电子签名小程序并签署合同。
       class SignUrl < TencentCloud::Common::AbstractModel
-        # @param AppSignUrl: 小程序签署链接
+        # @param AppSignUrl: 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
         # @type AppSignUrl: String
-        # @param EffectiveTime: 签署链接有效时间
+        # @param EffectiveTime: 签署链接有效时间，格式类似"2022-08-05 15:55:01"
         # @type EffectiveTime: String
-        # @param HttpSignUrl: 移动端签署链接
+        # @param HttpSignUrl: 跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
         # @type HttpSignUrl: String
 
         attr_accessor :AppSignUrl, :EffectiveTime, :HttpSignUrl

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.682
+  version: 3.0.684
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common