tencentcloud-sdk-essbasic 1.0.364 → 3.0.381

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38924cf3535ec33e1acea2f8cfc69ff680c21fc0
-  data.tar.gz: 3423cfa7378b71ce44bfeb27d4b8ee072b808037
+  metadata.gz: 777737cac8067f7d12b1c88ba1c9ad830f9b2afe
+  data.tar.gz: f04d4eacaaac070a6b6b4aa5a057fbe2c047f69d
 SHA512:
-  metadata.gz: 8073401e0831031f843e85cff8002111dc36a05b4fadead6de7e65d920ca7f21b6c65bcb63ccb9760f7e6d4b255b2efe5f1f9ca32d475867631f915ba65095bc
-  data.tar.gz: c7947051d6bad6054f3494f52aff7ba8b2c3c589d27a1ff12d7fe78dcbc992f0a049a310917195a3fc74f4b3499fe0cf3f0080c1580a1405500e3d4a6bd06312
+  metadata.gz: 68148b916d79c18d15cf0716af5b61bd736a2fba573572a16abf4a0d7df651b23f65e00c259c377727d1edbf0ce5519a26b699d77f6caac02e64ec660167a157
+  data.tar.gz: 5abf82d5c264d3f32b795fe20f8baeacbf389831801a66b23be45ddbf5e0c3f1ec1e7677beee9a80c54c425e083a2ef6ce36bf669c181b3d574b62768c5fc154

data/lib/VERSION

@@ -1 +1 @@
-1.0.364
+3.0.381

data/lib/v20210526/client.rb

@@ -53,6 +53,31 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 指定需要批量撤回的签署流程Id，获取批量撤销链接
+        # 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
+
+        # @param request: Request instance for ChannelCreateBatchCancelFlowUrl.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchCancelFlowUrlRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchCancelFlowUrlResponse`
+        def ChannelCreateBatchCancelFlowUrl(request)
+          body = send_request('ChannelCreateBatchCancelFlowUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateBatchCancelFlowUrlResponse.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
+
         # 接口（ChannelCreateFlowByFiles）用于渠道版通过文件创建签署流程。此接口不可直接使用，需要运营申请
 
         # @param request: Request instance for ChannelCreateFlowByFiles.

data/lib/v20210526/models.rb

@@ -21,13 +21,13 @@ module TencentCloud
       class Agent < TencentCloud::Common::AbstractModel
         # @param AppId: 腾讯电子签颁发给渠道的应用ID，32位字符串
         # @type AppId: String
-        # @param ProxyOrganizationOpenId: 渠道/平台合作企业的企业ID
+        # @param ProxyOrganizationOpenId: 渠道/平台合作企业的企业ID，最大64位字符串
         # @type ProxyOrganizationOpenId: String
         # @param ProxyOperator: 渠道/平台合作企业经办人（操作员）
         # @type ProxyOperator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
         # @param ProxyAppId: 腾讯电子签颁发给渠道侧合作企业的应用ID
         # @type ProxyAppId: String
-        # @param ProxyOrganizationId: 腾讯电子签颁发给渠道侧合作企业的企业ID
+        # @param ProxyOrganizationId: 内部参数，腾讯电子签颁发给渠道侧合作企业的企业ID，不需要传
         # @type ProxyOrganizationId: String
 
         attr_accessor :AppId, :ProxyOrganizationOpenId, :ProxyOperator, :ProxyAppId, :ProxyOrganizationId
@@ -52,6 +52,34 @@ module TencentCloud
         end
       end
 
+      # 指定签署人限制项
+      class ApproverRestriction < TencentCloud::Common::AbstractModel
+        # @param Name: 指定签署人名字
+        # @type Name: String
+        # @param Mobile: 指定签署人手机号
+        # @type Mobile: String
+        # @param IdCardType: 指定签署人证件类型
+        # @type IdCardType: String
+        # @param IdCardNumber: 指定签署人证件号码
+        # @type IdCardNumber: String
+
+        attr_accessor :Name, :Mobile, :IdCardType, :IdCardNumber
+        
+        def initialize(name=nil, mobile=nil, idcardtype=nil, idcardnumber=nil)
+          @Name = name
+          @Mobile = mobile
+          @IdCardType = idcardtype
+          @IdCardNumber = idcardnumber
+        end
+
+        def deserialize(params)
+          @Name = params['Name']
+          @Mobile = params['Mobile']
+          @IdCardType = params['IdCardType']
+          @IdCardNumber = params['IdCardNumber']
+        end
+      end
+
       # 授权出错信息
       class AuthFailMessage < TencentCloud::Common::AbstractModel
         # @param ProxyOrganizationOpenId: 合作企业Id
@@ -134,6 +162,64 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateBatchCancelFlowUrl请求参数结构体
+      class ChannelCreateBatchCancelFlowUrlRequest < 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数组
+        # @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
+
+      # ChannelCreateBatchCancelFlowUrl返回参数结构体
+      class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
+        # @param BatchCancelFlowUrl: 批量撤回url
+        # @type BatchCancelFlowUrl: String
+        # @param FailMessages: 签署流程批量撤回失败原因
+        # @type FailMessages: Array
+        # @param UrlExpireOn: 签署撤回url过期时间-年月日-时分秒
+        # @type UrlExpireOn: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :BatchCancelFlowUrl, :FailMessages, :UrlExpireOn, :RequestId
+        
+        def initialize(batchcancelflowurl=nil, failmessages=nil, urlexpireon=nil, requestid=nil)
+          @BatchCancelFlowUrl = batchcancelflowurl
+          @FailMessages = failmessages
+          @UrlExpireOn = urlexpireon
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @BatchCancelFlowUrl = params['BatchCancelFlowUrl']
+          @FailMessages = params['FailMessages']
+          @UrlExpireOn = params['UrlExpireOn']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateFlowByFiles请求参数结构体
       class ChannelCreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息
@@ -158,12 +244,14 @@ module TencentCloud
         # @type FlowDescription: String
         # @param CustomShowMap: 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
         # @type CustomShowMap: String
+        # @param CustomerData: 渠道的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+        # @type CustomerData: String
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :Operator
+        attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :Operator
         
-        def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, operator=nil)
+        def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, operator=nil)
           @Agent = agent
           @FlowName = flowname
           @FlowApprovers = flowapprovers
