tencentcloud-sdk-ess 3.0.656 → 3.0.658

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f9b6ac1e67e0e1ff834c6f218d0caac5ec68d6d
-  data.tar.gz: fa6f05f00450a8405c3f924b7a5c6f5f0c085e14
+  metadata.gz: d082f169231143a032c3fc356d0d7a645eb6f0a5
+  data.tar.gz: 323b167fd95e76dde617be89ca4eaa6d075f675d
 SHA512:
-  metadata.gz: e90c630b3276311411c515dbe63a214dcc86a7cf504dd5797a87dee3179d092f39a39bf8bbcae880b93488bdc7681a14265bda45b479b7efa6e0de9ed619a3ba
-  data.tar.gz: 447ff4c821bba7e132091114a224e8c5da05e1aa0bbf728eee657e134af20d2ca0729c293a7a0e950ae92a8224471452c5ce94cfc47725347add3d0e15523509
+  metadata.gz: 7268ec91991184f29b9ffcaf9e4b072c32df22765ab3ee4eb390567a60b925946f736fb5e05d666471d28fb9cecc023988e728910c3aecf638c8429a16c32415
+  data.tar.gz: 1c09c28a79a3d8e7913ec1d8571c58c4022a1262685c6f92fe570d1d1070b7278ae467780ebea33852068d1a43137bcb3f36d19d0550615bae6fd5fc89142fa7

data/lib/VERSION

@@ -1 +1 @@
-3.0.656
+3.0.658

data/lib/v20201111/client.rb

@@ -159,36 +159,6 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 根据产品要求，调整接口目录
-
-        # 新接口：ChannelCreateOrganizationModifyQrCode
-
-        # 老接口目前无线上流量，测试用例已下线处理
-
-        # 生成子客编辑企业信息二维码
-
-        # @param request: Request instance for CreateChannelSubOrganizationModifyQrCode.
-        # @type request: :class:`Tencentcloud::ess::V20201111::CreateChannelSubOrganizationModifyQrCodeRequest`
-        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateChannelSubOrganizationModifyQrCodeResponse`
-        def CreateChannelSubOrganizationModifyQrCode(request)
-          body = send_request('CreateChannelSubOrganizationModifyQrCode', request.serialize)
-          response = JSON.parse(body)
-          if response['Response'].key?('Error') == false
-            model = CreateChannelSubOrganizationModifyQrCodeResponse.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
-
         # 此接口（CreateConvertTaskApi）用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
         # 前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
         # 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
@@ -496,7 +466,8 @@ module TencentCloud
         # `注意：`<br/>
         # `1. 该接口目前仅支持签署人类型是个人签署方的场景（PERSON）。` <br/>
         # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
-        # `3. 该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
+        # `3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接 。` <br/>
+        # `4. 该接口返回的签署链接是用于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 CreateFlowSignUrl.
@@ -664,8 +635,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 通过此接口，创建企业批量签署链接，企业员工点击链接即可跳转控制台进行批量签署。
-        # 如果没有UserId，Name和Mobile必填，对应的员工必须在企业下已经实名，且该员工为批量签署合同中的签署方。
+        # 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。</br>
+        # 附注：
+        # - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。
+        # - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
 
         # @param request: Request instance for CreateOrganizationBatchSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateOrganizationBatchSignUrlRequest`
@@ -689,7 +662,13 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口（CreatePersonAuthCertificateImage）用于创建个人用户证书证明图片
+        # 获取个人用户认证证书图片下载URL
+
+        # 个人用户认证证书图片样式如下图
+
+        # ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
+
+        # 注:  `只能获取个人用户证明图片, 企业员工的暂不支持`
 
         # @param request: Request instance for CreatePersonAuthCertificateImage.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
@@ -763,14 +742,16 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 发起解除协议，主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
+        # 发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。
+        # 解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。
 
