tencentcloud-sdk-essbasic 1.0.225 → 1.0.229

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 756982db6361aa680200a5e95824ab459d01dbda
-  data.tar.gz: 17514e2f1cbb01fc7adde8de7b7f51e17292d5d8
+  metadata.gz: e6fcddff21db989ec2e98e24c5e65c07236a42d9
+  data.tar.gz: 264acf3091feb13dd667560eabf2a071ed30a318
 SHA512:
-  metadata.gz: 540f7add0bb2155cca70de0e0332718c509992a9d1acd828105ba222da3dc5d210695f55fd236aa579db9e0858d31a1904a35c57e59d02c5d089426095ce5693
-  data.tar.gz: ec3e849216a11bd5b9254f957ad773c920349aace391ee2640281b3375b4370bf3c93f12523a4661ac2051755ba5a17d0c208bac099fc983e054bf7946677117
+  metadata.gz: a4ba485c3df2b49f2a2200b9fda92f525d9e5ff43bcb27a988d54aec348f437f991b135620ae44a4a21869f9c56255fb975fa17743af5a50343fd28d5eccd7a9
+  data.tar.gz: e4f934c24eec240aabe03f81e9d02ed596b2d05958dce0327db4c0efb8483875edd4e3966599b9332d68fa7b94f7acdbc8313f6df1c0383492fad8cc202eb05e

data/lib/VERSION

@@ -1 +1 @@
-1.0.225
+1.0.229

data/lib/v20210526/client.rb