@@ -175,6 +263,7 @@ module TencentCloud
           @FlowType = flowtype
           @FlowDescription = flowdescription
           @CustomShowMap = customshowmap
+          @CustomerData = customerdata
           @Operator = operator
         end
 
@@ -207,6 +296,7 @@ module TencentCloud
           @FlowType = params['FlowType']
           @FlowDescription = params['FlowDescription']
           @CustomShowMap = params['CustomShowMap']
+          @CustomerData = params['CustomerData']
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
@@ -254,12 +344,14 @@ module TencentCloud
         # 不传默认使用渠道应用号配置的回调地址
         # 回调时机:用户通过签署二维码发起合同时，企业额度不足导致失败
         # @type CallbackUrl: String
+        # @param ApproverRestrictions: 限制二维码用户条件
+        # @type ApproverRestrictions: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverRestriction`
         # @param Operator: 用户信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :CallbackUrl, :Operator
+        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :CallbackUrl, :ApproverRestrictions, :Operator
         
-        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, callbackurl=nil, operator=nil)
+        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, callbackurl=nil, approverrestrictions=nil, operator=nil)
           @Agent = agent
           @TemplateId = templateid
           @FlowName = flowname
@@ -267,6 +359,7 @@ module TencentCloud
           @FlowEffectiveDay = floweffectiveday
           @QrEffectiveDay = qreffectiveday
           @CallbackUrl = callbackurl
+          @ApproverRestrictions = approverrestrictions
           @Operator = operator
         end
 
@@ -281,6 +374,10 @@ module TencentCloud
           @FlowEffectiveDay = params['FlowEffectiveDay']
           @QrEffectiveDay = params['QrEffectiveDay']
           @CallbackUrl = params['CallbackUrl']
+          unless params['ApproverRestrictions'].nil?
+            @ApproverRestrictions = ApproverRestriction.new
+            @ApproverRestrictions.deserialize(params['ApproverRestrictions'])
+          end
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
@@ -292,13 +389,16 @@ module TencentCloud
       class ChannelCreateMultiFlowSignQRCodeResponse < TencentCloud::Common::AbstractModel
         # @param QrCode: 签署二维码对象
         # @type QrCode: :class:`Tencentcloud::Essbasic.v20210526.models.SignQrCode`
+        # @param SignUrls: 签署链接对象
+        # @type SignUrls: :class:`Tencentcloud::Essbasic.v20210526.models.SignUrl`
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :QrCode, :RequestId
+        attr_accessor :QrCode, :SignUrls, :RequestId
         
-        def initialize(qrcode=nil, requestid=nil)
+        def initialize(qrcode=nil, signurls=nil, requestid=nil)
           @QrCode = qrcode
+          @SignUrls = signurls
           @RequestId = requestid
         end
 
@@ -307,6 +407,10 @@ module TencentCloud
             @QrCode = SignQrCode.new
             @QrCode.deserialize(params['QrCode'])
           end
+          unless params['SignUrls'].nil?
+            @SignUrls = SignUrl.new
+            @SignUrls.deserialize(params['SignUrls'])
+          end
           @RequestId = params['RequestId']
         end
       end
@@ -327,6 +431,7 @@ module TencentCloud
         # @param ComponentType: 如果是Component控件类型，则可选的字段为：
         # TEXT - 普通文本控件；
         # DATE - 普通日期控件；跟TEXT相比会有校验逻辑
