tencentcloud-sdk-ess 3.0.622 → 3.0.624

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f218afd8080dda8b31eb92a0826b66d30934e78b
-  data.tar.gz: 5a20c2357e7aec7dd27615d870acd6797dc393bc
+  metadata.gz: ec4f0ebc12c5d36c7a173d5985f87849f9247318
+  data.tar.gz: 4df263779adca30edde79d9c94f94097ad151353
 SHA512:
-  metadata.gz: 6d41d6e8c5b0d89920c4a5c134dc669a84d6c6e8d66781aed80531a1135d031bf3d668a975b89c69fe1d812e265e13d0b67dc05a8d7662b3e6cfa8b24cbf55fa
-  data.tar.gz: 30aeb97544852a4b47bcd73e87c7e3e53d0d2c23b56e3b17a33060faae9c8c24ba7635af964ffc8f255c3a862533e4eae4c9d3c9d87f37c9ca95f313cebffad0
+  metadata.gz: d25169e815d3f3e2218e6d3fa202941877207dec64ede76d4452569232d7628cc4a1ce39d9e4084a80349d341f707514f239cbd2932c4116c0d9e154d1ffaaec
+  data.tar.gz: 58e7f34630351eb9640ece81719baa4d1dd0f22693c4c3833a1c58d7436a1b23d10e34ff17fb8fc1d4fa8d4ba2183c3674c4cb0a771d75e4cd58a613fe48d346

data/lib/VERSION

@@ -1 +1 @@
-3.0.622
+3.0.624

data/lib/v20201111/client.rb

@@ -471,8 +471,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建个人H5签署链接，请联系客户经理申请使用 <br/>
-        # 该接口用于发起合同后，生成C端签署人的签署链接 <br/>
+        # 创建个人H5签署链接，请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
+
+        # 该接口用于发起合同后，生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
+
         # 注意：该接口目前签署人类型仅支持个人签署方（PERSON） <br/>
         # 注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
         # 注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -977,9 +979,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询流程摘要
+        # 查询流程基础信息
         # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
-        # 日调用量限制：10W
+        # 每个企业限制日调用量限制：10W,  当当日超过此限制后再调用接口返回错误
 
         # @param request: Request instance for DescribeFlowBriefs.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -1076,8 +1078,19 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。<br/>
-        # 该接口常用来配合“创建电子文档”接口作为前置的接口使用。<br/>
+        # 本接口用于查询本企业模板列表。
+
+        # 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。
+
+        # > **适用场景**
+        # >
+        # >  该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
+        # >  一个模板通常会包含以下结构信息
+        # >- 模板基本信息
+        # >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+        # >- 填写控件 Components
+        # >- 签署控件 SignComponents
+        # >- 生成模板的文件基础信息 FileInfos
 
         # @param request: Request instance for DescribeFlowTemplates.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
@@ -1320,8 +1333,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 通过发起转换任务接口（CreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。<br/>
-        # 大文件转换所需的时间可能会比较长。
+        # 查询转换任务的状态。转换任务Id通过发起转换任务接口（CreateConvertTaskApi）获取。
+        # 注意：大文件转换所需的时间可能会比较长。
 
         # @param request: Request instance for GetTaskResultApi.
         # @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest`

data/lib/v20201111/models.rb

@@ -249,15 +249,32 @@ module TencentCloud
       class AutoSignConfig < TencentCloud::Common::AbstractModel
         # @param UserInfo: 自动签开通个人用户的三要素
         # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
-        # @param CallbackUrl: 接受自动签开启的回调地址。需要保证post返回200
+        # @param CallbackUrl: 接受回调URL地址。支持http://或者https://协议
+
+        # Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
         # @type CallbackUrl: String
-        # @param CertInfoCallback: 是否回调证书信息，默认false-不需要
+        # @param CertInfoCallback: 是否回调证书信息
+        # false-不需要 (默认值)
+        # true-需要
         # @type CertInfoCallback: Boolean
-        # @param UserDefineSeal: 是否支持用户自定义签名印章，默认false-不需要
+        # @param UserDefineSeal: 是否支持用户自定义签名印章
+        # false-不需要(默认)
+        # true-需要
         # @type UserDefineSeal: Boolean
-        # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64，默认false-不需要
+        # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
+
+        # false-不需要(默认)
+        # true-需要(
         # @type SealImgCallback: Boolean