-        # `注意：原合同必须签署完成后，才能发起解除协议。` <br/>
-        # `注意：只有原合同企业类型的参与人才能发起解除协议，个人不能发起解除协议。`<br/>
-        # `注意：原合同个人类型参与人必须是解除协议的参与人，不能更换其他第三方个人参与解除协议。`<br/>
-        # `注意：如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的企业员工代为处理。`<br/>
-        # `注意：发起解除协议同发起其他企业合同一样，也会参与合同扣费，扣费标准同其他类型合同。`<br/>
-        # `注意：在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均会转变为已解除状态。`<br/>
+        # 注意：
+        # <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
+        # <li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>
+        # <li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>
+        # <li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
+        # <li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>
+        # <li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>
 
         # @param request: Request instance for CreateReleaseFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest`
@@ -1086,7 +1067,8 @@ module TencentCloud
 
         # 查询流程基础信息
         # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
-        # 每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误
+
+        # 注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
 
         # @param request: Request instance for DescribeFlowBriefs.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -1366,7 +1348,14 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 通过AuthCode查询用户是否实名
+        # 通过AuthCode查询个人用户是否实名
+
+
+        # 注意:
+        # <ul>
+        # <li>此接口为合作引流场景使用，使用`有白名单限制`，使用前请联系对接的客户经理沟通。</li>
+        # <li>`AuthCode 只能使用一次`，查询一次再次查询会返回错误</li>
+        # </ul>
 
         # @param request: Request instance for DescribeThirdPartyAuthCode.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeThirdPartyAuthCodeRequest`

data/lib/v20201111/models.rb

@@ -173,10 +173,14 @@ module TencentCloud
 
         # 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
         # @type ApproverNeedSignReview: Boolean
+        # @param AddSignComponentsLimits: [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。
 
-        attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview
+        # 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
+        # @type AddSignComponentsLimits: Array
 
-        def initialize(approvertype=nil, approvername=nil, approvermobile=nil, organizationname=nil, signcomponents=nil, approveridcardtype=nil, approveridcardnumber=nil, notifytype=nil, approverrole=nil, verifychannel=nil, prereadtime=nil, userid=nil, approversource=nil, customapprovertag=nil, approveroption=nil, approververifytypes=nil, approversigntypes=nil, approverneedsignreview=nil)
+        attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview, :AddSignComponentsLimits
+
+        def initialize(approvertype=nil, approvername=nil, approvermobile=nil, organizationname=nil, signcomponents=nil, approveridcardtype=nil, approveridcardnumber=nil, notifytype=nil, approverrole=nil, verifychannel=nil, prereadtime=nil, userid=nil, approversource=nil, customapprovertag=nil, approveroption=nil, approververifytypes=nil, approversigntypes=nil, approverneedsignreview=nil, addsigncomponentslimits=nil)
           @ApproverType = approvertype
           @ApproverName = approvername
           @ApproverMobile = approvermobile
@@ -195,6 +199,7 @@ module TencentCloud
           @ApproverVerifyTypes = approververifytypes
           @ApproverSignTypes = approversigntypes
           @ApproverNeedSignReview = approverneedsignreview
+          @AddSignComponentsLimits = addsigncomponentslimits
         end
 
         def deserialize(params)
@@ -226,6 +231,14 @@ module TencentCloud
           @ApproverVerifyTypes = params['ApproverVerifyTypes']
           @ApproverSignTypes = params['ApproverSignTypes']
           @ApproverNeedSignReview = params['ApproverNeedSignReview']
+          unless params['AddSignComponentsLimits'].nil?
+            @AddSignComponentsLimits = []
+            params['AddSignComponentsLimits'].each do |i|
+              componentlimit_tmp = ComponentLimit.new
+              componentlimit_tmp.deserialize(i)
+              @AddSignComponentsLimits << componentlimit_tmp
+            end
+          end
         end
       end
 
@@ -945,14 +958,51 @@ module TencentCloud
         end
       end
 
