# frozen_string_literal: true # Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. module TencentCloud module Essbasic module V20210526 # 应用相关信息, 整体应用的层级图如下 # 注: # 1. `不同的业务系统可以采用不同的应用,不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证` class Agent < TencentCloud::Common::AbstractModel # @param AppId: 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下: # ![image](https://qcloudimg.tencent-cloud.cn/raw/fac77e0d3f28aaec56669f67e65c8db8.png) # @type AppId: String # @param ProxyOrganizationOpenId: 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串 # @type ProxyOrganizationOpenId: String # @param ProxyOperator: 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。 # @type ProxyOperator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param ProxyAppId: **不用填写**,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。 # @type ProxyAppId: String # @param ProxyOrganizationId: 内部参数,暂未开放使用 # @type ProxyOrganizationId: String attr_accessor :AppId, :ProxyOrganizationOpenId, :ProxyOperator, :ProxyAppId, :ProxyOrganizationId extend Gem::Deprecate deprecate :ProxyOrganizationId, :none, 2023, 11 deprecate :ProxyOrganizationId=, :none, 2023, 11 def initialize(appid=nil, proxyorganizationopenid=nil, proxyoperator=nil, proxyappid=nil, proxyorganizationid=nil) @AppId = appid @ProxyOrganizationOpenId = proxyorganizationopenid @ProxyOperator = proxyoperator @ProxyAppId = proxyappid @ProxyOrganizationId = proxyorganizationid end def deserialize(params) @AppId = params['AppId'] @ProxyOrganizationOpenId = params['ProxyOrganizationOpenId'] unless params['ProxyOperator'].nil? @ProxyOperator = UserInfo.new @ProxyOperator.deserialize(params['ProxyOperator']) end @ProxyAppId = params['ProxyAppId'] @ProxyOrganizationId = params['ProxyOrganizationId'] end end # 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。 class ApproverComponentLimitType < TencentCloud::Common::AbstractModel # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。 # @type RecipientId: String # @param Values: 签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。 # 签名方式: # # @type Values: Array attr_accessor :RecipientId, :Values def initialize(recipientid=nil, values=nil) @RecipientId = recipientid @Values = values end def deserialize(params) @RecipientId = params['RecipientId'] @Values = params['Values'] end end # 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称 class ApproverItem < TencentCloud::Common::AbstractModel # @param SignId: 签署方唯一编号 # 在动态补充签署人场景下,可以用此编号确定参与方 # 注意:此字段可能返回 null,表示取不到有效值。 # @type SignId: String # @param RecipientId: 签署方角色编号 # 在动态补充签署人场景下,可以用此编号确定参与方 # 注意:此字段可能返回 null,表示取不到有效值。 # @type RecipientId: String # @param ApproverRoleName: 签署方角色名称 # 注意:此字段可能返回 null,表示取不到有效值。 # @type ApproverRoleName: String attr_accessor :SignId, :RecipientId, :ApproverRoleName def initialize(signid=nil, recipientid=nil, approverrolename=nil) @SignId = signid @RecipientId = recipientid @ApproverRoleName = approverrolename end def deserialize(params) @SignId = params['SignId'] @RecipientId = params['RecipientId'] @ApproverRoleName = params['ApproverRoleName'] end end # 签署人个性化能力信息 class ApproverOption < TencentCloud::Common::AbstractModel # @param NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签 # @type NoRefuse: Boolean # @param NoTransfer: 是否可以转发 默认false-可以转发 true-不可以转发 # @type NoTransfer: Boolean # @param HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏 # @type HideOneKeySign: Boolean # @param FillType: 签署人信息补充类型,默认无需补充。 # # @type FillType: Integer # @param FlowReadLimit: 签署人阅读合同限制参数 #
取值: # # @type FlowReadLimit: String attr_accessor :NoRefuse, :NoTransfer, :HideOneKeySign, :FillType, :FlowReadLimit def initialize(norefuse=nil, notransfer=nil, hideonekeysign=nil, filltype=nil, flowreadlimit=nil) @NoRefuse = norefuse @NoTransfer = notransfer @HideOneKeySign = hideonekeysign @FillType = filltype @FlowReadLimit = flowreadlimit end def deserialize(params) @NoRefuse = params['NoRefuse'] @NoTransfer = params['NoTransfer'] @HideOneKeySign = params['HideOneKeySign'] @FillType = params['FillType'] @FlowReadLimit = params['FlowReadLimit'] end end # 指定签署人限制项 class ApproverRestriction < TencentCloud::Common::AbstractModel # @param Name: 指定签署人姓名 # @type Name: String # @param Mobile: 指定签署人手机号,11位数字 # @type Mobile: String # @param IdCardType: 指定签署人证件类型,ID_CARD-身份证,HONGKONG_AND_MACAO-港澳居民来往内地通行证,HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证 # @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: 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。 # 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。 # @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 AuthorizedUser < TencentCloud::Common::AbstractModel # @param OpenId: 第三方应用平台的用户openid # @type OpenId: String attr_accessor :OpenId def initialize(openid=nil) @OpenId = openid end def deserialize(params) @OpenId = params['OpenId'] end end # 自动签开启、签署相关配置 class AutoSignConfig < TencentCloud::Common::AbstractModel # @param UserInfo: 自动签开通个人用户信息, 包括名字,身份证等 # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor` # @param CertInfoCallback: 是否回调证书信息: # # @type CertInfoCallback: Boolean # @param UserDefineSeal: 是否支持用户自定义签名印章: # # @type UserDefineSeal: Boolean # @param SealImgCallback: 回调中是否需要自动签将要使用的印章(签名)图片的 base64: # # @type SealImgCallback: Boolean # @param CallbackUrl: 回调链接,如果渠道已经配置了,可以不传 # @type CallbackUrl: String # @param VerifyChannels: 开通时候的身份验证方式, 取值为: # # 注: # # @type VerifyChannels: Array # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。 # # @type LicenseType: Integer attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType def initialize(userinfo=nil, certinfocallback=nil, userdefineseal=nil, sealimgcallback=nil, callbackurl=nil, verifychannels=nil, licensetype=nil) @UserInfo = userinfo @CertInfoCallback = certinfocallback @UserDefineSeal = userdefineseal @SealImgCallback = sealimgcallback @CallbackUrl = callbackurl @VerifyChannels = verifychannels @LicenseType = licensetype end def deserialize(params) unless params['UserInfo'].nil? @UserInfo = UserThreeFactor.new @UserInfo.deserialize(params['UserInfo']) end @CertInfoCallback = params['CertInfoCallback'] @UserDefineSeal = params['UserDefineSeal'] @SealImgCallback = params['SealImgCallback'] @CallbackUrl = params['CallbackUrl'] @VerifyChannels = params['VerifyChannels'] @LicenseType = params['LicenseType'] end end # 基础流程信息 class BaseFlowInfo < TencentCloud::Common::AbstractModel # @param FlowName: 合同流程名称 # @type FlowName: String # @param FlowType: 合同流程类型 #
客户自定义,用于合同分类展示 # @type FlowType: String # @param FlowDescription: 合同流程描述信息 # @type FlowDescription: String # @param Deadline: 合同流程截止时间,unix时间戳,单位秒 # @type Deadline: Integer # @param Unordered: 是否顺序签署(true:无序签,false:顺序签) #
默认false,有序签署合同 # @type Unordered: Boolean # @param IntelligentStatus: 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE") # @type IntelligentStatus: String # @param FormFields: 填写控件内容 # @type FormFields: Array # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批 #
true:开启发起方签署审批 #
false:不开启发起方签署审批 #
开启后,使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署 # @type NeedSignReview: Boolean # @param UserData: 用户流程自定义数据参数 # @type UserData: String # @param CcInfos: 抄送人信息 # @type CcInfos: Array # @param NeedCreateReview: 是否需要开启发起方发起前审核 #
true:开启发起方发起前审核 #
false:不开启发起方发起前审核 #
当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同 # @type NeedCreateReview: Boolean # @param Components: 填写控件:文件发起使用 # @type Components: Array attr_accessor :FlowName, :FlowType, :FlowDescription, :Deadline, :Unordered, :IntelligentStatus, :FormFields, :NeedSignReview, :UserData, :CcInfos, :NeedCreateReview, :Components def initialize(flowname=nil, flowtype=nil, flowdescription=nil, deadline=nil, unordered=nil, intelligentstatus=nil, formfields=nil, needsignreview=nil, userdata=nil, ccinfos=nil, needcreatereview=nil, components=nil) @FlowName = flowname @FlowType = flowtype @FlowDescription = flowdescription @Deadline = deadline @Unordered = unordered @IntelligentStatus = intelligentstatus @FormFields = formfields @NeedSignReview = needsignreview @UserData = userdata @CcInfos = ccinfos @NeedCreateReview = needcreatereview @Components = components end def deserialize(params) @FlowName = params['FlowName'] @FlowType = params['FlowType'] @FlowDescription = params['FlowDescription'] @Deadline = params['Deadline'] @Unordered = params['Unordered'] @IntelligentStatus = params['IntelligentStatus'] unless params['FormFields'].nil? @FormFields = [] params['FormFields'].each do |i| formfield_tmp = FormField.new formfield_tmp.deserialize(i) @FormFields << formfield_tmp end end @NeedSignReview = params['NeedSignReview'] @UserData = params['UserData'] unless params['CcInfos'].nil? @CcInfos = [] params['CcInfos'].each do |i| ccinfo_tmp = CcInfo.new ccinfo_tmp.deserialize(i) @CcInfos << ccinfo_tmp end end @NeedCreateReview = params['NeedCreateReview'] unless params['Components'].nil? @Components = [] params['Components'].each do |i| component_tmp = Component.new component_tmp.deserialize(i) @Components << component_tmp end end end end # 用户计费使用情况详情 class BillUsageDetail < TencentCloud::Common::AbstractModel # @param FlowId: 合同流程ID,为32位字符串。 # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type FlowId: String # @param OperatorName: 合同经办人名称 # 如果有多个经办人用分号隔开。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type OperatorName: String # @param CreateOrganizationName: 发起方组织机构名称 # 注意:此字段可能返回 null,表示取不到有效值。 # @type CreateOrganizationName: String # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 # 该名称还将用于合同签署完成后的下载文件名。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type FlowName: String # @param Status: 当前合同状态,如下是状态码对应的状态。 # 0-还没有发起 # 1-等待签署 # 2-部分签署 # 3-拒签 # 4-已签署 # 5-已过期 # 6-已撤销 # 7-还没有预发起 # 8-等待填写 # 9-部分填写 # 10-拒填 # 11-已解除 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Status: Integer # @param QuotaType: 套餐类型 # 对应关系如下 # CloudEnterprise-企业版合同 # SingleSignature-单方签章 # CloudProve-签署报告 # CloudOnlineSign-腾讯会议在线签约 # ChannelWeCard-微工卡 # SignFlow-合同套餐 # SignFace-签署意愿(人脸识别) # SignPassword-签署意愿(密码) # SignSMS-签署意愿(短信) # PersonalEssAuth-签署人实名(腾讯电子签认证) # PersonalThirdAuth-签署人实名(信任第三方认证) # OrgEssAuth-签署企业实名 # FlowNotify-短信通知 # AuthService-企业工商信息查询 # 注意:此字段可能返回 null,表示取不到有效值。 # @type QuotaType: String # @param UseCount: 合同使用量 # 注意:此字段可能返回 null,表示取不到有效值。 # @type UseCount: Integer # @param CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type CostTime: Integer # @param QuotaName: 消耗的套餐名称 # 注意:此字段可能返回 null,表示取不到有效值。 # @type QuotaName: String # @param CostType: 消耗类型 # 1.扣费 2.撤销返还 # 注意:此字段可能返回 null,表示取不到有效值。 # @type CostType: Integer # @param Remark: 备注 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Remark: String attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, status=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil) @FlowId = flowid @OperatorName = operatorname @CreateOrganizationName = createorganizationname @FlowName = flowname @Status = status @QuotaType = quotatype @UseCount = usecount @CostTime = costtime @QuotaName = quotaname @CostType = costtype @Remark = remark end def deserialize(params) @FlowId = params['FlowId'] @OperatorName = params['OperatorName'] @CreateOrganizationName = params['CreateOrganizationName'] @FlowName = params['FlowName'] @Status = params['Status'] @QuotaType = params['QuotaType'] @UseCount = params['UseCount'] @CostTime = params['CostTime'] @QuotaName = params['QuotaName'] @CostType = params['CostType'] @Remark = params['Remark'] end end # 抄送信息 class CcInfo < TencentCloud::Common::AbstractModel # @param Mobile: 被抄送人手机号,大陆11位手机号 # @type Mobile: String # @param Name: 被抄送人姓名 # @type Name: String # @param CcType: 被抄送人类型 # 0--个人. 1--员工 # @type CcType: Integer # @param CcPermission: 被抄送人权限 # 0--可查看 # 1--可查看也可下载 # @type CcPermission: Integer attr_accessor :Mobile, :Name, :CcType, :CcPermission def initialize(mobile=nil, name=nil, cctype=nil, ccpermission=nil) @Mobile = mobile @Name = name @CcType = cctype @CcPermission = ccpermission end def deserialize(params) @Mobile = params['Mobile'] @Name = params['Name'] @CcType = params['CcType'] @CcPermission = params['CcPermission'] end end # ChannelBatchCancelFlows请求参数结构体 class ChannelBatchCancelFlowsRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理 # @type FlowIds: Array # @param CancelMessage: 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。 # 备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"` # @type CancelMessage: String # @param CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式: # **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同 # **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同 # **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同 # **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同 # 注: `CancelMessage为撤销当前合同的理由` # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png) # @type CancelMessageFormat: Integer # @param Operator: 暂未开放 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :Agent, :FlowIds, :CancelMessage, :CancelMessageFormat, :Operator extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(agent=nil, flowids=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil) @Agent = agent @FlowIds = flowids @CancelMessage = cancelmessage @CancelMessageFormat = cancelmessageformat @Operator = operator end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @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']) 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 # 用户计费使用情况详情 class ChannelBillUsageDetail < TencentCloud::Common::AbstractModel # @param FlowId: 合同流程ID,为32位字符串。 # @type FlowId: String # @param OperatorName: 合同经办人名称 # 如果有多个经办人用分号隔开。 # @type OperatorName: String # @param CreateOrganizationName: 发起方组织机构名称 # @type CreateOrganizationName: String # @param FlowName: 合同流程的名称。 # @type FlowName: String # @param FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值 # # @type FlowStatus: String # @param QuotaType: 查询的套餐类型 # 对应关系如下: # # @type QuotaType: String # @param UseCount: 合同使用量 # 注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量` # @type UseCount: Integer # @param CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。 # @type CostTime: Integer # @param QuotaName: 消耗的套餐名称 # @type QuotaName: String # @param CostType: 消耗类型 # **1**.扣费 # **2**.撤销返还 # @type CostType: Integer # @param Remark: 备注 # @type Remark: String attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :FlowStatus, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, flowstatus=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil) @FlowId = flowid @OperatorName = operatorname @CreateOrganizationName = createorganizationname @FlowName = flowname @FlowStatus = flowstatus @QuotaType = quotatype @UseCount = usecount @CostTime = costtime @QuotaName = quotaname @CostType = costtype @Remark = remark end def deserialize(params) @FlowId = params['FlowId'] @OperatorName = params['OperatorName'] @CreateOrganizationName = params['CreateOrganizationName'] @FlowName = params['FlowName'] @FlowStatus = params['FlowStatus'] @QuotaType = params['QuotaType'] @UseCount = params['UseCount'] @CostTime = params['CostTime'] @QuotaName = params['QuotaName'] @CostType = params['CostType'] @Remark = params['Remark'] end end # ChannelCancelFlow请求参数结构体 class ChannelCancelFlowRequest < TencentCloud::Common::AbstractModel # @param FlowId: 要撤销的合同流程ID # @type FlowId: String # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param CancelMessage: 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。 # @type CancelMessage: String # @param CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式: # **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同 # **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同 # **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同 # **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同 # 注: `CancelMessage为撤销当前合同的理由` # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png) # @type CancelMessageFormat: Integer # @param Operator: 暂未开放 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :FlowId, :Agent, :CancelMessage, :CancelMessageFormat, :Operator extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(flowid=nil, agent=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil) @FlowId = flowid @Agent = agent @CancelMessage = cancelmessage @CancelMessageFormat = cancelmessageformat @Operator = operator end def deserialize(params) @FlowId = params['FlowId'] unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @CancelMessage = params['CancelMessage'] @CancelMessageFormat = params['CancelMessageFormat'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end 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 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param QrCodeId: 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回 # @type QrCodeId: String # @param Operator: 暂未开放 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :Agent, :QrCodeId, :Operator extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(agent=nil, qrcodeid=nil, operator=nil) @Agent = agent @QrCodeId = qrcodeid @Operator = operator end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @QrCodeId = params['QrCodeId'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end end end # ChannelCancelMultiFlowSignQRCode返回参数结构体 class ChannelCancelMultiFlowSignQRCodeResponse < 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 # ChannelCancelUserAutoSignEnableUrl请求参数结构体 class ChannelCancelUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 渠道应用相关信息 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param Operator: 操作人信息 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param SceneKey: 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方 # @type SceneKey: String # @param UserInfo: 指定撤销链接的用户信息,包含姓名、证件类型、证件号码。 # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor` attr_accessor :Agent, :Operator, :SceneKey, :UserInfo def initialize(agent=nil, operator=nil, scenekey=nil, userinfo=nil) @Agent = agent @Operator = operator @SceneKey = scenekey @UserInfo = userinfo 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 @SceneKey = params['SceneKey'] unless params['UserInfo'].nil? @UserInfo = UserThreeFactor.new @UserInfo.deserialize(params['UserInfo']) end end end # ChannelCancelUserAutoSignEnableUrl返回参数结构体 class ChannelCancelUserAutoSignEnableUrlResponse < 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 # ChannelCreateBatchCancelFlowUrl请求参数结构体 class ChannelCreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @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 extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 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链接, 需要在手机端打开, 有效期24小时 # @type BatchCancelFlowUrl: String # @param FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因 # @type FailMessages: Array # @param UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效 # @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 # ChannelCreateBatchQuickSignUrl请求参数结构体 class ChannelCreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel # @param FlowIds: 批量签署的合同流程ID数组。 # 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。` # @type FlowIds: Array # @param FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 # 注: # `1. ApproverType目前只支持个人类型的签署人。` # `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。` # `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。` # @type FlowApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverInfo` # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议) # @type JumpUrl: String # @param SignatureTypes: 指定批量签署合同的签名类型,可传递以下值: # # 注: # # @type SignatureTypes: Array # @param ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值: # # 注: # # @type ApproverSignTypes: Array attr_accessor :FlowIds, :FlowApproverInfo, :Agent, :JumpUrl, :SignatureTypes, :ApproverSignTypes def initialize(flowids=nil, flowapproverinfo=nil, agent=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil) @FlowIds = flowids @FlowApproverInfo = flowapproverinfo @Agent = agent @JumpUrl = jumpurl @SignatureTypes = signaturetypes @ApproverSignTypes = approversigntypes end def deserialize(params) @FlowIds = params['FlowIds'] unless params['FlowApproverInfo'].nil? @FlowApproverInfo = FlowApproverInfo.new @FlowApproverInfo.deserialize(params['FlowApproverInfo']) end unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @JumpUrl = params['JumpUrl'] @SignatureTypes = params['SignatureTypes'] @ApproverSignTypes = params['ApproverSignTypes'] end end # ChannelCreateBatchQuickSignUrl返回参数结构体 class ChannelCreateBatchQuickSignUrlResponse < TencentCloud::Common::AbstractModel # @param FlowApproverUrlInfo: 签署人签署链接信息 # @type FlowApproverUrlInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverUrlInfo` # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :FlowApproverUrlInfo, :RequestId def initialize(flowapproverurlinfo=nil, requestid=nil) @FlowApproverUrlInfo = flowapproverurlinfo @RequestId = requestid end def deserialize(params) unless params['FlowApproverUrlInfo'].nil? @FlowApproverUrlInfo = FlowApproverUrlInfo.new @FlowApproverUrlInfo.deserialize(params['FlowApproverUrlInfo']) end @RequestId = params['RequestId'] end end # ChannelCreateBatchSignUrl请求参数结构体 class ChannelCreateBatchSignUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param Name: 签署方经办人的姓名。 # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。 # 注:`请确保和合同中填入的一致` # @type Name: String # @param Mobile: 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 # 请确认手机号所有方为此业务通知方。 # 注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息` # @type Mobile: String # @param Operator: 执行本接口操作的员工信息。 # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。` # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param IdCardType: 证件类型,支持以下类型 # # 注:`请确保和合同中填入的一致` # @type IdCardType: String # @param IdCardNumber: 证件号码,应符合以下规则 # # 注:`请确保和合同中填入的一致` # @type IdCardNumber: String # @param NotifyType: 通知用户方式: # # @type NotifyType: String # @param FlowIds: 本次需要批量签署的合同流程ID列表。 # 可以不传, 如不传则是发给对方的所有待签署合同流程。 # @type FlowIds: Array # @param OrganizationName: 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。 # 注: # # @type OrganizationName: String # @param JumpToDetail: 是否直接跳转至合同内容页面进行签署 # # @type JumpToDetail: Boolean attr_accessor :Agent, :Name, :Mobile, :Operator, :IdCardType, :IdCardNumber, :NotifyType, :FlowIds, :OrganizationName, :JumpToDetail def initialize(agent=nil, name=nil, mobile=nil, operator=nil, idcardtype=nil, idcardnumber=nil, notifytype=nil, flowids=nil, organizationname=nil, jumptodetail=nil) @Agent = agent @Name = name @Mobile = mobile @Operator = operator @IdCardType = idcardtype @IdCardNumber = idcardnumber @NotifyType = notifytype @FlowIds = flowids @OrganizationName = organizationname @JumpToDetail = jumptodetail end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @Name = params['Name'] @Mobile = params['Mobile'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end @IdCardType = params['IdCardType'] @IdCardNumber = params['IdCardNumber'] @NotifyType = params['NotifyType'] @FlowIds = params['FlowIds'] @OrganizationName = params['OrganizationName'] @JumpToDetail = params['JumpToDetail'] end end # ChannelCreateBatchSignUrl返回参数结构体 class ChannelCreateBatchSignUrlResponse < TencentCloud::Common::AbstractModel # @param SignUrl: 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。 # 注: `非小程序和APP集成使用` # @type SignUrl: String # @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。 # @type ExpiredTime: Integer # @param MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径 # 注: `小程序和APP集成使用` # @type MiniAppPath: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :SignUrl, :ExpiredTime, :MiniAppPath, :RequestId def initialize(signurl=nil, expiredtime=nil, miniapppath=nil, requestid=nil) @SignUrl = signurl @ExpiredTime = expiredtime @MiniAppPath = miniapppath @RequestId = requestid end def deserialize(params) @SignUrl = params['SignUrl'] @ExpiredTime = params['ExpiredTime'] @MiniAppPath = params['MiniAppPath'] @RequestId = params['RequestId'] end end # ChannelCreateBoundFlows请求参数结构体 class ChannelCreateBoundFlowsRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理 # @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 extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 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 # ChannelCreateBoundFlows返回参数结构体 class ChannelCreateBoundFlowsResponse < 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 # ChannelCreateConvertTaskApi请求参数结构体 class ChannelCreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param ResourceType: 需要进行转换的资源文件类型 # 支持的文件类型如下: # # @type ResourceType: String # @param ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。 # 注: `资源名称长度限制为256个字符` # @type ResourceName: String # @param ResourceId: 需要进行转换操作的文件资源Id,通过UploadFiles接口获取文件资源Id。 # 注: `目前,此接口仅支持单个文件进行转换。` # @type ResourceId: String # @param Operator: 调用方用户信息,不用传 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param Organization: 暂未开放 # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo` attr_accessor :Agent, :ResourceType, :ResourceName, :ResourceId, :Operator, :Organization extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 deprecate :Organization, :none, 2023, 11 deprecate :Organization=, :none, 2023, 11 def initialize(agent=nil, resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, organization=nil) @Agent = agent @ResourceType = resourcetype @ResourceName = resourcename @ResourceId = resourceid @Operator = operator @Organization = organization end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @ResourceType = params['ResourceType'] @ResourceName = params['ResourceName'] @ResourceId = params['ResourceId'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end unless params['Organization'].nil? @Organization = OrganizationInfo.new @Organization.deserialize(params['Organization']) end end end # ChannelCreateConvertTaskApi返回参数结构体 class ChannelCreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel # @param TaskId: 接口返回的文件转换任务Id,可以调用接口查询转换任务状态获取转换任务的状态和转换后的文件资源Id。 # @type TaskId: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :TaskId, :RequestId def initialize(taskid=nil, requestid=nil) @TaskId = taskid @RequestId = requestid end def deserialize(params) @TaskId = params['TaskId'] @RequestId = params['RequestId'] end end # ChannelCreateEmbedWebUrl请求参数结构体 class ChannelCreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param EmbedType: 要生成WEB嵌入界面的类型, 可以选择的值如下: # - CREATE_SEAL: 生成创建印章的嵌入页面 # - CREATE_TEMPLATE:生成创建模板的嵌入页面 # - MODIFY_TEMPLATE:生成修改模板的嵌入页面 # - PREVIEW_TEMPLATE:生成预览模板的嵌入页面 # - PREVIEW_FLOW:生成预览合同文档的嵌入页面 # - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面 # - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面 # - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面 # - EXTEND_SERVICE:生成扩展服务的嵌入页面 # @type EmbedType: String # @param BusinessId: WEB嵌入的业务资源ID # - 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId # - 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId # - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId # @type BusinessId: String # @param HiddenComponents: 是否隐藏控件,只有预览模板时生效 # @type HiddenComponents: Boolean # @param Operator: 渠道操作者信息 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil) @Agent = agent @EmbedType = embedtype @BusinessId = businessid @HiddenComponents = hiddencomponents @Operator = operator end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @EmbedType = params['EmbedType'] @BusinessId = params['BusinessId'] @HiddenComponents = params['HiddenComponents'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end end end # ChannelCreateEmbedWebUrl返回参数结构体 class ChannelCreateEmbedWebUrlResponse < TencentCloud::Common::AbstractModel # @param WebUrl: 嵌入的web链接 # @type WebUrl: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :WebUrl, :RequestId def initialize(weburl=nil, requestid=nil) @WebUrl = weburl @RequestId = requestid end def deserialize(params) @WebUrl = params['WebUrl'] @RequestId = params['RequestId'] end end # ChannelCreateFlowApprovers请求参数结构体 class ChannelCreateFlowApproversRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowId: 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 # @type FlowId: String # @param Approvers: 补充企业签署人信息。 # - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId; # - 如果不指定,则使用姓名和手机号进行补充。 # @type Approvers: Array # @param Operator: 操作人信息 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param FillApproverType: 签署人信息补充方式 # # @type FillApproverType: Integer attr_accessor :Agent, :FlowId, :Approvers, :Operator, :FillApproverType def initialize(agent=nil, flowid=nil, approvers=nil, operator=nil, fillapprovertype=nil) @Agent = agent @FlowId = flowid @Approvers = approvers @Operator = operator @FillApproverType = fillapprovertype end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @FlowId = params['FlowId'] unless params['Approvers'].nil? @Approvers = [] params['Approvers'].each do |i| fillapproverinfo_tmp = FillApproverInfo.new fillapproverinfo_tmp.deserialize(i) @Approvers << fillapproverinfo_tmp end end unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end @FillApproverType = params['FillApproverType'] end end # ChannelCreateFlowApprovers返回参数结构体 class ChannelCreateFlowApproversResponse < TencentCloud::Common::AbstractModel # @param FillError: 批量补充签署人时,补充失败的报错说明 # 注:`目前仅补充动态签署人时会返回补充失败的原因` # 注意:此字段可能返回 null,表示取不到有效值。 # @type FillError: Array # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :FillError, :RequestId def initialize(fillerror=nil, requestid=nil) @FillError = fillerror @RequestId = requestid end def deserialize(params) unless params['FillError'].nil? @FillError = [] params['FillError'].each do |i| fillerror_tmp = FillError.new fillerror_tmp.deserialize(i) @FillError << fillerror_tmp end end @RequestId = params['RequestId'] end end # ChannelCreateFlowByFiles请求参数结构体 class ChannelCreateFlowByFilesRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 # @type FlowName: String # @param FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。 # @type FlowDescription: String # @param FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的FlowApproverInfo结构体。 # 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。 # @type FlowApprovers: Array # @param FileIds: 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。 # 注: `目前,此接口仅支持单个文件发起。` # @type FileIds: Array # @param Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体 # # @type Components: Array # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。 # 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。 # @type Deadline: Integer # @param CallbackUrl: 执行结果的回调URL,长度不超过255个字符,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。 # 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。 # 回调的相关说明可参考开发者中心的回调通知模块。 # 注: # `如果不传递回调地址, 则默认是配置应用号时候使用的回调地址` # @type CallbackUrl: String # @param Unordered: 合同流程的签署顺序类型: # # **注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序` # @type Unordered: Boolean # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为255个字符,仅限中文、字母、数字和下划线组成。 # @type FlowType: String # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量: # # 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。 # 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子 # 合同名称:租房合同 # 发起方:腾讯公司(张三) # 签署方:李四 # @type CustomShowMap: String # @param CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1000长度。 # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 # @type CustomerData: String # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下: # # 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 # # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同` # @type NeedSignReview: Boolean # @param ApproverVerifyType: 签署人校验方式 # VerifyCheck: 人脸识别(默认) # MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) # 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。 # @type ApproverVerifyType: String # @param SignBeanTag: 签署方签署控件(印章/签名等)的生成方式: # # **注**: `发起后添加控件功能不支持添加签批控件` # @type SignBeanTag: Integer # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。 # @type CcInfos: Array # @param CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容: # # @type CcNotifyType: Integer # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: # # 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。` # @type AutoSignScene: String # @param Operator: 操作者的信息,不用传 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :Agent, :FlowName, :FlowDescription, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :CcInfos, :CcNotifyType, :AutoSignScene, :Operator extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(agent=nil, flowname=nil, flowdescription=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil) @Agent = agent @FlowName = flowname @FlowDescription = flowdescription @FlowApprovers = flowapprovers @FileIds = fileids @Components = components @Deadline = deadline @CallbackUrl = callbackurl @Unordered = unordered @FlowType = flowtype @CustomShowMap = customshowmap @CustomerData = customerdata @NeedSignReview = needsignreview @ApproverVerifyType = approververifytype @SignBeanTag = signbeantag @CcInfos = ccinfos @CcNotifyType = ccnotifytype @AutoSignScene = autosignscene @Operator = operator end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @FlowName = params['FlowName'] @FlowDescription = params['FlowDescription'] unless params['FlowApprovers'].nil? @FlowApprovers = [] params['FlowApprovers'].each do |i| flowapproverinfo_tmp = FlowApproverInfo.new flowapproverinfo_tmp.deserialize(i) @FlowApprovers << flowapproverinfo_tmp end end @FileIds = params['FileIds'] unless params['Components'].nil? @Components = [] params['Components'].each do |i| component_tmp = Component.new component_tmp.deserialize(i) @Components << component_tmp end end @Deadline = params['Deadline'] @CallbackUrl = params['CallbackUrl'] @Unordered = params['Unordered'] @FlowType = params['FlowType'] @CustomShowMap = params['CustomShowMap'] @CustomerData = params['CustomerData'] @NeedSignReview = params['NeedSignReview'] @ApproverVerifyType = params['ApproverVerifyType'] @SignBeanTag = params['SignBeanTag'] unless params['CcInfos'].nil? @CcInfos = [] params['CcInfos'].each do |i| ccinfo_tmp = CcInfo.new ccinfo_tmp.deserialize(i) @CcInfos << ccinfo_tmp end end @CcNotifyType = params['CcNotifyType'] @AutoSignScene = params['AutoSignScene'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end end end # ChannelCreateFlowByFiles返回参数结构体 class ChannelCreateFlowByFilesResponse < TencentCloud::Common::AbstractModel # @param FlowId: 合同流程ID,为32位字符串。 # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type FlowId: String # @param Approvers: 签署方信息,如角色ID、角色名称等 # 注意:此字段可能返回 null,表示取不到有效值。 # @type Approvers: Array # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :FlowId, :Approvers, :RequestId def initialize(flowid=nil, approvers=nil, requestid=nil) @FlowId = flowid @Approvers = approvers @RequestId = requestid end def deserialize(params) @FlowId = params['FlowId'] unless params['Approvers'].nil? @Approvers = [] params['Approvers'].each do |i| approveritem_tmp = ApproverItem.new approveritem_tmp.deserialize(i) @Approvers << approveritem_tmp end end @RequestId = params['RequestId'] end end # ChannelCreateFlowGroupByFiles请求参数结构体 class ChannelCreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel # @param FlowFileInfos: 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。 # @type FlowFileInfos: Array # @param FlowGroupName: 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 # @type FlowGroupName: String # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param ApproverVerifyType: 合同组中签署人校验和认证的方式: # # 注意: # `1. MobileCheck 方式,未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同(但签署合同时仍然需要人脸实名),企业签署方需经过人脸认证。` # `2. 合同组的校验和认证的方式会优先使用,会覆盖合同组中单个合同和合同签署方认证方式的限制配置。` # @type ApproverVerifyType: String # @param FlowGroupOptions: 合同组的签署配置项信息,例如在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。 # @type FlowGroupOptions: :class:`Tencentcloud::Essbasic.v20210526.models.FlowGroupOptions` # @param Operator: 操作者的信息,此参数不用传 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :FlowFileInfos, :FlowGroupName, :Agent, :ApproverVerifyType, :FlowGroupOptions, :Operator extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(flowfileinfos=nil, flowgroupname=nil, agent=nil, approververifytype=nil, flowgroupoptions=nil, operator=nil) @FlowFileInfos = flowfileinfos @FlowGroupName = flowgroupname @Agent = agent @ApproverVerifyType = approververifytype @FlowGroupOptions = flowgroupoptions @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 @ApproverVerifyType = params['ApproverVerifyType'] unless params['FlowGroupOptions'].nil? @FlowGroupOptions = FlowGroupOptions.new @FlowGroupOptions.deserialize(params['FlowGroupOptions']) end unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end end end # ChannelCreateFlowGroupByFiles返回参数结构体 class ChannelCreateFlowGroupByFilesResponse < TencentCloud::Common::AbstractModel # @param FlowGroupId: 合同组ID,为32位字符串。 # 建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。 # 注意:此字段可能返回 null,表示取不到有效值。 # @type FlowGroupId: String # @param FlowIds: 合同组中每个合同流程ID,每个ID均为32位字符串。 # 注: # `此数组的顺序和入参中的FlowGroupInfos顺序一致` # 注意:此字段可能返回 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 # ChannelCreateFlowGroupByTemplates请求参数结构体 class ChannelCreateFlowGroupByTemplatesRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowInfos: 合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。 # @type FlowInfos: Array # @param FlowGroupName: 合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 # @type FlowGroupName: String attr_accessor :Agent, :FlowInfos, :FlowGroupName def initialize(agent=nil, flowinfos=nil, flowgroupname=nil) @Agent = agent @FlowInfos = flowinfos @FlowGroupName = flowgroupname end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end unless params['FlowInfos'].nil? @FlowInfos = [] params['FlowInfos'].each do |i| flowinfo_tmp = FlowInfo.new flowinfo_tmp.deserialize(i) @FlowInfos << flowinfo_tmp end end @FlowGroupName = params['FlowGroupName'] end end # ChannelCreateFlowGroupByTemplates返回参数结构体 class ChannelCreateFlowGroupByTemplatesResponse < TencentCloud::Common::AbstractModel # @param FlowGroupId: 合同组ID,为32位字符串。 # 建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。 # @type FlowGroupId: String # @param FlowIds: 合同组中每个合同流程ID,每个ID均为32位字符串。 # 注: # `此数组的顺序和入参中的FlowInfos顺序一致` # @type FlowIds: Array # @param TaskInfos: 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组; # 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情; # @type TaskInfos: Array # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :FlowGroupId, :FlowIds, :TaskInfos, :RequestId def initialize(flowgroupid=nil, flowids=nil, taskinfos=nil, requestid=nil) @FlowGroupId = flowgroupid @FlowIds = flowids @TaskInfos = taskinfos @RequestId = requestid end def deserialize(params) @FlowGroupId = params['FlowGroupId'] @FlowIds = params['FlowIds'] unless params['TaskInfos'].nil? @TaskInfos = [] params['TaskInfos'].each do |i| taskinfo_tmp = TaskInfo.new taskinfo_tmp.deserialize(i) @TaskInfos << taskinfo_tmp end end @RequestId = params['RequestId'] end end # ChannelCreateFlowReminds请求参数结构体 class ChannelCreateFlowRemindsRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowIds: 需执行催办的合同流程ID数组,最多支持100个。 # @type FlowIds: Array attr_accessor :Agent, :FlowIds def initialize(agent=nil, flowids=nil) @Agent = agent @FlowIds = flowids end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @FlowIds = params['FlowIds'] end end # ChannelCreateFlowReminds返回参数结构体 class ChannelCreateFlowRemindsResponse < TencentCloud::Common::AbstractModel # @param RemindFlowRecords: 合同催办结果的详细信息列表。 # @type RemindFlowRecords: Array # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :RemindFlowRecords, :RequestId def initialize(remindflowrecords=nil, requestid=nil) @RemindFlowRecords = remindflowrecords @RequestId = requestid end def deserialize(params) unless params['RemindFlowRecords'].nil? @RemindFlowRecords = [] params['RemindFlowRecords'].each do |i| remindflowrecords_tmp = RemindFlowRecords.new remindflowrecords_tmp.deserialize(i) @RemindFlowRecords << remindflowrecords_tmp end end @RequestId = params['RequestId'] end end # ChannelCreateFlowSignReview请求参数结构体 class ChannelCreateFlowSignReviewRequest < TencentCloud::Common::AbstractModel # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowId: 签署流程编号 # @type FlowId: String # @param ReviewType: 企业内部审核结果 # PASS: 通过 # REJECT: 拒绝 # SIGN_REJECT:拒签(流程结束) # @type ReviewType: String # @param ReviewMessage: 审核原因 # 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200 # @type ReviewMessage: String # @param RecipientId: 签署节点审核时需要指定,给个人审核时必填。 # @type RecipientId: String # @param OperateType: 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核 # 注:接口通过该字段区分操作类型 # 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程 # 若想使用发起审核,请指定该字段为:CreateReview # 若发起个人审核,则指定该字段为:SignReview # @type OperateType: String attr_accessor :Agent, :FlowId, :ReviewType, :ReviewMessage, :RecipientId, :OperateType def initialize(agent=nil, flowid=nil, reviewtype=nil, reviewmessage=nil, recipientid=nil, operatetype=nil) @Agent = agent @FlowId = flowid @ReviewType = reviewtype @ReviewMessage = reviewmessage @RecipientId = recipientid @OperateType = operatetype end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @FlowId = params['FlowId'] @ReviewType = params['ReviewType'] @ReviewMessage = params['ReviewMessage'] @RecipientId = params['RecipientId'] @OperateType = params['OperateType'] end end # ChannelCreateFlowSignReview返回参数结构体 class ChannelCreateFlowSignReviewResponse < 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 # ChannelCreateFlowSignUrl请求参数结构体 class ChannelCreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowId: 合同流程ID,为32位字符串。 # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 # @type FlowId: String # @param FlowApproverInfos: 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。 # 注: # `1. ApproverType目前只支持个人(PERSON)类型的签署人。` # `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。` # @type FlowApproverInfos: Array # @param Operator: 用户信息,暂未开放 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param Organization: 机构信息,暂未开放 # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo` # @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议) # @type JumpUrl: String attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 deprecate :Organization, :none, 2023, 11 deprecate :Organization=, :none, 2023, 11 def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil) @Agent = agent @FlowId = flowid @FlowApproverInfos = flowapproverinfos @Operator = operator @Organization = organization @JumpUrl = jumpurl end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @FlowId = params['FlowId'] unless params['FlowApproverInfos'].nil? @FlowApproverInfos = [] params['FlowApproverInfos'].each do |i| flowapproverinfo_tmp = FlowApproverInfo.new flowapproverinfo_tmp.deserialize(i) @FlowApproverInfos << flowapproverinfo_tmp end end unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end unless params['Organization'].nil? @Organization = OrganizationInfo.new @Organization.deserialize(params['Organization']) end @JumpUrl = params['JumpUrl'] end end # ChannelCreateFlowSignUrl返回参数结构体 class ChannelCreateFlowSignUrlResponse < TencentCloud::Common::AbstractModel # @param FlowApproverUrlInfos: 签署人签署链接信息 # @type FlowApproverUrlInfos: Array # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :FlowApproverUrlInfos, :RequestId def initialize(flowapproverurlinfos=nil, requestid=nil) @FlowApproverUrlInfos = flowapproverurlinfos @RequestId = requestid end def deserialize(params) unless params['FlowApproverUrlInfos'].nil? @FlowApproverUrlInfos = [] params['FlowApproverUrlInfos'].each do |i| flowapproverurlinfo_tmp = FlowApproverUrlInfo.new flowapproverurlinfo_tmp.deserialize(i) @FlowApproverUrlInfos << flowapproverurlinfo_tmp end end @RequestId = params['RequestId'] end end # ChannelCreateMultiFlowSignQRCode请求参数结构体 class ChannelCreateMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param TemplateId: 合同模板ID,为32位字符串。 # @type TemplateId: String # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。 # @type FlowName: String # @param MaxFlowNum: 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。 一旦发起流程数超越该限制,该二维码将自动失效。 # @type MaxFlowNum: Integer # @param FlowEffectiveDay: 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。 # @type FlowEffectiveDay: Integer # @param QrEffectiveDay: 二维码的有效期限,默认为7天,最高设定不得超过90天。 一旦超过二维码的有效期限,该二维码将自动失效。 # @type QrEffectiveDay: Integer # @param Restrictions: 指定签署人信息。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。 # @type Restrictions: Array # @param ApproverComponentLimitTypes: 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。 # @type ApproverComponentLimitTypes: Array # @param CallbackUrl: 已废弃,回调配置统一使用企业应用管理-应用集成-第三方应用中的配置 #
通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign #
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83 # @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, :Restrictions, :ApproverComponentLimitTypes, :CallbackUrl, :ApproverRestrictions, :Operator extend Gem::Deprecate deprecate :CallbackUrl, :none, 2023, 11 deprecate :CallbackUrl=, :none, 2023, 11 deprecate :ApproverRestrictions, :none, 2023, 11 deprecate :ApproverRestrictions=, :none, 2023, 11 deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, approvercomponentlimittypes=nil, callbackurl=nil, approverrestrictions=nil, operator=nil) @Agent = agent @TemplateId = templateid @FlowName = flowname @MaxFlowNum = maxflownum @FlowEffectiveDay = floweffectiveday @QrEffectiveDay = qreffectiveday @Restrictions = restrictions @ApproverComponentLimitTypes = approvercomponentlimittypes @CallbackUrl = callbackurl @ApproverRestrictions = approverrestrictions @Operator = operator end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @TemplateId = params['TemplateId'] @FlowName = params['FlowName'] @MaxFlowNum = params['MaxFlowNum'] @FlowEffectiveDay = params['FlowEffectiveDay'] @QrEffectiveDay = params['QrEffectiveDay'] unless params['Restrictions'].nil? @Restrictions = [] params['Restrictions'].each do |i| approverrestriction_tmp = ApproverRestriction.new approverrestriction_tmp.deserialize(i) @Restrictions << approverrestriction_tmp end end unless params['ApproverComponentLimitTypes'].nil? @ApproverComponentLimitTypes = [] params['ApproverComponentLimitTypes'].each do |i| approvercomponentlimittype_tmp = ApproverComponentLimitType.new approvercomponentlimittype_tmp.deserialize(i) @ApproverComponentLimitTypes << approvercomponentlimittype_tmp end end @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']) end end end # ChannelCreateMultiFlowSignQRCode返回参数结构体 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, :SignUrls, :RequestId def initialize(qrcode=nil, signurls=nil, requestid=nil) @QrCode = qrcode @SignUrls = signurls @RequestId = requestid end def deserialize(params) unless params['QrCode'].nil? @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 # ChannelCreateOrganizationBatchSignUrl请求参数结构体 class ChannelCreateOrganizationBatchSignUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。 # @type FlowIds: Array # @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。 # @type OpenId: String # @param Name: 签署方经办人的姓名。 # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。 # 注:`请确保和合同中填入的一致` # @type Name: String # @param Mobile: 员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。 # @type Mobile: String attr_accessor :Agent, :FlowIds, :OpenId, :Name, :Mobile def initialize(agent=nil, flowids=nil, openid=nil, name=nil, mobile=nil) @Agent = agent @FlowIds = flowids @OpenId = openid @Name = name @Mobile = mobile end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @FlowIds = params['FlowIds'] @OpenId = params['OpenId'] @Name = params['Name'] @Mobile = params['Mobile'] end end # ChannelCreateOrganizationBatchSignUrl返回参数结构体 class ChannelCreateOrganizationBatchSignUrlResponse < TencentCloud::Common::AbstractModel # @param SignUrl: 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。 # @type SignUrl: String # @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。 # @type ExpiredTime: Integer # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :SignUrl, :ExpiredTime, :RequestId def initialize(signurl=nil, expiredtime=nil, requestid=nil) @SignUrl = signurl @ExpiredTime = expiredtime @RequestId = requestid end def deserialize(params) @SignUrl = params['SignUrl'] @ExpiredTime = params['ExpiredTime'] @RequestId = params['RequestId'] end end # ChannelCreateOrganizationModifyQrCode请求参数结构体 class ChannelCreateOrganizationModifyQrCodeRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # 渠道应用标识: Agent.AppId # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` attr_accessor :Agent def initialize(agent=nil) @Agent = agent end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end end end # ChannelCreateOrganizationModifyQrCode返回参数结构体 class ChannelCreateOrganizationModifyQrCodeResponse < 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 # ChannelCreatePrepareFlow请求参数结构体 class ChannelCreatePrepareFlowRequest < TencentCloud::Common::AbstractModel # @param ResourceId: 资源id,与ResourceType对应 # @type ResourceId: String # @param ResourceType: 资源类型,与ResourceId对应1:模板 2: 文件 # @type ResourceType: Integer # @param FlowInfo: 合同流程基础信息 # @type FlowInfo: :class:`Tencentcloud::Essbasic.v20210526.models.BaseFlowInfo` # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param FlowOption: 合同流程配置信息,用于配置发起合同时定制化 # @type FlowOption: :class:`Tencentcloud::Essbasic.v20210526.models.CreateFlowOption` # @param FlowApproverList: 合同签署人信息 # @type FlowApproverList: Array # @param FlowId: 通过flowid快速获得之前成功通过页面发起的合同生成链接 # @type FlowId: String # @param NeedPreview: 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL # @type NeedPreview: Boolean # @param Organization: 企业机构信息,不用传 # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo` # @param Operator: 操作人(用户)信息,不用传 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` attr_accessor :ResourceId, :ResourceType, :FlowInfo, :Agent, :FlowOption, :FlowApproverList, :FlowId, :NeedPreview, :Organization, :Operator extend Gem::Deprecate deprecate :NeedPreview, :none, 2023, 11 deprecate :NeedPreview=, :none, 2023, 11 deprecate :Organization, :none, 2023, 11 deprecate :Organization=, :none, 2023, 11 deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, agent=nil, flowoption=nil, flowapproverlist=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil) @ResourceId = resourceid @ResourceType = resourcetype @FlowInfo = flowinfo @Agent = agent @FlowOption = flowoption @FlowApproverList = flowapproverlist @FlowId = flowid @NeedPreview = needpreview @Organization = organization @Operator = operator end def deserialize(params) @ResourceId = params['ResourceId'] @ResourceType = params['ResourceType'] unless params['FlowInfo'].nil? @FlowInfo = BaseFlowInfo.new @FlowInfo.deserialize(params['FlowInfo']) end unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end unless params['FlowOption'].nil? @FlowOption = CreateFlowOption.new @FlowOption.deserialize(params['FlowOption']) end unless params['FlowApproverList'].nil? @FlowApproverList = [] params['FlowApproverList'].each do |i| commonflowapprover_tmp = CommonFlowApprover.new commonflowapprover_tmp.deserialize(i) @FlowApproverList << commonflowapprover_tmp end end @FlowId = params['FlowId'] @NeedPreview = params['NeedPreview'] unless params['Organization'].nil? @Organization = OrganizationInfo.new @Organization.deserialize(params['Organization']) end unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end end end # ChannelCreatePrepareFlow返回参数结构体 class ChannelCreatePrepareFlowResponse < TencentCloud::Common::AbstractModel # @param PrepareFlowUrl: 预发起的合同链接, 可以直接点击进入进行合同发起 # @type PrepareFlowUrl: String # @param PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果 # @type PreviewFlowUrl: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :PrepareFlowUrl, :PreviewFlowUrl, :RequestId def initialize(prepareflowurl=nil, previewflowurl=nil, requestid=nil) @PrepareFlowUrl = prepareflowurl @PreviewFlowUrl = previewflowurl @RequestId = requestid end def deserialize(params) @PrepareFlowUrl = params['PrepareFlowUrl'] @PreviewFlowUrl = params['PreviewFlowUrl'] @RequestId = params['RequestId'] end end # ChannelCreatePreparedPersonalEsign请求参数结构体 class ChannelCreatePreparedPersonalEsignRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param UserName: 个人用户姓名 # @type UserName: String # @param IdCardNumber: 证件号码, 应符合以下规则 # # @type IdCardNumber: String # @param SealName: 电子印章名字,1-50个中文字符 # 注:`同一企业下电子印章名字不能相同` # @type SealName: String # @param SealImage: 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。 # @type SealImage: String # @param Operator: 执行本接口操作的员工信息。 # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。` # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param IdCardType: 证件类型,支持以下类型 # # 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。` # @type IdCardType: String # @param SealImageCompress: 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。 # @type SealImageCompress: Boolean # @param Mobile: 手机号码;当需要开通自动签时,该参数必传 # @type Mobile: String # @param EnableAutoSign: 是否开通自动签,该功能需联系运营工作人员开通后使用 # @type EnableAutoSign: Boolean # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减 # @type LicenseType: Integer attr_accessor :Agent, :UserName, :IdCardNumber, :SealName, :SealImage, :Operator, :IdCardType, :SealImageCompress, :Mobile, :EnableAutoSign, :LicenseType def initialize(agent=nil, username=nil, idcardnumber=nil, sealname=nil, sealimage=nil, operator=nil, idcardtype=nil, sealimagecompress=nil, mobile=nil, enableautosign=nil, licensetype=nil) @Agent = agent @UserName = username @IdCardNumber = idcardnumber @SealName = sealname @SealImage = sealimage @Operator = operator @IdCardType = idcardtype @SealImageCompress = sealimagecompress @Mobile = mobile @EnableAutoSign = enableautosign @LicenseType = licensetype end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @UserName = params['UserName'] @IdCardNumber = params['IdCardNumber'] @SealName = params['SealName'] @SealImage = params['SealImage'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end @IdCardType = params['IdCardType'] @SealImageCompress = params['SealImageCompress'] @Mobile = params['Mobile'] @EnableAutoSign = params['EnableAutoSign'] @LicenseType = params['LicenseType'] end end # ChannelCreatePreparedPersonalEsign返回参数结构体 class ChannelCreatePreparedPersonalEsignResponse < TencentCloud::Common::AbstractModel # @param SealId: 电子印章ID,为32位字符串。 # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。 # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。 # @type SealId: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :SealId, :RequestId def initialize(sealid=nil, requestid=nil) @SealId = sealid @RequestId = requestid end def deserialize(params) @SealId = params['SealId'] @RequestId = params['RequestId'] end end # ChannelCreateReleaseFlow请求参数结构体 class ChannelCreateReleaseFlowRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。 # @type NeedRelievedFlowId: String # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。 # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo` # @param ReleasedApprovers: 指定解除协议的签署人,如不指定,则默认使用原流程的签署人。
# 如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口DescribeFlowDetailInfo查询签署人的ApproverNumber编号,默认从0开始,顺序递增)
# 注意: # # @type ReleasedApprovers: Array # @param CallbackUrl: 签署完回调url,最大长度1000个字符 # @type CallbackUrl: String # @param Organization: 暂未开放 # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo` # @param Operator: 暂未开放 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。 # 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。 # @type Deadline: Integer # @param UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。 # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。 # 回调的相关说明可参考开发者中心的回调通知模块。 # @type UserData: String attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline, :UserData extend Gem::Deprecate deprecate :CallbackUrl, :none, 2023, 11 deprecate :CallbackUrl=, :none, 2023, 11 deprecate :Organization, :none, 2023, 11 deprecate :Organization=, :none, 2023, 11 deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil, userdata=nil) @Agent = agent @NeedRelievedFlowId = needrelievedflowid @ReliveInfo = reliveinfo @ReleasedApprovers = releasedapprovers @CallbackUrl = callbackurl @Organization = organization @Operator = operator @Deadline = deadline @UserData = userdata end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @NeedRelievedFlowId = params['NeedRelievedFlowId'] unless params['ReliveInfo'].nil? @ReliveInfo = RelieveInfo.new @ReliveInfo.deserialize(params['ReliveInfo']) end unless params['ReleasedApprovers'].nil? @ReleasedApprovers = [] params['ReleasedApprovers'].each do |i| releasedapprover_tmp = ReleasedApprover.new releasedapprover_tmp.deserialize(i) @ReleasedApprovers << releasedapprover_tmp end end @CallbackUrl = params['CallbackUrl'] unless params['Organization'].nil? @Organization = OrganizationInfo.new @Organization.deserialize(params['Organization']) end unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end @Deadline = params['Deadline'] @UserData = params['UserData'] end end # ChannelCreateReleaseFlow返回参数结构体 class ChannelCreateReleaseFlowResponse < TencentCloud::Common::AbstractModel # @param FlowId: 解除协议流程编号 # @type FlowId: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :FlowId, :RequestId def initialize(flowid=nil, requestid=nil) @FlowId = flowid @RequestId = requestid end def deserialize(params) @FlowId = params['FlowId'] @RequestId = params['RequestId'] end end # ChannelCreateRole请求参数结构体 class ChannelCreateRoleRequest < TencentCloud::Common::AbstractModel # @param Name: 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。 # @type Name: String # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # # 第三方平台子客企业和员工必须已经经过实名认证 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param Description: 角色描述,最大长度为50个字符 # @type Description: String # @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出 # @type PermissionGroups: Array attr_accessor :Name, :Agent, :Description, :PermissionGroups def initialize(name=nil, agent=nil, description=nil, permissiongroups=nil) @Name = name @Agent = agent @Description = description @PermissionGroups = permissiongroups end def deserialize(params) @Name = params['Name'] unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @Description = params['Description'] unless params['PermissionGroups'].nil? @PermissionGroups = [] params['PermissionGroups'].each do |i| permissiongroup_tmp = PermissionGroup.new permissiongroup_tmp.deserialize(i) @PermissionGroups << permissiongroup_tmp end end end end # ChannelCreateRole返回参数结构体 class ChannelCreateRoleResponse < TencentCloud::Common::AbstractModel # @param RoleId: 角色id # @type RoleId: String # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :RoleId, :RequestId def initialize(roleid=nil, requestid=nil) @RoleId = roleid @RequestId = requestid end def deserialize(params) @RoleId = params['RoleId'] @RequestId = params['RequestId'] end end # ChannelCreateSealPolicy请求参数结构体 class ChannelCreateSealPolicyRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # 此接口下面信息必填。 # 渠道应用标识: Agent.AppId # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId # 第三方平台子客企业和员工必须已经经过实名认证。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param SealId: 电子印章ID,为32位字符串。 # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。 # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。 # @type SealId: String # @param UserIds: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。 # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。 # 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 # 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。 # 指定待授权的用户ID数组,电子签的用户ID # 可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。 # @type UserIds: Array # @param Operator: 操作人(用户)信息,不用传 # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param Organization: 企业机构信息,不用传 # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo` attr_accessor :Agent, :SealId, :UserIds, :Operator, :Organization extend Gem::Deprecate deprecate :Operator, :none, 2023, 11 deprecate :Operator=, :none, 2023, 11 deprecate :Organization, :none, 2023, 11 deprecate :Organization=, :none, 2023, 11 def initialize(agent=nil, sealid=nil, userids=nil, operator=nil, organization=nil) @Agent = agent @SealId = sealid @UserIds = userids @Operator = operator @Organization = organization end def deserialize(params) unless params['Agent'].nil? @Agent = Agent.new @Agent.deserialize(params['Agent']) end @SealId = params['SealId'] @UserIds = params['UserIds'] unless params['Operator'].nil? @Operator = UserInfo.new @Operator.deserialize(params['Operator']) end unless params['Organization'].nil? @Organization = OrganizationInfo.new @Organization.deserialize(params['Organization']) end end end # ChannelCreateSealPolicy返回参数结构体 class ChannelCreateSealPolicyResponse < TencentCloud::Common::AbstractModel # @param UserIds: 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。 # 请求参数填写OpenId时,返回授权成功的 Openid。 # @type UserIds: Array # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :UserIds, :RequestId def initialize(userids=nil, requestid=nil) @UserIds = userids @RequestId = requestid end def deserialize(params) @UserIds = params['UserIds'] @RequestId = params['RequestId'] end end # ChannelCreateUserAutoSignEnableUrl请求参数结构体 class ChannelCreateUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent` # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下: # # 注: `现在仅支持电子处方场景` # @type SceneKey: String # @param Operator: 执行本接口操作的员工信息。 # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。` # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo` # @param AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等 # @type AutoSignConfig: :class:`Tencentcloud::Essbasic.v20210526.models.AutoSignConfig` # @param UrlType: 生成的链接类型: # # @type UrlType: String # @param NotifyType: 是否通知开通方,通知类型: #