-        # @param VerifyChannels: 开通时候的验证方式，取值：WEIXINAPP（微信人脸识别），INSIGHT（慧眼人脸认别），TELECOM（运营商三要素验证）。如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
+        # @param VerifyChannels: 开通时候的验证方式, 分布为
+
+        # WEIXINAPP : 微信人脸识别
+        # INSIGHT : 慧眼人脸认别
+        # TELECOM : 运营商三要素验证
+
+        # 如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。
+
+        # 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
         # @type VerifyChannels: Array
 
         attr_accessor :UserInfo, :CallbackUrl, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :VerifyChannels
@@ -823,7 +840,8 @@ module TencentCloud
       class CreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 调用方用户信息，userId 必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowIds: 需要执行撤回的签署流程id数组，最多100个
+        # @param FlowIds: 需要执行撤回的流程(合同)的编号列表，最多100个.
+        # 列表中的流程(合同)编号不要重复.
         # @type FlowIds: Array
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -854,8 +872,11 @@ module TencentCloud
         # @param BatchCancelFlowUrl: 批量撤回签署流程链接
         # @type BatchCancelFlowUrl: String
         # @param FailMessages: 签署流程撤回失败信息
+        # 数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
         # @type FailMessages: Array
         # @param UrlExpireOn: 签署连接过期时间字符串：年月日-时分秒
+
+        # 例如:2023-07-28 17:25:59
         # @type UrlExpireOn: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -1801,7 +1822,7 @@ module TencentCloud
         # 默认：SignReview；SignReview:签署审核
 
         # 该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程
-        # 若发起个人审核，则指定该字段为：SignReview（注意，给个人审核时，需联系客户经理开白使用）
+        # 若发起个人审核，则指定该字段为：SignReview
         # @type OperateType: String
 
         attr_accessor :Operator, :FlowId, :ReviewType, :ReviewMessage, :Agent, :RecipientId, :OperateType
@@ -1853,7 +1874,9 @@ module TencentCloud
       class CreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
         # @param FlowId: 流程编号
         # @type FlowId: String
-        # @param FlowApproverInfos: 流程签署人，其中ApproverName，ApproverMobile和ApproverType必传，其他可不传，ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。
+        # @param FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，ApproverType目前只支持个人类型的签署人。
+
+        # 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。
         # @type FlowApproverInfos: Array
         # @param Operator: 用户信息，此结构体UserId必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
@@ -2569,7 +2592,10 @@ module TencentCloud
         # @type FlowGroupId: String
         # @param PathType: 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
         # @type PathType: Integer
-        # @param AutoJumpBack: 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
+        # @param AutoJumpBack: 是否自动回跳
+        # true：是，
+        # false：否。
+        # 该参数只针对"APP" 类型的签署链接有效
         # @type AutoJumpBack: Boolean
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -2855,11 +2881,16 @@ module TencentCloud
         # @type SceneKey: String
         # @param AutoSignConfig: 自动签开通，签署相关配置
         # @type AutoSignConfig: :class:`Tencentcloud::Ess.v20201111.models.AutoSignConfig`
-        # @param UrlType: 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+        # @param UrlType: 链接类型，
+        # 空-默认小程序端链接
+        # H5SIGN-h5端链接
         # @type UrlType: String
-        # @param NotifyType: 通知类型，默认不填为不通知开通方，填写 SMS 为短信通知。
+        # @param NotifyType: 通知类型
+
+        # 默认不设置为不通知开通方，
+        # SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
         # @type NotifyType: String
-        # @param NotifyAddress: 若上方填写为 SMS，则此处为手机号
+        # @param NotifyAddress: 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
         # @type NotifyAddress: String
         # @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为30天。如果不传，默认有效期为7天。
         # @type ExpiredTime: Integer
@@ -2910,7 +2941,7 @@ module TencentCloud
         # @type AppOriginalId: String
         # @param Path: 跳转路径
         # @type Path: String
-        # @param QrCode: base64格式跳转二维码
+        # @param QrCode: base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
         # @type QrCode: String
         # @param UrlType: 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
         # @type UrlType: String
@@ -3577,12 +3608,14 @@ module TencentCloud
 
       # DescribeFlowEvidenceReport返回参数结构体
       class DescribeFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
-        # @param ReportUrl: 报告 URL
+        # @param ReportUrl: 出证报告PDF的下载 URL
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReportUrl: String
-        # @param Status: 执行中：EvidenceStatusExecuting
-        # 成功：EvidenceStatusSuccess
-        # 失败：EvidenceStatusFailed
+        # @param Status: 出证任务执行的状态, 分布表示下面的含义
+
+        # EvidenceStatusExecuting  出证任务在执行中
+        # EvidenceStatusSuccess  出证任务执行成功
+        # EvidenceStatusFailed  出征任务执行失败
         # @type Status: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3607,10 +3640,13 @@ module TencentCloud
         # @param Operator: 调用方用户信息，userId 必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param FlowIds: 需要查询的流程ID列表，限制最大100个