+      # 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
+      class ComponentLimit < TencentCloud::Common::AbstractModel
+        # @param ComponentType: 控件类型，支持以下类型
+        # <ul><li>SIGN_SEAL : 印章控件</li>
+        # <li>SIGN_PAGING_SEAL : 骑缝章控件</li>
+        # <li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
+        # <li>SIGN_SIGNATURE : 用户签名控件</li></ul>
+        # @type ComponentType: String
+        # @param ComponentValue: 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
+
+        # 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）
+
+        # 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
+
+        # <ul><li>HANDWRITE : 手写签名</li>
+        # <li>OCR_ESIGN : OCR印章（智慧手写签名）</li>
+        # <li>ESIGN : 个人印章</li>
+        # <li>SYSTEM_ESIGN : 系统印章</li></ul>
+
+        # 3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
+        # @type ComponentValue: Array
+
+        attr_accessor :ComponentType, :ComponentValue
+
+        def initialize(componenttype=nil, componentvalue=nil)
+          @ComponentType = componenttype
+          @ComponentValue = componentvalue
+        end
+
+        def deserialize(params)
+          @ComponentType = params['ComponentType']
+          @ComponentValue = params['ComponentValue']
+        end
+      end
+
       # CreateBatchCancelFlowUrl请求参数结构体
       class CreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param FlowIds: 需要执行撤回的流程(合同)的编号列表，最多100个.
-        # 列表中的流程(合同)编号不要重复.
+        # <br>列表中的流程(合同)编号不要重复.
         # @type FlowIds: Array
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :FlowIds, :Agent
@@ -1007,53 +1057,6 @@ module TencentCloud
         end
       end
 
-      # CreateChannelSubOrganizationModifyQrCode请求参数结构体
-      class CreateChannelSubOrganizationModifyQrCodeRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 操作人信息，userId必填
-        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param ApplicationId: 应用编号
-        # @type ApplicationId: String
-
-        attr_accessor :Operator, :ApplicationId
-
-        def initialize(operator=nil, applicationid=nil)
-          @Operator = operator
-          @ApplicationId = applicationid
-        end
-
-        def deserialize(params)
-          unless params['Operator'].nil?
-            @Operator = UserInfo.new
-            @Operator.deserialize(params['Operator'])
-          end
-          @ApplicationId = params['ApplicationId']
-        end
-      end
-
-      # CreateChannelSubOrganizationModifyQrCode返回参数结构体
-      class CreateChannelSubOrganizationModifyQrCodeResponse < TencentCloud::Common::AbstractModel
-        # @param QrCodeUrl: 二维码下载链接
-        # @type QrCodeUrl: String
-        # @param ExpiredTime: 二维码失效时间 UNIX 时间戳 精确到秒
-        # @type ExpiredTime: Integer
-        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-        # @type RequestId: String
-
-        attr_accessor :QrCodeUrl, :ExpiredTime, :RequestId
-
-        def initialize(qrcodeurl=nil, expiredtime=nil, requestid=nil)
-          @QrCodeUrl = qrcodeurl
-          @ExpiredTime = expiredtime
-          @RequestId = requestid
-        end
-
-        def deserialize(params)
-          @QrCodeUrl = params['QrCodeUrl']
-          @ExpiredTime = params['ExpiredTime']
-          @RequestId = params['RequestId']
-        end
-      end
-
       # CreateConvertTaskApi请求参数结构体
       class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
         # @param ResourceType: 需要进行转换的资源文件类型
@@ -1239,7 +1242,8 @@ module TencentCloud
 
       # CreateEmbedWebUrl请求参数结构体
       class CreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 操作者信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param EmbedType: WEB嵌入资源类型。
         # <br/>CREATE_SEAL: 生成创建印章的嵌入页面