+        # DYNAMIC_TABLE-动态表格控件；
         # 如果是SignComponent控件类型，则可选的字段为
         # SIGN_SEAL - 签署印章控件；
         # SIGN_DATE - 签署日期控件；
@@ -1251,6 +1356,65 @@ module TencentCloud
       end
 
       # 此结构体 (FlowInfo) 用于描述签署流程信息。
+
+      # 【动态表格传参说明】
+      # 当模板的 ComponentType='DYNAMIC_TABLE'时（渠道版），FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充动态表格（支持内容的单元格合并）
+      # 输入示例
+
+      # ```
+      # {
+      #     "headers":[
+      #         {
+      #             "content":"head1"
+      #         },
+      #         {
+      #             "content":"head2"
+      #         },
+      #         {
+      #             "content":"head3"
+      #         }
+      #     ],
+      #     "rowCount":3,
+      #     "body":{
+      #         "cells":[
+      #             {
+      #                 "rowStart":1,
+      #                 "rowEnd":1,
+      #                 "columnStart":1,
+      #                 "columnEnd":1,
+      #                 "content":"123"
+      #             },
+      #             {
+      #                 "rowStart":2,
+      #                 "rowEnd":3,
+      #                 "columnStart":1,
+      #                 "columnEnd":2,
+      #                 "content":"456"
+      #             },
+      #             {
+      #                 "rowStart":3,
+      #                 "rowEnd":3,
+      #                 "columnStart":3,
+      #                 "columnEnd":3,
+      #                 "content":"789"
+      #             }
+      #         ]
+      #     }
+      # }
+
+      # ```
+
+      # 表格参数说明
+
+      # | 名称                | 类型    | 描述                                              |
+      # | ------------------- | ------- | ------------------------------------------------- |
+      # | headers             | Array   | 表头：不超过10列，不支持单元格合并，字数不超过100 |
+      # | rowCount            | Integer | 表格内容最大行数                                  |
+      # | cells.N.rowStart    | Integer | 单元格坐标：行起始index                           |
+      # | cells.N.rowEnd      | Integer | 单元格坐标：行结束index                           |
+      # | cells.N.columnStart | Integer | 单元格坐标：列起始index                           |
+      # | cells.N.columnEnd   | Integer | 单元格坐标：列结束index                           |
+      # | cells.N.content     | String  | 单元格内容，字数不超过100                         |
       class FlowInfo < TencentCloud::Common::AbstractModel
         # @param FlowName: 合同名字，最大长度200个字符
         # @type FlowName: String
@@ -1729,6 +1893,30 @@ module TencentCloud
         end
       end
 
+      # 一码多扫签署二维码签署信息
+      class SignUrl < TencentCloud::Common::AbstractModel
+        # @param AppSignUrl: 小程序签署链接
+        # @type AppSignUrl: String
+        # @param EffectiveTime: 签署链接有效时间
+        # @type EffectiveTime: String
+        # @param HttpSignUrl: 移动端签署链接
+        # @type HttpSignUrl: String
+
+        attr_accessor :AppSignUrl, :EffectiveTime, :HttpSignUrl
+        
+        def initialize(appsignurl=nil, effectivetime=nil, httpsignurl=nil)
+          @AppSignUrl = appsignurl
+          @EffectiveTime = effectivetime
+          @HttpSignUrl = httpsignurl
+        end
+
+        def deserialize(params)
+          @AppSignUrl = params['AppSignUrl']
+          @EffectiveTime = params['EffectiveTime']
+          @HttpSignUrl = params['HttpSignUrl']
+        end
+      end
+
       # 签署链接内容
       class SignUrlInfo < TencentCloud::Common::AbstractModel
         # @param SignUrl: 签署链接
@@ -2157,7 +2345,7 @@ module TencentCloud
 
       # 接口调用者信息
       class UserInfo < TencentCloud::Common::AbstractModel
-        # @param OpenId: 用户在渠道的编号
+        # @param OpenId: 用户在渠道的编号，最大64位字符串
         # @type OpenId: String
         # @param Channel: 用户的来源渠道
         # @type Channel: String

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 1.0.364
+  version: 3.0.381
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Tencent Cloud Ruby SDK is the official software development kit, which
@@ -33,12 +33,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/VERSION
 - lib/tencentcloud-sdk-essbasic.rb
-- lib/v20201222/client.rb
-- lib/v20201222/models.rb
-- lib/v20210526/client.rb
 - lib/v20210526/models.rb
+- lib/v20210526/client.rb
+- lib/v20201222/models.rb
+- lib/v20201222/client.rb
+- lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
 licenses:
 - Apache-2.0
@@ -51,17 +51,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Tencent Cloud SDK for Ruby - ESSBASIC