tencentcloud-sdk-ess 3.0.657 → 3.0.659

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37dd475bff07a1197cddcdc7f860704644098a1
-  data.tar.gz: 10c8ea48f302c10cea8931ec57bc6dc22e8f402c
+  metadata.gz: efc4c0633580ab9b74dbd7f13cd53b701ff8ea6f
+  data.tar.gz: 9f433efe62a9562e0bcb92a387f90be00227e524
 SHA512:
-  metadata.gz: 5b2ca2793677ae0c899ee7606c40cc3c1c9fa18966620701be7255746e224e1e75d38ea0a5b7d488959922e8c2dea93bae7a714cfe21a399899e92d22d9d9ef1
-  data.tar.gz: 3e5d78958dbb03b3b428c1ece35c1de3495b7f19e9fc5a2f1f304a7e6d80b556a6d1db81877357558a57a53ebb94e889904ade18ed8f02f0abdc5e178583f22f
+  metadata.gz: 7626bc5059f0a2f9905e7f31d36a76252718c3e4a2f4bdcdfb71ba376286f6f5e3266c011f40a64699ec5b801841270d8443693a1e23adee0ca789e59b18dc1d
+  data.tar.gz: c2825ba3fdd0513c9ba379632138183e793d6a9131cc9217674f500de494691e04221ce23b3383a08fa43018458f7cf944bdb06945d5283668bda785f5ff2b5c

data/lib/VERSION

@@ -1 +1 @@
-3.0.657
+3.0.659

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文件后发起合同
@@ -357,9 +327,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建出证报告并返回报告ID。
-        # 使用此功能需搭配出证套餐。
-        # 注意：出证过程需一定时间，建议在调用创建出证后的24小时之后，通过DescribeFlowEvidenceReport接口进行查询。
+        # 提交申请出证报告任务并返回报告ID。
+
+        # 注意：
+        # <ul><li>使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。</li>
+        # <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
+        # <li>合同流程必须所有参与方`已经签署完成`。</li>
+        # <li>出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
+
+        # <svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
 
         # @param request: Request instance for CreateFlowEvidenceReport.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowEvidenceReportRequest`
@@ -383,9 +359,11 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CreateFlowGroupByFiles）通过多文件创建合同组签署流程。<br/>
-        # PDF资源Id 通过上传文件接口获取
-        # 此接口合同组中的子合同必须都是文件发起的合同
+        # 此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。
+
+        # 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+        # 注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
 
         # @param request: Request instance for CreateFlowGroupByFiles.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesRequest`
@@ -665,8 +643,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`
@@ -916,7 +896,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 用来创建页面主题配置
+        # 用来创建嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），该接口配合其他所有可嵌入页面接口使用
+        # 创建配置对当前企业全局生效，如果多次调用，会以最后一次的配置为准
 
         # @param request: Request instance for CreateWebThemeConfig.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigRequest`
@@ -1144,7 +1125,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询签署报告，返回报告 URL。需调用创建并返回出证报告接口（CreateFlowEvidenceReport）获取报告编号后调用当前接口获取报告链接。
+        # 获取出证报告任务执行结果，返回报告 URL。
+
+
+
+        # 注意：
+        # <ul><li>使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。</li>
+        # <li>需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。</li></ul>
+
+        # <svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
 
         # @param request: Request instance for DescribeFlowEvidenceReport.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest`

data/lib/v20201111/models.rb

@@ -343,7 +343,7 @@ module TencentCloud
         # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
 
         # <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
-        # <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
+        # </ul>
         # @type LicenseType: Integer
 
         attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType
@@ -995,12 +995,14 @@ module TencentCloud
 
       # 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
@@ -1055,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: 需要进行转换的资源文件类型
@@ -1287,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: 生成创建印章的嵌入页面
@@ -1305,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
@@ -1348,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
@@ -1674,14 +1631,14 @@ module TencentCloud
 
       # CreateFlowEvidenceReport返回参数结构体
       class CreateFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
-        # @param ReportId: 出证报告 ID，可用于DescribeFlowEvidenceReport接口查询出证PDF的下载地址
+        # @param ReportId: 出证报告 ID，可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReportId: String
-        # @param Status: 出证任务执行的状态, 可能会有以下状态：
+        # @param Status: 出证任务执行的状态, 状态含义如下：
 
-        # <ul><li>EvidenceStatusExecuting：  出证任务在执行中</li>
-        # <li>EvidenceStatusSuccess：  出证任务执行成功</li>
-        # <li>EvidenceStatusFailed ： 出征任务执行失败</li></ul>
+        # <ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li>
+        # <li>**EvidenceStatusSuccess**：  出证任务执行成功</li>
+        # <li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
         # @type Status: String
         # @param ReportUrl: 此字段已经废除,不再使用.
         # 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