@@ -1257,11 +1261,12 @@ module TencentCloud
         # <br/>MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
         # <br/>PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
         # @type BusinessId: String
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作
+        # @param Agent: 代理企业和员工的信息。
+        # <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
         # @param Reviewer: 抄送方信息
         # @type Reviewer: :class:`Tencentcloud::Ess.v20201111.models.ReviewerInfo`
-        # @param Option: 个性化参数
+        # @param Option: 个性化参数，用于控制页面展示内容
         # @type Option: :class:`Tencentcloud::Ess.v20201111.models.EmbedUrlOption`
 
         attr_accessor :Operator, :EmbedType, :BusinessId, :Agent, :Reviewer, :Option
@@ -1300,7 +1305,7 @@ module TencentCloud
       # CreateEmbedWebUrl返回参数结构体
       class CreateEmbedWebUrlResponse < TencentCloud::Common::AbstractModel
         # @param WebUrl: 嵌入的web链接，有效期：5分钟
-        # EmbedType=PREVIEW_CC_FLOW，该url为h5链接
+        # <br/>EmbedType=PREVIEW_CC_FLOW，该url为h5链接
         # @type WebUrl: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -2662,17 +2667,27 @@ module TencentCloud
 
       # CreateOrganizationBatchSignUrl请求参数结构体
       class CreateOrganizationBatchSignUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，UserId 必填，支持填入集团子公司经办人UserId。
+        # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+        # 支持填入集团子公司经办人 userId 代发合同。
+
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowIds: 指定需要进行批量签署的流程id，数量1-100，填写后用户将通过链接对这些合同进行批量签署。
+        # @param FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。</br>
+        # 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。</br>
+        # 用户将利用链接对这些合同实施批量操作。
         # @type FlowIds: Array
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param UserId: 员工的UserId，该UserId对应的员工必须已经加入企业并实名，Name和Mobile为空时该字段不能为空。（优先使用UserId对应的员工）
+        # @param UserId: 员工在腾讯电子签平台的独特身份标识，为32位字符串。</br>
+        # 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。</br>
+        # UserId必须是传入合同（FlowId）中的签署人。
+        # - 1. 若UserId为空，Name和Mobile 必须提供。
+        # - 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。
         # @type UserId: String
-        # @param Name: 员工姓名，该字段需要与Mobile组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+        # @param Name: 员工姓名，必须与手机号码一起使用。</br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
         # @type Name: String
-        # @param Mobile: 员工手机号码，该字段需要与Name组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+        # @param Mobile: 员工手机号，必须与姓名一起使用。</br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
         # @type Mobile: String
 
         attr_accessor :Operator, :FlowIds, :Agent, :UserId, :Name, :Mobile
@@ -2704,9 +2719,9 @@ module TencentCloud
 
       # CreateOrganizationBatchSignUrl返回参数结构体
       class CreateOrganizationBatchSignUrlResponse < TencentCloud::Common::AbstractModel
-        # @param SignUrl: 批量签署入口链接
+        # @param SignUrl: 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
         # @type SignUrl: String
-        # @param ExpiredTime: 链接过期时间戳
+        # @param ExpiredTime: 链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
         # @type ExpiredTime: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -2728,20 +2743,25 @@ module TencentCloud
 
       # CreatePersonAuthCertificateImage请求参数结构体
       class CreatePersonAuthCertificateImageRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 操作人信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param UserName: 个人用户名称
         # @type UserName: String
-        # @param IdCardType: 身份证件类型取值：
-        # ID_CARD 身居民身份证
-        # PASSPORT 护照
-        # HONGKONG_AND_MACAO 港澳居民来往内地通行证
-        # FOREIGN_ID_CARD 外国人永久居留身份证
-        # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+        # @param IdCardType: 证件类型，支持以下类型
+        # <ul><li> ID_CARD  : 居民身份证 (默认值)</li>
+        # <li> PASSPORT  : 护照</li>
+        # <li> FOREIGN_ID_CARD  : 外国人永久居留身份证</li>
+        # <li> HONGKONG_AND_MACAO  : 港澳居民来往内地通行证</li>
+        # <li> HONGKONG_MACAO_AND_TAIWAN  : 港澳台居民居住证(格式同居民身份证)</li></ul>
         # @type IdCardType: String
