tencentcloud-sdk-ess 3.0.657 → 3.0.658

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37dd475bff07a1197cddcdc7f860704644098a1
-  data.tar.gz: 10c8ea48f302c10cea8931ec57bc6dc22e8f402c
+  metadata.gz: d082f169231143a032c3fc356d0d7a645eb6f0a5
+  data.tar.gz: 323b167fd95e76dde617be89ca4eaa6d075f675d
 SHA512:
-  metadata.gz: 5b2ca2793677ae0c899ee7606c40cc3c1c9fa18966620701be7255746e224e1e75d38ea0a5b7d488959922e8c2dea93bae7a714cfe21a399899e92d22d9d9ef1
-  data.tar.gz: 3e5d78958dbb03b3b428c1ece35c1de3495b7f19e9fc5a2f1f304a7e6d80b556a6d1db81877357558a57a53ebb94e889904ade18ed8f02f0abdc5e178583f22f
+  metadata.gz: 7268ec91991184f29b9ffcaf9e4b072c32df22765ab3ee4eb390567a60b925946f736fb5e05d666471d28fb9cecc023988e728910c3aecf638c8429a16c32415
+  data.tar.gz: 1c09c28a79a3d8e7913ec1d8571c58c4022a1262685c6f92fe570d1d1070b7278ae467780ebea33852068d1a43137bcb3f36d19d0550615bae6fd5fc89142fa7

data/lib/VERSION

@@ -1 +1 @@
-3.0.657
+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文件后发起合同
@@ -665,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`

data/lib/v20201111/models.rb

@@ -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
@@ -2710,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
@@ -2752,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
@@ -8294,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.657
+  version: 3.0.658
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common