+
+        # 如果查询合同组的信息,不要传此参数
         # @type FlowIds: Array
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param FlowGroupId: 合同组ID
+        # @param FlowGroupId: 合同组ID, 如果传此参数会忽略FlowIds入参
+        #  所以如传此参数不要传FlowIds参数
         # @type FlowGroupId: String
 
         attr_accessor :Operator, :FlowIds, :Agent, :FlowGroupId
@@ -3673,19 +3709,27 @@ module TencentCloud
 
       # DescribeFlowTemplates请求参数结构体
       class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 调用方员工/经办人信息
+        # UserId 必填，在企业控制台组织架构中可以查到员工的UserId
+        # 注：请保证对应
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理相关应用信息
+        # 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param ContentType: 查询内容：0-模板列表及详情（默认），1-仅模板列表
+        # @param ContentType: 查询内容类型
+        # 0-模板列表及详情（默认）
+        # 1-仅模板列表
         # @type ContentType: Integer
-        # @param Filters: 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
+        # @param Filters: 搜索条件，本字段用于指定模板Id进行查询。
+        # Key：template-id
+        # Values：需要查询的模板Id列表
         # @type Filters: Array
-        # @param Offset: 查询偏移位置，默认0
+        # @param Offset: 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。
         # @type Offset: Integer
-        # @param Limit: 查询个数，默认20，最大200
+        # @param Limit: 指定每页多少条数据，如果不传默认为20，单页最大200。
         # @type Limit: Integer
-        # @param ApplicationId: ApplicationId不为空，查询指定应用下的模板列表
+        # @param ApplicationId: 用于查询指定应用号下单模板列表。
+        # ApplicationId不为空，查询指定应用下的模板列表
         # ApplicationId为空，查询所有应用下的模板列表
         # @type ApplicationId: String
         # @param IsChannel: 默认为false，查询SaaS模板库列表；
@@ -4285,7 +4329,7 @@ module TencentCloud
         # @param SceneKey: 自动签场景:
         # E_PRESCRIPTION_AUTO_SIGN 电子处方
         # @type SceneKey: String
-        # @param UserInfo: 查询开启状态的用户信息
+        # @param UserInfo: 要查询开启状态的用户信息
         # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -4318,11 +4362,14 @@ module TencentCloud
 
       # DescribeUserAutoSignStatus返回参数结构体
       class DescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
-        # @param IsOpen: 是否已开通自动签
+        # @param IsOpen: 查询用户是否已开通自动签
         # @type IsOpen: Boolean
         # @param LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
+
+        # 值为unix时间戳,单位为秒。
         # @type LicenseFrom: Integer
         # @param LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
+        # 值为unix时间戳,单位为秒。
         # @type LicenseTo: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -4856,7 +4903,9 @@ module TencentCloud
         # @param CreatedOn: 流程创建的时间戳，单位秒
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type CreatedOn: Integer
-        # @param FlowMessage: 拒签或者取消的原因描述
+        # @param FlowMessage: 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
+        # 此字段展示拒签或者取消的原因描述
+
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowMessage: String
         # @param Creator:  合同发起人userId
@@ -5371,7 +5420,7 @@ module TencentCloud
 
       # GetTaskResultApi请求参数结构体
       class GetTaskResultApiRequest < TencentCloud::Common::AbstractModel
-        # @param TaskId: 任务Id，通过CreateConvertTaskApi得到
+        # @param TaskId: 任务Id，通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id
         # @type TaskId: String
         # @param Operator: 操作人信息,UserId必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
@@ -5431,7 +5480,7 @@ module TencentCloud
         # ProcessFailed  - 转换失败
         # ProcessTimeout - 转换文件超时
         # @type TaskMessage: String
-        # @param ResourceId: 资源Id，也是FileId，用于文件发起使用
+        # @param ResourceId: 资源Id，也是FileId，用于文件发起时使用
         # @type ResourceId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -6084,7 +6133,7 @@ module TencentCloud
         # - SIGN_SEAL-默认为印章控件类型
         # - SIGN_SIGNATURE-手写签名控件类型
         # @type ApproverSignComponentType: String
-        # @param ApproverSignRole: 签署方自定义控件别名，最大长度20个字符
+        # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推.  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
         # @type ApproverSignRole: String
 
         attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.622
+  version: 3.0.624
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common