-        # @param IdCardNumber: 身份证件号码
+        # @param IdCardNumber: 证件号码，应符合以下规则
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
-        # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :UserName, :IdCardType, :IdCardNumber, :Agent
@@ -2771,18 +2791,25 @@ module TencentCloud
 
       # CreatePersonAuthCertificateImage返回参数结构体
       class CreatePersonAuthCertificateImageResponse < TencentCloud::Common::AbstractModel
-        # @param AuthCertUrl: 个人用户证明证书的下载链接
+        # @param AuthCertUrl: 个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。
         # @type AuthCertUrl: String
-        # @param ImageCertId: 证书图片上的证书编号，20位数字
+        # @param ImageCertId: 个人用户认证证书的编号, 为20位数字组成的字符串,  由腾讯电子签下发此编号 。
+        # 该编号会合成到个人用户证书证明图片。
+
+        # 注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ImageCertId: String
-        # @param SerialNumber: 图片证明对应的CA证书序列号
+        # @param SerialNumber: CA供应商下发给用户的证书编号，在证书到期后自动续期后此证书编号会发生变动，且不会合成到个人用户证书证明图片中。
+
+        # 注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下。`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SerialNumber: String
-        # @param ValidFrom: CA证书颁发时间戳
+        # @param ValidFrom: CA证书颁发时间，格式为Unix标准时间戳（秒）
+        # 该时间格式化后会合成到个人用户证书证明图片
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ValidFrom: Integer
-        # @param ValidTo: CA证书有效截止时间戳
+        # @param ValidTo: CA证书有效截止时间，格式为Unix标准时间戳（秒）
+        # 该时间格式化后会合成到个人用户证书证明图片
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ValidTo: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3072,16 +3099,16 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param NeedRelievedFlowId: 待解除的签署流程编号（即原签署流程的编号）。
         # @type NeedRelievedFlowId: String
-        # @param ReliveInfo: 解除协议内容。
+        # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
         # @type ReliveInfo: :class:`Tencentcloud::Ess.v20201111.models.RelieveInfo`
         # @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/>
+        # @param ReleasedApprovers: 替换解除协议的签署人， 如不指定替换签署人,  则使用原流程的签署人。 <br/>
+        # 如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
 
-        # `注意：只能更换同企业的签署人。`<br/>
-        # `注意：不支持更换个人类型的签署人。`<br/>
+        # 注意：
+        # `只能更换自己企业的签署人,  不支持更换个人类型或者其他企业的签署人。`
+        # `可以不指定替换签署人, 使用原流程的签署人 `
         # @type ReleasedApprovers: Array
         # @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
         # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
@@ -4114,11 +4141,16 @@ module TencentCloud
 
       # DescribeFlowBriefs请求参数结构体
       class DescribeFlowBriefsRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowIds: 需要查询的流程ID列表，限制最大100个
+        # @param FlowIds: 查询的合同流程ID列表最多支持100个流程ID。
+        # 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
+
+        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         # @type FlowIds: Array
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :FlowIds, :Agent
@@ -4144,7 +4176,8 @@ module TencentCloud
 
       # DescribeFlowBriefs返回参数结构体
       class DescribeFlowBriefsResponse < TencentCloud::Common::AbstractModel
-        # @param FlowBriefs: 流程列表
+        # @param FlowBriefs: 合同流程基础信息列表，包含流程的名称、状态、创建日期等基本信息。
+        # 注：`与入参 FlowIds 的顺序可能存在不一致的情况。`
         # @type FlowBriefs: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -4552,7 +4585,9 @@ module TencentCloud
         # @type Limit: Integer
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param Filters: 查询过滤实名用户，Key为Status，Values为["IsVerified"]
+        # @param Filters: 查询过滤实名用户，Key为Status，Values为["IsVerified"]，查询过滤未实名用户，Key为Status，Values为["NotVerified"]
+        # 查询某个部门的用户，Key为DepartmentId，Values为["DepartmentId"]
+        # 根据用户Id查询员工时，Key为UserId，Values为["UserId"]
         # 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
         # @type Filters: Array
         # @param Offset: 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大20000