@@ -1712,15 +1669,22 @@ module TencentCloud
 
       # CreateFlowGroupByFiles请求参数结构体
       class CreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId 代发合同
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowGroupName: 合同（流程）组名称,最大长度200个字符
+        # @param FlowGroupName: 合同（流程）组名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
         # @type FlowGroupName: String
         # @param FlowGroupInfos: 合同（流程）组的子合同信息，支持2-50个子合同
         # @type FlowGroupInfos: Array
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param FlowGroupOptions: 合同（流程）组的配置项信息。包括是否通知本企业签署方，是否通知其他签署方
+        # @param FlowGroupOptions: 合同（流程）组的配置项信息。
+        # 其中包括：
+        # <ul>
+        # <li>是否通知本企业签署方</li>
+        # <li>是否通知其他签署方</li>
+        # </ul>
         # @type FlowGroupOptions: :class:`Tencentcloud::Ess.v20201111.models.FlowGroupOptions`
 
         attr_accessor :Operator, :FlowGroupName, :FlowGroupInfos, :Agent, :FlowGroupOptions
@@ -2710,17 +2674,29 @@ 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。
+        # 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。
+        # 用户将利用链接对这些合同实施批量操作。
         # @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位字符串。
+        # 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
+        # UserId必须是传入合同（FlowId）中的签署人。
+        # - 1. 若UserId为空，Name和Mobile 必须提供。
+        # - 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。
         # @type UserId: String
-        # @param Name: 员工姓名，该字段需要与Mobile组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+        # @param Name: 员工姓名，必须与手机号码一起使用。
+        # 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
         # @type Name: String
-        # @param Mobile: 员工手机号码，该字段需要与Name组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+        # @param Mobile: 员工手机号，必须与姓名一起使用。
+        #  如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
         # @type Mobile: String
 
         attr_accessor :Operator, :FlowIds, :Agent, :UserId, :Name, :Mobile
@@ -2752,9 +2728,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
@@ -3665,15 +3641,16 @@ module TencentCloud
 
       # CreateWebThemeConfig请求参数结构体
       class CreateWebThemeConfigRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 操作人信息
+        # @param Operator: 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param ThemeType: 主题类型
-        # <br/>EMBED_WEB_THEME：嵌入式主题
-        # <br/>目前只支持EMBED_WEB_THEME，web页面嵌入的主题风格配置
+        # @param ThemeType: 主题类型，取值如下：
+        # <ul><li> **EMBED_WEB_THEME**：嵌入式主题（默认），web页面嵌入的主题风格配置</li>
+        # </ul>
         # @type ThemeType: String
         # @param WebThemeConfig: 主题配置
         # @type WebThemeConfig: :class:`Tencentcloud::Ess.v20201111.models.WebThemeConfig`
-        # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :ThemeType, :WebThemeConfig, :Agent
@@ -4298,7 +4275,7 @@ module TencentCloud
         # @param Operator: 执行本接口操作的员工信息。
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param ReportId: 签署报告编号
+        # @param ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
         # @type ReportId: String
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -4327,15 +4304,14 @@ module TencentCloud
 
       # DescribeFlowEvidenceReport返回参数结构体
       class DescribeFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
-        # @param ReportUrl: 出证报告PDF的下载 URL
+        # @param ReportUrl: 出证报告PDF的下载 URL，`有效期为5分钟`，超过有效期后将无法再下载。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReportUrl: String
-        # @param Status: 签署报告出证任务的状态
-        # <ul>
-        # <li>EvidenceStatusExecuting : 出证任务在执行中</li>
-        # <li>EvidenceStatusSuccess : 出证任务执行成功</li>
-        # <li>EvidenceStatusFailed : 出证任务执行失败</li>
-        # </ul>
+        # @param Status: 出证任务执行的状态, 状态含义如下：
+
+        # <ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li>
+        # <li>**EvidenceStatusSuccess**：  出证任务执行成功</li>
+        # <li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
         # @type Status: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -5136,8 +5112,7 @@ module TencentCloud
         # @type LicenseTo: Integer
         # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
 
-        # <ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
-        # <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
+        # <ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li></ul>
         # @type LicenseType: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -6054,34 +6029,63 @@ module TencentCloud
 
       # 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
       class FlowGroupInfo < TencentCloud::Common::AbstractModel
-        # @param FlowName: 合同（流程）的名称
+        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+        # 该名称还将用于合同签署完成后的下载文件名。
         # @type FlowName: String
-        # @param Approvers: 合同（流程）的签署方信息
+        # @param Approvers: 签署流程参与者信息，最大限制50方
+        # 注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
         # @type Approvers: Array
-        # @param FileIds: 发起合同（流程）的资源Id,此资源必须是PDF文件,来自UploadFiles,使用文件发起合同(流程)组时必传
+        # @param FileIds: 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
+        # 建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
         # @type FileIds: Array
