tencentcloud-sdk-essbasic 3.0.434 → 3.0.436

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c8fe5b8c73ada4ed477ff795f4542531f7cedb9
-  data.tar.gz: 557e784630b28cf3be994ffed0010a25d3e6bdfa
+  metadata.gz: fdc7a95dca98bedc2cedccb5a42a14ac30e728b3
+  data.tar.gz: edb2d0ef1e951bd246ecb33450030f5382848311
 SHA512:
-  metadata.gz: d4b59b93d79d70979ea156caa2a9ebdb0084d68823e6e2e8d0f9784c4d27ef9079b2f25387bddf4ad9fa612cedb4ce16d3b580cccb729cb53eef7c8ce75bef7f
-  data.tar.gz: a5675f3f6d73d5121d007cc8cfc5d455b88b25f02bd221873c88591b445a9ebf9bcd3b9d65eddee527f86f67456825a963a29b3881830ff460d25dff16e2bfd4
+  metadata.gz: b33a8dfac6641e61c3ad9af0f84cb71ed4464acd13988a8dda973c18636fe3a8ac6bafeb4c7b4be0e03262c60105aea5758fd3c8b625e7ccb325c7692e4b78e8
+  data.tar.gz: c512ef04039b9b6b2633af33035237c941be7fb6c4bef78c23ca46e99e4ec4c7545004ef639d7a31238b98e3a454caaaaa5214c639914d4389ffc0c6551f6f01

data/lib/VERSION

@@ -1 +1 @@
-3.0.434
+3.0.436

data/lib/v20210526/client.rb