@@ -4959,11 +4994,13 @@ module TencentCloud
 
       # DescribeThirdPartyAuthCode请求参数结构体
       class DescribeThirdPartyAuthCodeRequest < TencentCloud::Common::AbstractModel
-        # @param AuthCode: 电子签小程序跳转客户小程序时携带的授权查看码
+        # @param AuthCode: 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。
         # @type AuthCode: String
-        # @param Operator: 操作人信息
+        # @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`
 
         attr_accessor :AuthCode, :Operator, :Agent
@@ -4989,7 +5026,10 @@ module TencentCloud
 
       # DescribeThirdPartyAuthCode返回参数结构体
       class DescribeThirdPartyAuthCodeResponse < TencentCloud::Common::AbstractModel
-        # @param VerifyStatus: 用户是否实名，VERIFIED 为实名，UNVERIFIED 未实名
+        # @param VerifyStatus: AuthCode 中对应个人用户是否实名
+        # <ul>
+        # <li> **VERIFIED** : 此个人已实名</li>
+        # <li> **UNVERIFIED**: 此个人未实名</li></ul>
         # @type VerifyStatus: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -7230,7 +7270,9 @@ module TencentCloud
         # <ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
         # <li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
         # @type ApproverSignComponentType: String
-        # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字。
+        # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
+
+        # 如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
         # @type ApproverSignRole: String
 
         attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole
@@ -7256,15 +7298,15 @@ module TencentCloud
 
       # 解除协议文档中内容信息，包括但不限于：解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
       class RelieveInfo < TencentCloud::Common::AbstractModel
-        # @param Reason: 解除理由，最大支持200个字
+        # @param Reason: 解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
         # @type Reason: String
-        # @param RemainInForceItem: 解除后仍然有效的条款，保留条款，最大支持200个字
+        # @param RemainInForceItem: 解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
         # @type RemainInForceItem: String
-        # @param OriginalExpenseSettlement: 原合同事项处理-费用结算，最大支持200个字
+        # @param OriginalExpenseSettlement: 原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
         # @type OriginalExpenseSettlement: String
-        # @param OriginalOtherSettlement: 原合同事项处理-其他事项，最大支持200个字
+        # @param OriginalOtherSettlement: 原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
         # @type OriginalOtherSettlement: String
-        # @param OtherDeals: 其他约定，最大支持200个字
+        # @param OtherDeals: 其他约定，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
         # @type OtherDeals: String
 
         attr_accessor :Reason, :RemainInForceItem, :OriginalExpenseSettlement, :OriginalOtherSettlement, :OtherDeals
@@ -8219,10 +8261,11 @@ module TencentCloud
 
       # 页面主题配置
       class WebThemeConfig < TencentCloud::Common::AbstractModel
-        # @param DisplaySignBrandLogo: 是否页面底部显示电子签logo
-        # <br/>true：允许在页面底部隐藏电子签logo
-        # <br/>false：不允许允许在页面底部隐藏电子签logo
-        # <br/>默认false，不隐藏logo
+        # @param DisplaySignBrandLogo: 是否显示页面底部电子签logo，取值如下：
+        # <ul>
+        # <li> **true**：页面底部显示电子签logo</li>
+        # <li> **false**：页面底部不显示电子签logo（默认）</li>
+        # </ul>
         # @type DisplaySignBrandLogo: Boolean
         # @param WebEmbedThemeColor: 主题颜色
         # <br/>支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.656
+  version: 3.0.658
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common