-        # @param TemplateId: 发起合同（流程）的模板Id,用模板发起合同（流程）组时必填
+        # @param TemplateId: 合同模板ID，为32位字符串。
+        # 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+        # 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
         # @type TemplateId: String
-        # @param FlowType: 合同（流程）的类型
+        # @param FlowType: 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
+        # 示例值：劳务合同
         # @type FlowType: String
-        # @param FlowDescription: 合同（流程）的描述
+        # @param FlowDescription: 签署流程描述,最大长度1000个字符
         # @type FlowDescription: String
-        # @param Deadline: 合同（流程）的截止时间戳，单位秒。默认是一年
+        # @param Deadline: 签署流程的签署截止时间。
+
+        # 值为unix时间戳,精确到秒,不传默认为当前时间一年后
+        # 示例值：1604912664
         # @type Deadline: Integer
         # @param CallbackUrl: 合同（流程）的回调地址
         # @type CallbackUrl: String
-        # @param UserData: 第三方平台传递过来的信息, 限制1024字符 格式必须是base64的
+        # @param UserData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
+        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+        # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
         # @type UserData: String
-        # @param Unordered: 合同（流程）的签署是否是无序签, true - 无序。 false - 有序, 默认
+        # @param Unordered: 发送类型：
+        # true：无序签
+        # false：有序签
+        # 注：默认为false（有序签），请和模板中的配置保持一致
+        # 示例值：true
         # @type Unordered: Boolean
-        # @param Components: 合同（流程）发起方的填写控件, 由发起方进行在发起时进行填充
+        # @param Components: 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
+        # <ul><li>单行文本控件</li>
+        # <li>多行文本控件</li>
+        # <li>勾选框控件</li>
+        # <li>数字控件</li>
+        # <li>图片控件</li>
+        # <li>动态表格等填写控件</li></ul>
         # @type Components: Array
-        # @param NeedSignReview: 本企业（发起方）是否需要签署审批，若需要审批则只允许查看不允许签署，需要您调用接口CreateFlowSignReview提交审批结果。
+        # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
+        # 若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+        # 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+        # 示例值：true
         # @type NeedSignReview: Boolean
-        # @param AutoSignScene: 本企业（发起方）自动签署，需要您在发起合同时给印章控件指定自动签的印章。
+        # @param AutoSignScene: 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+        # 示例值：E_PRESCRIPTION_AUTO_SIGN
         # @type AutoSignScene: String
 
         attr_accessor :FlowName, :Approvers, :FileIds, :TemplateId, :FlowType, :FlowDescription, :Deadline, :CallbackUrl, :UserData, :Unordered, :Components, :NeedSignReview, :AutoSignScene
+        extend Gem::Deprecate
+        deprecate :CallbackUrl, :none, 2023, 9
+        deprecate :CallbackUrl=, :none, 2023, 9
 
         def initialize(flowname=nil, approvers=nil, fileids=nil, templateid=nil, flowtype=nil, flowdescription=nil, deadline=nil, callbackurl=nil, userdata=nil, unordered=nil, components=nil, needsignreview=nil, autosignscene=nil)
           @FlowName = flowname
@@ -6132,16 +6136,18 @@ module TencentCloud
 
       # 此结构体(FlowGroupOptions)描述的是合同组的个性化配置，支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证（仅在合同组文件发起配置时生效）
       class FlowGroupOptions < TencentCloud::Common::AbstractModel
-        # @param ApproverVerifyType: 发起合同（流程）组的合同（流程）签署人校验方式
-        # VerifyCheck: 人脸识别（默认）
-        # MobileCheck：手机号验证
+        # @param ApproverVerifyType: 签署人校验方式,支持以下类型
+        # <ul><li>VerifyCheck : 人脸识别 (默认值)</li>
+        # <li>MobileCheck : 手机号验证</li></ul>
         # 参数说明：此参数仅在合同组文件发起有效，可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
         # @type ApproverVerifyType: String
         # @param SelfOrganizationApproverNotifyType: 发起合同（流程）组本方企业经办人通知方式
-        # 签署通知类型：sms--短信，none--不通知
+        # 签署通知类型，支持以下类型
+        # <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
         # @type SelfOrganizationApproverNotifyType: String
         # @param OtherApproverNotifyType: 发起合同（流程）组他方经办人通知方式
-        # 签署通知类型：sms--短信，none--不通知
+        # 签署通知类型，支持以下类型
+        # <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
         # @type OtherApproverNotifyType: String
 
         attr_accessor :ApproverVerifyType, :SelfOrganizationApproverNotifyType, :OtherApproverNotifyType
@@ -8294,13 +8300,13 @@ 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)
+        # @param WebEmbedThemeColor: 主题颜色：
+        # 支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
+        # <br/>
         # @type WebEmbedThemeColor: String
 
         attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor

metadata

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