tencentcloud-sdk-essbasic 3.0.406 → 3.0.407

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77caee2c4a919bce63b19f888fe8195875775e02
-  data.tar.gz: 569632f3aeefd72573ce976e418e31c071e8fcf1
+  metadata.gz: 75512571ccda6f1e273b0cbaa97a450e492fc969
+  data.tar.gz: d7201ca7d9241aea18bf266dd5767ccea4cf28fa
 SHA512:
-  metadata.gz: d8931f5d7efa03fe4ce173e9d26d7ba78ee4e216c5b577965d62ffb2a7f00cc0c403e74166ee00c320c1fb0ce1a84ad5607219c4f1a973dbd602533413d8f148
-  data.tar.gz: 7566ac8c9f17329b909f52862526f7c886f4443ec5f148db4b5930e0463fd1122263e0dc2e6628c580ed2565b51b5bc11af522cfdda0020aa30bce1d85dd9580
+  metadata.gz: 458575fd7f76f295166e07c15b50769732e46ad3f8c40110ac97fe0fca115adfe003f0e469322e3710845d42e605c14c112bec4aae9006aad528bf9ccb568207
+  data.tar.gz: 185acbd7bf9a75ca4af82a9d7d3d8a12869402e741b6aa6f8a588002a3ff9356e54c74cf6c47a33357f80fdf7dddc366789984157015ec5804a98e64d942a320

data/lib/VERSION

@@ -1 +1 @@
-3.0.406
+3.0.407

data/lib/v20210526/client.rb

@@ -29,6 +29,31 @@ module TencentCloud
         end
 
 