@@ -174,6 +174,67 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 此接口（GetDownloadFlowUrl）用于创建电子签批量下载确认页面链接，支持客户合同（流程）归类打包下载。
+
+        # @param request: Request instance for GetDownloadFlowUrl.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::GetDownloadFlowUrlRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::GetDownloadFlowUrlResponse`
+        def GetDownloadFlowUrl(request)
+          body = send_request('GetDownloadFlowUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = GetDownloadFlowUrlResponse.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
+
+        # 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的指定.
+        # 1、同步标识=select时：
+        # 输入规则：“可见标识”、“指定合作企业列表”为空。
+        # 处理规则：返回指定模版的可见标识、指定合作企业列表。
+        # 2、同步标识=update时：
+        # 输入规则：“可见标识”、“指定合作企业列表”非必填输入。
+        # 处理规则：
+        # 若“可见标识”=空，不做处理，返回当前的可见标识。
+        # 若“可见标识”=所有合作企业，不取“指定合作企业列表”的值处理。
+        # 若“可见标识”=指定合作企业，取“指定合作企业列表”的值进行更新/插入。
+        # 3、同步标识=delete时：
+        # 输入规则：“可见标识”、“指定合作企业列表”非必填输入。
+        # 处理规则：
+        # 仅取“指定合作企业列表”的值进行删除处理，为空时不做处。
+
+        # @param request: Request instance for OperateChannelTemplate.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::OperateChannelTemplateRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::OperateChannelTemplateResponse`
+        def OperateChannelTemplate(request)
+          body = send_request('OperateChannelTemplate', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = OperateChannelTemplateResponse.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
+
         # 该接口 (PrepareFlows) 用于创建待发起文件
 
         # @param request: Request instance for PrepareFlows.

data/lib/v20210526/models.rb

@@ -52,6 +52,42 @@ module TencentCloud
         end
       end
 
+      # 授权出错信息
+      class AuthFailMessage < TencentCloud::Common::AbstractModel
+        # @param ProxyOrganizationOpenId: 合作企业Id
+        # @type ProxyOrganizationOpenId: String
+        # @param Message: 出错信息
+        # @type Message: String
+
+        attr_accessor :ProxyOrganizationOpenId, :Message
+        
+        def initialize(proxyorganizationopenid=nil, message=nil)
+          @ProxyOrganizationOpenId = proxyorganizationopenid
+          @Message = message
+        end
+
+        def deserialize(params)
+          @ProxyOrganizationOpenId = params['ProxyOrganizationOpenId']
+          @Message = params['Message']
+        end
+      end
+
+      # 抄送信息
+      class CcInfo < TencentCloud::Common::AbstractModel
+        # @param Mobile: 被抄送人手机号
+        # @type Mobile: String
+
+        attr_accessor :Mobile
+        
+        def initialize(mobile=nil)
+          @Mobile = mobile
+        end
+
+        def deserialize(params)
+          @Mobile = params['Mobile']
+        end
+      end
+
       # 此结构体 (Component) 用于描述控件属性。
       class Component < TencentCloud::Common::AbstractModel
         # @param ComponentId: 控件编号
@@ -564,6 +600,26 @@ module TencentCloud
         end
       end
 
+      # 合同（流程）下载信息
+      class DownloadFlowInfo < TencentCloud::Common::AbstractModel
+        # @param FileName: 文件夹名称
+        # @type FileName: String
+        # @param FlowIdList: 合同（流程）的标识数组
+        # @type FlowIdList: Array
+
+        attr_accessor :FileName, :FlowIdList
+        
+        def initialize(filename=nil, flowidlist=nil)
+          @FileName = filename
+          @FlowIdList = flowidlist
+        end
+
+        def deserialize(params)
+          @FileName = params['FileName']
+          @FlowIdList = params['FlowIdList']
+        end
+      end
+
       # 创建流程签署人入参
       class FlowApproverInfo < TencentCloud::Common::AbstractModel
         # @param Name: 签署人姓名
@@ -582,10 +638,12 @@ module TencentCloud
         # @type ApproverType: String
         # @param OpenId: 用户侧第三方id
         # @type OpenId: String
+        # @param PreReadTime: 合同的强制预览时间：3~300s，未指定则按合同页数计算
+        # @type PreReadTime: Integer
 
-        attr_accessor :Name, :Mobile, :IdCardNumber, :JumpUrl, :Deadline, :CallbackUrl, :ApproverType, :OpenId
+        attr_accessor :Name, :Mobile, :IdCardNumber, :JumpUrl, :Deadline, :CallbackUrl, :ApproverType, :OpenId, :PreReadTime
         
-        def initialize(name=nil, mobile=nil, idcardnumber=nil, jumpurl=nil, deadline=nil, callbackurl=nil, approvertype=nil, openid=nil)
+        def initialize(name=nil, mobile=nil, idcardnumber=nil, jumpurl=nil, deadline=nil, callbackurl=nil, approvertype=nil, openid=nil, prereadtime=nil)
           @Name = name
           @Mobile = mobile
           @IdCardNumber = idcardnumber
@@ -594,6 +652,7 @@ module TencentCloud
           @CallbackUrl = callbackurl
           @ApproverType = approvertype
           @OpenId = openid
+          @PreReadTime = prereadtime
         end
 
         def deserialize(params)
@@ -605,6 +664,7 @@ module TencentCloud
           @CallbackUrl = params['CallbackUrl']
           @ApproverType = params['ApproverType']
           @OpenId = params['OpenId']
+          @PreReadTime = params['PreReadTime']
         end
       end
 
@@ -632,10 +692,12 @@ module TencentCloud
         # @type FlowDescription: String
         # @param CustomerData: 渠道的业务信息，限制1024字符
         # @type CustomerData: String
+        # @param CcInfos: 被抄送人的信息列表
+        # @type CcInfos: Array
 
-        attr_accessor :FlowName, :Deadline, :TemplateId, :FlowType, :CallbackUrl, :FlowApprovers, :FormFields, :FlowDescription, :CustomerData
+        attr_accessor :FlowName, :Deadline, :TemplateId, :FlowType, :CallbackUrl, :FlowApprovers, :FormFields, :FlowDescription, :CustomerData, :CcInfos
         
-        def initialize(flowname=nil, deadline=nil, templateid=nil, flowtype=nil, callbackurl=nil, flowapprovers=nil, formfields=nil, flowdescription=nil, customerdata=nil)
+        def initialize(flowname=nil, deadline=nil, templateid=nil, flowtype=nil, callbackurl=nil, flowapprovers=nil, formfields=nil, flowdescription=nil, customerdata=nil, ccinfos=nil)
           @FlowName = flowname
           @Deadline = deadline
           @TemplateId = templateid
@@ -645,6 +707,7 @@ module TencentCloud
           @FormFields = formfields
           @FlowDescription = flowdescription
           @CustomerData = customerdata
+          @CcInfos = ccinfos
         end
 
         def deserialize(params)
@@ -671,6 +734,14 @@ module TencentCloud
           end
           @FlowDescription = params['FlowDescription']
           @CustomerData = params['CustomerData']
+          unless params['CcInfos'].nil?
+            @CcInfos = []
+            params['CcInfos'].each do |i|
+              ccinfo_tmp = CcInfo.new
+              ccinfo_tmp.deserialize(i)
+              @CcInfos << ccinfo_tmp
+            end
+          end
         end
       end
 
@@ -729,6 +800,159 @@ module TencentCloud
         end
       end
 
+      # GetDownloadFlowUrl请求参数结构体
+      class GetDownloadFlowUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 应用信息
+        # 此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param Operator: 操作者的信息
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param DownLoadFlows: 文件夹数组，合同（流程）总数不能超过50个，一个文件夹下，不能超过20个合同（流程），
+        # @type DownLoadFlows: Array
+
+        attr_accessor :Agent, :Operator, :DownLoadFlows
+        
+        def initialize(agent=nil, operator=nil, downloadflows=nil)
+          @Agent = agent
+          @Operator = operator
+          @DownLoadFlows = downloadflows
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          unless params['DownLoadFlows'].nil?
+            @DownLoadFlows = []
+            params['DownLoadFlows'].each do |i|
+              downloadflowinfo_tmp = DownloadFlowInfo.new
+              downloadflowinfo_tmp.deserialize(i)
+              @DownLoadFlows << downloadflowinfo_tmp
+            end
+          end
+        end
+      end
+
+      # GetDownloadFlowUrl返回参数结构体
+      class GetDownloadFlowUrlResponse < TencentCloud::Common::AbstractModel
+        # @param DownLoadUrl: 进入合同（流程）下载确认页面链接
+        # @type DownLoadUrl: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :DownLoadUrl, :RequestId
+        
+        def initialize(downloadurl=nil, requestid=nil)
+          @DownLoadUrl = downloadurl
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @DownLoadUrl = params['DownLoadUrl']
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # OperateChannelTemplate请求参数结构体
+      class OperateChannelTemplateRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 应用信息
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param TemplateId: 渠道方模板库模板唯一标识
+        # @type TemplateId: String
+        # @param OperateType: 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
+        # @type OperateType: String
+        # @param Operator: 操作者的信息
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param AuthTag: 模板可见性, 全部可见-"all", 部分可见-"part"
+        # @type AuthTag: String
+        # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据
+        # @type ProxyOrganizationOpenIds: String
+
+        attr_accessor :Agent, :TemplateId, :OperateType, :Operator, :AuthTag, :ProxyOrganizationOpenIds
+        
+        def initialize(agent=nil, templateid=nil, operatetype=nil, operator=nil, authtag=nil, proxyorganizationopenids=nil)
+          @Agent = agent
+          @TemplateId = templateid
+          @OperateType = operatetype
+          @Operator = operator
+          @AuthTag = authtag
+          @ProxyOrganizationOpenIds = proxyorganizationopenids
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @TemplateId = params['TemplateId']
+          @OperateType = params['OperateType']
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @AuthTag = params['AuthTag']
+          @ProxyOrganizationOpenIds = params['ProxyOrganizationOpenIds']
+        end
+      end
+
+      # OperateChannelTemplate返回参数结构体
+      class OperateChannelTemplateResponse < TencentCloud::Common::AbstractModel
+        # @param AppId: 腾讯电子签颁发给渠道的应用ID
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type AppId: String
+        # @param TemplateId: 渠道方模板库模板唯一标识
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type TemplateId: String
+        # @param OperateResult: 全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type OperateResult: String
+        # @param AuthTag: 模板可见性, 全部可见-"all", 部分可见-"part"
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type AuthTag: String
+        # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ProxyOrganizationOpenIds: Array
+        # @param FailMessageList: 操作失败信息数组
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FailMessageList: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :AppId, :TemplateId, :OperateResult, :AuthTag, :ProxyOrganizationOpenIds, :FailMessageList, :RequestId
+        
+        def initialize(appid=nil, templateid=nil, operateresult=nil, authtag=nil, proxyorganizationopenids=nil, failmessagelist=nil, requestid=nil)
+          @AppId = appid
+          @TemplateId = templateid
+          @OperateResult = operateresult
+          @AuthTag = authtag
+          @ProxyOrganizationOpenIds = proxyorganizationopenids
+          @FailMessageList = failmessagelist
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @AppId = params['AppId']
+          @TemplateId = params['TemplateId']
+          @OperateResult = params['OperateResult']
+          @AuthTag = params['AuthTag']
+          @ProxyOrganizationOpenIds = params['ProxyOrganizationOpenIds']
+          unless params['FailMessageList'].nil?
+            @FailMessageList = []
+            params['FailMessageList'].each do |i|
+              authfailmessage_tmp = AuthFailMessage.new
+              authfailmessage_tmp.deserialize(i)
+              @FailMessageList << authfailmessage_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # PrepareFlows请求参数结构体
       class PrepareFlowsRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息
@@ -1144,10 +1368,12 @@ module TencentCloud
         # @type TemplateType: Integer
         # @param Recipients: 模板中的流程参与人信息
         # @type Recipients: Array
+        # @param IsPromoter: 是否是发起人
+        # @type IsPromoter: Boolean
 
-        attr_accessor :TemplateId, :TemplateName, :Description, :Components, :SignComponents, :Creator, :CreatedOn, :TemplateType, :Recipients
+        attr_accessor :TemplateId, :TemplateName, :Description, :Components, :SignComponents, :Creator, :CreatedOn, :TemplateType, :Recipients, :IsPromoter
         
-        def initialize(templateid=nil, templatename=nil, description=nil, components=nil, signcomponents=nil, creator=nil, createdon=nil, templatetype=nil, recipients=nil)
+        def initialize(templateid=nil, templatename=nil, description=nil, components=nil, signcomponents=nil, creator=nil, createdon=nil, templatetype=nil, recipients=nil, ispromoter=nil)
           @TemplateId = templateid
           @TemplateName = templatename
           @Description = description
@@ -1157,6 +1383,7 @@ module TencentCloud
           @CreatedOn = createdon
           @TemplateType = templatetype
           @Recipients = recipients
+          @IsPromoter = ispromoter
         end
 
         def deserialize(params)
@@ -1190,6 +1417,7 @@ module TencentCloud
               @Recipients << recipient_tmp
             end
           end
+          @IsPromoter = params['IsPromoter']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 1.0.225
+  version: 1.0.229
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common