@@ -56,6 +56,32 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 渠道版撤销签署流程接口
+        # 注意:
+        # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
+
+        # @param request: Request instance for ChannelCancelFlow.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelFlowRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelFlowResponse`
+        def ChannelCancelFlow(request)
+          body = send_request('ChannelCancelFlow', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCancelFlowResponse.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.
@@ -470,7 +496,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 通过此接口（DescribeTemplates）查询该子客企业在电子签拥有的的有效模板，不包括渠道模版
+        # 通过此接口（DescribeTemplates）查询该子客企业在电子签拥有的有效模板，不包括渠道模板
 
         # @param request: Request instance for DescribeTemplates.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesRequest`

data/lib/v20210526/models.rb

@@ -52,6 +52,22 @@ module TencentCloud
         end
       end
 
+      # 签署人个性化能力信息
+      class ApproverOption < TencentCloud::Common::AbstractModel
+        # @param HideOneKeySign: 是否隐藏一键签署 false-不隐藏,默认 true-隐藏
+        # @type HideOneKeySign: Boolean
+
+        attr_accessor :HideOneKeySign
+        
+        def initialize(hideonekeysign=nil)
+          @HideOneKeySign = hideonekeysign
+        end
+
+        def deserialize(params)
+          @HideOneKeySign = params['HideOneKeySign']
+        end
+      end
+
       # 指定签署人限制项
       class ApproverRestriction < TencentCloud::Common::AbstractModel
         # @param Name: 指定签署人名字
@@ -122,14 +138,24 @@ module TencentCloud
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowIds: 签署流程Id数组，最多100个，超过100不处理
         # @type FlowIds: Array
+        # @param CancelMessage: 撤销理由
+        # @type CancelMessage: String
+        # @param CancelMessageFormat: 撤销理由自定义格式；选项：
+        # 0 默认格式
+        # 1 只保留身份信息：展示为【发起方】
+        # 2 保留身份信息+企业名称：展示为【发起方xxx公司】
+        # 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+        # @type CancelMessageFormat: Integer
         # @param Operator: 操作人信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :Agent, :FlowIds, :Operator
+        attr_accessor :Agent, :FlowIds, :CancelMessage, :CancelMessageFormat, :Operator
         
-        def initialize(agent=nil, flowids=nil, operator=nil)
+        def initialize(agent=nil, flowids=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil)
           @Agent = agent
           @FlowIds = flowids
+          @CancelMessage = cancelmessage
+          @CancelMessageFormat = cancelmessageformat
           @Operator = operator
         end
 
@@ -139,6 +165,8 @@ module TencentCloud
             @Agent.deserialize(params['Agent'])
           end
           @FlowIds = params['FlowIds']
+          @CancelMessage = params['CancelMessage']
+          @CancelMessageFormat = params['CancelMessageFormat']
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
@@ -166,6 +194,64 @@ module TencentCloud
         end
       end
 
+      # ChannelCancelFlow请求参数结构体
+      class ChannelCancelFlowRequest < TencentCloud::Common::AbstractModel
+        # @param FlowId: 签署流程编号
+        # @type FlowId: String
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param CancelMessage: 撤回原因，最大不超过200字符
+        # @type CancelMessage: String
+        # @param Operator: 操作者的信息
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param CancelMessageFormat: 撤销理由自定义格式；选项：
+        # 0 默认格式
+        # 1 只保留身份信息：展示为【发起方】
+        # 2 保留身份信息+企业名称：展示为【发起方xxx公司】
+        # 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+        # @type CancelMessageFormat: Integer
+
+        attr_accessor :FlowId, :Agent, :CancelMessage, :Operator, :CancelMessageFormat
+        
+        def initialize(flowid=nil, agent=nil, cancelmessage=nil, operator=nil, cancelmessageformat=nil)
+          @FlowId = flowid
+          @Agent = agent
+          @CancelMessage = cancelmessage
+          @Operator = operator
+          @CancelMessageFormat = cancelmessageformat
+        end
+
+        def deserialize(params)
+          @FlowId = params['FlowId']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @CancelMessage = params['CancelMessage']
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @CancelMessageFormat = params['CancelMessageFormat']
+        end
+      end
+
+      # ChannelCancelFlow返回参数结构体
+      class ChannelCancelFlowResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+        
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCancelMultiFlowSignQRCode请求参数结构体
       class ChannelCancelMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
@@ -1528,7 +1614,7 @@ module TencentCloud
       class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param TemplateId: 模板唯一标识，查询单个模版时使用
+        # @param TemplateId: 模板唯一标识，查询单个模板时使用
         # @type TemplateId: String
         # @param ContentType: 查询内容：0-模板列表及详情（默认），1-仅模板列表
         # @type ContentType: Integer
@@ -1798,14 +1884,14 @@ module TencentCloud
       # 创建签署流程签署人入参。
 
       # 其中签署方FlowApproverInfo需要传递的参数
-      # 非单C、单B、B2C合同，ApproverType、RecipientId（模版发起合同时）必传，建议都传。其他身份标识
+      # 非单C、单B、B2C合同，ApproverType、RecipientId（模板发起合同时）必传，建议都传。其他身份标识
       # 1-个人：Name、Mobile必传
       # 2-渠道子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；
       # 3-渠道合作企业不指定经办人：（暂不支持）
       # 4-非渠道合作企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。
 
       # RecipientId参数：
-      # 从DescribeTemplates接口中，可以得到模版下的签署方Recipient列表，根据模版自定义的Rolename在此结构体中确定其RecipientId
+      # 从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId
       class FlowApproverInfo < TencentCloud::Common::AbstractModel
         # @param Name: 签署人姓名，最大长度50个字符
         # @type Name: String
@@ -1831,7 +1917,7 @@ module TencentCloud
         # PERSON_AUTO_SIGN-个人自动签；
         # ORGANIZATION-企业；
         # ENTERPRISESERVER-企业静默签;
-        # 注：ENTERPRISESERVER 类型仅用于使用文件创建签署流程（ChannelCreateFlowByFiles）接口；并且仅能指定发起方企业签署方为静默签署；
+        # 注：ENTERPRISESERVER 类型仅用于使用文件创建签署流程（ChannelCreateFlowByFiles）接口；
         # @type ApproverType: String
         # @param RecipientId: 签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；
         # @type RecipientId: String
@@ -1847,10 +1933,14 @@ module TencentCloud
         # @type PreReadTime: Integer
         # @param JumpUrl: 签署完前端跳转的url，暂未使用
         # @type JumpUrl: String
+        # @param ApproverOption: 签署人个性化能力值
+        # @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverOption`
+        # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批，true 则为需要
+        # @type ApproverNeedSignReview: Boolean
 
-        attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl
+        attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview
         
-        def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil)
+        def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil, approveroption=nil, approverneedsignreview=nil)
           @Name = name
           @IdCardType = idcardtype
           @IdCardNumber = idcardnumber
@@ -1867,6 +1957,8 @@ module TencentCloud
           @ComponentLimitType = componentlimittype
           @PreReadTime = prereadtime
           @JumpUrl = jumpurl
+          @ApproverOption = approveroption
+          @ApproverNeedSignReview = approverneedsignreview
         end
 
         def deserialize(params)
@@ -1893,6 +1985,11 @@ module TencentCloud
           @ComponentLimitType = params['ComponentLimitType']
           @PreReadTime = params['PreReadTime']
           @JumpUrl = params['JumpUrl']
+          unless params['ApproverOption'].nil?
+            @ApproverOption = ApproverOption.new
+            @ApproverOption.deserialize(params['ApproverOption'])
+          end
+          @ApproverNeedSignReview = params['ApproverNeedSignReview']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.434
+  version: 3.0.436
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common