+        # 指定需要批量撤销的签署流程Id，批量撤销合同
+        # 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口失败后返回错误信息
+
+        # @param request: Request instance for ChannelBatchCancelFlows.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsResponse`
+        def ChannelBatchCancelFlows(request)
+          body = send_request('ChannelBatchCancelFlows', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelBatchCancelFlowsResponse.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
+
         # 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
 
         # @param request: Request instance for ChannelCancelMultiFlowSignQRCode.
@@ -126,6 +151,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
+
+        # @param request: Request instance for ChannelCreateFlowGroupByFiles.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByFilesRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByFilesResponse`
+        def ChannelCreateFlowGroupByFiles(request)
+          body = send_request('ChannelCreateFlowGroupByFiles', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateFlowGroupByFilesResponse.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
+
         # 提交企业签署流程审批结果
 
         # 在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
@@ -202,7 +251,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建出证报告，返回报告 URL
+        # 【描述】：创建出证报告，返回报告 URL
+        # 【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
 
         # @param request: Request instance for CreateChannelFlowEvidenceReport.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelFlowEvidenceReportRequest`

data/lib/v20210526/models.rb

@@ -116,6 +116,56 @@ module TencentCloud
         end
       end
 
+      # ChannelBatchCancelFlows请求参数结构体
+      class ChannelBatchCancelFlowsRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param FlowIds: 签署流程Id数组，最多100个，超过100不处理
+        # @type FlowIds: Array
+        # @param Operator: 操作人信息
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+
+        attr_accessor :Agent, :FlowIds, :Operator
+        
+        def initialize(agent=nil, flowids=nil, operator=nil)
+          @Agent = agent
+          @FlowIds = flowids
+          @Operator = operator
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @FlowIds = params['FlowIds']
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+        end
+      end
+
+      # ChannelBatchCancelFlows返回参数结构体
+      class ChannelBatchCancelFlowsResponse < TencentCloud::Common::AbstractModel
+        # @param FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id一一对应，如果部分流程不可撤销，不会返回错误信息，只会撤销可撤销流程
+        # @type FailMessages: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :FailMessages, :RequestId
+        
+        def initialize(failmessages=nil, requestid=nil)
+          @FailMessages = failmessages
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @FailMessages = params['FailMessages']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCancelMultiFlowSignQRCode请求参数结构体
       class ChannelCancelMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
@@ -394,6 +444,73 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateFlowGroupByFiles请求参数结构体
+      class ChannelCreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel
+        # @param FlowFileInfos: 每个子合同的发起所需的信息，数量限制2-100
+        # @type FlowFileInfos: Array
+        # @param FlowGroupName: 合同组名称，长度不超过200个字符
+        # @type FlowGroupName: String
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param Operator: 操作者的信息
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+
+        attr_accessor :FlowFileInfos, :FlowGroupName, :Agent, :Operator
+        
+        def initialize(flowfileinfos=nil, flowgroupname=nil, agent=nil, operator=nil)
+          @FlowFileInfos = flowfileinfos
+          @FlowGroupName = flowgroupname
+          @Agent = agent
+          @Operator = operator
+        end
+
+        def deserialize(params)
+          unless params['FlowFileInfos'].nil?
+            @FlowFileInfos = []
+            params['FlowFileInfos'].each do |i|
+              flowfileinfo_tmp = FlowFileInfo.new
+              flowfileinfo_tmp.deserialize(i)
+              @FlowFileInfos << flowfileinfo_tmp
+            end
+          end
+          @FlowGroupName = params['FlowGroupName']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+        end
+      end
+
+      # ChannelCreateFlowGroupByFiles返回参数结构体
+      class ChannelCreateFlowGroupByFilesResponse < TencentCloud::Common::AbstractModel
+        # @param FlowGroupId: 合同组ID
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowGroupId: String
+        # @param FlowIds: 子合同ID列表
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowIds: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :FlowGroupId, :FlowIds, :RequestId
+        
+        def initialize(flowgroupid=nil, flowids=nil, requestid=nil)
+          @FlowGroupId = flowgroupid
+          @FlowIds = flowids
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @FlowGroupId = params['FlowGroupId']
+          @FlowIds = params['FlowIds']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateFlowSignReview请求参数结构体
       class ChannelCreateFlowSignReviewRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
@@ -1014,7 +1131,7 @@ module TencentCloud
       class CreateSignUrlsRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowIds: 签署流程编号数组，最多支持100个。
+        # @param FlowIds: 签署流程编号数组，最多支持100个。(备注：该参数和合同组编号必须二选一)
         # @type FlowIds: Array
         # @param Endpoint: 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；
         # @type Endpoint: String
@@ -1042,10 +1159,12 @@ module TencentCloud
         # @type JumpUrl: String
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param FlowGroupId: 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)
+        # @type FlowGroupId: String
 
-        attr_accessor :Agent, :FlowIds, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator
+        attr_accessor :Agent, :FlowIds, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :FlowGroupId
         
-        def initialize(agent=nil, flowids=nil, endpoint=nil, generatetype=nil, organizationname=nil, name=nil, mobile=nil, organizationopenid=nil, openid=nil, autojumpback=nil, jumpurl=nil, operator=nil)
+        def initialize(agent=nil, flowids=nil, endpoint=nil, generatetype=nil, organizationname=nil, name=nil, mobile=nil, organizationopenid=nil, openid=nil, autojumpback=nil, jumpurl=nil, operator=nil, flowgroupid=nil)
           @Agent = agent
           @FlowIds = flowids
           @Endpoint = endpoint
@@ -1058,6 +1177,7 @@ module TencentCloud
           @AutoJumpBack = autojumpback
           @JumpUrl = jumpurl
           @Operator = operator
+          @FlowGroupId = flowgroupid
         end
 
         def deserialize(params)
@@ -1079,6 +1199,7 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          @FlowGroupId = params['FlowGroupId']
         end
       end
 
@@ -1118,16 +1239,20 @@ module TencentCloud
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowIds: 合同(流程)编号数组，最多支持100个。
+        # （备注：该参数和合同组编号必须二选一）
         # @type FlowIds: Array
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param FlowGroupId: 合同组编号（备注：该参数和合同(流程)编号数组必须二选一）
+        # @type FlowGroupId: String
 
-        attr_accessor :Agent, :FlowIds, :Operator
+        attr_accessor :Agent, :FlowIds, :Operator, :FlowGroupId
         
-        def initialize(agent=nil, flowids=nil, operator=nil)
+        def initialize(agent=nil, flowids=nil, operator=nil, flowgroupid=nil)
           @Agent = agent
           @FlowIds = flowids
           @Operator = operator
+          @FlowGroupId = flowgroupid
         end
 
         def deserialize(params)
@@ -1140,6 +1265,7 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          @FlowGroupId = params['FlowGroupId']
         end
       end
 
@@ -1152,15 +1278,23 @@ module TencentCloud
         # @param FlowInfo: 合同(签署流程)的具体详细描述信息
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowInfo: Array
+        # @param FlowGroupId: 合同组编号
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowGroupId: String
+        # @param FlowGroupName: 合同组名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowGroupName: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :ApplicationId, :ProxyOrganizationOpenId, :FlowInfo, :RequestId
+        attr_accessor :ApplicationId, :ProxyOrganizationOpenId, :FlowInfo, :FlowGroupId, :FlowGroupName, :RequestId
         
-        def initialize(applicationid=nil, proxyorganizationopenid=nil, flowinfo=nil, requestid=nil)
+        def initialize(applicationid=nil, proxyorganizationopenid=nil, flowinfo=nil, flowgroupid=nil, flowgroupname=nil, requestid=nil)
           @ApplicationId = applicationid
           @ProxyOrganizationOpenId = proxyorganizationopenid
           @FlowInfo = flowinfo
+          @FlowGroupId = flowgroupid
+          @FlowGroupName = flowgroupname
           @RequestId = requestid
         end
 
@@ -1175,6 +1309,8 @@ module TencentCloud
               @FlowInfo << flowdetailinfo_tmp
             end
           end
+          @FlowGroupId = params['FlowGroupId']
+          @FlowGroupName = params['FlowGroupName']
           @RequestId = params['RequestId']
         end
       end
@@ -1639,6 +1775,69 @@ module TencentCloud
         end
       end
 
+      # 合同组中每个子合同的发起信息
+      class FlowFileInfo < TencentCloud::Common::AbstractModel
+        # @param FileIds: 签署文件资源Id列表，目前仅支持单个文件
+        # @type FileIds: Array
+        # @param FlowName: 签署流程名称，长度不超过200个字符
+        # @type FlowName: String
+        # @param FlowApprovers: 签署流程签约方列表，最多不超过5个参与方
+        # @type FlowApprovers: Array
+        # @param Deadline: 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
+        # @type Deadline: Integer
+        # @param FlowDescription: 签署流程的描述，长度不超过1000个字符
+        # @type FlowDescription: String
+        # @param FlowType: 签署流程的类型，长度不超过255个字符
+        # @type FlowType: String
+        # @param CallbackUrl: 签署流程回调地址，长度不超过255个字符
+        # @type CallbackUrl: String
+        # @param CustomerData: 渠道的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+        # @type CustomerData: String
+        # @param Unordered: 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
+        # @type Unordered: Boolean
+        # @param CustomShowMap: 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+        # @type CustomShowMap: String
+        # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批
+        # @type NeedSignReview: Boolean
+
+        attr_accessor :FileIds, :FlowName, :FlowApprovers, :Deadline, :FlowDescription, :FlowType, :CallbackUrl, :CustomerData, :Unordered, :CustomShowMap, :NeedSignReview
+        
+        def initialize(fileids=nil, flowname=nil, flowapprovers=nil, deadline=nil, flowdescription=nil, flowtype=nil, callbackurl=nil, customerdata=nil, unordered=nil, customshowmap=nil, needsignreview=nil)
+          @FileIds = fileids
+          @FlowName = flowname
+          @FlowApprovers = flowapprovers
+          @Deadline = deadline
+          @FlowDescription = flowdescription
+          @FlowType = flowtype
+          @CallbackUrl = callbackurl
+          @CustomerData = customerdata
+          @Unordered = unordered
+          @CustomShowMap = customshowmap
+          @NeedSignReview = needsignreview
+        end
+
+        def deserialize(params)
+          @FileIds = params['FileIds']
+          @FlowName = params['FlowName']
+          unless params['FlowApprovers'].nil?
+            @FlowApprovers = []
+            params['FlowApprovers'].each do |i|
+              flowapproverinfo_tmp = FlowApproverInfo.new
+              flowapproverinfo_tmp.deserialize(i)
+              @FlowApprovers << flowapproverinfo_tmp
+            end
+          end
+          @Deadline = params['Deadline']
+          @FlowDescription = params['FlowDescription']
+          @FlowType = params['FlowType']
+          @CallbackUrl = params['CallbackUrl']
+          @CustomerData = params['CustomerData']
+          @Unordered = params['Unordered']
+          @CustomShowMap = params['CustomShowMap']
+          @NeedSignReview = params['NeedSignReview']
+        end
+      end
+
       # 此结构体 (FlowInfo) 用于描述签署流程信息。
 
       # 【动态表格传参说明】
@@ -2287,10 +2486,13 @@ module TencentCloud
         # @param OpenId: 企业经办人 用户在渠道的编号
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OpenId: String
+        # @param FlowGroupId: 合同组签署链接对应的合同组id
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowGroupId: String
 
-        attr_accessor :SignUrl, :Deadline, :SignOrder, :SignId, :CustomUserId, :Name, :Mobile, :OrganizationName, :ApproverType, :IdCardNumber, :FlowId, :OpenId
+        attr_accessor :SignUrl, :Deadline, :SignOrder, :SignId, :CustomUserId, :Name, :Mobile, :OrganizationName, :ApproverType, :IdCardNumber, :FlowId, :OpenId, :FlowGroupId
         
-        def initialize(signurl=nil, deadline=nil, signorder=nil, signid=nil, customuserid=nil, name=nil, mobile=nil, organizationname=nil, approvertype=nil, idcardnumber=nil, flowid=nil, openid=nil)
+        def initialize(signurl=nil, deadline=nil, signorder=nil, signid=nil, customuserid=nil, name=nil, mobile=nil, organizationname=nil, approvertype=nil, idcardnumber=nil, flowid=nil, openid=nil, flowgroupid=nil)
           @SignUrl = signurl
           @Deadline = deadline
           @SignOrder = signorder
@@ -2303,6 +2505,7 @@ module TencentCloud
           @IdCardNumber = idcardnumber
           @FlowId = flowid
           @OpenId = openid
+          @FlowGroupId = flowgroupid
         end
 
         def deserialize(params)
@@ -2318,6 +2521,7 @@ module TencentCloud
           @IdCardNumber = params['IdCardNumber']
           @FlowId = params['FlowId']
           @OpenId = params['OpenId']
+          @FlowGroupId = params['FlowGroupId']
         end
       end
 

metadata

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