# -*- coding: utf8 -*-
# Copyright (c) 2017-2021 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.
import warnings
from tencentcloud.common.abstract_model import AbstractModel
class Agent(AbstractModel):
"""应用相关信息, 整体应用的层级图如下
注:
1. `不同的业务系统可以采用不同的应用，不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`
"""
def __init__(self):
r"""
:param _AppId: 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
:type AppId: str
:param _ProxyOrganizationOpenId: 第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串
:type ProxyOrganizationOpenId: str
:param _ProxyOperator: 第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。
:type ProxyOperator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ProxyAppId: **不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
:type ProxyAppId: str
:param _ProxyOrganizationId: 内部参数，暂未开放使用
:type ProxyOrganizationId: str
"""
self._AppId = None
self._ProxyOrganizationOpenId = None
self._ProxyOperator = None
self._ProxyAppId = None
self._ProxyOrganizationId = None
@property
def AppId(self):
"""应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId，不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
:rtype: str
"""
return self._AppId
@AppId.setter
def AppId(self, AppId):
self._AppId = AppId
@property
def ProxyOrganizationOpenId(self):
"""第三方应用平台自定义，对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的，不可更改，不可重复使用。（例如，可以使用企业名称的hash值，或者社会统一信用代码的hash值，或者随机hash值，需要第三方应用平台保存），最大64位字符串
:rtype: str
"""
return self._ProxyOrganizationOpenId
@ProxyOrganizationOpenId.setter
def ProxyOrganizationOpenId(self, ProxyOrganizationOpenId):
self._ProxyOrganizationOpenId = ProxyOrganizationOpenId
@property
def ProxyOperator(self):
"""第三方平台子客企业中的员工/经办人，通过第三方应用平台进入电子签完成实名、且被赋予相关权限后，可以参与到企业资源的管理或签署流程中。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._ProxyOperator
@ProxyOperator.setter
def ProxyOperator(self, ProxyOperator):
self._ProxyOperator = ProxyOperator
@property
def ProxyAppId(self):
"""**不用填写**，在第三方平台子客企业开通电子签后，会生成唯一的子客应用Id（ProxyAppId）用于代理调用时的鉴权，在子客开通的回调中获取。
:rtype: str
"""
return self._ProxyAppId
@ProxyAppId.setter
def ProxyAppId(self, ProxyAppId):
self._ProxyAppId = ProxyAppId
@property
def ProxyOrganizationId(self):
warnings.warn("parameter `ProxyOrganizationId` is deprecated", DeprecationWarning)
"""内部参数，暂未开放使用
:rtype: str
"""
return self._ProxyOrganizationId
@ProxyOrganizationId.setter
def ProxyOrganizationId(self, ProxyOrganizationId):
warnings.warn("parameter `ProxyOrganizationId` is deprecated", DeprecationWarning)
self._ProxyOrganizationId = ProxyOrganizationId
def _deserialize(self, params):
self._AppId = params.get("AppId")
self._ProxyOrganizationOpenId = params.get("ProxyOrganizationOpenId")
if params.get("ProxyOperator") is not None:
self._ProxyOperator = UserInfo()
self._ProxyOperator._deserialize(params.get("ProxyOperator"))
self._ProxyAppId = params.get("ProxyAppId")
self._ProxyOrganizationId = params.get("ProxyOrganizationId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ApproverComponentLimitType(AbstractModel):
"""指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
"""
def __init__(self):
r"""
:param _RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
:type RecipientId: str
:param _Values: 签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
签名方式：
<ul>
<li>HANDWRITE-手写签名</li>
<li>ESIGN-个人印章类型</li>
<li>OCR_ESIGN-AI智能识别手写签名</li>
<li>SYSTEM_ESIGN-系统签名</li>
</ul>
:type Values: list of str
"""
self._RecipientId = None
self._Values = None
@property
def RecipientId(self):
"""签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def Values(self):
"""签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
签名方式：
<ul>
<li>HANDWRITE-手写签名</li>
<li>ESIGN-个人印章类型</li>
<li>OCR_ESIGN-AI智能识别手写签名</li>
<li>SYSTEM_ESIGN-系统签名</li>
</ul>
:rtype: list of str
"""
return self._Values
@Values.setter
def Values(self, Values):
self._Values = Values
def _deserialize(self, params):
self._RecipientId = params.get("RecipientId")
self._Values = params.get("Values")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ApproverItem(AbstractModel):
"""签署方信息，发起合同后可获取到对应的签署方信息，如角色ID，角色名称
"""
def __init__(self):
r"""
:param _SignId: 签署方唯一编号
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下，可以用此编号确定参与方
:type SignId: str
:param _RecipientId: 签署方角色编号
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下，可以用此编号确定参与方
:type RecipientId: str
:param _ApproverRoleName: 签署方角色名称
:type ApproverRoleName: str
"""
self._SignId = None
self._RecipientId = None
self._ApproverRoleName = None
@property
def SignId(self):
"""签署方唯一编号
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下，可以用此编号确定参与方
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def RecipientId(self):
"""签署方角色编号
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下，可以用此编号确定参与方
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def ApproverRoleName(self):
"""签署方角色名称
:rtype: str
"""
return self._ApproverRoleName
@ApproverRoleName.setter
def ApproverRoleName(self, ApproverRoleName):
self._ApproverRoleName = ApproverRoleName
def _deserialize(self, params):
self._SignId = params.get("SignId")
self._RecipientId = params.get("RecipientId")
self._ApproverRoleName = params.get("ApproverRoleName")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ApproverOption(AbstractModel):
"""签署人个性化能力信息
"""
def __init__(self):
r"""
:param _NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
:type NoRefuse: bool
:param _NoTransfer: 是否可以转发 默认false-可以转发 true-不可以转发
:type NoTransfer: bool
:param _HideOneKeySign: 当签署方有多个签署区时候，是否隐藏一键所有的签署区
false：（默认）不隐藏
true：隐藏，每个签署区要单独选择印章或者签名
:type HideOneKeySign: bool
:param _FillType: 签署人信息补充类型，默认无需补充。
<ul><li> **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
注：
`使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
:type FillType: int
:param _FlowReadLimit: 签署人阅读合同限制参数
<br/>取值：
<ul>
<li> LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底</li>
<li> LimitReadTime，阅读合同仅限制阅读时长</li>
<li> LimitBottom，阅读合同仅限制必须阅读到底</li>
<li> NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）</li>
</ul>
:type FlowReadLimit: str
:param _ForbidAddSignDate: 禁止在签署过程中添加签署日期控件
<br/>前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）：
<ul>
<li> 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件</li>
<li> 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件</li>
</ul>
:type ForbidAddSignDate: bool
"""
self._NoRefuse = None
self._NoTransfer = None
self._HideOneKeySign = None
self._FillType = None
self._FlowReadLimit = None
self._ForbidAddSignDate = None
@property
def NoRefuse(self):
"""是否可以拒签 默认false-可以拒签 true-不可以拒签
:rtype: bool
"""
return self._NoRefuse
@NoRefuse.setter
def NoRefuse(self, NoRefuse):
self._NoRefuse = NoRefuse
@property
def NoTransfer(self):
"""是否可以转发 默认false-可以转发 true-不可以转发
:rtype: bool
"""
return self._NoTransfer
@NoTransfer.setter
def NoTransfer(self, NoTransfer):
self._NoTransfer = NoTransfer
@property
def HideOneKeySign(self):
"""当签署方有多个签署区时候，是否隐藏一键所有的签署区
false：（默认）不隐藏
true：隐藏，每个签署区要单独选择印章或者签名
:rtype: bool
"""
return self._HideOneKeySign
@HideOneKeySign.setter
def HideOneKeySign(self, HideOneKeySign):
self._HideOneKeySign = HideOneKeySign
@property
def FillType(self):
"""签署人信息补充类型，默认无需补充。
<ul><li> **1** : 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
注：
`使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
:rtype: int
"""
return self._FillType
@FillType.setter
def FillType(self, FillType):
self._FillType = FillType
@property
def FlowReadLimit(self):
"""签署人阅读合同限制参数
<br/>取值：
<ul>
<li> LimitReadTimeAndBottom，阅读合同必须限制阅读时长并且必须阅读到底</li>
<li> LimitReadTime，阅读合同仅限制阅读时长</li>
<li> LimitBottom，阅读合同仅限制必须阅读到底</li>
<li> NoReadTimeAndBottom，阅读合同不限制阅读时长且不限制阅读到底（白名单功能，请联系客户经理开白使用）</li>
</ul>
:rtype: str
"""
return self._FlowReadLimit
@FlowReadLimit.setter
def FlowReadLimit(self, FlowReadLimit):
self._FlowReadLimit = FlowReadLimit
@property
def ForbidAddSignDate(self):
"""禁止在签署过程中添加签署日期控件
<br/>前置条件：文件发起合同时，指定SignBeanTag=1（可以在签署过程中添加签署控件）：
<ul>
<li> 默认值：false，在开启：签署过程中添加签署控件时，添加签署控件会默认自带签署日期控件</li>
<li> 可选值：true，在开启：签署过程中添加签署控件时，添加签署控件不会自带签署日期控件</li>
</ul>
:rtype: bool
"""
return self._ForbidAddSignDate
@ForbidAddSignDate.setter
def ForbidAddSignDate(self, ForbidAddSignDate):
self._ForbidAddSignDate = ForbidAddSignDate
def _deserialize(self, params):
self._NoRefuse = params.get("NoRefuse")
self._NoTransfer = params.get("NoTransfer")
self._HideOneKeySign = params.get("HideOneKeySign")
self._FillType = params.get("FillType")
self._FlowReadLimit = params.get("FlowReadLimit")
self._ForbidAddSignDate = params.get("ForbidAddSignDate")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ApproverRestriction(AbstractModel):
"""指定签署人限制项
"""
def __init__(self):
r"""
:param _Name: 指定签署人姓名
:type Name: str
:param _Mobile: 指定签署人手机号，11位数字
:type Mobile: str
:param _IdCardType: 指定签署人证件类型，ID_CARD-身份证，HONGKONG_AND_MACAO-港澳居民来往内地通行证，HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证
:type IdCardType: str
:param _IdCardNumber: 指定签署人证件号码，其中字母大写
:type IdCardNumber: str
"""
self._Name = None
self._Mobile = None
self._IdCardType = None
self._IdCardNumber = None
@property
def Name(self):
"""指定签署人姓名
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Mobile(self):
"""指定签署人手机号，11位数字
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def IdCardType(self):
"""指定签署人证件类型，ID_CARD-身份证，HONGKONG_AND_MACAO-港澳居民来往内地通行证，HONGKONG_MACAO_AND_TAIWAN-港澳台居民居住证
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""指定签署人证件号码，其中字母大写
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
def _deserialize(self, params):
self._Name = params.get("Name")
self._Mobile = params.get("Mobile")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ArchiveDynamicFlowRequest(AbstractModel):
"""ArchiveDynamicFlow请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 合同流程ID
:type FlowId: str
"""
self._Agent = None
self._FlowId = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""合同流程ID
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ArchiveDynamicFlowResponse(AbstractModel):
"""ArchiveDynamicFlow返回参数结构体
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID
:type FlowId: str
:param _Approvers: 动态签署人的参与人信息
:type Approvers: list of ChannelArchiveDynamicApproverData
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowId = None
self._Approvers = None
self._RequestId = None
@property
def FlowId(self):
"""合同流程ID
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Approvers(self):
"""动态签署人的参与人信息
:rtype: list of ChannelArchiveDynamicApproverData
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = ChannelArchiveDynamicApproverData()
obj._deserialize(item)
self._Approvers.append(obj)
self._RequestId = params.get("RequestId")
class AuthFailMessage(AbstractModel):
"""授权出错信息
"""
def __init__(self):
r"""
:param _ProxyOrganizationOpenId: 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
:type ProxyOrganizationOpenId: str
:param _Message: 错误信息
:type Message: str
"""
self._ProxyOrganizationOpenId = None
self._Message = None
@property
def ProxyOrganizationOpenId(self):
"""第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
:rtype: str
"""
return self._ProxyOrganizationOpenId
@ProxyOrganizationOpenId.setter
def ProxyOrganizationOpenId(self, ProxyOrganizationOpenId):
self._ProxyOrganizationOpenId = ProxyOrganizationOpenId
@property
def Message(self):
"""错误信息
:rtype: str
"""
return self._Message
@Message.setter
def Message(self, Message):
self._Message = Message
def _deserialize(self, params):
self._ProxyOrganizationOpenId = params.get("ProxyOrganizationOpenId")
self._Message = params.get("Message")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class AuthInfoDetail(AbstractModel):
"""企业扩展服务授权列表详情
"""
def __init__(self):
r"""
:param _Type: 扩展服务类型，和入参一致
:type Type: str
:param _Name: 扩展服务名称
:type Name: str
:param _HasAuthUserList: 授权员工列表
:type HasAuthUserList: list of HasAuthUser
:param _HasAuthOrganizationList: 授权企业列表（企业自动签时，该字段有值）
:type HasAuthOrganizationList: list of HasAuthOrganization
:param _AuthUserTotal: 授权员工列表总数
:type AuthUserTotal: int
:param _AuthOrganizationTotal: 授权企业列表总数
:type AuthOrganizationTotal: int
"""
self._Type = None
self._Name = None
self._HasAuthUserList = None
self._HasAuthOrganizationList = None
self._AuthUserTotal = None
self._AuthOrganizationTotal = None
@property
def Type(self):
"""扩展服务类型，和入参一致
:rtype: str
"""
return self._Type
@Type.setter
def Type(self, Type):
self._Type = Type
@property
def Name(self):
"""扩展服务名称
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def HasAuthUserList(self):
"""授权员工列表
:rtype: list of HasAuthUser
"""
return self._HasAuthUserList
@HasAuthUserList.setter
def HasAuthUserList(self, HasAuthUserList):
self._HasAuthUserList = HasAuthUserList
@property
def HasAuthOrganizationList(self):
"""授权企业列表（企业自动签时，该字段有值）
:rtype: list of HasAuthOrganization
"""
return self._HasAuthOrganizationList
@HasAuthOrganizationList.setter
def HasAuthOrganizationList(self, HasAuthOrganizationList):
self._HasAuthOrganizationList = HasAuthOrganizationList
@property
def AuthUserTotal(self):
"""授权员工列表总数
:rtype: int
"""
return self._AuthUserTotal
@AuthUserTotal.setter
def AuthUserTotal(self, AuthUserTotal):
self._AuthUserTotal = AuthUserTotal
@property
def AuthOrganizationTotal(self):
"""授权企业列表总数
:rtype: int
"""
return self._AuthOrganizationTotal
@AuthOrganizationTotal.setter
def AuthOrganizationTotal(self, AuthOrganizationTotal):
self._AuthOrganizationTotal = AuthOrganizationTotal
def _deserialize(self, params):
self._Type = params.get("Type")
self._Name = params.get("Name")
if params.get("HasAuthUserList") is not None:
self._HasAuthUserList = []
for item in params.get("HasAuthUserList"):
obj = HasAuthUser()
obj._deserialize(item)
self._HasAuthUserList.append(obj)
if params.get("HasAuthOrganizationList") is not None:
self._HasAuthOrganizationList = []
for item in params.get("HasAuthOrganizationList"):
obj = HasAuthOrganization()
obj._deserialize(item)
self._HasAuthOrganizationList.append(obj)
self._AuthUserTotal = params.get("AuthUserTotal")
self._AuthOrganizationTotal = params.get("AuthOrganizationTotal")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class AuthorizedUser(AbstractModel):
"""授权用户
"""
def __init__(self):
r"""
:param _OpenId: 第三方应用平台的用户openid
:type OpenId: str
"""
self._OpenId = None
@property
def OpenId(self):
"""第三方应用平台的用户openid
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
def _deserialize(self, params):
self._OpenId = params.get("OpenId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class AutoSignConfig(AbstractModel):
"""自动签开启、签署相关配置
"""
def __init__(self):
r"""
:param _UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
:param _CertInfoCallback: 是否回调证书信息:
<ul><li>**false**: 不需要(默认)</li>
<li>**true**:需要</li></ul>
:type CertInfoCallback: bool
:param _UserDefineSeal: 是否支持用户自定义签名印章:
<ul><li>**false**: 不能自己定义(默认)</li>
<li>**true**: 可以自己定义</li></ul>
:type UserDefineSeal: bool
:param _SealImgCallback: 回调中是否需要自动签将要使用的印章（签名）图片的 base64:
<ul><li>**false**: 不需要(默认)</li>
<li>**true**: 需要</li></ul>
:type SealImgCallback: bool
:param _CallbackUrl: 该字段已废弃，请使用【应用号配置】中的回调地址统一接口消息
:type CallbackUrl: str
:param _VerifyChannels: 开通时候的身份验证方式, 取值为：
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
<li>**INSIGHT** : 慧眼人脸认别</li>
<li>**TELECOM** : 运营商三要素验证</li></ul>
注：
<ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
<li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
:type VerifyChannels: list of str
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
<ul><li><b>1</b>: (默认)不绑定自动签账号许可开通，开通后一直有效, 后续使用合同份额进行合同发起</li></ul>
:type LicenseType: int
:param _JumpUrl: 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
跳转场景：
<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
成功结果返回：
若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如：qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
:type JumpUrl: str
"""
self._UserInfo = None
self._CertInfoCallback = None
self._UserDefineSeal = None
self._SealImgCallback = None
self._CallbackUrl = None
self._VerifyChannels = None
self._LicenseType = None
self._JumpUrl = None
@property
def UserInfo(self):
"""自动签开通个人用户信息, 包括名字,身份证等
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
return self._UserInfo
@UserInfo.setter
def UserInfo(self, UserInfo):
self._UserInfo = UserInfo
@property
def CertInfoCallback(self):
"""是否回调证书信息:
<ul><li>**false**: 不需要(默认)</li>
<li>**true**:需要</li></ul>
:rtype: bool
"""
return self._CertInfoCallback
@CertInfoCallback.setter
def CertInfoCallback(self, CertInfoCallback):
self._CertInfoCallback = CertInfoCallback
@property
def UserDefineSeal(self):
"""是否支持用户自定义签名印章:
<ul><li>**false**: 不能自己定义(默认)</li>
<li>**true**: 可以自己定义</li></ul>
:rtype: bool
"""
return self._UserDefineSeal
@UserDefineSeal.setter
def UserDefineSeal(self, UserDefineSeal):
self._UserDefineSeal = UserDefineSeal
@property
def SealImgCallback(self):
"""回调中是否需要自动签将要使用的印章（签名）图片的 base64:
<ul><li>**false**: 不需要(默认)</li>
<li>**true**: 需要</li></ul>
:rtype: bool
"""
return self._SealImgCallback
@SealImgCallback.setter
def SealImgCallback(self, SealImgCallback):
self._SealImgCallback = SealImgCallback
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""该字段已废弃，请使用【应用号配置】中的回调地址统一接口消息
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def VerifyChannels(self):
"""开通时候的身份验证方式, 取值为：
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
<li>**INSIGHT** : 慧眼人脸认别</li>
<li>**TELECOM** : 运营商三要素验证</li></ul>
注：
<ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
<li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
:rtype: list of str
"""
return self._VerifyChannels
@VerifyChannels.setter
def VerifyChannels(self, VerifyChannels):
self._VerifyChannels = VerifyChannels
@property
def LicenseType(self):
"""设置用户开通自动签时是否绑定个人自动签账号许可。
<ul><li><b>1</b>: (默认)不绑定自动签账号许可开通，开通后一直有效, 后续使用合同份额进行合同发起</li></ul>
:rtype: int
"""
return self._LicenseType
@LicenseType.setter
def LicenseType(self, LicenseType):
self._LicenseType = LicenseType
@property
def JumpUrl(self):
"""开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
跳转场景：
<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
成功结果返回：
若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如：qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
:rtype: str
"""
return self._JumpUrl
@JumpUrl.setter
def JumpUrl(self, JumpUrl):
self._JumpUrl = JumpUrl
def _deserialize(self, params):
if params.get("UserInfo") is not None:
self._UserInfo = UserThreeFactor()
self._UserInfo._deserialize(params.get("UserInfo"))
self._CertInfoCallback = params.get("CertInfoCallback")
self._UserDefineSeal = params.get("UserDefineSeal")
self._SealImgCallback = params.get("SealImgCallback")
self._CallbackUrl = params.get("CallbackUrl")
self._VerifyChannels = params.get("VerifyChannels")
self._LicenseType = params.get("LicenseType")
self._JumpUrl = params.get("JumpUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class BaseFlowInfo(AbstractModel):
"""基础流程信息
"""
def __init__(self):
r"""
:param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:type FlowName: str
:param _Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
:type Deadline: int
:param _FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
:type FlowType: str
:param _FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
:type FlowDescription: str
:param _Unordered: 合同流程的签署顺序类型：
**false**：(默认)有序签署, 本合同多个参与人需要依次签署
**true**：无序签署, 本合同多个参与人没有先后签署限制
:type Unordered: bool
:param _IntelligentStatus: 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
:type IntelligentStatus: str
:param _FormFields: 填写控件内容， 填写的控制的ID-填写的内容对列表
:type FormFields: list of FormField
:param _NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
:type NeedSignReview: bool
:param _UserData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
:type UserData: str
:param _CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
:type CcInfos: list of CcInfo
:param _NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
:type NeedCreateReview: bool
:param _Components: 填写控件：文件发起使用
:type Components: list of Component
:param _FlowDisplayType: 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:type FlowDisplayType: int
"""
self._FlowName = None
self._Deadline = None
self._FlowType = None
self._FlowDescription = None
self._Unordered = None
self._IntelligentStatus = None
self._FormFields = None
self._NeedSignReview = None
self._UserData = None
self._CcInfos = None
self._NeedCreateReview = None
self._Components = None
self._FlowDisplayType = None
@property
def FlowName(self):
"""合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def Deadline(self):
"""合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def FlowType(self):
"""合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowType
@FlowType.setter
def FlowType(self, FlowType):
self._FlowType = FlowType
@property
def FlowDescription(self):
"""合同流程描述信息(可自定义此描述)，最大长度1000个字符。
:rtype: str
"""
return self._FlowDescription
@FlowDescription.setter
def FlowDescription(self, FlowDescription):
self._FlowDescription = FlowDescription
@property
def Unordered(self):
"""合同流程的签署顺序类型：
**false**：(默认)有序签署, 本合同多个参与人需要依次签署
**true**：无序签署, 本合同多个参与人没有先后签署限制
:rtype: bool
"""
return self._Unordered
@Unordered.setter
def Unordered(self, Unordered):
self._Unordered = Unordered
@property
def IntelligentStatus(self):
"""是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
:rtype: str
"""
return self._IntelligentStatus
@IntelligentStatus.setter
def IntelligentStatus(self, IntelligentStatus):
self._IntelligentStatus = IntelligentStatus
@property
def FormFields(self):
"""填写控件内容， 填写的控制的ID-填写的内容对列表
:rtype: list of FormField
"""
return self._FormFields
@FormFields.setter
def FormFields(self, FormFields):
self._FormFields = FormFields
@property
def NeedSignReview(self):
"""发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
:rtype: bool
"""
return self._NeedSignReview
@NeedSignReview.setter
def NeedSignReview(self, NeedSignReview):
self._NeedSignReview = NeedSignReview
@property
def UserData(self):
"""调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
:rtype: str
"""
return self._UserData
@UserData.setter
def UserData(self, UserData):
self._UserData = UserData
@property
def CcInfos(self):
"""合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
注
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
:rtype: list of CcInfo
"""
return self._CcInfos
@CcInfos.setter
def CcInfos(self, CcInfos):
self._CcInfos = CcInfos
@property
def NeedCreateReview(self):
"""发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签，审核通过后，发起方企业签署人方可进行发起操作，否则会阻塞其发起操作。
:rtype: bool
"""
return self._NeedCreateReview
@NeedCreateReview.setter
def NeedCreateReview(self, NeedCreateReview):
self._NeedCreateReview = NeedCreateReview
@property
def Components(self):
"""填写控件：文件发起使用
:rtype: list of Component
"""
return self._Components
@Components.setter
def Components(self, Components):
self._Components = Components
@property
def FlowDisplayType(self):
"""在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:rtype: int
"""
return self._FlowDisplayType
@FlowDisplayType.setter
def FlowDisplayType(self, FlowDisplayType):
self._FlowDisplayType = FlowDisplayType
def _deserialize(self, params):
self._FlowName = params.get("FlowName")
self._Deadline = params.get("Deadline")
self._FlowType = params.get("FlowType")
self._FlowDescription = params.get("FlowDescription")
self._Unordered = params.get("Unordered")
self._IntelligentStatus = params.get("IntelligentStatus")
if params.get("FormFields") is not None:
self._FormFields = []
for item in params.get("FormFields"):
obj = FormField()
obj._deserialize(item)
self._FormFields.append(obj)
self._NeedSignReview = params.get("NeedSignReview")
self._UserData = params.get("UserData")
if params.get("CcInfos") is not None:
self._CcInfos = []
for item in params.get("CcInfos"):
obj = CcInfo()
obj._deserialize(item)
self._CcInfos.append(obj)
self._NeedCreateReview = params.get("NeedCreateReview")
if params.get("Components") is not None:
self._Components = []
for item in params.get("Components"):
obj = Component()
obj._deserialize(item)
self._Components.append(obj)
self._FlowDisplayType = params.get("FlowDisplayType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CancelFailureFlow(AbstractModel):
"""撤销失败的流程信息
"""
def __init__(self):
r"""
:param _FlowId: 签署流程编号，为32位字符串
:type FlowId: str
:param _Reason: 撤销失败原因
:type Reason: str
"""
self._FlowId = None
self._Reason = None
@property
def FlowId(self):
"""签署流程编号，为32位字符串
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Reason(self):
"""撤销失败原因
:rtype: str
"""
return self._Reason
@Reason.setter
def Reason(self, Reason):
self._Reason = Reason
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._Reason = params.get("Reason")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CcInfo(AbstractModel):
"""抄送信息
"""
def __init__(self):
r"""
:param _Mobile: 被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
:type Mobile: str
:param _Name: 被抄送方姓名。
抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。
:type Name: str
:param _CcType: 被抄送方类型, 可设置以下类型:
<ul><li> **0** :个人抄送方</li>
<li> **1** :企业员工抄送方</li></ul>
:type CcType: int
:param _CcPermission: 被抄送方权限, 可设置如下权限:
<ul><li> **0** :可查看合同内容</li>
<li> **1** :可查看合同内容也可下载原文</li></ul>
:type CcPermission: int
"""
self._Mobile = None
self._Name = None
self._CcType = None
self._CcPermission = None
@property
def Mobile(self):
"""被抄送方手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def Name(self):
"""被抄送方姓名。
抄送方的姓名将用于身份认证，请确保填写的姓名为抄送方的真实姓名，而非昵称等代名。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def CcType(self):
"""被抄送方类型, 可设置以下类型:
<ul><li> **0** :个人抄送方</li>
<li> **1** :企业员工抄送方</li></ul>
:rtype: int
"""
return self._CcType
@CcType.setter
def CcType(self, CcType):
self._CcType = CcType
@property
def CcPermission(self):
"""被抄送方权限, 可设置如下权限:
<ul><li> **0** :可查看合同内容</li>
<li> **1** :可查看合同内容也可下载原文</li></ul>
:rtype: int
"""
return self._CcPermission
@CcPermission.setter
def CcPermission(self, CcPermission):
self._CcPermission = CcPermission
def _deserialize(self, params):
self._Mobile = params.get("Mobile")
self._Name = params.get("Name")
self._CcType = params.get("CcType")
self._CcPermission = params.get("CcPermission")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelArchiveDynamicApproverData(AbstractModel):
"""动态签署2.0合同参与人信息
"""
def __init__(self):
r"""
:param _SignId: 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。 可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。
:type SignId: str
:param _RecipientId: 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。 填写控件和签署控件都与特定的角色编号关联。
:type RecipientId: str
"""
self._SignId = None
self._RecipientId = None
@property
def SignId(self):
"""签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。 可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def RecipientId(self):
"""签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。 填写控件和签署控件都与特定的角色编号关联。
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
def _deserialize(self, params):
self._SignId = params.get("SignId")
self._RecipientId = params.get("RecipientId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelBatchCancelFlowsRequest(AbstractModel):
"""ChannelBatchCancelFlows请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 要撤销的合同流程ID列表，最多100个，超过100不处理
:type FlowIds: list of str
:param _CancelMessage: 撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
备注:`如果不传递撤回原因，那么默认撤回原因是 "自动撤销（通过接口实现）"`
:type CancelMessage: str
:param _CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式：
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
注: `CancelMessage为撤销当前合同的理由`
:type CancelMessageFormat: int
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowIds = None
self._CancelMessage = None
self._CancelMessageFormat = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""要撤销的合同流程ID列表，最多100个，超过100不处理
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def CancelMessage(self):
"""撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
备注:`如果不传递撤回原因，那么默认撤回原因是 "自动撤销（通过接口实现）"`
:rtype: str
"""
return self._CancelMessage
@CancelMessage.setter
def CancelMessage(self, CancelMessage):
self._CancelMessage = CancelMessage
@property
def CancelMessageFormat(self):
"""撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式：
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
注: `CancelMessage为撤销当前合同的理由`
:rtype: int
"""
return self._CancelMessageFormat
@CancelMessageFormat.setter
def CancelMessageFormat(self, CancelMessageFormat):
self._CancelMessageFormat = CancelMessageFormat
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
self._CancelMessage = params.get("CancelMessage")
self._CancelMessageFormat = params.get("CancelMessageFormat")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelBatchCancelFlowsResponse(AbstractModel):
"""ChannelBatchCancelFlows返回参数结构体
"""
def __init__(self):
r"""
:param _FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
注: `如果全部撤销成功, 此数组为空数组`
:type FailMessages: list of str
:param _TaskId: 批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
:type TaskId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FailMessages = None
self._TaskId = None
self._RequestId = None
@property
def FailMessages(self):
"""签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
注: `如果全部撤销成功, 此数组为空数组`
:rtype: list of str
"""
return self._FailMessages
@FailMessages.setter
def FailMessages(self, FailMessages):
self._FailMessages = FailMessages
@property
def TaskId(self):
"""批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FailMessages = params.get("FailMessages")
self._TaskId = params.get("TaskId")
self._RequestId = params.get("RequestId")
class ChannelBillUsageDetail(AbstractModel):
"""用户计费使用情况详情
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。
:type FlowId: str
:param _OperatorName: 合同经办人名称
如果有多个经办人用分号隔开。
:type OperatorName: str
:param _CreateOrganizationName: 发起方组织机构名称
:type CreateOrganizationName: str
:param _FlowName: 合同流程的名称。
:type FlowName: str
:param _FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
<ul>
<li>**INIT**: 合同创建</li>
<li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
<li>**REJECT**: 合同拒签</li>
<li>**ALL**: 合同签署完成</li>
<li>**DEADLINE**: 合同流签(合同过期)</li>
<li>**CANCEL**: 合同撤回</li>
<li>**RELIEVED**: 解除协议（已解除）</li>
<li>**WILLEXPIRE**: 合同即将过期</li>
<li>**EXCEPTION**: 合同异常</li>
</ul>
:type FlowStatus: str
:param _QuotaType: 查询的套餐类型
对应关系如下:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
:type QuotaType: str
:param _UseCount: 合同使用量
注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
:type UseCount: int
:param _CostTime: 消耗的时间戳，格式为Unix标准时间戳（秒）。
:type CostTime: int
:param _QuotaName: 消耗的套餐名称
:type QuotaName: str
:param _CostType: 消耗类型
**1**.扣费
**2**.撤销返还
:type CostType: int
:param _Remark: 备注
:type Remark: str
"""
self._FlowId = None
self._OperatorName = None
self._CreateOrganizationName = None
self._FlowName = None
self._FlowStatus = None
self._QuotaType = None
self._UseCount = None
self._CostTime = None
self._QuotaName = None
self._CostType = None
self._Remark = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def OperatorName(self):
"""合同经办人名称
如果有多个经办人用分号隔开。
:rtype: str
"""
return self._OperatorName
@OperatorName.setter
def OperatorName(self, OperatorName):
self._OperatorName = OperatorName
@property
def CreateOrganizationName(self):
"""发起方组织机构名称
:rtype: str
"""
return self._CreateOrganizationName
@CreateOrganizationName.setter
def CreateOrganizationName(self, CreateOrganizationName):
self._CreateOrganizationName = CreateOrganizationName
@property
def FlowName(self):
"""合同流程的名称。
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def FlowStatus(self):
"""合同流程当前的签署状态, 会存在下列的状态值
<ul>
<li>**INIT**: 合同创建</li>
<li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
<li>**REJECT**: 合同拒签</li>
<li>**ALL**: 合同签署完成</li>
<li>**DEADLINE**: 合同流签(合同过期)</li>
<li>**CANCEL**: 合同撤回</li>
<li>**RELIEVED**: 解除协议（已解除）</li>
<li>**WILLEXPIRE**: 合同即将过期</li>
<li>**EXCEPTION**: 合同异常</li>
</ul>
:rtype: str
"""
return self._FlowStatus
@FlowStatus.setter
def FlowStatus(self, FlowStatus):
self._FlowStatus = FlowStatus
@property
def QuotaType(self):
"""查询的套餐类型
对应关系如下:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
:rtype: str
"""
return self._QuotaType
@QuotaType.setter
def QuotaType(self, QuotaType):
self._QuotaType = QuotaType
@property
def UseCount(self):
"""合同使用量
注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
:rtype: int
"""
return self._UseCount
@UseCount.setter
def UseCount(self, UseCount):
self._UseCount = UseCount
@property
def CostTime(self):
"""消耗的时间戳，格式为Unix标准时间戳（秒）。
:rtype: int
"""
return self._CostTime
@CostTime.setter
def CostTime(self, CostTime):
self._CostTime = CostTime
@property
def QuotaName(self):
"""消耗的套餐名称
:rtype: str
"""
return self._QuotaName
@QuotaName.setter
def QuotaName(self, QuotaName):
self._QuotaName = QuotaName
@property
def CostType(self):
"""消耗类型
**1**.扣费
**2**.撤销返还
:rtype: int
"""
return self._CostType
@CostType.setter
def CostType(self, CostType):
self._CostType = CostType
@property
def Remark(self):
"""备注
:rtype: str
"""
return self._Remark
@Remark.setter
def Remark(self, Remark):
self._Remark = Remark
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._OperatorName = params.get("OperatorName")
self._CreateOrganizationName = params.get("CreateOrganizationName")
self._FlowName = params.get("FlowName")
self._FlowStatus = params.get("FlowStatus")
self._QuotaType = params.get("QuotaType")
self._UseCount = params.get("UseCount")
self._CostTime = params.get("CostTime")
self._QuotaName = params.get("QuotaName")
self._CostType = params.get("CostType")
self._Remark = params.get("Remark")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCancelFlowRequest(AbstractModel):
"""ChannelCancelFlow请求参数结构体
"""
def __init__(self):
r"""
:param _FlowId: 要撤销的合同流程ID
:type FlowId: str
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _CancelMessage: 撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
:type CancelMessage: str
:param _CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式：
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
注: `CancelMessage为撤销当前合同的理由`
:type CancelMessageFormat: int
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._FlowId = None
self._Agent = None
self._CancelMessage = None
self._CancelMessageFormat = None
self._Operator = None
@property
def FlowId(self):
"""要撤销的合同流程ID
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def CancelMessage(self):
"""撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._CancelMessage
@CancelMessage.setter
def CancelMessage(self, CancelMessage):
self._CancelMessage = CancelMessage
@property
def CancelMessageFormat(self):
"""撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式：
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
注: `CancelMessage为撤销当前合同的理由`
:rtype: int
"""
return self._CancelMessageFormat
@CancelMessageFormat.setter
def CancelMessageFormat(self, CancelMessageFormat):
self._CancelMessageFormat = CancelMessageFormat
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._CancelMessage = params.get("CancelMessage")
self._CancelMessageFormat = params.get("CancelMessageFormat")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCancelFlowResponse(AbstractModel):
"""ChannelCancelFlow返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelCancelMultiFlowSignQRCodeRequest(AbstractModel):
"""ChannelCancelMultiFlowSignQRCode请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _QrCodeId: 需要取消的签署码ID，为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
:type QrCodeId: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._QrCodeId = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def QrCodeId(self):
"""需要取消的签署码ID，为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
:rtype: str
"""
return self._QrCodeId
@QrCodeId.setter
def QrCodeId(self, QrCodeId):
self._QrCodeId = QrCodeId
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._QrCodeId = params.get("QrCodeId")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCancelMultiFlowSignQRCodeResponse(AbstractModel):
"""ChannelCancelMultiFlowSignQRCode返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
"""ChannelCancelUserAutoSignEnableUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 渠道应用相关信息
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Operator: 操作人信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
:param _UserInfo: 指定撤销链接的用户信息，包含姓名、证件类型、证件号码。
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
self._Agent = None
self._Operator = None
self._SceneKey = None
self._UserInfo = None
@property
def Agent(self):
"""渠道应用相关信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Operator(self):
"""操作人信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
@property
def UserInfo(self):
"""指定撤销链接的用户信息，包含姓名、证件类型、证件号码。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
return self._UserInfo
@UserInfo.setter
def UserInfo(self, UserInfo):
self._UserInfo = UserInfo
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._SceneKey = params.get("SceneKey")
if params.get("UserInfo") is not None:
self._UserInfo = UserThreeFactor()
self._UserInfo._deserialize(params.get("UserInfo"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCancelUserAutoSignEnableUrlResponse(AbstractModel):
"""ChannelCancelUserAutoSignEnableUrl返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelCreateBatchCancelFlowUrlRequest(AbstractModel):
"""ChannelCreateBatchCancelFlowUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 要撤销的合同流程ID列表，最多100个，超过100不处理
:type FlowIds: list of str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowIds = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""要撤销的合同流程ID列表，最多100个，超过100不处理
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateBatchCancelFlowUrlResponse(AbstractModel):
"""ChannelCreateBatchCancelFlowUrl返回参数结构体
"""
def __init__(self):
r"""
:param _BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
注：<font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type BatchCancelFlowUrl: str
:param _FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
:type FailMessages: list of str
:param _UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
:type UrlExpireOn: str
:param _TaskId: 批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
:type TaskId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._BatchCancelFlowUrl = None
self._FailMessages = None
self._UrlExpireOn = None
self._TaskId = None
self._RequestId = None
@property
def BatchCancelFlowUrl(self):
"""批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
注：<font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._BatchCancelFlowUrl
@BatchCancelFlowUrl.setter
def BatchCancelFlowUrl(self, BatchCancelFlowUrl):
self._BatchCancelFlowUrl = BatchCancelFlowUrl
@property
def FailMessages(self):
"""与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
:rtype: list of str
"""
return self._FailMessages
@FailMessages.setter
def FailMessages(self, FailMessages):
self._FailMessages = FailMessages
@property
def UrlExpireOn(self):
"""签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
:rtype: str
"""
return self._UrlExpireOn
@UrlExpireOn.setter
def UrlExpireOn(self, UrlExpireOn):
self._UrlExpireOn = UrlExpireOn
@property
def TaskId(self):
"""批量撤销任务编号，为32位字符串，可用于[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._BatchCancelFlowUrl = params.get("BatchCancelFlowUrl")
self._FailMessages = params.get("FailMessages")
self._UrlExpireOn = params.get("UrlExpireOn")
self._TaskId = params.get("TaskId")
self._RequestId = params.get("RequestId")
class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
"""ChannelCreateBatchQuickSignUrl请求参数结构体
"""
def __init__(self):
r"""
:param _FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
<ul>
<li>若为个人参与方：ApproverType:"PERSON"</li>
<li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，还需要传 OpenId、OrganizationOpenId。</li>
</ul>
注:
`1. 暂不支持签署人拖动签署控件功能，以及签批控件。`
`2. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
:type FlowApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
:type FlowIds: list of str
:param _FlowGroupId: 合同组编号
注：`该参数和合同流程ID数组必须二选一`
:type FlowGroupId: str
:param _JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
:type JumpUrl: str
:param _SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：
<ul><li>**0**：手写签名(默认)</li>
<li>**1**：OCR楷体</li>
<li>**2**：姓名印章</li>
<li>**3**：图片印章</li>
<li>**4**：系统签名</li></ul>
注：
<ul><li>默认情况下，签名类型为手写签名</li>
<li>您可以传递多种值，表示可用多种签名类型。</li>
<li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li>
<li>若签署方为企业员工，此参数无效，签名方式将以合同中为准。</li>
</ul>
:type SignatureTypes: list of int
:param _ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
<ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
<li>**2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li>
<li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
注：
<ul><li>默认情况下，认证校验方式为人脸和密码认证</li>
<li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
:type ApproverSignTypes: list of int
:param _SignTypeSelector: 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
<ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li>
<li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>
注：
`不指定该值时，默认为签署方自行选择。`
:type SignTypeSelector: int
:param _FlowBatchUrlInfo: 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
注: `若签署方为企业员工，暂不支持通过H5端进行动态签署人的补充`
:type FlowBatchUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
:param _Intention: <b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。 3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
:type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
:param _CacheApproverInfo: 缓存签署人信息。在H5签署链接动态领取场景，首次填写后，选择缓存签署人信息，在下次签署人点击领取链接时，会自动将个人信息（姓名、身份证号、手机号）填入，否则需要每次手动填写。
注: `若参与方为企业员工时，暂不支持对参与方信息进行缓存`
:type CacheApproverInfo: bool
"""
self._FlowApproverInfo = None
self._Agent = None
self._FlowIds = None
self._FlowGroupId = None
self._JumpUrl = None
self._SignatureTypes = None
self._ApproverSignTypes = None
self._SignTypeSelector = None
self._FlowBatchUrlInfo = None
self._Intention = None
self._CacheApproverInfo = None
@property
def FlowApproverInfo(self):
"""批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
<ul>
<li>若为个人参与方：ApproverType:"PERSON"</li>
<li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，还需要传 OpenId、OrganizationOpenId。</li>
</ul>
注:
`1. 暂不支持签署人拖动签署控件功能，以及签批控件。`
`2. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
"""
return self._FlowApproverInfo
@FlowApproverInfo.setter
def FlowApproverInfo(self, FlowApproverInfo):
self._FlowApproverInfo = FlowApproverInfo
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def FlowGroupId(self):
"""合同组编号
注：`该参数和合同流程ID数组必须二选一`
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def JumpUrl(self):
"""签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
:rtype: str
"""
return self._JumpUrl
@JumpUrl.setter
def JumpUrl(self, JumpUrl):
self._JumpUrl = JumpUrl
@property
def SignatureTypes(self):
"""指定批量签署合同的签名类型，可传递以下值：
<ul><li>**0**：手写签名(默认)</li>
<li>**1**：OCR楷体</li>
<li>**2**：姓名印章</li>
<li>**3**：图片印章</li>
<li>**4**：系统签名</li></ul>
注：
<ul><li>默认情况下，签名类型为手写签名</li>
<li>您可以传递多种值，表示可用多种签名类型。</li>
<li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li>
<li>若签署方为企业员工，此参数无效，签名方式将以合同中为准。</li>
</ul>
:rtype: list of int
"""
return self._SignatureTypes
@SignatureTypes.setter
def SignatureTypes(self, SignatureTypes):
self._SignatureTypes = SignatureTypes
@property
def ApproverSignTypes(self):
"""指定批量签署合同的认证校验方式，可传递以下值：
<ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
<li>**2**：密码认证(默认)，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li>
<li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
注：
<ul><li>默认情况下，认证校验方式为人脸和密码认证</li>
<li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
:rtype: list of int
"""
return self._ApproverSignTypes
@ApproverSignTypes.setter
def ApproverSignTypes(self, ApproverSignTypes):
self._ApproverSignTypes = ApproverSignTypes
@property
def SignTypeSelector(self):
"""生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
<ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li>
<li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>
注：
`不指定该值时，默认为签署方自行选择。`
:rtype: int
"""
return self._SignTypeSelector
@SignTypeSelector.setter
def SignTypeSelector(self, SignTypeSelector):
self._SignTypeSelector = SignTypeSelector
@property
def FlowBatchUrlInfo(self):
"""批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
注: `若签署方为企业员工，暂不支持通过H5端进行动态签署人的补充`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
"""
return self._FlowBatchUrlInfo
@FlowBatchUrlInfo.setter
def FlowBatchUrlInfo(self, FlowBatchUrlInfo):
self._FlowBatchUrlInfo = FlowBatchUrlInfo
@property
def Intention(self):
"""<b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。 注意： 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。 3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Intention`
"""
return self._Intention
@Intention.setter
def Intention(self, Intention):
self._Intention = Intention
@property
def CacheApproverInfo(self):
"""缓存签署人信息。在H5签署链接动态领取场景，首次填写后，选择缓存签署人信息，在下次签署人点击领取链接时，会自动将个人信息（姓名、身份证号、手机号）填入，否则需要每次手动填写。
注: `若参与方为企业员工时，暂不支持对参与方信息进行缓存`
:rtype: bool
"""
return self._CacheApproverInfo
@CacheApproverInfo.setter
def CacheApproverInfo(self, CacheApproverInfo):
self._CacheApproverInfo = CacheApproverInfo
def _deserialize(self, params):
if params.get("FlowApproverInfo") is not None:
self._FlowApproverInfo = FlowApproverInfo()
self._FlowApproverInfo._deserialize(params.get("FlowApproverInfo"))
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
self._FlowGroupId = params.get("FlowGroupId")
self._JumpUrl = params.get("JumpUrl")
self._SignatureTypes = params.get("SignatureTypes")
self._ApproverSignTypes = params.get("ApproverSignTypes")
self._SignTypeSelector = params.get("SignTypeSelector")
if params.get("FlowBatchUrlInfo") is not None:
self._FlowBatchUrlInfo = FlowBatchUrlInfo()
self._FlowBatchUrlInfo._deserialize(params.get("FlowBatchUrlInfo"))
if params.get("Intention") is not None:
self._Intention = Intention()
self._Intention._deserialize(params.get("Intention"))
self._CacheApproverInfo = params.get("CacheApproverInfo")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateBatchQuickSignUrlResponse(AbstractModel):
"""ChannelCreateBatchQuickSignUrl返回参数结构体
"""
def __init__(self):
r"""
:param _FlowApproverUrlInfo: 签署人签署链接信息
:type FlowApproverUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverUrlInfo`
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowApproverUrlInfo = None
self._RequestId = None
@property
def FlowApproverUrlInfo(self):
"""签署人签署链接信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverUrlInfo`
"""
return self._FlowApproverUrlInfo
@FlowApproverUrlInfo.setter
def FlowApproverUrlInfo(self, FlowApproverUrlInfo):
self._FlowApproverUrlInfo = FlowApproverUrlInfo
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("FlowApproverUrlInfo") is not None:
self._FlowApproverUrlInfo = FlowApproverUrlInfo()
self._FlowApproverUrlInfo._deserialize(params.get("FlowApproverUrlInfo"))
self._RequestId = params.get("RequestId")
class ChannelCreateBatchSignUrlRequest(AbstractModel):
"""ChannelCreateBatchSignUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Name: 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`，`除动态签署人或子客员工经办人场景外，此参数必填`
:type Name: str
:param _Mobile: 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人或子客员工经办人场景外，此参数必填`
:type Mobile: str
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _IdCardType: 证件类型，支持以下类型
<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>
<li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>
<li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
注：`请确保和合同中填入的一致`
:type IdCardType: str
:param _IdCardNumber: 证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
注：`请确保和合同中填入的一致`
:type IdCardNumber: str
:param _NotifyType: 通知用户方式：
<ul>
<li>**NONE** : 不通知（默认）</li>
<li>**SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）</li>
</ul>
:type NotifyType: str
:param _FlowIds: 批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
:type FlowIds: list of str
:param _OrganizationName: SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份，此参数必填。
注：
<ul>
<li>请确认该名称与企业营业执照中注册的名称一致。</li>
<li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>
<li>请确保此企业已完成腾讯电子签企业认证。</li>
<li>**若为子客企业员工，请使用OpenId，OrganizationOpenId参数，此参数留空即可**</li>
</ul>
:type OrganizationName: str
:param _JumpToDetail: 是否直接跳转至合同内容页面进行签署
<ul>
<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
</ul>
:type JumpToDetail: bool
:param _FlowBatchUrlInfo: 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
:type FlowBatchUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
:param _OpenId: 第三方平台子客企业员工的标识OpenId，批签合同经办人为子客员工的情况下为必填。
注：
<ul>
<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>
<li>传递了此参数可以无需传递Name，Mobile，IdCardNumber，IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>
</ul>
:type OpenId: str
:param _OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId，批签合同经办人为子客企业员工是为必填。
:type OrganizationOpenId: str
:param _AutoJumpBack: 签署完成后是否自动回跳
<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
注:
1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
:type AutoJumpBack: bool
:param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。
参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
:type UrlUseEnv: str
"""
self._Agent = None
self._Name = None
self._Mobile = None
self._Operator = None
self._IdCardType = None
self._IdCardNumber = None
self._NotifyType = None
self._FlowIds = None
self._OrganizationName = None
self._JumpToDetail = None
self._FlowBatchUrlInfo = None
self._OpenId = None
self._OrganizationOpenId = None
self._AutoJumpBack = None
self._UrlUseEnv = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Name(self):
"""签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`，`除动态签署人或子客员工经办人场景外，此参数必填`
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Mobile(self):
"""手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
请确认手机号所有方为此业务通知方。
注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人或子客员工经办人场景外，此参数必填`
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
@property
def IdCardType(self):
"""证件类型，支持以下类型
<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>
<li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>
<li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
注：`请确保和合同中填入的一致`
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
注：`请确保和合同中填入的一致`
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def NotifyType(self):
"""通知用户方式：
<ul>
<li>**NONE** : 不通知（默认）</li>
<li>**SMS** : 短信通知（发送短信通知到Mobile参数所传的手机号）</li>
</ul>
:rtype: str
"""
return self._NotifyType
@NotifyType.setter
def NotifyType(self, NotifyType):
self._NotifyType = NotifyType
@property
def FlowIds(self):
"""批量签署的合同流程ID数组。
注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def OrganizationName(self):
"""SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份，此参数必填。
注：
<ul>
<li>请确认该名称与企业营业执照中注册的名称一致。</li>
<li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>
<li>请确保此企业已完成腾讯电子签企业认证。</li>
<li>**若为子客企业员工，请使用OpenId，OrganizationOpenId参数，此参数留空即可**</li>
</ul>
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def JumpToDetail(self):
"""是否直接跳转至合同内容页面进行签署
<ul>
<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
</ul>
:rtype: bool
"""
return self._JumpToDetail
@JumpToDetail.setter
def JumpToDetail(self, JumpToDetail):
self._JumpToDetail = JumpToDetail
@property
def FlowBatchUrlInfo(self):
"""批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
"""
return self._FlowBatchUrlInfo
@FlowBatchUrlInfo.setter
def FlowBatchUrlInfo(self, FlowBatchUrlInfo):
self._FlowBatchUrlInfo = FlowBatchUrlInfo
@property
def OpenId(self):
"""第三方平台子客企业员工的标识OpenId，批签合同经办人为子客员工的情况下为必填。
注：
<ul>
<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>
<li>传递了此参数可以无需传递Name，Mobile，IdCardNumber，IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>
</ul>
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def OrganizationOpenId(self):
"""第三方平台子客企业的企业的标识, 即OrganizationOpenId，批签合同经办人为子客企业员工是为必填。
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def AutoJumpBack(self):
"""签署完成后是否自动回跳
<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
注:
1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
:rtype: bool
"""
return self._AutoJumpBack
@AutoJumpBack.setter
def AutoJumpBack(self, AutoJumpBack):
self._AutoJumpBack = AutoJumpBack
@property
def UrlUseEnv(self):
"""<font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。
参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
:rtype: str
"""
return self._UrlUseEnv
@UrlUseEnv.setter
def UrlUseEnv(self, UrlUseEnv):
self._UrlUseEnv = UrlUseEnv
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Name = params.get("Name")
self._Mobile = params.get("Mobile")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
self._NotifyType = params.get("NotifyType")
self._FlowIds = params.get("FlowIds")
self._OrganizationName = params.get("OrganizationName")
self._JumpToDetail = params.get("JumpToDetail")
if params.get("FlowBatchUrlInfo") is not None:
self._FlowBatchUrlInfo = FlowBatchUrlInfo()
self._FlowBatchUrlInfo._deserialize(params.get("FlowBatchUrlInfo"))
self._OpenId = params.get("OpenId")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._AutoJumpBack = params.get("AutoJumpBack")
self._UrlUseEnv = params.get("UrlUseEnv")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateBatchSignUrlResponse(AbstractModel):
"""ChannelCreateBatchSignUrl返回参数结构体
"""
def __init__(self):
r"""
:param _SignUrl: 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
注:
1. 非小程序和APP集成使用
2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type SignUrl: str
:param _ExpiredTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:type ExpiredTime: int
:param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
注:
1. 小程序和APP集成使用
2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type MiniAppPath: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._SignUrl = None
self._ExpiredTime = None
self._MiniAppPath = None
self._RequestId = None
@property
def SignUrl(self):
"""批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
注:
1. 非小程序和APP集成使用
2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._SignUrl
@SignUrl.setter
def SignUrl(self, SignUrl):
self._SignUrl = SignUrl
@property
def ExpiredTime(self):
"""链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
@property
def MiniAppPath(self):
"""从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
注:
1. 小程序和APP集成使用
2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._MiniAppPath
@MiniAppPath.setter
def MiniAppPath(self, MiniAppPath):
self._MiniAppPath = MiniAppPath
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._SignUrl = params.get("SignUrl")
self._ExpiredTime = params.get("ExpiredTime")
self._MiniAppPath = params.get("MiniAppPath")
self._RequestId = params.get("RequestId")
class ChannelCreateBoundFlowsRequest(AbstractModel):
"""ChannelCreateBoundFlows请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 需要领取的合同流程的ID列表
:type FlowIds: list of str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowIds = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""需要领取的合同流程的ID列表
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateBoundFlowsResponse(AbstractModel):
"""ChannelCreateBoundFlows返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelCreateConvertTaskApiRequest(AbstractModel):
"""ChannelCreateConvertTaskApi请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ResourceType: 需要进行转换的资源文件类型
支持的文件类型如下：
<ul><li>doc</li>
<li>docx</li>
<li>xls</li>
<li>xlsx</li>
<li>jpg</li>
<li>jpeg</li>
<li>png</li>
<li>bmp</li>
<li>html</li>
<li>txt</li></ul>
:type ResourceType: str
:param _ResourceName: 需要进行转换操作的文件资源名称，带资源后缀名。
注: `资源名称长度限制为256个字符`
:type ResourceName: str
:param _ResourceId: 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
注: `目前，此接口仅支持单个文件进行转换。`
:type ResourceId: str
:param _Operator: 调用方用户信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _Organization: 暂未开放
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
self._Agent = None
self._ResourceType = None
self._ResourceName = None
self._ResourceId = None
self._Operator = None
self._Organization = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ResourceType(self):
"""需要进行转换的资源文件类型
支持的文件类型如下：
<ul><li>doc</li>
<li>docx</li>
<li>xls</li>
<li>xlsx</li>
<li>jpg</li>
<li>jpeg</li>
<li>png</li>
<li>bmp</li>
<li>html</li>
<li>txt</li></ul>
:rtype: str
"""
return self._ResourceType
@ResourceType.setter
def ResourceType(self, ResourceType):
self._ResourceType = ResourceType
@property
def ResourceName(self):
"""需要进行转换操作的文件资源名称，带资源后缀名。
注: `资源名称长度限制为256个字符`
:rtype: str
"""
return self._ResourceName
@ResourceName.setter
def ResourceName(self, ResourceName):
self._ResourceName = ResourceName
@property
def ResourceId(self):
"""需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
注: `目前，此接口仅支持单个文件进行转换。`
:rtype: str
"""
return self._ResourceId
@ResourceId.setter
def ResourceId(self, ResourceId):
self._ResourceId = ResourceId
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""调用方用户信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ResourceType = params.get("ResourceType")
self._ResourceName = params.get("ResourceName")
self._ResourceId = params.get("ResourceId")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateConvertTaskApiResponse(AbstractModel):
"""ChannelCreateConvertTaskApi返回参数结构体
"""
def __init__(self):
r"""
:param _TaskId: 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
:type TaskId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._TaskId = None
self._RequestId = None
@property
def TaskId(self):
"""接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._TaskId = params.get("TaskId")
self._RequestId = params.get("RequestId")
class ChannelCreateDynamicFlowApproverRequest(AbstractModel):
"""ChannelCreateDynamicFlowApprover请求参数结构体
"""
def __init__(self):
r"""
:param _FillDynamicFlowList: 动态合同信息
:type FillDynamicFlowList: list of DynamicFlowInfo
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._FillDynamicFlowList = None
self._Agent = None
@property
def FillDynamicFlowList(self):
"""动态合同信息
:rtype: list of DynamicFlowInfo
"""
return self._FillDynamicFlowList
@FillDynamicFlowList.setter
def FillDynamicFlowList(self, FillDynamicFlowList):
self._FillDynamicFlowList = FillDynamicFlowList
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
if params.get("FillDynamicFlowList") is not None:
self._FillDynamicFlowList = []
for item in params.get("FillDynamicFlowList"):
obj = DynamicFlowInfo()
obj._deserialize(item)
self._FillDynamicFlowList.append(obj)
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateDynamicFlowApproverResponse(AbstractModel):
"""ChannelCreateDynamicFlowApprover返回参数结构体
"""
def __init__(self):
r"""
:param _DynamicFlowResultList: 动态合同补充结果列表
:type DynamicFlowResultList: list of DynamicFlowResult
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._DynamicFlowResultList = None
self._RequestId = None
@property
def DynamicFlowResultList(self):
"""动态合同补充结果列表
:rtype: list of DynamicFlowResult
"""
return self._DynamicFlowResultList
@DynamicFlowResultList.setter
def DynamicFlowResultList(self, DynamicFlowResultList):
self._DynamicFlowResultList = DynamicFlowResultList
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("DynamicFlowResultList") is not None:
self._DynamicFlowResultList = []
for item in params.get("DynamicFlowResultList"):
obj = DynamicFlowResult()
obj._deserialize(item)
self._DynamicFlowResultList.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateEmbedWebUrlRequest(AbstractModel):
"""ChannelCreateEmbedWebUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _EmbedType: 要生成WEB嵌入界面的类型, 可以选择的值如下:
<ul>
<li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
<li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
<li>MODIFY_TEMPLATE：生成修改模板的嵌入页面</li>
<li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
<li>PREVIEW_FLOW：生成预览合同文档的嵌入页面（H5链接，支持移动端的浏览器中打开）</li>
<li>PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面（仅支持PC的浏览器中打开）</li>
<li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
<li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
<li>EXTEND_SERVICE：生成扩展服务的嵌入页面</li>
</ul>
:type EmbedType: str
:param _BusinessId: WEB嵌入的业务资源ID
当EmbedType取值
<ul>
<li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE必填，取值为模板id</li>
<li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li>
<li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL必填，取值为合同id</li>
<li>为PREVIEW_SEAL_DETAIL必填，取值为印章id</li>
</ul>
注意：
1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务](https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi) 来进行转换成PDF资源。
:type BusinessId: str
:param _HiddenComponents: 是否隐藏控件，只有预览模板时生效
:type HiddenComponents: bool
:param _Operator: 渠道操作者信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _UserData: 用户自定义参数
<ul>
<li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
<li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li>
<li>支持的格式：json字符串的BASE64编码字符串</li>
<li>示例：<ul>
<li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>
<li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li>
</ul>
</li>
</ul>
:type UserData: str
:param _Option: 个性化参数，用于控制页面展示内容
:type Option: :class:`tencentcloud.essbasic.v20210526.models.EmbedUrlOption`
"""
self._Agent = None
self._EmbedType = None
self._BusinessId = None
self._HiddenComponents = None
self._Operator = None
self._UserData = None
self._Option = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def EmbedType(self):
"""要生成WEB嵌入界面的类型, 可以选择的值如下:
<ul>
<li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
<li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
<li>MODIFY_TEMPLATE：生成修改模板的嵌入页面</li>
<li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
<li>PREVIEW_FLOW：生成预览合同文档的嵌入页面（H5链接，支持移动端的浏览器中打开）</li>
<li>PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面（仅支持PC的浏览器中打开）</li>
<li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
<li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
<li>EXTEND_SERVICE：生成扩展服务的嵌入页面</li>
</ul>
:rtype: str
"""
return self._EmbedType
@EmbedType.setter
def EmbedType(self, EmbedType):
self._EmbedType = EmbedType
@property
def BusinessId(self):
"""WEB嵌入的业务资源ID
当EmbedType取值
<ul>
<li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE必填，取值为模板id</li>
<li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li>
<li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL必填，取值为合同id</li>
<li>为PREVIEW_SEAL_DETAIL必填，取值为印章id</li>
</ul>
注意：
1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务](https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi) 来进行转换成PDF资源。
:rtype: str
"""
return self._BusinessId
@BusinessId.setter
def BusinessId(self, BusinessId):
self._BusinessId = BusinessId
@property
def HiddenComponents(self):
"""是否隐藏控件，只有预览模板时生效
:rtype: bool
"""
return self._HiddenComponents
@HiddenComponents.setter
def HiddenComponents(self, HiddenComponents):
self._HiddenComponents = HiddenComponents
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""渠道操作者信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def UserData(self):
"""用户自定义参数
<ul>
<li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
<li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li>
<li>支持的格式：json字符串的BASE64编码字符串</li>
<li>示例：<ul>
<li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>
<li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li>
</ul>
</li>
</ul>
:rtype: str
"""
return self._UserData
@UserData.setter
def UserData(self, UserData):
self._UserData = UserData
@property
def Option(self):
"""个性化参数，用于控制页面展示内容
:rtype: :class:`tencentcloud.essbasic.v20210526.models.EmbedUrlOption`
"""
return self._Option
@Option.setter
def Option(self, Option):
self._Option = Option
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._EmbedType = params.get("EmbedType")
self._BusinessId = params.get("BusinessId")
self._HiddenComponents = params.get("HiddenComponents")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._UserData = params.get("UserData")
if params.get("Option") is not None:
self._Option = EmbedUrlOption()
self._Option._deserialize(params.get("Option"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateEmbedWebUrlResponse(AbstractModel):
"""ChannelCreateEmbedWebUrl返回参数结构体
"""
def __init__(self):
r"""
:param _WebUrl: 嵌入的web链接，5分钟有效
:type WebUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._WebUrl = None
self._RequestId = None
@property
def WebUrl(self):
"""嵌入的web链接，5分钟有效
:rtype: str
"""
return self._WebUrl
@WebUrl.setter
def WebUrl(self, WebUrl):
self._WebUrl = WebUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._WebUrl = params.get("WebUrl")
self._RequestId = params.get("RequestId")
class ChannelCreateFlowApproversRequest(AbstractModel):
"""ChannelCreateFlowApprovers请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Approvers: 补充企业签署人信息。
- 如果发起方指定的补充签署人是企业签署人，则需要提供企业名称或者企业OpenId；
- 如果不指定，则使用姓名和手机号进行补充。
:type Approvers: list of FillApproverInfo
:param _FlowId: 合同流程ID，为32位字符串。
- 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
- 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
- <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
:type FlowId: str
:param _FillApproverType: 签署人信息补充方式
<ul><li>**1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。</li></ul>
:type FillApproverType: int
:param _Operator: 操作人信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _FlowGroupId: 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
:type FlowGroupId: str
"""
self._Agent = None
self._Approvers = None
self._FlowId = None
self._FillApproverType = None
self._Operator = None
self._FlowGroupId = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Approvers(self):
"""补充企业签署人信息。
- 如果发起方指定的补充签署人是企业签署人，则需要提供企业名称或者企业OpenId；
- 如果不指定，则使用姓名和手机号进行补充。
:rtype: list of FillApproverInfo
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
- 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
- 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
- <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def FillApproverType(self):
"""签署人信息补充方式
<ul><li>**1**: 表示往未指定签署人的节点，添加一个明确的签署人，支持企业或个人签署方。</li></ul>
:rtype: int
"""
return self._FillApproverType
@FillApproverType.setter
def FillApproverType(self, FillApproverType):
self._FillApproverType = FillApproverType
@property
def Operator(self):
"""操作人信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
@property
def FlowGroupId(self):
"""合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = FillApproverInfo()
obj._deserialize(item)
self._Approvers.append(obj)
self._FlowId = params.get("FlowId")
self._FillApproverType = params.get("FillApproverType")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._FlowGroupId = params.get("FlowGroupId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowApproversResponse(AbstractModel):
"""ChannelCreateFlowApprovers返回参数结构体
"""
def __init__(self):
r"""
:param _FillError: 批量补充签署人时，补充失败的报错说明
注:`目前仅补充动态签署人时会返回补充失败的原因`
:type FillError: list of FillError
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FillError = None
self._RequestId = None
@property
def FillError(self):
"""批量补充签署人时，补充失败的报错说明
注:`目前仅补充动态签署人时会返回补充失败的原因`
:rtype: list of FillError
"""
return self._FillError
@FillError.setter
def FillError(self, FillError):
self._FillError = FillError
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("FillError") is not None:
self._FillError = []
for item in params.get("FillError"):
obj = FillError()
obj._deserialize(item)
self._FillError.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateFlowByFilesRequest(AbstractModel):
"""ChannelCreateFlowByFiles请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:type FlowName: str
:param _FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
:type FlowDescription: str
:param _FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
:type FlowApprovers: list of FlowApproverInfo
:param _FileIds: 本合同流程需包含的PDF文件资源编号列表，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
:type FileIds: list of str
:param _Components: 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
<ul><li>单行文本控件</li>
<li>多行文本控件</li>
<li>勾选框控件</li>
<li>数字控件</li>
<li>图片控件</li>
<li>数据表格等填写控件</li></ul>
:type Components: list of Component
:param _Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
:type Deadline: int
:param _CallbackUrl: 该字段已废弃，请使用【应用号配置】中的回调地址
:type CallbackUrl: str
:param _Unordered: 合同流程的签署顺序类型：
<ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
<li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
:type Unordered: bool
:param _FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
:type FlowType: str
:param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
<ul><li>{合同名称} </li>
<li>{发起方企业} </li>
<li>{发起方姓名} </li>
<li>{签署方N企业}</li>
<li>{签署方N姓名}</li></ul>
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
:type CustomShowMap: str
:param _CustomerData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。
:type CustomerData: str
:param _NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
:type NeedSignReview: bool
:param _ApproverVerifyType: 签署人校验方式
VerifyCheck: 人脸识别（默认）
MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
:type ApproverVerifyType: str
:param _SignBeanTag: 签署方签署控件（印章/签名等）的生成方式：
<ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
<li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
**注**:
1.发起后添加控件功能不支持添加签批控件
2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5
:type SignBeanTag: int
:param _CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
<b>注</b>
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
:type CcInfos: list of CcInfo
:param _CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
<ul><li> **0**：合同发起时通知（默认值）</li>
<li> **1**：签署完成后通知</li></ul>
:type CcNotifyType: int
:param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
:type AutoSignScene: str
:param _Operator: 操作者的信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _FlowDisplayType: 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:type FlowDisplayType: int
:param _NeedPreview: 是否为预览模式，取值如下： <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
:type NeedPreview: bool
:param _PreviewType: 预览模式下产生的预览链接类型
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
注: `此参数在NeedPreview 为true时有效`
:type PreviewType: int
:param _OpenDynamicFlow: 是否开启动态合同（动态签署人2.0）
<ul><li> **false** :(默认) 不开启动态合同（动态签署人2.0）</li>
<li> **true** :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人</li></ul>
:type OpenDynamicFlow: bool
:param _OpenDynamicSignFlow: 是否开启动态合同（动态签署人2.0）<ul><li> **false** :(默认) 不开启动态合同（动态签署人2.0）</li><li> **true** :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人</li></ul>
:type OpenDynamicSignFlow: bool
"""
self._Agent = None
self._FlowName = None
self._FlowDescription = None
self._FlowApprovers = None
self._FileIds = None
self._Components = None
self._Deadline = None
self._CallbackUrl = None
self._Unordered = None
self._FlowType = None
self._CustomShowMap = None
self._CustomerData = None
self._NeedSignReview = None
self._ApproverVerifyType = None
self._SignBeanTag = None
self._CcInfos = None
self._CcNotifyType = None
self._AutoSignScene = None
self._Operator = None
self._FlowDisplayType = None
self._NeedPreview = None
self._PreviewType = None
self._OpenDynamicFlow = None
self._OpenDynamicSignFlow = None
@property
def Agent(self):
"""合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowName(self):
"""合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def FlowDescription(self):
"""合同流程描述信息(可自定义此描述)，最大长度1000个字符。
:rtype: str
"""
return self._FlowDescription
@FlowDescription.setter
def FlowDescription(self, FlowDescription):
self._FlowDescription = FlowDescription
@property
def FlowApprovers(self):
"""合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。
如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
:rtype: list of FlowApproverInfo
"""
return self._FlowApprovers
@FlowApprovers.setter
def FlowApprovers(self, FlowApprovers):
self._FlowApprovers = FlowApprovers
@property
def FileIds(self):
"""本合同流程需包含的PDF文件资源编号列表，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
注: `目前，此接口仅支持单个文件发起。`
:rtype: list of str
"""
return self._FileIds
@FileIds.setter
def FileIds(self, FileIds):
self._FileIds = FileIds
@property
def Components(self):
"""模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
<ul><li>单行文本控件</li>
<li>多行文本控件</li>
<li>勾选框控件</li>
<li>数字控件</li>
<li>图片控件</li>
<li>数据表格等填写控件</li></ul>
:rtype: list of Component
"""
return self._Components
@Components.setter
def Components(self, Components):
self._Components = Components
@property
def Deadline(self):
"""合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""该字段已废弃，请使用【应用号配置】中的回调地址
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def Unordered(self):
"""合同流程的签署顺序类型：
<ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
<li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
**注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
:rtype: bool
"""
return self._Unordered
@Unordered.setter
def Unordered(self, Unordered):
self._Unordered = Unordered
@property
def FlowType(self):
"""合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为255个字符，仅限中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowType
@FlowType.setter
def FlowType(self, FlowType):
self._FlowType = FlowType
@property
def CustomShowMap(self):
"""您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
<ul><li>{合同名称} </li>
<li>{发起方企业} </li>
<li>{发起方姓名} </li>
<li>{签署方N企业}</li>
<li>{签署方N姓名}</li></ul>
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
:rtype: str
"""
return self._CustomShowMap
@CustomShowMap.setter
def CustomShowMap(self, CustomShowMap):
self._CustomShowMap = CustomShowMap
@property
def CustomerData(self):
"""调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。
:rtype: str
"""
return self._CustomerData
@CustomerData.setter
def CustomerData(self, CustomerData):
self._CustomerData = CustomerData
@property
def NeedSignReview(self):
"""发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
:rtype: bool
"""
return self._NeedSignReview
@NeedSignReview.setter
def NeedSignReview(self, NeedSignReview):
self._NeedSignReview = NeedSignReview
@property
def ApproverVerifyType(self):
"""签署人校验方式
VerifyCheck: 人脸识别（默认）
MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
:rtype: str
"""
return self._ApproverVerifyType
@ApproverVerifyType.setter
def ApproverVerifyType(self, ApproverVerifyType):
self._ApproverVerifyType = ApproverVerifyType
@property
def SignBeanTag(self):
"""签署方签署控件（印章/签名等）的生成方式：
<ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
<li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
**注**:
1.发起后添加控件功能不支持添加签批控件
2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5
:rtype: int
"""
return self._SignBeanTag
@SignBeanTag.setter
def SignBeanTag(self, SignBeanTag):
self._SignBeanTag = SignBeanTag
@property
def CcInfos(self):
"""合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
<b>注</b>
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
:rtype: list of CcInfo
"""
return self._CcInfos
@CcInfos.setter
def CcInfos(self, CcInfos):
self._CcInfos = CcInfos
@property
def CcNotifyType(self):
"""可以设置以下时间节点来给抄送人发送短信通知来查看合同内容：
<ul><li> **0**：合同发起时通知（默认值）</li>
<li> **1**：签署完成后通知</li></ul>
:rtype: int
"""
return self._CcNotifyType
@CcNotifyType.setter
def CcNotifyType(self, CcNotifyType):
self._CcNotifyType = CcNotifyType
@property
def AutoSignScene(self):
"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
:rtype: str
"""
return self._AutoSignScene
@AutoSignScene.setter
def AutoSignScene(self, AutoSignScene):
self._AutoSignScene = AutoSignScene
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def FlowDisplayType(self):
"""在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:rtype: int
"""
return self._FlowDisplayType
@FlowDisplayType.setter
def FlowDisplayType(self, FlowDisplayType):
self._FlowDisplayType = FlowDisplayType
@property
def NeedPreview(self):
"""是否为预览模式，取值如下： <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
:rtype: bool
"""
return self._NeedPreview
@NeedPreview.setter
def NeedPreview(self, NeedPreview):
self._NeedPreview = NeedPreview
@property
def PreviewType(self):
"""预览模式下产生的预览链接类型
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
注: `此参数在NeedPreview 为true时有效`
:rtype: int
"""
return self._PreviewType
@PreviewType.setter
def PreviewType(self, PreviewType):
self._PreviewType = PreviewType
@property
def OpenDynamicFlow(self):
warnings.warn("parameter `OpenDynamicFlow` is deprecated", DeprecationWarning)
"""是否开启动态合同（动态签署人2.0）
<ul><li> **false** :(默认) 不开启动态合同（动态签署人2.0）</li>
<li> **true** :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人</li></ul>
:rtype: bool
"""
return self._OpenDynamicFlow
@OpenDynamicFlow.setter
def OpenDynamicFlow(self, OpenDynamicFlow):
warnings.warn("parameter `OpenDynamicFlow` is deprecated", DeprecationWarning)
self._OpenDynamicFlow = OpenDynamicFlow
@property
def OpenDynamicSignFlow(self):
"""是否开启动态合同（动态签署人2.0）<ul><li> **false** :(默认) 不开启动态合同（动态签署人2.0）</li><li> **true** :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人</li></ul>
:rtype: bool
"""
return self._OpenDynamicSignFlow
@OpenDynamicSignFlow.setter
def OpenDynamicSignFlow(self, OpenDynamicSignFlow):
self._OpenDynamicSignFlow = OpenDynamicSignFlow
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowName = params.get("FlowName")
self._FlowDescription = params.get("FlowDescription")
if params.get("FlowApprovers") is not None:
self._FlowApprovers = []
for item in params.get("FlowApprovers"):
obj = FlowApproverInfo()
obj._deserialize(item)
self._FlowApprovers.append(obj)
self._FileIds = params.get("FileIds")
if params.get("Components") is not None:
self._Components = []
for item in params.get("Components"):
obj = Component()
obj._deserialize(item)
self._Components.append(obj)
self._Deadline = params.get("Deadline")
self._CallbackUrl = params.get("CallbackUrl")
self._Unordered = params.get("Unordered")
self._FlowType = params.get("FlowType")
self._CustomShowMap = params.get("CustomShowMap")
self._CustomerData = params.get("CustomerData")
self._NeedSignReview = params.get("NeedSignReview")
self._ApproverVerifyType = params.get("ApproverVerifyType")
self._SignBeanTag = params.get("SignBeanTag")
if params.get("CcInfos") is not None:
self._CcInfos = []
for item in params.get("CcInfos"):
obj = CcInfo()
obj._deserialize(item)
self._CcInfos.append(obj)
self._CcNotifyType = params.get("CcNotifyType")
self._AutoSignScene = params.get("AutoSignScene")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._FlowDisplayType = params.get("FlowDisplayType")
self._NeedPreview = params.get("NeedPreview")
self._PreviewType = params.get("PreviewType")
self._OpenDynamicFlow = params.get("OpenDynamicFlow")
self._OpenDynamicSignFlow = params.get("OpenDynamicSignFlow")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowByFilesResponse(AbstractModel):
"""ChannelCreateFlowByFiles返回参数结构体
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
[点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:type FlowId: str
:param _Approvers: 签署方信息，如角色ID、角色名称等
:type Approvers: list of ApproverItem
:param _PreviewUrl: 预览链接，有效期5分钟
注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
:type PreviewUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowId = None
self._Approvers = None
self._PreviewUrl = None
self._RequestId = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
[点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Approvers(self):
"""签署方信息，如角色ID、角色名称等
:rtype: list of ApproverItem
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
@property
def PreviewUrl(self):
"""预览链接，有效期5分钟
注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
:rtype: str
"""
return self._PreviewUrl
@PreviewUrl.setter
def PreviewUrl(self, PreviewUrl):
self._PreviewUrl = PreviewUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = ApproverItem()
obj._deserialize(item)
self._Approvers.append(obj)
self._PreviewUrl = params.get("PreviewUrl")
self._RequestId = params.get("RequestId")
class ChannelCreateFlowGroupByFilesRequest(AbstractModel):
"""ChannelCreateFlowGroupByFiles请求参数结构体
"""
def __init__(self):
r"""
:param _FlowFileInfos: 合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
:type FlowFileInfos: list of FlowFileInfo
:param _FlowGroupName: 合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:type FlowGroupName: str
:param _Agent: 合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
合同的发起企业和发起人必需已经完成实名，并加入企业
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ApproverVerifyType: 合同组中签署人校验和认证的方式：
<ul><li>**VerifyCheck**：人脸识别（默认）</li>
<li>**MobileCheck**：手机号验证</li></ul>
注意：
`1. MobileCheck 方式，未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同（但签署合同时仍然需要人脸实名），企业签署方需经过人脸认证。`
`2. 合同组的校验和认证的方式会优先使用，会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`
:type ApproverVerifyType: str
:param _FlowGroupOptions: 合同组的签署配置项信息，例如在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。
:type FlowGroupOptions: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupOptions`
:param _Operator: 操作者的信息，此参数不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._FlowFileInfos = None
self._FlowGroupName = None
self._Agent = None
self._ApproverVerifyType = None
self._FlowGroupOptions = None
self._Operator = None
@property
def FlowFileInfos(self):
"""合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
:rtype: list of FlowFileInfo
"""
return self._FlowFileInfos
@FlowFileInfos.setter
def FlowFileInfos(self, FlowFileInfos):
self._FlowFileInfos = FlowFileInfos
@property
def FlowGroupName(self):
"""合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowGroupName
@FlowGroupName.setter
def FlowGroupName(self, FlowGroupName):
self._FlowGroupName = FlowGroupName
@property
def Agent(self):
"""合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
合同的发起企业和发起人必需已经完成实名，并加入企业
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ApproverVerifyType(self):
"""合同组中签署人校验和认证的方式：
<ul><li>**VerifyCheck**：人脸识别（默认）</li>
<li>**MobileCheck**：手机号验证</li></ul>
注意：
`1. MobileCheck 方式，未实名的个人/自然人签署方无需进行人脸识别实名认证即可查看合同（但签署合同时仍然需要人脸实名），企业签署方需经过人脸认证。`
`2. 合同组的校验和认证的方式会优先使用，会覆盖合同组中单个合同和合同签署方认证方式的限制配置。`
:rtype: str
"""
return self._ApproverVerifyType
@ApproverVerifyType.setter
def ApproverVerifyType(self, ApproverVerifyType):
self._ApproverVerifyType = ApproverVerifyType
@property
def FlowGroupOptions(self):
"""合同组的签署配置项信息，例如在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupOptions`
"""
return self._FlowGroupOptions
@FlowGroupOptions.setter
def FlowGroupOptions(self, FlowGroupOptions):
self._FlowGroupOptions = FlowGroupOptions
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息，此参数不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("FlowFileInfos") is not None:
self._FlowFileInfos = []
for item in params.get("FlowFileInfos"):
obj = FlowFileInfo()
obj._deserialize(item)
self._FlowFileInfos.append(obj)
self._FlowGroupName = params.get("FlowGroupName")
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ApproverVerifyType = params.get("ApproverVerifyType")
if params.get("FlowGroupOptions") is not None:
self._FlowGroupOptions = FlowGroupOptions()
self._FlowGroupOptions._deserialize(params.get("FlowGroupOptions"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowGroupByFilesResponse(AbstractModel):
"""ChannelCreateFlowGroupByFiles返回参数结构体
"""
def __init__(self):
r"""
:param _FlowGroupId: 合同组ID，为32位字符串。
建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
:type FlowGroupId: str
:param _FlowIds: 合同组中每个合同流程ID，每个ID均为32位字符串。
注:
`此数组的顺序和入参中的FlowGroupInfos顺序一致`
:type FlowIds: list of str
:param _Approvers: 合同组签署方信息。
:type Approvers: list of FlowGroupApprovers
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowGroupId = None
self._FlowIds = None
self._Approvers = None
self._RequestId = None
@property
def FlowGroupId(self):
"""合同组ID，为32位字符串。
建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def FlowIds(self):
"""合同组中每个合同流程ID，每个ID均为32位字符串。
注:
`此数组的顺序和入参中的FlowGroupInfos顺序一致`
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def Approvers(self):
"""合同组签署方信息。
:rtype: list of FlowGroupApprovers
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FlowGroupId = params.get("FlowGroupId")
self._FlowIds = params.get("FlowIds")
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = FlowGroupApprovers()
obj._deserialize(item)
self._Approvers.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateFlowGroupByTemplatesRequest(AbstractModel):
"""ChannelCreateFlowGroupByTemplates请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
合同的发起企业和发起人必需已经完成实名，并加入企业
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowInfos: 合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
:type FlowInfos: list of FlowInfo
:param _FlowGroupName: 合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:type FlowGroupName: str
"""
self._Agent = None
self._FlowInfos = None
self._FlowGroupName = None
@property
def Agent(self):
"""合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
合同的发起企业和发起人必需已经完成实名，并加入企业
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowInfos(self):
"""合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
:rtype: list of FlowInfo
"""
return self._FlowInfos
@FlowInfos.setter
def FlowInfos(self, FlowInfos):
self._FlowInfos = FlowInfos
@property
def FlowGroupName(self):
"""合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowGroupName
@FlowGroupName.setter
def FlowGroupName(self, FlowGroupName):
self._FlowGroupName = FlowGroupName
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("FlowInfos") is not None:
self._FlowInfos = []
for item in params.get("FlowInfos"):
obj = FlowInfo()
obj._deserialize(item)
self._FlowInfos.append(obj)
self._FlowGroupName = params.get("FlowGroupName")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowGroupByTemplatesResponse(AbstractModel):
"""ChannelCreateFlowGroupByTemplates返回参数结构体
"""
def __init__(self):
r"""
:param _FlowGroupId: 合同组ID，为32位字符串。
建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
:type FlowGroupId: str
:param _FlowIds: 合同组中每个合同流程ID，每个ID均为32位字符串。
注:
`此数组的顺序和入参中的FlowInfos顺序一致`
:type FlowIds: list of str
:param _TaskInfos: 复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
:type TaskInfos: list of TaskInfo
:param _Approvers: 合同组签署方信息
:type Approvers: list of FlowGroupApprovers
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowGroupId = None
self._FlowIds = None
self._TaskInfos = None
self._Approvers = None
self._RequestId = None
@property
def FlowGroupId(self):
"""合同组ID，为32位字符串。
建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def FlowIds(self):
"""合同组中每个合同流程ID，每个ID均为32位字符串。
注:
`此数组的顺序和入参中的FlowInfos顺序一致`
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def TaskInfos(self):
"""复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
:rtype: list of TaskInfo
"""
return self._TaskInfos
@TaskInfos.setter
def TaskInfos(self, TaskInfos):
self._TaskInfos = TaskInfos
@property
def Approvers(self):
"""合同组签署方信息
:rtype: list of FlowGroupApprovers
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FlowGroupId = params.get("FlowGroupId")
self._FlowIds = params.get("FlowIds")
if params.get("TaskInfos") is not None:
self._TaskInfos = []
for item in params.get("TaskInfos"):
obj = TaskInfo()
obj._deserialize(item)
self._TaskInfos.append(obj)
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = FlowGroupApprovers()
obj._deserialize(item)
self._Approvers.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateFlowRemindsRequest(AbstractModel):
"""ChannelCreateFlowReminds请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 需执行催办的合同流程ID数组，最多支持100个。
:type FlowIds: list of str
"""
self._Agent = None
self._FlowIds = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""需执行催办的合同流程ID数组，最多支持100个。
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowRemindsResponse(AbstractModel):
"""ChannelCreateFlowReminds返回参数结构体
"""
def __init__(self):
r"""
:param _RemindFlowRecords: 合同催办结果的详细信息列表。
:type RemindFlowRecords: list of RemindFlowRecords
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RemindFlowRecords = None
self._RequestId = None
@property
def RemindFlowRecords(self):
"""合同催办结果的详细信息列表。
:rtype: list of RemindFlowRecords
"""
return self._RemindFlowRecords
@RemindFlowRecords.setter
def RemindFlowRecords(self, RemindFlowRecords):
self._RemindFlowRecords = RemindFlowRecords
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("RemindFlowRecords") is not None:
self._RemindFlowRecords = []
for item in params.get("RemindFlowRecords"):
obj = RemindFlowRecords()
obj._deserialize(item)
self._RemindFlowRecords.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateFlowSignReviewRequest(AbstractModel):
"""ChannelCreateFlowSignReview请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 合同流程ID，为32位字符串。
:type FlowId: str
:param _ReviewType: 企业内部审核结果
<ul><li>PASS: 审核通过（流程可以继续签署或者发起）</li>
<li>REJECT: 审核拒绝（流程状态不变，可以继续调用审核接口通过审核）</li>
<li>SIGN_REJECT:拒签(流程终止，流程状态变为拒签状态)</li></ul>
:type ReviewType: str
:param _ReviewMessage: 审核结果原因
<ul><li>字符串长度不超过200</li>
<li>当ReviewType 是拒绝（REJECT） 时此字段必填。</li>
<li>当ReviewType 是拒绝（SIGN_REJECT） 时此字段必填。</li></ul>
:type ReviewMessage: str
:param _RecipientId: 审核节点的签署人标志，用于指定当前审核的签署方。
<font color= "red">注意：以下情况必须传递RecipientId</font>
<ul><li> **发起签署流程时，指定签署人需要审批（即签署人需要审批
<a href="https://qian.tencent.com/developers/partnerApis/dataTypes#flowapproverinfo" target="_blank">ApproverNeedSignReview</a>为true），则必须指定RecipientId**</li><li>**如果签署审核节点是个人， 此参数必填**。</li></ul>
:type RecipientId: str
:param _OperateType: 流程审核操作类型，取值如下：
<ul><li>**SignReview**：（默认）签署审核</li>
<li>**CreateReview**：发起审核</li>
<li>注意：`该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程`</li></ul>
:type OperateType: str
"""
self._Agent = None
self._FlowId = None
self._ReviewType = None
self._ReviewMessage = None
self._RecipientId = None
self._OperateType = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def ReviewType(self):
"""企业内部审核结果
<ul><li>PASS: 审核通过（流程可以继续签署或者发起）</li>
<li>REJECT: 审核拒绝（流程状态不变，可以继续调用审核接口通过审核）</li>
<li>SIGN_REJECT:拒签(流程终止，流程状态变为拒签状态)</li></ul>
:rtype: str
"""
return self._ReviewType
@ReviewType.setter
def ReviewType(self, ReviewType):
self._ReviewType = ReviewType
@property
def ReviewMessage(self):
"""审核结果原因
<ul><li>字符串长度不超过200</li>
<li>当ReviewType 是拒绝（REJECT） 时此字段必填。</li>
<li>当ReviewType 是拒绝（SIGN_REJECT） 时此字段必填。</li></ul>
:rtype: str
"""
return self._ReviewMessage
@ReviewMessage.setter
def ReviewMessage(self, ReviewMessage):
self._ReviewMessage = ReviewMessage
@property
def RecipientId(self):
"""审核节点的签署人标志，用于指定当前审核的签署方。
<font color= "red">注意：以下情况必须传递RecipientId</font>
<ul><li> **发起签署流程时，指定签署人需要审批（即签署人需要审批
<a href="https://qian.tencent.com/developers/partnerApis/dataTypes#flowapproverinfo" target="_blank">ApproverNeedSignReview</a>为true），则必须指定RecipientId**</li><li>**如果签署审核节点是个人， 此参数必填**。</li></ul>
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def OperateType(self):
"""流程审核操作类型，取值如下：
<ul><li>**SignReview**：（默认）签署审核</li>
<li>**CreateReview**：发起审核</li>
<li>注意：`该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程`</li></ul>
:rtype: str
"""
return self._OperateType
@OperateType.setter
def OperateType(self, OperateType):
self._OperateType = OperateType
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
self._ReviewType = params.get("ReviewType")
self._ReviewMessage = params.get("ReviewMessage")
self._RecipientId = params.get("RecipientId")
self._OperateType = params.get("OperateType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowSignReviewResponse(AbstractModel):
"""ChannelCreateFlowSignReview返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelCreateFlowSignUrlRequest(AbstractModel):
"""ChannelCreateFlowSignUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
:type FlowId: str
:param _FlowApproverInfos: 流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
此结构体和发起接口参与方结构体复用，除了上述参数外，可传递的参数有：
1. RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。
2. ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。
3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。
4. Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
:type FlowApproverInfos: list of FlowApproverInfo
:param _Operator: 用户信息，暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _Organization: 机构信息，暂未开放
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
:param _JumpUrl: 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
:type JumpUrl: str
:param _UrlType: 链接类型，支持指定以下类型
<ul><li>0 : 签署链接 (默认值)</li>
<li>1 : 预览链接</li></ul>
注:
`1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
`2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
:type UrlType: int
"""
self._Agent = None
self._FlowId = None
self._FlowApproverInfos = None
self._Operator = None
self._Organization = None
self._JumpUrl = None
self._UrlType = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def FlowApproverInfos(self):
"""流程签署人列表，其中结构体的ApproverType必传。
若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
若为子客企业签署方则需传OpenId、OrganizationOpenId，其他可不传。
此结构体和发起接口参与方结构体复用，除了上述参数外，可传递的参数有：
1. RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。
2. ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。
3. SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。
4. Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。
注:
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
:rtype: list of FlowApproverInfo
"""
return self._FlowApproverInfos
@FlowApproverInfos.setter
def FlowApproverInfos(self, FlowApproverInfos):
self._FlowApproverInfos = FlowApproverInfos
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""用户信息，暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""机构信息，暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
@property
def JumpUrl(self):
"""签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
:rtype: str
"""
return self._JumpUrl
@JumpUrl.setter
def JumpUrl(self, JumpUrl):
self._JumpUrl = JumpUrl
@property
def UrlType(self):
"""链接类型，支持指定以下类型
<ul><li>0 : 签署链接 (默认值)</li>
<li>1 : 预览链接</li></ul>
注:
`1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
`2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
:rtype: int
"""
return self._UrlType
@UrlType.setter
def UrlType(self, UrlType):
self._UrlType = UrlType
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
if params.get("FlowApproverInfos") is not None:
self._FlowApproverInfos = []
for item in params.get("FlowApproverInfos"):
obj = FlowApproverInfo()
obj._deserialize(item)
self._FlowApproverInfos.append(obj)
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
self._JumpUrl = params.get("JumpUrl")
self._UrlType = params.get("UrlType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateFlowSignUrlResponse(AbstractModel):
"""ChannelCreateFlowSignUrl返回参数结构体
"""
def __init__(self):
r"""
:param _FlowApproverUrlInfos: 签署人签署链接信息
:type FlowApproverUrlInfos: list of FlowApproverUrlInfo
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowApproverUrlInfos = None
self._RequestId = None
@property
def FlowApproverUrlInfos(self):
"""签署人签署链接信息
:rtype: list of FlowApproverUrlInfo
"""
return self._FlowApproverUrlInfos
@FlowApproverUrlInfos.setter
def FlowApproverUrlInfos(self, FlowApproverUrlInfos):
self._FlowApproverUrlInfos = FlowApproverUrlInfos
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("FlowApproverUrlInfos") is not None:
self._FlowApproverUrlInfos = []
for item in params.get("FlowApproverUrlInfos"):
obj = FlowApproverUrlInfo()
obj._deserialize(item)
self._FlowApproverUrlInfos.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
"""ChannelCreateMultiFlowSignQRCode请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _TemplateId: 合同模板ID，为32位字符串。
:type TemplateId: str
:param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
:type FlowName: str
:param _MaxFlowNum: 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。
:type MaxFlowNum: int
:param _FlowEffectiveDay: 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。 最长设定期限不得超过30天。
:type FlowEffectiveDay: int
:param _QrEffectiveDay: 二维码的有效期限，默认为7天，最高设定不得超过90天。 一旦超过二维码的有效期限，该二维码将自动失效。
:type QrEffectiveDay: int
:param _Restrictions: 指定签署人信息。 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
:type Restrictions: list of ApproverRestriction
:param _ApproverComponentLimitTypes: 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
:type ApproverComponentLimitTypes: list of ApproverComponentLimitType
:param _CallbackUrl: 已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
<br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
<br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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: str
:param _ApproverRestrictions: 限制二维码用户条件（已弃用）
:type ApproverRestrictions: :class:`tencentcloud.essbasic.v20210526.models.ApproverRestriction`
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ForbidPersonalMultipleSign: 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
:type ForbidPersonalMultipleSign: bool
:param _FlowNameAppendScannerInfo: 合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。 例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。
:type FlowNameAppendScannerInfo: bool
"""
self._Agent = None
self._TemplateId = None
self._FlowName = None
self._MaxFlowNum = None
self._FlowEffectiveDay = None
self._QrEffectiveDay = None
self._Restrictions = None
self._ApproverComponentLimitTypes = None
self._CallbackUrl = None
self._ApproverRestrictions = None
self._Operator = None
self._ForbidPersonalMultipleSign = None
self._FlowNameAppendScannerInfo = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def TemplateId(self):
"""合同模板ID，为32位字符串。
:rtype: str
"""
return self._TemplateId
@TemplateId.setter
def TemplateId(self, TemplateId):
self._TemplateId = TemplateId
@property
def FlowName(self):
"""合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def MaxFlowNum(self):
"""通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。
:rtype: int
"""
return self._MaxFlowNum
@MaxFlowNum.setter
def MaxFlowNum(self, MaxFlowNum):
self._MaxFlowNum = MaxFlowNum
@property
def FlowEffectiveDay(self):
"""合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。 最长设定期限不得超过30天。
:rtype: int
"""
return self._FlowEffectiveDay
@FlowEffectiveDay.setter
def FlowEffectiveDay(self, FlowEffectiveDay):
self._FlowEffectiveDay = FlowEffectiveDay
@property
def QrEffectiveDay(self):
"""二维码的有效期限，默认为7天，最高设定不得超过90天。 一旦超过二维码的有效期限，该二维码将自动失效。
:rtype: int
"""
return self._QrEffectiveDay
@QrEffectiveDay.setter
def QrEffectiveDay(self, QrEffectiveDay):
self._QrEffectiveDay = QrEffectiveDay
@property
def Restrictions(self):
"""指定签署人信息。 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
:rtype: list of ApproverRestriction
"""
return self._Restrictions
@Restrictions.setter
def Restrictions(self, Restrictions):
self._Restrictions = Restrictions
@property
def ApproverComponentLimitTypes(self):
"""指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
:rtype: list of ApproverComponentLimitType
"""
return self._ApproverComponentLimitTypes
@ApproverComponentLimitTypes.setter
def ApproverComponentLimitTypes(self, ApproverComponentLimitTypes):
self._ApproverComponentLimitTypes = ApproverComponentLimitTypes
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
<br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
<br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def ApproverRestrictions(self):
warnings.warn("parameter `ApproverRestrictions` is deprecated", DeprecationWarning)
"""限制二维码用户条件（已弃用）
:rtype: :class:`tencentcloud.essbasic.v20210526.models.ApproverRestriction`
"""
return self._ApproverRestrictions
@ApproverRestrictions.setter
def ApproverRestrictions(self, ApproverRestrictions):
warnings.warn("parameter `ApproverRestrictions` is deprecated", DeprecationWarning)
self._ApproverRestrictions = ApproverRestrictions
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def ForbidPersonalMultipleSign(self):
"""禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
:rtype: bool
"""
return self._ForbidPersonalMultipleSign
@ForbidPersonalMultipleSign.setter
def ForbidPersonalMultipleSign(self, ForbidPersonalMultipleSign):
self._ForbidPersonalMultipleSign = ForbidPersonalMultipleSign
@property
def FlowNameAppendScannerInfo(self):
"""合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。 例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。
:rtype: bool
"""
return self._FlowNameAppendScannerInfo
@FlowNameAppendScannerInfo.setter
def FlowNameAppendScannerInfo(self, FlowNameAppendScannerInfo):
self._FlowNameAppendScannerInfo = FlowNameAppendScannerInfo
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._TemplateId = params.get("TemplateId")
self._FlowName = params.get("FlowName")
self._MaxFlowNum = params.get("MaxFlowNum")
self._FlowEffectiveDay = params.get("FlowEffectiveDay")
self._QrEffectiveDay = params.get("QrEffectiveDay")
if params.get("Restrictions") is not None:
self._Restrictions = []
for item in params.get("Restrictions"):
obj = ApproverRestriction()
obj._deserialize(item)
self._Restrictions.append(obj)
if params.get("ApproverComponentLimitTypes") is not None:
self._ApproverComponentLimitTypes = []
for item in params.get("ApproverComponentLimitTypes"):
obj = ApproverComponentLimitType()
obj._deserialize(item)
self._ApproverComponentLimitTypes.append(obj)
self._CallbackUrl = params.get("CallbackUrl")
if params.get("ApproverRestrictions") is not None:
self._ApproverRestrictions = ApproverRestriction()
self._ApproverRestrictions._deserialize(params.get("ApproverRestrictions"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._ForbidPersonalMultipleSign = params.get("ForbidPersonalMultipleSign")
self._FlowNameAppendScannerInfo = params.get("FlowNameAppendScannerInfo")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateMultiFlowSignQRCodeResponse(AbstractModel):
"""ChannelCreateMultiFlowSignQRCode返回参数结构体
"""
def __init__(self):
r"""
:param _QrCode: 一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。
:type QrCode: :class:`tencentcloud.essbasic.v20210526.models.SignQrCode`
:param _SignUrls: 一码多签签署码链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
:type SignUrls: :class:`tencentcloud.essbasic.v20210526.models.SignUrl`
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._QrCode = None
self._SignUrls = None
self._RequestId = None
@property
def QrCode(self):
"""一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.SignQrCode`
"""
return self._QrCode
@QrCode.setter
def QrCode(self, QrCode):
self._QrCode = QrCode
@property
def SignUrls(self):
"""一码多签签署码链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.SignUrl`
"""
return self._SignUrls
@SignUrls.setter
def SignUrls(self, SignUrls):
self._SignUrls = SignUrls
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("QrCode") is not None:
self._QrCode = SignQrCode()
self._QrCode._deserialize(params.get("QrCode"))
if params.get("SignUrls") is not None:
self._SignUrls = SignUrl()
self._SignUrls._deserialize(params.get("SignUrls"))
self._RequestId = params.get("RequestId")
class ChannelCreateOrganizationBatchSignUrlRequest(AbstractModel):
"""ChannelCreateOrganizationBatchSignUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。
:type FlowIds: list of str
:param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
<ul>
<li>1. 若OpenId为空，Name和Mobile 必须提供。</li>
<li>2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。 </li>
</ul>
:type OpenId: str
:param _Name: 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`
:type Name: str
:param _Mobile: 员工手机号，必须与姓名一起使用。 如果OpenId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
:type Mobile: str
"""
self._Agent = None
self._FlowIds = None
self._OpenId = None
self._Name = None
self._Mobile = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def OpenId(self):
"""第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
<ul>
<li>1. 若OpenId为空，Name和Mobile 必须提供。</li>
<li>2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。 </li>
</ul>
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def Name(self):
"""签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`请确保和合同中填入的一致`
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Mobile(self):
"""员工手机号，必须与姓名一起使用。 如果OpenId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
self._OpenId = params.get("OpenId")
self._Name = params.get("Name")
self._Mobile = params.get("Mobile")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateOrganizationBatchSignUrlResponse(AbstractModel):
"""ChannelCreateOrganizationBatchSignUrl返回参数结构体
"""
def __init__(self):
r"""
:param _SignUrl: 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
:type SignUrl: str
:param _ExpiredTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:type ExpiredTime: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._SignUrl = None
self._ExpiredTime = None
self._RequestId = None
@property
def SignUrl(self):
"""批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
:rtype: str
"""
return self._SignUrl
@SignUrl.setter
def SignUrl(self, SignUrl):
self._SignUrl = SignUrl
@property
def ExpiredTime(self):
"""链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._SignUrl = params.get("SignUrl")
self._ExpiredTime = params.get("ExpiredTime")
self._RequestId = params.get("RequestId")
class ChannelCreateOrganizationModifyQrCodeRequest(AbstractModel):
"""ChannelCreateOrganizationModifyQrCode请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._Agent = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateOrganizationModifyQrCodeResponse(AbstractModel):
"""ChannelCreateOrganizationModifyQrCode返回参数结构体
"""
def __init__(self):
r"""
:param _QrCodeUrl: 二维码下载链接
:type QrCodeUrl: str
:param _ExpiredTime: 二维码失效时间 UNIX 时间戳 精确到秒
:type ExpiredTime: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._QrCodeUrl = None
self._ExpiredTime = None
self._RequestId = None
@property
def QrCodeUrl(self):
"""二维码下载链接
:rtype: str
"""
return self._QrCodeUrl
@QrCodeUrl.setter
def QrCodeUrl(self, QrCodeUrl):
self._QrCodeUrl = QrCodeUrl
@property
def ExpiredTime(self):
"""二维码失效时间 UNIX 时间戳 精确到秒
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._QrCodeUrl = params.get("QrCodeUrl")
self._ExpiredTime = params.get("ExpiredTime")
self._RequestId = params.get("RequestId")
class ChannelCreatePrepareFlowRequest(AbstractModel):
"""ChannelCreatePrepareFlow请求参数结构体
"""
def __init__(self):
r"""
:param _ResourceType: 资源类型，取值有：
<ul><li> **1**：模板</li>
<li> **2**：文件（默认值）</li></ul>
:type ResourceType: int
:param _FlowInfo: 要创建的合同信息
:type FlowInfo: :class:`tencentcloud.essbasic.v20210526.models.BaseFlowInfo`
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ResourceId: 资源id，与ResourceType相对应，取值范围：
<ul>
<li>文件Id（通过UploadFiles获取文件资源Id）</li>
<li>模板Id（通过控制台创建模板后获取模板Id）</li>
</ul>
注意：需要同时设置 ResourceType 参数指定资源类型
:type ResourceId: str
:param _FlowOption: 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑
:type FlowOption: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowOption`
:param _FlowApproverList: 合同签署人信息
:type FlowApproverList: list of CommonFlowApprover
:param _FlowId: 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
:type FlowId: str
:param _NeedPreview: 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL
:type NeedPreview: bool
:param _Organization: 企业机构信息，不用传
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
:param _Operator: 操作人（用户）信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._ResourceType = None
self._FlowInfo = None
self._Agent = None
self._ResourceId = None
self._FlowOption = None
self._FlowApproverList = None
self._FlowId = None
self._NeedPreview = None
self._Organization = None
self._Operator = None
@property
def ResourceType(self):
"""资源类型，取值有：
<ul><li> **1**：模板</li>
<li> **2**：文件（默认值）</li></ul>
:rtype: int
"""
return self._ResourceType
@ResourceType.setter
def ResourceType(self, ResourceType):
self._ResourceType = ResourceType
@property
def FlowInfo(self):
"""要创建的合同信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.BaseFlowInfo`
"""
return self._FlowInfo
@FlowInfo.setter
def FlowInfo(self, FlowInfo):
self._FlowInfo = FlowInfo
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ResourceId(self):
"""资源id，与ResourceType相对应，取值范围：
<ul>
<li>文件Id（通过UploadFiles获取文件资源Id）</li>
<li>模板Id（通过控制台创建模板后获取模板Id）</li>
</ul>
注意：需要同时设置 ResourceType 参数指定资源类型
:rtype: str
"""
return self._ResourceId
@ResourceId.setter
def ResourceId(self, ResourceId):
self._ResourceId = ResourceId
@property
def FlowOption(self):
"""合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑
:rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowOption`
"""
return self._FlowOption
@FlowOption.setter
def FlowOption(self, FlowOption):
self._FlowOption = FlowOption
@property
def FlowApproverList(self):
"""合同签署人信息
:rtype: list of CommonFlowApprover
"""
return self._FlowApproverList
@FlowApproverList.setter
def FlowApproverList(self, FlowApproverList):
self._FlowApproverList = FlowApproverList
@property
def FlowId(self):
"""合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def NeedPreview(self):
warnings.warn("parameter `NeedPreview` is deprecated", DeprecationWarning)
"""该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL
:rtype: bool
"""
return self._NeedPreview
@NeedPreview.setter
def NeedPreview(self, NeedPreview):
warnings.warn("parameter `NeedPreview` is deprecated", DeprecationWarning)
self._NeedPreview = NeedPreview
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""企业机构信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作人（用户）信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
self._ResourceType = params.get("ResourceType")
if params.get("FlowInfo") is not None:
self._FlowInfo = BaseFlowInfo()
self._FlowInfo._deserialize(params.get("FlowInfo"))
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ResourceId = params.get("ResourceId")
if params.get("FlowOption") is not None:
self._FlowOption = CreateFlowOption()
self._FlowOption._deserialize(params.get("FlowOption"))
if params.get("FlowApproverList") is not None:
self._FlowApproverList = []
for item in params.get("FlowApproverList"):
obj = CommonFlowApprover()
obj._deserialize(item)
self._FlowApproverList.append(obj)
self._FlowId = params.get("FlowId")
self._NeedPreview = params.get("NeedPreview")
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreatePrepareFlowResponse(AbstractModel):
"""ChannelCreatePrepareFlow返回参数结构体
"""
def __init__(self):
r"""
:param _PrepareFlowUrl: 发起的合同嵌入链接， 可以直接点击进入进行合同发起， 有效期为5分钟
:type PrepareFlowUrl: str
:param _PreviewFlowUrl: 合同发起后预览链接， 注意此时合同并未发起，仅只是展示效果， 有效期为5分钟
:type PreviewFlowUrl: str
:param _FlowId: 发起的合同临时Id， 只有当点击进入链接，成功发起合同后， 此Id才有效
:type FlowId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._PrepareFlowUrl = None
self._PreviewFlowUrl = None
self._FlowId = None
self._RequestId = None
@property
def PrepareFlowUrl(self):
"""发起的合同嵌入链接， 可以直接点击进入进行合同发起， 有效期为5分钟
:rtype: str
"""
return self._PrepareFlowUrl
@PrepareFlowUrl.setter
def PrepareFlowUrl(self, PrepareFlowUrl):
self._PrepareFlowUrl = PrepareFlowUrl
@property
def PreviewFlowUrl(self):
"""合同发起后预览链接， 注意此时合同并未发起，仅只是展示效果， 有效期为5分钟
:rtype: str
"""
return self._PreviewFlowUrl
@PreviewFlowUrl.setter
def PreviewFlowUrl(self, PreviewFlowUrl):
self._PreviewFlowUrl = PreviewFlowUrl
@property
def FlowId(self):
"""发起的合同临时Id， 只有当点击进入链接，成功发起合同后， 此Id才有效
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._PrepareFlowUrl = params.get("PrepareFlowUrl")
self._PreviewFlowUrl = params.get("PreviewFlowUrl")
self._FlowId = params.get("FlowId")
self._RequestId = params.get("RequestId")
class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
"""ChannelCreatePreparedPersonalEsign请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _UserName: 个人用户姓名
:type UserName: str
:param _IdCardNumber: 证件号码, 应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type IdCardNumber: str
:param _SealName: 电子印章名字，1-50个中文字符
注:`同一企业下电子印章名字不能相同`
:type SealName: str
:param _SealImage: 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。
:type SealImage: str
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _IdCardType: 证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE : 其他</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:type IdCardType: str
:param _SealImageCompress: 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
:type SealImageCompress: bool
:param _Mobile: 手机号码；当需要开通自动签时，该参数必传
:type Mobile: str
:param _EnableAutoSign: 此字段已废弃，请勿继续使用。
:type EnableAutoSign: bool
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
:type LicenseType: int
:param _SceneKey: <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
"""
self._Agent = None
self._UserName = None
self._IdCardNumber = None
self._SealName = None
self._SealImage = None
self._Operator = None
self._IdCardType = None
self._SealImageCompress = None
self._Mobile = None
self._EnableAutoSign = None
self._LicenseType = None
self._SceneKey = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def UserName(self):
"""个人用户姓名
:rtype: str
"""
return self._UserName
@UserName.setter
def UserName(self, UserName):
self._UserName = UserName
@property
def IdCardNumber(self):
"""证件号码, 应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def SealName(self):
"""电子印章名字，1-50个中文字符
注:`同一企业下电子印章名字不能相同`
:rtype: str
"""
return self._SealName
@SealName.setter
def SealName(self, SealName):
self._SealName = SealName
@property
def SealImage(self):
"""电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。
:rtype: str
"""
return self._SealImage
@SealImage.setter
def SealImage(self, SealImage):
self._SealImage = SealImage
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
@property
def IdCardType(self):
"""证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE : 其他</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def SealImageCompress(self):
"""是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
:rtype: bool
"""
return self._SealImageCompress
@SealImageCompress.setter
def SealImageCompress(self, SealImageCompress):
self._SealImageCompress = SealImageCompress
@property
def Mobile(self):
"""手机号码；当需要开通自动签时，该参数必传
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def EnableAutoSign(self):
"""此字段已废弃，请勿继续使用。
:rtype: bool
"""
return self._EnableAutoSign
@EnableAutoSign.setter
def EnableAutoSign(self, EnableAutoSign):
self._EnableAutoSign = EnableAutoSign
@property
def LicenseType(self):
"""设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
:rtype: int
"""
return self._LicenseType
@LicenseType.setter
def LicenseType(self, LicenseType):
self._LicenseType = LicenseType
@property
def SceneKey(self):
"""<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._UserName = params.get("UserName")
self._IdCardNumber = params.get("IdCardNumber")
self._SealName = params.get("SealName")
self._SealImage = params.get("SealImage")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._IdCardType = params.get("IdCardType")
self._SealImageCompress = params.get("SealImageCompress")
self._Mobile = params.get("Mobile")
self._EnableAutoSign = params.get("EnableAutoSign")
self._LicenseType = params.get("LicenseType")
self._SceneKey = params.get("SceneKey")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreatePreparedPersonalEsignResponse(AbstractModel):
"""ChannelCreatePreparedPersonalEsign返回参数结构体
"""
def __init__(self):
r"""
:param _SealId: 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
:type SealId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._SealId = None
self._RequestId = None
@property
def SealId(self):
"""电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._SealId = params.get("SealId")
self._RequestId = params.get("RequestId")
class ChannelCreateReleaseFlowRequest(AbstractModel):
"""ChannelCreateReleaseFlow请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:type NeedRelievedFlowId: str
:param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
:type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
:param _ReleasedApprovers: 替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号，默认从0开始，顺序递增)<br/>
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. <b>仅将需要替换的签署人添加至此列表</b>，无需替换的签署人无需添加进来。
:type ReleasedApprovers: list of ReleasedApprover
:param _CallbackUrl: 签署完回调url，最大长度1000个字符
:type CallbackUrl: str
: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: int
:param _UserData: 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
:type UserData: str
"""
self._Agent = None
self._NeedRelievedFlowId = None
self._ReliveInfo = None
self._ReleasedApprovers = None
self._CallbackUrl = None
self._Organization = None
self._Operator = None
self._Deadline = None
self._UserData = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def NeedRelievedFlowId(self):
"""待解除的签署流程编号(即原签署流程的编号)。
[点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:rtype: str
"""
return self._NeedRelievedFlowId
@NeedRelievedFlowId.setter
def NeedRelievedFlowId(self, NeedRelievedFlowId):
self._NeedRelievedFlowId = NeedRelievedFlowId
@property
def ReliveInfo(self):
"""解除协议内容, 包括解除理由等信息。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
"""
return self._ReliveInfo
@ReliveInfo.setter
def ReliveInfo(self, ReliveInfo):
self._ReliveInfo = ReliveInfo
@property
def ReleasedApprovers(self):
"""替换解除协议的签署人， 如不指定新的签署人，将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
如需更换原合同中的企业端签署人，可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号，默认从0开始，顺序递增)<br/>
注：
1. 支持更换企业的签署人，不支持更换个人类型的签署人。
2. 己方企业支持自动签署，他方企业不支持自动签署。
3. <b>仅将需要替换的签署人添加至此列表</b>，无需替换的签署人无需添加进来。
:rtype: list of ReleasedApprover
"""
return self._ReleasedApprovers
@ReleasedApprovers.setter
def ReleasedApprovers(self, ReleasedApprovers):
self._ReleasedApprovers = ReleasedApprovers
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""签署完回调url，最大长度1000个字符
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Deadline(self):
"""合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def UserData(self):
"""调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
:rtype: str
"""
return self._UserData
@UserData.setter
def UserData(self, UserData):
self._UserData = UserData
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._NeedRelievedFlowId = params.get("NeedRelievedFlowId")
if params.get("ReliveInfo") is not None:
self._ReliveInfo = RelieveInfo()
self._ReliveInfo._deserialize(params.get("ReliveInfo"))
if params.get("ReleasedApprovers") is not None:
self._ReleasedApprovers = []
for item in params.get("ReleasedApprovers"):
obj = ReleasedApprover()
obj._deserialize(item)
self._ReleasedApprovers.append(obj)
self._CallbackUrl = params.get("CallbackUrl")
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._Deadline = params.get("Deadline")
self._UserData = params.get("UserData")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateReleaseFlowResponse(AbstractModel):
"""ChannelCreateReleaseFlow返回参数结构体
"""
def __init__(self):
r"""
:param _FlowId: 解除协议流程编号
:type FlowId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowId = None
self._RequestId = None
@property
def FlowId(self):
"""解除协议流程编号
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._RequestId = params.get("RequestId")
class ChannelCreateRoleRequest(AbstractModel):
"""ChannelCreateRole请求参数结构体
"""
def __init__(self):
r"""
:param _Name: 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
:type Name: str
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Description: 角色描述，最大长度为50个字符
:type Description: str
:param _PermissionGroups: 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
:type PermissionGroups: list of PermissionGroup
"""
self._Name = None
self._Agent = None
self._Description = None
self._PermissionGroups = None
@property
def Name(self):
"""角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Description(self):
"""角色描述，最大长度为50个字符
:rtype: str
"""
return self._Description
@Description.setter
def Description(self, Description):
self._Description = Description
@property
def PermissionGroups(self):
"""权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
:rtype: list of PermissionGroup
"""
return self._PermissionGroups
@PermissionGroups.setter
def PermissionGroups(self, PermissionGroups):
self._PermissionGroups = PermissionGroups
def _deserialize(self, params):
self._Name = params.get("Name")
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Description = params.get("Description")
if params.get("PermissionGroups") is not None:
self._PermissionGroups = []
for item in params.get("PermissionGroups"):
obj = PermissionGroup()
obj._deserialize(item)
self._PermissionGroups.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateRoleResponse(AbstractModel):
"""ChannelCreateRole返回参数结构体
"""
def __init__(self):
r"""
:param _RoleId: 角色id
:type RoleId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RoleId = None
self._RequestId = None
@property
def RoleId(self):
"""角色id
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RoleId = params.get("RoleId")
self._RequestId = params.get("RequestId")
class ChannelCreateSealPolicyRequest(AbstractModel):
"""ChannelCreateSealPolicy请求参数结构体
"""
def __init__(self):
r"""
: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: str
:param _UserIds:
员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
指定待授权的用户ID数组,电子签的用户ID
可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权。
:type UserIds: list of str
:param _Operator: 操作人（用户）信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _Organization: 企业机构信息，不用传
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
self._Agent = None
self._SealId = None
self._UserIds = None
self._Operator = None
self._Organization = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SealId(self):
"""电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台，在 "印章"->"印章中心"选择查看的印章，在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def UserIds(self):
"""
员工在腾讯电子签平台的唯一身份标识，为32位字符串。
可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一企业内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
指定待授权的用户ID数组,电子签的用户ID
可以填写OpenId，系统会通过组织+渠道+OpenId查询得到UserId进行授权。
:rtype: list of str
"""
return self._UserIds
@UserIds.setter
def UserIds(self, UserIds):
self._UserIds = UserIds
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作人（用户）信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""企业机构信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SealId = params.get("SealId")
self._UserIds = params.get("UserIds")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateSealPolicyResponse(AbstractModel):
"""ChannelCreateSealPolicy返回参数结构体
"""
def __init__(self):
r"""
:param _UserIds: 最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
请求参数填写OpenId时，返回授权成功的 Openid。
:type UserIds: list of str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._UserIds = None
self._RequestId = None
@property
def UserIds(self):
"""最终授权成功的电子签系统用户ID数组。其他的跳过的是已经授权了的。
请求参数填写OpenId时，返回授权成功的 Openid。
:rtype: list of str
"""
return self._UserIds
@UserIds.setter
def UserIds(self, UserIds):
self._UserIds = UserIds
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._UserIds = params.get("UserIds")
self._RequestId = params.get("RequestId")
class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
"""ChannelCreateUserAutoSignEnableUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
:type AutoSignConfig: :class:`tencentcloud.essbasic.v20210526.models.AutoSignConfig`
:param _UrlType: 生成的链接类型：
<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
<li> **H5SIGN** : 生成H5端开通链接</li></ul>
:type UrlType: str
:param _NotifyType: 是否通知开通方，通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
:type NotifyType: str
:param _NotifyAddress: 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
:type NotifyAddress: str
:param _ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
:type ExpiredTime: int
:param _UserData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。
:type UserData: str
"""
self._Agent = None
self._SceneKey = None
self._Operator = None
self._AutoSignConfig = None
self._UrlType = None
self._NotifyType = None
self._NotifyAddress = None
self._ExpiredTime = None
self._UserData = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
@property
def AutoSignConfig(self):
"""自动签开通配置信息, 包括开通的人员的信息等
:rtype: :class:`tencentcloud.essbasic.v20210526.models.AutoSignConfig`
"""
return self._AutoSignConfig
@AutoSignConfig.setter
def AutoSignConfig(self, AutoSignConfig):
self._AutoSignConfig = AutoSignConfig
@property
def UrlType(self):
"""生成的链接类型：
<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
<li> **H5SIGN** : 生成H5端开通链接</li></ul>
:rtype: str
"""
return self._UrlType
@UrlType.setter
def UrlType(self, UrlType):
self._UrlType = UrlType
@property
def NotifyType(self):
"""是否通知开通方，通知类型:<ul><li>默认为不通知开通方</li><li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
:rtype: str
"""
return self._NotifyType
@NotifyType.setter
def NotifyType(self, NotifyType):
self._NotifyType = NotifyType
@property
def NotifyAddress(self):
"""如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
:rtype: str
"""
return self._NotifyAddress
@NotifyAddress.setter
def NotifyAddress(self, NotifyAddress):
self._NotifyAddress = NotifyAddress
@property
def ExpiredTime(self):
"""链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
@property
def UserData(self):
"""调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。
:rtype: str
"""
return self._UserData
@UserData.setter
def UserData(self, UserData):
self._UserData = UserData
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SceneKey = params.get("SceneKey")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
if params.get("AutoSignConfig") is not None:
self._AutoSignConfig = AutoSignConfig()
self._AutoSignConfig._deserialize(params.get("AutoSignConfig"))
self._UrlType = params.get("UrlType")
self._NotifyType = params.get("NotifyType")
self._NotifyAddress = params.get("NotifyAddress")
self._ExpiredTime = params.get("ExpiredTime")
self._UserData = params.get("UserData")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateUserAutoSignEnableUrlResponse(AbstractModel):
"""ChannelCreateUserAutoSignEnableUrl返回参数结构体
"""
def __init__(self):
r"""
:param _Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
:type Url: str
:param _AppId: 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
:type AppId: str
:param _AppOriginalId: 腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
:type AppOriginalId: str
:param _Path: 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
:type Path: str
:param _QrCode: base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
注: `如果获取的是H5链接, 则不会返回此二维码图片`
:type QrCode: str
:param _UrlType: 返回的链接类型
<ul><li> 空: 默认小程序端链接</li>
<li> **H5SIGN** : h5端链接</li></ul>
:type UrlType: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Url = None
self._AppId = None
self._AppOriginalId = None
self._Path = None
self._QrCode = None
self._UrlType = None
self._RequestId = None
@property
def Url(self):
"""个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def AppId(self):
"""腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
:rtype: str
"""
return self._AppId
@AppId.setter
def AppId(self, AppId):
self._AppId = AppId
@property
def AppOriginalId(self):
"""腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
:rtype: str
"""
return self._AppOriginalId
@AppOriginalId.setter
def AppOriginalId(self, AppOriginalId):
self._AppOriginalId = AppOriginalId
@property
def Path(self):
"""腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
注: `如果获取的是H5链接, 则不会返回此值`
:rtype: str
"""
return self._Path
@Path.setter
def Path(self, Path):
self._Path = Path
@property
def QrCode(self):
"""base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
注: `如果获取的是H5链接, 则不会返回此二维码图片`
:rtype: str
"""
return self._QrCode
@QrCode.setter
def QrCode(self, QrCode):
self._QrCode = QrCode
@property
def UrlType(self):
"""返回的链接类型
<ul><li> 空: 默认小程序端链接</li>
<li> **H5SIGN** : h5端链接</li></ul>
:rtype: str
"""
return self._UrlType
@UrlType.setter
def UrlType(self, UrlType):
self._UrlType = UrlType
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Url = params.get("Url")
self._AppId = params.get("AppId")
self._AppOriginalId = params.get("AppOriginalId")
self._Path = params.get("Path")
self._QrCode = params.get("QrCode")
self._UrlType = params.get("UrlType")
self._RequestId = params.get("RequestId")
class ChannelCreateUserAutoSignSealUrlRequest(AbstractModel):
"""ChannelCreateUserAutoSignSealUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 渠道应用相关信息。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
:param _UserInfo: 自动签开通个人用户信息，包括名字，身份证等。
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
:type ExpiredTime: int
"""
self._Agent = None
self._SceneKey = None
self._UserInfo = None
self._Operator = None
self._ExpiredTime = None
@property
def Agent(self):
"""渠道应用相关信息。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
@property
def UserInfo(self):
"""自动签开通个人用户信息，包括名字，身份证等。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
return self._UserInfo
@UserInfo.setter
def UserInfo(self, UserInfo):
self._UserInfo = UserInfo
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
@property
def ExpiredTime(self):
"""链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SceneKey = params.get("SceneKey")
if params.get("UserInfo") is not None:
self._UserInfo = UserThreeFactor()
self._UserInfo._deserialize(params.get("UserInfo"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._ExpiredTime = params.get("ExpiredTime")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateUserAutoSignSealUrlResponse(AbstractModel):
"""ChannelCreateUserAutoSignSealUrl返回参数结构体
"""
def __init__(self):
r"""
:param _AppId: 腾讯电子签小程序的AppId，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
:type AppId: str
:param _AppOriginalId: 腾讯电子签小程序的原始Id，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
:type AppOriginalId: str
:param _Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
:type Url: str
:param _Path: 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
:type Path: str
:param _QrCode: base64格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
:type QrCode: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._AppId = None
self._AppOriginalId = None
self._Url = None
self._Path = None
self._QrCode = None
self._RequestId = None
@property
def AppId(self):
"""腾讯电子签小程序的AppId，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
:rtype: str
"""
return self._AppId
@AppId.setter
def AppId(self, AppId):
self._AppId = AppId
@property
def AppOriginalId(self):
"""腾讯电子签小程序的原始Id，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
:rtype: str
"""
return self._AppOriginalId
@AppOriginalId.setter
def AppOriginalId(self, AppOriginalId):
self._AppOriginalId = AppOriginalId
@property
def Url(self):
"""个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def Path(self):
"""腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
:rtype: str
"""
return self._Path
@Path.setter
def Path(self, Path):
self._Path = Path
@property
def QrCode(self):
"""base64格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
:rtype: str
"""
return self._QrCode
@QrCode.setter
def QrCode(self, QrCode):
self._QrCode = QrCode
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._AppId = params.get("AppId")
self._AppOriginalId = params.get("AppOriginalId")
self._Url = params.get("Url")
self._Path = params.get("Path")
self._QrCode = params.get("QrCode")
self._RequestId = params.get("RequestId")
class ChannelCreateUserRolesRequest(AbstractModel):
"""ChannelCreateUserRoles请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _RoleIds: 绑定角色的角色id列表，最多 100 个
:type RoleIds: list of str
:param _UserIds: 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多 100 个
:type UserIds: list of str
:param _OpenIds: 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多 100 个
:type OpenIds: list of str
:param _Operator: 操作者信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._RoleIds = None
self._UserIds = None
self._OpenIds = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def RoleIds(self):
"""绑定角色的角色id列表，最多 100 个
:rtype: list of str
"""
return self._RoleIds
@RoleIds.setter
def RoleIds(self, RoleIds):
self._RoleIds = RoleIds
@property
def UserIds(self):
"""电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多 100 个
:rtype: list of str
"""
return self._UserIds
@UserIds.setter
def UserIds(self, UserIds):
self._UserIds = UserIds
@property
def OpenIds(self):
"""客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多 100 个
:rtype: list of str
"""
return self._OpenIds
@OpenIds.setter
def OpenIds(self, OpenIds):
self._OpenIds = OpenIds
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._RoleIds = params.get("RoleIds")
self._UserIds = params.get("UserIds")
self._OpenIds = params.get("OpenIds")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateUserRolesResponse(AbstractModel):
"""ChannelCreateUserRoles返回参数结构体
"""
def __init__(self):
r"""
:param _FailedCreateRoleData: 绑定失败的用户角色列表
:type FailedCreateRoleData: list of FailedCreateRoleData
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FailedCreateRoleData = None
self._RequestId = None
@property
def FailedCreateRoleData(self):
"""绑定失败的用户角色列表
:rtype: list of FailedCreateRoleData
"""
return self._FailedCreateRoleData
@FailedCreateRoleData.setter
def FailedCreateRoleData(self, FailedCreateRoleData):
self._FailedCreateRoleData = FailedCreateRoleData
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("FailedCreateRoleData") is not None:
self._FailedCreateRoleData = []
for item in params.get("FailedCreateRoleData"):
obj = FailedCreateRoleData()
obj._deserialize(item)
self._FailedCreateRoleData.append(obj)
self._RequestId = params.get("RequestId")
class ChannelCreateWebThemeConfigRequest(AbstractModel):
"""ChannelCreateWebThemeConfig请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ThemeType: 主题类型<br/>EMBED_WEB_THEME：嵌入式主题
<ul>
<li>EMBED_WEB_THEME，web页面嵌入的主题风格配置</li>
<li>COMPANY_AUTHENTICATE，子客认证主题配置， 对当前第三方应用号生效，
目前支持的有，背景图替换，隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
</ul>
:type ThemeType: str
:param _WebThemeConfig: 主题配置
:type WebThemeConfig: :class:`tencentcloud.essbasic.v20210526.models.WebThemeConfig`
"""
self._Agent = None
self._ThemeType = None
self._WebThemeConfig = None
@property
def Agent(self):
"""应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ThemeType(self):
"""主题类型<br/>EMBED_WEB_THEME：嵌入式主题
<ul>
<li>EMBED_WEB_THEME，web页面嵌入的主题风格配置</li>
<li>COMPANY_AUTHENTICATE，子客认证主题配置， 对当前第三方应用号生效，
目前支持的有，背景图替换，隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
</ul>
:rtype: str
"""
return self._ThemeType
@ThemeType.setter
def ThemeType(self, ThemeType):
self._ThemeType = ThemeType
@property
def WebThemeConfig(self):
"""主题配置
:rtype: :class:`tencentcloud.essbasic.v20210526.models.WebThemeConfig`
"""
return self._WebThemeConfig
@WebThemeConfig.setter
def WebThemeConfig(self, WebThemeConfig):
self._WebThemeConfig = WebThemeConfig
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ThemeType = params.get("ThemeType")
if params.get("WebThemeConfig") is not None:
self._WebThemeConfig = WebThemeConfig()
self._WebThemeConfig._deserialize(params.get("WebThemeConfig"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelCreateWebThemeConfigResponse(AbstractModel):
"""ChannelCreateWebThemeConfig返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelDeleteRoleRequest(AbstractModel):
"""ChannelDeleteRole请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _RoleIds: 角色id，最多20个
:type RoleIds: list of str
"""
self._Agent = None
self._RoleIds = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def RoleIds(self):
"""角色id，最多20个
:rtype: list of str
"""
return self._RoleIds
@RoleIds.setter
def RoleIds(self, RoleIds):
self._RoleIds = RoleIds
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._RoleIds = params.get("RoleIds")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDeleteRoleResponse(AbstractModel):
"""ChannelDeleteRole返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelDeleteRoleUsersRequest(AbstractModel):
"""ChannelDeleteRoleUsers请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 代理信息此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _RoleId: 角色Id（非超管或法人角色Id）
:type RoleId: str
:param _UserIds: 电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多两百
:type UserIds: list of str
:param _Operator: 操作人信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _OpenIds: 客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多两百
:type OpenIds: list of str
"""
self._Agent = None
self._RoleId = None
self._UserIds = None
self._Operator = None
self._OpenIds = None
@property
def Agent(self):
"""代理信息此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def RoleId(self):
"""角色Id（非超管或法人角色Id）
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def UserIds(self):
"""电子签用户ID列表，与OpenIds参数二选一,优先UserIds参数，最多两百
:rtype: list of str
"""
return self._UserIds
@UserIds.setter
def UserIds(self, UserIds):
self._UserIds = UserIds
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作人信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def OpenIds(self):
"""客户系统用户ID列表，与UserIds参数二选一,优先UserIds参数，最多两百
:rtype: list of str
"""
return self._OpenIds
@OpenIds.setter
def OpenIds(self, OpenIds):
self._OpenIds = OpenIds
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._RoleId = params.get("RoleId")
self._UserIds = params.get("UserIds")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._OpenIds = params.get("OpenIds")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDeleteRoleUsersResponse(AbstractModel):
"""ChannelDeleteRoleUsers返回参数结构体
"""
def __init__(self):
r"""
:param _RoleId: 角色id
:type RoleId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RoleId = None
self._RequestId = None
@property
def RoleId(self):
"""角色id
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RoleId = params.get("RoleId")
self._RequestId = params.get("RequestId")
class ChannelDeleteSealPoliciesRequest(AbstractModel):
"""ChannelDeleteSealPolicies请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SealId: 操作的印章ID
:type SealId: str
:param _UserIds: 需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。
注:
1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`
:type UserIds: list of str
:param _Organization: 组织机构信息，不用传
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
:param _Operator: 操作人（用户）信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._SealId = None
self._UserIds = None
self._Organization = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SealId(self):
"""操作的印章ID
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def UserIds(self):
"""需要删除授权的用户ID数组，可以传入电子签系统用户ID或OpenId。
注:
1. `填写OpenId时，系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`
:rtype: list of str
"""
return self._UserIds
@UserIds.setter
def UserIds(self, UserIds):
self._UserIds = UserIds
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""组织机构信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作人（用户）信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SealId = params.get("SealId")
self._UserIds = params.get("UserIds")
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDeleteSealPoliciesResponse(AbstractModel):
"""ChannelDeleteSealPolicies返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelDescribeAccountBillDetailRequest(AbstractModel):
"""ChannelDescribeAccountBillDetail请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
第三方平台子客企业必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._Agent = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
第三方平台子客企业必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeAccountBillDetailResponse(AbstractModel):
"""ChannelDescribeAccountBillDetail返回参数结构体
"""
def __init__(self):
r"""
:param _BoundAccountsNumber: 当前绑定中账号数量
:type BoundAccountsNumber: int
:param _RemainAvailableAccountsNumber: 剩余可绑定账号数量
:type RemainAvailableAccountsNumber: int
:param _InvalidAccountsNumber: 已失效账号数量
:type InvalidAccountsNumber: int
:param _TotalBuyAccountsNumber: 购买数量
:type TotalBuyAccountsNumber: int
:param _TotalGiftAccountsNumber: 赠送数量
:type TotalGiftAccountsNumber: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._BoundAccountsNumber = None
self._RemainAvailableAccountsNumber = None
self._InvalidAccountsNumber = None
self._TotalBuyAccountsNumber = None
self._TotalGiftAccountsNumber = None
self._RequestId = None
@property
def BoundAccountsNumber(self):
"""当前绑定中账号数量
:rtype: int
"""
return self._BoundAccountsNumber
@BoundAccountsNumber.setter
def BoundAccountsNumber(self, BoundAccountsNumber):
self._BoundAccountsNumber = BoundAccountsNumber
@property
def RemainAvailableAccountsNumber(self):
"""剩余可绑定账号数量
:rtype: int
"""
return self._RemainAvailableAccountsNumber
@RemainAvailableAccountsNumber.setter
def RemainAvailableAccountsNumber(self, RemainAvailableAccountsNumber):
self._RemainAvailableAccountsNumber = RemainAvailableAccountsNumber
@property
def InvalidAccountsNumber(self):
"""已失效账号数量
:rtype: int
"""
return self._InvalidAccountsNumber
@InvalidAccountsNumber.setter
def InvalidAccountsNumber(self, InvalidAccountsNumber):
self._InvalidAccountsNumber = InvalidAccountsNumber
@property
def TotalBuyAccountsNumber(self):
"""购买数量
:rtype: int
"""
return self._TotalBuyAccountsNumber
@TotalBuyAccountsNumber.setter
def TotalBuyAccountsNumber(self, TotalBuyAccountsNumber):
self._TotalBuyAccountsNumber = TotalBuyAccountsNumber
@property
def TotalGiftAccountsNumber(self):
"""赠送数量
:rtype: int
"""
return self._TotalGiftAccountsNumber
@TotalGiftAccountsNumber.setter
def TotalGiftAccountsNumber(self, TotalGiftAccountsNumber):
self._TotalGiftAccountsNumber = TotalGiftAccountsNumber
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._BoundAccountsNumber = params.get("BoundAccountsNumber")
self._RemainAvailableAccountsNumber = params.get("RemainAvailableAccountsNumber")
self._InvalidAccountsNumber = params.get("InvalidAccountsNumber")
self._TotalBuyAccountsNumber = params.get("TotalBuyAccountsNumber")
self._TotalGiftAccountsNumber = params.get("TotalGiftAccountsNumber")
self._RequestId = params.get("RequestId")
class ChannelDescribeBillUsageDetailRequest(AbstractModel):
"""ChannelDescribeBillUsageDetail请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
第三方平台子客企业必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _StartTime: 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
:type StartTime: str
:param _EndTime: 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
:type EndTime: str
:param _QuotaType: 查询的套餐类型 （选填 ）不传则查询所有套餐；
目前支持:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
:type QuotaType: str
:param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
:type Offset: int
:param _Limit: 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
:type Limit: int
"""
self._Agent = None
self._StartTime = None
self._EndTime = None
self._QuotaType = None
self._Offset = None
self._Limit = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
第三方平台子客企业必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def StartTime(self):
"""查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
:rtype: str
"""
return self._StartTime
@StartTime.setter
def StartTime(self, StartTime):
self._StartTime = StartTime
@property
def EndTime(self):
"""查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
:rtype: str
"""
return self._EndTime
@EndTime.setter
def EndTime(self, EndTime):
self._EndTime = EndTime
@property
def QuotaType(self):
"""查询的套餐类型 （选填 ）不传则查询所有套餐；
目前支持:
<ul>
<li>**CloudEnterprise**: 企业版合同</li>
<li>**SingleSignature**: 单方签章</li>
<li>**CloudProve**: 签署报告</li>
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
<li>**ChannelWeCard**: 微工卡</li>
<li>**SignFlow**: 合同套餐</li>
<li>**SignFace**: 签署意愿（人脸识别）</li>
<li>**SignPassword**: 签署意愿（密码）</li>
<li>**SignSMS**: 签署意愿（短信）</li>
<li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
<li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
<li>**OrgEssAuth**: 签署企业实名</li>
<li>**FlowNotify**: 短信通知</li>
<li>**AuthService**: 企业工商信息查询</li>
</ul>
:rtype: str
"""
return self._QuotaType
@QuotaType.setter
def QuotaType(self, QuotaType):
self._QuotaType = QuotaType
@property
def Offset(self):
"""指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Limit(self):
"""指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._StartTime = params.get("StartTime")
self._EndTime = params.get("EndTime")
self._QuotaType = params.get("QuotaType")
self._Offset = params.get("Offset")
self._Limit = params.get("Limit")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeBillUsageDetailResponse(AbstractModel):
"""ChannelDescribeBillUsageDetail返回参数结构体
"""
def __init__(self):
r"""
:param _Total: 返回查询记录总数
:type Total: int
:param _Details: 消耗记录详情
:type Details: list of ChannelBillUsageDetail
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Total = None
self._Details = None
self._RequestId = None
@property
def Total(self):
"""返回查询记录总数
:rtype: int
"""
return self._Total
@Total.setter
def Total(self, Total):
self._Total = Total
@property
def Details(self):
"""消耗记录详情
:rtype: list of ChannelBillUsageDetail
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Total = params.get("Total")
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = ChannelBillUsageDetail()
obj._deserialize(item)
self._Details.append(obj)
self._RequestId = params.get("RequestId")
class ChannelDescribeEmployeesRequest(AbstractModel):
"""ChannelDescribeEmployees请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Limit: 指定分页每页返回的数据条数，单页最大支持 20。
:type Limit: int
:param _Filters: 查询的关键字段，支持Key-Values查询。可选键值如下：
<ul>
<li>Key:**"Status"**，Values: **["IsVerified"]**, 查询已实名的员工</li>
<li>Key:**"Status"**，Values: **["QuiteJob"]**, 查询离职员工</li>
<li>Key:**"StaffOpenId"**，Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
</ul>
注: `同名字的Key的过滤条件会冲突, 只能填写一个`
:type Filters: list of Filter
:param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页。
页码从 0 开始，即首页为 0，最大20000。
:type Offset: int
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._Limit = None
self._Filters = None
self._Offset = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Limit(self):
"""指定分页每页返回的数据条数，单页最大支持 20。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Filters(self):
"""查询的关键字段，支持Key-Values查询。可选键值如下：
<ul>
<li>Key:**"Status"**，Values: **["IsVerified"]**, 查询已实名的员工</li>
<li>Key:**"Status"**，Values: **["QuiteJob"]**, 查询离职员工</li>
<li>Key:**"StaffOpenId"**，Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
</ul>
注: `同名字的Key的过滤条件会冲突, 只能填写一个`
:rtype: list of Filter
"""
return self._Filters
@Filters.setter
def Filters(self, Filters):
self._Filters = Filters
@property
def Offset(self):
"""指定分页返回第几页的数据，如果不传默认返回第一页。
页码从 0 开始，即首页为 0，最大20000。
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Limit = params.get("Limit")
if params.get("Filters") is not None:
self._Filters = []
for item in params.get("Filters"):
obj = Filter()
obj._deserialize(item)
self._Filters.append(obj)
self._Offset = params.get("Offset")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeEmployeesResponse(AbstractModel):
"""ChannelDescribeEmployees返回参数结构体
"""
def __init__(self):
r"""
:param _Employees: 员工信息列表。
:type Employees: list of Staff
:param _Offset: 偏移量，默认为0，最大20000。关于<code>Offset</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688" target="_blank">简介</a>中的相关小节。
:type Offset: int
:param _Limit: 指定分页每页返回的数据条数，单页最大支持 20。
:type Limit: int
:param _TotalCount: 符合条件的员工数量。
:type TotalCount: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Employees = None
self._Offset = None
self._Limit = None
self._TotalCount = None
self._RequestId = None
@property
def Employees(self):
"""员工信息列表。
:rtype: list of Staff
"""
return self._Employees
@Employees.setter
def Employees(self, Employees):
self._Employees = Employees
@property
def Offset(self):
"""偏移量，默认为0，最大20000。关于<code>Offset</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688" target="_blank">简介</a>中的相关小节。
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Limit(self):
"""指定分页每页返回的数据条数，单页最大支持 20。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def TotalCount(self):
"""符合条件的员工数量。
:rtype: int
"""
return self._TotalCount
@TotalCount.setter
def TotalCount(self, TotalCount):
self._TotalCount = TotalCount
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("Employees") is not None:
self._Employees = []
for item in params.get("Employees"):
obj = Staff()
obj._deserialize(item)
self._Employees.append(obj)
self._Offset = params.get("Offset")
self._Limit = params.get("Limit")
self._TotalCount = params.get("TotalCount")
self._RequestId = params.get("RequestId")
class ChannelDescribeFlowComponentsRequest(AbstractModel):
"""ChannelDescribeFlowComponents请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 需要获取填写控件填写内容的合同流程ID
:type FlowId: str
"""
self._Agent = None
self._FlowId = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""需要获取填写控件填写内容的合同流程ID
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeFlowComponentsResponse(AbstractModel):
"""ChannelDescribeFlowComponents返回参数结构体
"""
def __init__(self):
r"""
:param _RecipientComponentInfos: 合同填写控件信息列表，填写控件会按照参与方角色进行分类。
:type RecipientComponentInfos: list of RecipientComponentInfo
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RecipientComponentInfos = None
self._RequestId = None
@property
def RecipientComponentInfos(self):
"""合同填写控件信息列表，填写控件会按照参与方角色进行分类。
:rtype: list of RecipientComponentInfo
"""
return self._RecipientComponentInfos
@RecipientComponentInfos.setter
def RecipientComponentInfos(self, RecipientComponentInfos):
self._RecipientComponentInfos = RecipientComponentInfos
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("RecipientComponentInfos") is not None:
self._RecipientComponentInfos = []
for item in params.get("RecipientComponentInfos"):
obj = RecipientComponentInfo()
obj._deserialize(item)
self._RecipientComponentInfos.append(obj)
self._RequestId = params.get("RequestId")
class ChannelDescribeOrganizationSealsRequest(AbstractModel):
"""ChannelDescribeOrganizationSeals请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Limit: 指定分页每页返回的数据条数，单页最大支持 100。
:type Limit: int
:param _Offset: 分页查询偏移量，默认为0，最大为20000
:type Offset: int
:param _InfoType: 查询授权用户信息类型，取值如下：
<ul> <li><b>0</b>：（默认）不返回授权用户信息</li> <li><b>1</b>：返回授权用户的信息</li> </ul>
:type InfoType: int
:param _SealId: 印章id，是否查询特定的印章（没有输入返回所有）
注: `没有输入返回所有记录，最大返回100条。`
:type SealId: str
:param _SealTypes: 电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: 公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**LEGAL_PERSON_SEAL**: 法定代表人章;</li><li>**EMPLOYEE_QUALIFICATION_SEAL**: 员工执业章</li></ul>注: `1.为空时查询所有类型的印章。`
:type SealTypes: list of str
:param _SealStatuses:
需查询的印章状态列表。
<ul> <li>空，()仅查询启用状态的印章；</li> <li><strong>ALL</strong>，查询所有状态的印章；</li> <li><strong>CHECKING</strong>，查询待审核的印章；</li> <li><strong>SUCCESS</strong>，查询启用状态的印章；</li> <li><strong>FAIL</strong>，查询印章审核拒绝的印章；</li> <li><strong>DISABLE</strong>，查询已停用的印章；</li> <li><strong>STOPPED</strong>，查询已终止的印章；</li> <li><strong>VOID</strong>，查询已作废的印章；</li> <li><strong>INVALID</strong>，查询已失效的印章。</li> </ul>
:type SealStatuses: list of str
"""
self._Agent = None
self._Limit = None
self._Offset = None
self._InfoType = None
self._SealId = None
self._SealTypes = None
self._SealStatuses = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Limit(self):
"""指定分页每页返回的数据条数，单页最大支持 100。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Offset(self):
"""分页查询偏移量，默认为0，最大为20000
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def InfoType(self):
"""查询授权用户信息类型，取值如下：
<ul> <li><b>0</b>：（默认）不返回授权用户信息</li> <li><b>1</b>：返回授权用户的信息</li> </ul>
:rtype: int
"""
return self._InfoType
@InfoType.setter
def InfoType(self, InfoType):
self._InfoType = InfoType
@property
def SealId(self):
"""印章id，是否查询特定的印章（没有输入返回所有）
注: `没有输入返回所有记录，最大返回100条。`
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def SealTypes(self):
"""电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: 公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**LEGAL_PERSON_SEAL**: 法定代表人章;</li><li>**EMPLOYEE_QUALIFICATION_SEAL**: 员工执业章</li></ul>注: `1.为空时查询所有类型的印章。`
:rtype: list of str
"""
return self._SealTypes
@SealTypes.setter
def SealTypes(self, SealTypes):
self._SealTypes = SealTypes
@property
def SealStatuses(self):
"""
需查询的印章状态列表。
<ul> <li>空，()仅查询启用状态的印章；</li> <li><strong>ALL</strong>，查询所有状态的印章；</li> <li><strong>CHECKING</strong>，查询待审核的印章；</li> <li><strong>SUCCESS</strong>，查询启用状态的印章；</li> <li><strong>FAIL</strong>，查询印章审核拒绝的印章；</li> <li><strong>DISABLE</strong>，查询已停用的印章；</li> <li><strong>STOPPED</strong>，查询已终止的印章；</li> <li><strong>VOID</strong>，查询已作废的印章；</li> <li><strong>INVALID</strong>，查询已失效的印章。</li> </ul>
:rtype: list of str
"""
return self._SealStatuses
@SealStatuses.setter
def SealStatuses(self, SealStatuses):
self._SealStatuses = SealStatuses
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Limit = params.get("Limit")
self._Offset = params.get("Offset")
self._InfoType = params.get("InfoType")
self._SealId = params.get("SealId")
self._SealTypes = params.get("SealTypes")
self._SealStatuses = params.get("SealStatuses")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeOrganizationSealsResponse(AbstractModel):
"""ChannelDescribeOrganizationSeals返回参数结构体
"""
def __init__(self):
r"""
:param _TotalCount: 在设定了SealId时，返回值为0或1；若未设定SealId，则返回公司的总印章数量
:type TotalCount: int
:param _Seals: 查询到的印章结果数组
:type Seals: list of OccupiedSeal
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._TotalCount = None
self._Seals = None
self._RequestId = None
@property
def TotalCount(self):
"""在设定了SealId时，返回值为0或1；若未设定SealId，则返回公司的总印章数量
:rtype: int
"""
return self._TotalCount
@TotalCount.setter
def TotalCount(self, TotalCount):
self._TotalCount = TotalCount
@property
def Seals(self):
"""查询到的印章结果数组
:rtype: list of OccupiedSeal
"""
return self._Seals
@Seals.setter
def Seals(self, Seals):
self._Seals = Seals
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._TotalCount = params.get("TotalCount")
if params.get("Seals") is not None:
self._Seals = []
for item in params.get("Seals"):
obj = OccupiedSeal()
obj._deserialize(item)
self._Seals.append(obj)
self._RequestId = params.get("RequestId")
class ChannelDescribeRolesRequest(AbstractModel):
"""ChannelDescribeRoles请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Limit: 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
注: `因为历史原因, 此字段为字符串类型`
:type Limit: str
:param _Filters: 查询的关键字段:
Key:"**RoleType**",Values:["**1**"]查询系统角色，
Key:"**RoleType**",Values:["**2**"]查询自定义角色
Key:"**RoleStatus**",Values:["**1**"]查询启用角色
Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
Key:"**IsReturnPermissionGroup**"，Values:["**0**"]表示接口不返回角色对应的权限树字段
Key:"**IsReturnPermissionGroup**"，Values:["**1**"]表示接口返回角色对应的权限树字段
注: `同名字的Key的过滤条件会冲突, 只能填写一个`
:type Filters: list of Filter
:param _Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
注：
1.`offset从0开始，即第一页为0。`
2.`默认从第一页返回。`
:type Offset: int
:param _Operator: 操作人信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._Limit = None
self._Filters = None
self._Offset = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Limit(self):
"""指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
注: `因为历史原因, 此字段为字符串类型`
:rtype: str
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Filters(self):
"""查询的关键字段:
Key:"**RoleType**",Values:["**1**"]查询系统角色，
Key:"**RoleType**",Values:["**2**"]查询自定义角色
Key:"**RoleStatus**",Values:["**1**"]查询启用角色
Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
Key:"**IsReturnPermissionGroup**"，Values:["**0**"]表示接口不返回角色对应的权限树字段
Key:"**IsReturnPermissionGroup**"，Values:["**1**"]表示接口返回角色对应的权限树字段
注: `同名字的Key的过滤条件会冲突, 只能填写一个`
:rtype: list of Filter
"""
return self._Filters
@Filters.setter
def Filters(self, Filters):
self._Filters = Filters
@property
def Offset(self):
"""查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
注：
1.`offset从0开始，即第一页为0。`
2.`默认从第一页返回。`
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作人信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Limit = params.get("Limit")
if params.get("Filters") is not None:
self._Filters = []
for item in params.get("Filters"):
obj = Filter()
obj._deserialize(item)
self._Filters.append(obj)
self._Offset = params.get("Offset")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeRolesResponse(AbstractModel):
"""ChannelDescribeRoles返回参数结构体
"""
def __init__(self):
r"""
:param _Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
:type Offset: int
:param _Limit: 指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
:type Limit: int
:param _TotalCount: 查询角色的总数量
:type TotalCount: int
:param _ChannelRoles: 查询的角色信息列表
:type ChannelRoles: list of ChannelRole
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Offset = None
self._Limit = None
self._TotalCount = None
self._ChannelRoles = None
self._RequestId = None
@property
def Offset(self):
"""查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用，最大2000条。
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Limit(self):
"""指定每页返回的数据条数，和Offset参数配合使用，单页最大200。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def TotalCount(self):
"""查询角色的总数量
:rtype: int
"""
return self._TotalCount
@TotalCount.setter
def TotalCount(self, TotalCount):
self._TotalCount = TotalCount
@property
def ChannelRoles(self):
"""查询的角色信息列表
:rtype: list of ChannelRole
"""
return self._ChannelRoles
@ChannelRoles.setter
def ChannelRoles(self, ChannelRoles):
self._ChannelRoles = ChannelRoles
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Offset = params.get("Offset")
self._Limit = params.get("Limit")
self._TotalCount = params.get("TotalCount")
if params.get("ChannelRoles") is not None:
self._ChannelRoles = []
for item in params.get("ChannelRoles"):
obj = ChannelRole()
obj._deserialize(item)
self._ChannelRoles.append(obj)
self._RequestId = params.get("RequestId")
class ChannelDescribeSignFaceVideoRequest(AbstractModel):
"""ChannelDescribeSignFaceVideo请求参数结构体
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
:type FlowId: str
:param _SignId: 签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
:type SignId: str
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._FlowId = None
self._SignId = None
self._Agent = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def SignId(self):
"""签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._SignId = params.get("SignId")
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeSignFaceVideoResponse(AbstractModel):
"""ChannelDescribeSignFaceVideo返回参数结构体
"""
def __init__(self):
r"""
:param _VideoData: 核身视频结果。
:type VideoData: :class:`tencentcloud.essbasic.v20210526.models.DetectInfoVideoData`
:param _IntentionQuestionResult: 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
:type IntentionQuestionResult: :class:`tencentcloud.essbasic.v20210526.models.IntentionQuestionResult`
:param _IntentionActionResult: 意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。
注意：此字段可能返回 null，表示取不到有效值。
:type IntentionActionResult: :class:`tencentcloud.essbasic.v20210526.models.IntentionActionResult`
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._VideoData = None
self._IntentionQuestionResult = None
self._IntentionActionResult = None
self._RequestId = None
@property
def VideoData(self):
"""核身视频结果。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.DetectInfoVideoData`
"""
return self._VideoData
@VideoData.setter
def VideoData(self, VideoData):
self._VideoData = VideoData
@property
def IntentionQuestionResult(self):
"""意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.IntentionQuestionResult`
"""
return self._IntentionQuestionResult
@IntentionQuestionResult.setter
def IntentionQuestionResult(self, IntentionQuestionResult):
self._IntentionQuestionResult = IntentionQuestionResult
@property
def IntentionActionResult(self):
"""意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.IntentionActionResult`
"""
return self._IntentionActionResult
@IntentionActionResult.setter
def IntentionActionResult(self, IntentionActionResult):
self._IntentionActionResult = IntentionActionResult
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("VideoData") is not None:
self._VideoData = DetectInfoVideoData()
self._VideoData._deserialize(params.get("VideoData"))
if params.get("IntentionQuestionResult") is not None:
self._IntentionQuestionResult = IntentionQuestionResult()
self._IntentionQuestionResult._deserialize(params.get("IntentionQuestionResult"))
if params.get("IntentionActionResult") is not None:
self._IntentionActionResult = IntentionActionResult()
self._IntentionActionResult._deserialize(params.get("IntentionActionResult"))
self._RequestId = params.get("RequestId")
class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
"""ChannelDescribeUserAutoSignStatus请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
:param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._SceneKey = None
self._UserInfo = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
@property
def UserInfo(self):
"""要查询状态的用户信息, 包括名字,身份证等
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
return self._UserInfo
@UserInfo.setter
def UserInfo(self, UserInfo):
self._UserInfo = UserInfo
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SceneKey = params.get("SceneKey")
if params.get("UserInfo") is not None:
self._UserInfo = UserThreeFactor()
self._UserInfo._deserialize(params.get("UserInfo"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
"""ChannelDescribeUserAutoSignStatus返回参数结构体
"""
def __init__(self):
r"""
:param _IsOpen: 查询用户是否已开通自动签
:type IsOpen: bool
:param _LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
:type LicenseFrom: int
:param _LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
:type LicenseTo: int
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul>
:type LicenseType: int
:param _SealId: 用户开通自动签指定使用的印章，为空则未设置印章，需重新进入开通链接设置印章。
:type SealId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._IsOpen = None
self._LicenseFrom = None
self._LicenseTo = None
self._LicenseType = None
self._SealId = None
self._RequestId = None
@property
def IsOpen(self):
"""查询用户是否已开通自动签
:rtype: bool
"""
return self._IsOpen
@IsOpen.setter
def IsOpen(self, IsOpen):
self._IsOpen = IsOpen
@property
def LicenseFrom(self):
"""自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
:rtype: int
"""
return self._LicenseFrom
@LicenseFrom.setter
def LicenseFrom(self, LicenseFrom):
self._LicenseFrom = LicenseFrom
@property
def LicenseTo(self):
"""自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
:rtype: int
"""
return self._LicenseTo
@LicenseTo.setter
def LicenseTo(self, LicenseTo):
self._LicenseTo = LicenseTo
@property
def LicenseType(self):
"""设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul>
:rtype: int
"""
return self._LicenseType
@LicenseType.setter
def LicenseType(self, LicenseType):
self._LicenseType = LicenseType
@property
def SealId(self):
"""用户开通自动签指定使用的印章，为空则未设置印章，需重新进入开通链接设置印章。
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._IsOpen = params.get("IsOpen")
self._LicenseFrom = params.get("LicenseFrom")
self._LicenseTo = params.get("LicenseTo")
self._LicenseType = params.get("LicenseType")
self._SealId = params.get("SealId")
self._RequestId = params.get("RequestId")
class ChannelDisableUserAutoSignRequest(AbstractModel):
"""ChannelDisableUserAutoSign请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
:param _UserInfo: 需要关闭自动签的个人的信息，如姓名，证件信息等。
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._SceneKey = None
self._UserInfo = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
@property
def UserInfo(self):
"""需要关闭自动签的个人的信息，如姓名，证件信息等。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
return self._UserInfo
@UserInfo.setter
def UserInfo(self, UserInfo):
self._UserInfo = UserInfo
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SceneKey = params.get("SceneKey")
if params.get("UserInfo") is not None:
self._UserInfo = UserThreeFactor()
self._UserInfo._deserialize(params.get("UserInfo"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelDisableUserAutoSignResponse(AbstractModel):
"""ChannelDisableUserAutoSign返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelGetTaskResultApiRequest(AbstractModel):
"""ChannelGetTaskResultApi请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _TaskId: 转换任务Id，通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
:type TaskId: str
:param _Operator: 操作者的信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _Organization: 暂未开放
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
self._Agent = None
self._TaskId = None
self._Operator = None
self._Organization = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def TaskId(self):
"""转换任务Id，通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._TaskId = params.get("TaskId")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelGetTaskResultApiResponse(AbstractModel):
"""ChannelGetTaskResultApi返回参数结构体
"""
def __init__(self):
r"""
:param _TaskId: 任务Id
:type TaskId: str
:param _TaskStatus: 任务状态，需要关注的状态
<ul><li>**0** :NeedTranform - 任务已提交</li>
<li>**4** :Processing - 文档转换中</li>
<li>**8** :TaskEnd - 任务处理完成</li>
<li>**-2** :DownloadFailed - 下载失败</li>
<li>**-6** :ProcessFailed - 转换失败</li>
<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
:type TaskStatus: int
:param _TaskMessage: 状态描述，需要关注的状态
<ul><li> **NeedTranform** : 任务已提交</li>
<li> **Processing** : 文档转换中</li>
<li> **TaskEnd** : 任务处理完成</li>
<li> **DownloadFailed** : 下载失败</li>
<li> **ProcessFailed** : 转换失败</li>
<li> **ProcessTimeout** : 转换文件超时</li></ul>
:type TaskMessage: str
:param _ResourceId: 资源Id（即FileId），用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
:type ResourceId: str
:param _PreviewUrl: 预览文件Url，有效期30分钟
当前字段返回为空，发起的时候，将ResourceId 放入发起即可
:type PreviewUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._TaskId = None
self._TaskStatus = None
self._TaskMessage = None
self._ResourceId = None
self._PreviewUrl = None
self._RequestId = None
@property
def TaskId(self):
"""任务Id
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def TaskStatus(self):
"""任务状态，需要关注的状态
<ul><li>**0** :NeedTranform - 任务已提交</li>
<li>**4** :Processing - 文档转换中</li>
<li>**8** :TaskEnd - 任务处理完成</li>
<li>**-2** :DownloadFailed - 下载失败</li>
<li>**-6** :ProcessFailed - 转换失败</li>
<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
:rtype: int
"""
return self._TaskStatus
@TaskStatus.setter
def TaskStatus(self, TaskStatus):
self._TaskStatus = TaskStatus
@property
def TaskMessage(self):
"""状态描述，需要关注的状态
<ul><li> **NeedTranform** : 任务已提交</li>
<li> **Processing** : 文档转换中</li>
<li> **TaskEnd** : 任务处理完成</li>
<li> **DownloadFailed** : 下载失败</li>
<li> **ProcessFailed** : 转换失败</li>
<li> **ProcessTimeout** : 转换文件超时</li></ul>
:rtype: str
"""
return self._TaskMessage
@TaskMessage.setter
def TaskMessage(self, TaskMessage):
self._TaskMessage = TaskMessage
@property
def ResourceId(self):
"""资源Id（即FileId），用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
:rtype: str
"""
return self._ResourceId
@ResourceId.setter
def ResourceId(self, ResourceId):
self._ResourceId = ResourceId
@property
def PreviewUrl(self):
warnings.warn("parameter `PreviewUrl` is deprecated", DeprecationWarning)
"""预览文件Url，有效期30分钟
当前字段返回为空，发起的时候，将ResourceId 放入发起即可
:rtype: str
"""
return self._PreviewUrl
@PreviewUrl.setter
def PreviewUrl(self, PreviewUrl):
warnings.warn("parameter `PreviewUrl` is deprecated", DeprecationWarning)
self._PreviewUrl = PreviewUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._TaskId = params.get("TaskId")
self._TaskStatus = params.get("TaskStatus")
self._TaskMessage = params.get("TaskMessage")
self._ResourceId = params.get("ResourceId")
self._PreviewUrl = params.get("PreviewUrl")
self._RequestId = params.get("RequestId")
class ChannelModifyRoleRequest(AbstractModel):
"""ChannelModifyRole请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 代理企业和员工的信息。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Name: 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
:type Name: str
:param _RoleId: 角色Id，可通过接口 ChannelDescribeRoles 查询获取
:type RoleId: str
:param _Description: 角色描述，最大长度为50个字符
:type Description: str
:param _PermissionGroups: 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
:type PermissionGroups: list of PermissionGroup
"""
self._Agent = None
self._Name = None
self._RoleId = None
self._Description = None
self._PermissionGroups = None
@property
def Agent(self):
"""代理企业和员工的信息。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Name(self):
"""角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def RoleId(self):
"""角色Id，可通过接口 ChannelDescribeRoles 查询获取
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def Description(self):
"""角色描述，最大长度为50个字符
:rtype: str
"""
return self._Description
@Description.setter
def Description(self, Description):
self._Description = Description
@property
def PermissionGroups(self):
"""权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
:rtype: list of PermissionGroup
"""
return self._PermissionGroups
@PermissionGroups.setter
def PermissionGroups(self, PermissionGroups):
self._PermissionGroups = PermissionGroups
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Name = params.get("Name")
self._RoleId = params.get("RoleId")
self._Description = params.get("Description")
if params.get("PermissionGroups") is not None:
self._PermissionGroups = []
for item in params.get("PermissionGroups"):
obj = PermissionGroup()
obj._deserialize(item)
self._PermissionGroups.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelModifyRoleResponse(AbstractModel):
"""ChannelModifyRole返回参数结构体
"""
def __init__(self):
r"""
:param _RoleId: 角色id
:type RoleId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RoleId = None
self._RequestId = None
@property
def RoleId(self):
"""角色id
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RoleId = params.get("RoleId")
self._RequestId = params.get("RequestId")
class ChannelOrganizationInfo(AbstractModel):
"""渠道企业信息
"""
def __init__(self):
r"""
:param _OrganizationId: 电子签平台给企业分配的ID（在不同应用下同一个企业会分配通用的ID）
:type OrganizationId: str
:param _OrganizationOpenId: 第三方平台子客企业的唯一标识
:type OrganizationOpenId: str
:param _OrganizationName: 第三方平台子客企业名称
:type OrganizationName: str
:param _UnifiedSocialCreditCode: 企业的统一社会信用代码
:type UnifiedSocialCreditCode: str
:param _LegalName: 企业法定代表人的姓名
:type LegalName: str
:param _LegalOpenId: 企业法定代表人作为第三方平台子客企业员工的唯一标识
:type LegalOpenId: str
:param _AdminName: 企业超级管理员的姓名
:type AdminName: str
:param _AdminOpenId: 企业超级管理员作为第三方平台子客企业员工的唯一标识
:type AdminOpenId: str
:param _AdminMobile: 企业超级管理员的手机号码
**注**：`手机号码脱敏（隐藏部分用*替代）`
:type AdminMobile: str
:param _AuthorizationStatus: 企业认证状态字段。值如下：
<ul>
<li>**"UNVERIFIED"**： 未认证的企业</li>
<li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
<li>**"VERIFYING"**： 认证中的企业</li>
<li>**"VERIFIED"**： 已认证的企业</li>
</ul>
:type AuthorizationStatus: str
:param _AuthorizationType: 企业认证方式字段。值如下：
<ul>
<li>**"AuthorizationInit"**： 暂未选择授权方式</li>
<li>**"AuthorizationFile"**： 授权书</li>
<li>**"AuthorizationLegalPerson"**： 法人授权超管</li>
<li>**"AuthorizationLegalIdentity"**： 法人直接认证</li>
</ul>
:type AuthorizationType: str
:param _ActiveStatus: 子企业激活状态。值如下：
<ul>
<li>**0**： 未激活</li>
<li>**1**： 已激活</li>
</ul>
:type ActiveStatus: int
:param _LicenseExpireTime: 账号到期时间，时间戳
:type LicenseExpireTime: int
"""
self._OrganizationId = None
self._OrganizationOpenId = None
self._OrganizationName = None
self._UnifiedSocialCreditCode = None
self._LegalName = None
self._LegalOpenId = None
self._AdminName = None
self._AdminOpenId = None
self._AdminMobile = None
self._AuthorizationStatus = None
self._AuthorizationType = None
self._ActiveStatus = None
self._LicenseExpireTime = None
@property
def OrganizationId(self):
"""电子签平台给企业分配的ID（在不同应用下同一个企业会分配通用的ID）
:rtype: str
"""
return self._OrganizationId
@OrganizationId.setter
def OrganizationId(self, OrganizationId):
self._OrganizationId = OrganizationId
@property
def OrganizationOpenId(self):
"""第三方平台子客企业的唯一标识
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OrganizationName(self):
"""第三方平台子客企业名称
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def UnifiedSocialCreditCode(self):
"""企业的统一社会信用代码
:rtype: str
"""
return self._UnifiedSocialCreditCode
@UnifiedSocialCreditCode.setter
def UnifiedSocialCreditCode(self, UnifiedSocialCreditCode):
self._UnifiedSocialCreditCode = UnifiedSocialCreditCode
@property
def LegalName(self):
"""企业法定代表人的姓名
:rtype: str
"""
return self._LegalName
@LegalName.setter
def LegalName(self, LegalName):
self._LegalName = LegalName
@property
def LegalOpenId(self):
"""企业法定代表人作为第三方平台子客企业员工的唯一标识
:rtype: str
"""
return self._LegalOpenId
@LegalOpenId.setter
def LegalOpenId(self, LegalOpenId):
self._LegalOpenId = LegalOpenId
@property
def AdminName(self):
"""企业超级管理员的姓名
:rtype: str
"""
return self._AdminName
@AdminName.setter
def AdminName(self, AdminName):
self._AdminName = AdminName
@property
def AdminOpenId(self):
"""企业超级管理员作为第三方平台子客企业员工的唯一标识
:rtype: str
"""
return self._AdminOpenId
@AdminOpenId.setter
def AdminOpenId(self, AdminOpenId):
self._AdminOpenId = AdminOpenId
@property
def AdminMobile(self):
"""企业超级管理员的手机号码
**注**：`手机号码脱敏（隐藏部分用*替代）`
:rtype: str
"""
return self._AdminMobile
@AdminMobile.setter
def AdminMobile(self, AdminMobile):
self._AdminMobile = AdminMobile
@property
def AuthorizationStatus(self):
"""企业认证状态字段。值如下：
<ul>
<li>**"UNVERIFIED"**： 未认证的企业</li>
<li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
<li>**"VERIFYING"**： 认证中的企业</li>
<li>**"VERIFIED"**： 已认证的企业</li>
</ul>
:rtype: str
"""
return self._AuthorizationStatus
@AuthorizationStatus.setter
def AuthorizationStatus(self, AuthorizationStatus):
self._AuthorizationStatus = AuthorizationStatus
@property
def AuthorizationType(self):
"""企业认证方式字段。值如下：
<ul>
<li>**"AuthorizationInit"**： 暂未选择授权方式</li>
<li>**"AuthorizationFile"**： 授权书</li>
<li>**"AuthorizationLegalPerson"**： 法人授权超管</li>
<li>**"AuthorizationLegalIdentity"**： 法人直接认证</li>
</ul>
:rtype: str
"""
return self._AuthorizationType
@AuthorizationType.setter
def AuthorizationType(self, AuthorizationType):
self._AuthorizationType = AuthorizationType
@property
def ActiveStatus(self):
"""子企业激活状态。值如下：
<ul>
<li>**0**： 未激活</li>
<li>**1**： 已激活</li>
</ul>
:rtype: int
"""
return self._ActiveStatus
@ActiveStatus.setter
def ActiveStatus(self, ActiveStatus):
self._ActiveStatus = ActiveStatus
@property
def LicenseExpireTime(self):
"""账号到期时间，时间戳
:rtype: int
"""
return self._LicenseExpireTime
@LicenseExpireTime.setter
def LicenseExpireTime(self, LicenseExpireTime):
self._LicenseExpireTime = LicenseExpireTime
def _deserialize(self, params):
self._OrganizationId = params.get("OrganizationId")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OrganizationName = params.get("OrganizationName")
self._UnifiedSocialCreditCode = params.get("UnifiedSocialCreditCode")
self._LegalName = params.get("LegalName")
self._LegalOpenId = params.get("LegalOpenId")
self._AdminName = params.get("AdminName")
self._AdminOpenId = params.get("AdminOpenId")
self._AdminMobile = params.get("AdminMobile")
self._AuthorizationStatus = params.get("AuthorizationStatus")
self._AuthorizationType = params.get("AuthorizationType")
self._ActiveStatus = params.get("ActiveStatus")
self._LicenseExpireTime = params.get("LicenseExpireTime")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelRenewAutoSignLicenseRequest(AbstractModel):
"""ChannelRenewAutoSignLicense请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:type SceneKey: str
:param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
:param _Operator: 执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._SceneKey = None
self._UserInfo = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
@property
def UserInfo(self):
"""要查询状态的用户信息, 包括名字,身份证等
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
"""
return self._UserInfo
@UserInfo.setter
def UserInfo(self, UserInfo):
self._UserInfo = UserInfo
@property
def Operator(self):
"""执行本接口操作的员工信息。
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SceneKey = params.get("SceneKey")
if params.get("UserInfo") is not None:
self._UserInfo = UserThreeFactor()
self._UserInfo._deserialize(params.get("UserInfo"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelRenewAutoSignLicenseResponse(AbstractModel):
"""ChannelRenewAutoSignLicense返回参数结构体
"""
def __init__(self):
r"""
:param _LicenseTo: 续期成功后自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
:type LicenseTo: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._LicenseTo = None
self._RequestId = None
@property
def LicenseTo(self):
"""续期成功后自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
值为unix时间戳,单位为秒。
:rtype: int
"""
return self._LicenseTo
@LicenseTo.setter
def LicenseTo(self, LicenseTo):
self._LicenseTo = LicenseTo
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._LicenseTo = params.get("LicenseTo")
self._RequestId = params.get("RequestId")
class ChannelRole(AbstractModel):
"""角色信息
"""
def __init__(self):
r"""
:param _RoleId: 角色ID,为32位字符串
:type RoleId: str
:param _RoleName: 角色的名称
:type RoleName: str
:param _RoleStatus: 此角色状态
1: 已经启用
2: 已经禁用
:type RoleStatus: int
:param _PermissionGroups: 此角色对应的权限列表
:type PermissionGroups: list of PermissionGroup
"""
self._RoleId = None
self._RoleName = None
self._RoleStatus = None
self._PermissionGroups = None
@property
def RoleId(self):
"""角色ID,为32位字符串
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def RoleName(self):
"""角色的名称
:rtype: str
"""
return self._RoleName
@RoleName.setter
def RoleName(self, RoleName):
self._RoleName = RoleName
@property
def RoleStatus(self):
"""此角色状态
1: 已经启用
2: 已经禁用
:rtype: int
"""
return self._RoleStatus
@RoleStatus.setter
def RoleStatus(self, RoleStatus):
self._RoleStatus = RoleStatus
@property
def PermissionGroups(self):
"""此角色对应的权限列表
:rtype: list of PermissionGroup
"""
return self._PermissionGroups
@PermissionGroups.setter
def PermissionGroups(self, PermissionGroups):
self._PermissionGroups = PermissionGroups
def _deserialize(self, params):
self._RoleId = params.get("RoleId")
self._RoleName = params.get("RoleName")
self._RoleStatus = params.get("RoleStatus")
if params.get("PermissionGroups") is not None:
self._PermissionGroups = []
for item in params.get("PermissionGroups"):
obj = PermissionGroup()
obj._deserialize(item)
self._PermissionGroups.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelUpdateSealStatusRequest(AbstractModel):
"""ChannelUpdateSealStatus请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Status: 印章状态，目前支持传入以下类型：
<ul><li>DISABLE-停用印章</li></ul>
:type Status: str
:param _SealId: 印章ID
:type SealId: str
:param _Reason: 更新印章状态原因说明
:type Reason: str
:param _Operator: 操作者的信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._Status = None
self._SealId = None
self._Reason = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Status(self):
"""印章状态，目前支持传入以下类型：
<ul><li>DISABLE-停用印章</li></ul>
:rtype: str
"""
return self._Status
@Status.setter
def Status(self, Status):
self._Status = Status
@property
def SealId(self):
"""印章ID
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def Reason(self):
"""更新印章状态原因说明
:rtype: str
"""
return self._Reason
@Reason.setter
def Reason(self, Reason):
self._Reason = Reason
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Status = params.get("Status")
self._SealId = params.get("SealId")
self._Reason = params.get("Reason")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelUpdateSealStatusResponse(AbstractModel):
"""ChannelUpdateSealStatus返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class ChannelVerifyPdfRequest(AbstractModel):
"""ChannelVerifyPdf请求参数结构体
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。
:type FlowId: str
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._FlowId = None
self._Agent = None
self._Operator = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ChannelVerifyPdfResponse(AbstractModel):
"""ChannelVerifyPdf返回参数结构体
"""
def __init__(self):
r"""
:param _VerifyResult: 验签结果代码，代码的含义如下：
<ul><li>**1**：文件未被篡改，全部签名在腾讯电子签完成。</li>
<li>**2**：文件未被篡改，部分签名在腾讯电子签完成。</li>
<li>**3**：文件被篡改。</li>
<li>**4**：异常：文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
<li>**5**：异常：文件签名格式错误。</li></ul>
:type VerifyResult: int
:param _PdfVerifyResults: 验签结果详情，所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
:type PdfVerifyResults: list of PdfVerifyResult
:param _VerifySerialNo: 验签序列号, 为11为数组组成的字符串
:type VerifySerialNo: str
:param _PdfResourceMd5: 合同文件MD5哈希值
:type PdfResourceMd5: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._VerifyResult = None
self._PdfVerifyResults = None
self._VerifySerialNo = None
self._PdfResourceMd5 = None
self._RequestId = None
@property
def VerifyResult(self):
"""验签结果代码，代码的含义如下：
<ul><li>**1**：文件未被篡改，全部签名在腾讯电子签完成。</li>
<li>**2**：文件未被篡改，部分签名在腾讯电子签完成。</li>
<li>**3**：文件被篡改。</li>
<li>**4**：异常：文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
<li>**5**：异常：文件签名格式错误。</li></ul>
:rtype: int
"""
return self._VerifyResult
@VerifyResult.setter
def VerifyResult(self, VerifyResult):
self._VerifyResult = VerifyResult
@property
def PdfVerifyResults(self):
"""验签结果详情，所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
:rtype: list of PdfVerifyResult
"""
return self._PdfVerifyResults
@PdfVerifyResults.setter
def PdfVerifyResults(self, PdfVerifyResults):
self._PdfVerifyResults = PdfVerifyResults
@property
def VerifySerialNo(self):
"""验签序列号, 为11为数组组成的字符串
:rtype: str
"""
return self._VerifySerialNo
@VerifySerialNo.setter
def VerifySerialNo(self, VerifySerialNo):
self._VerifySerialNo = VerifySerialNo
@property
def PdfResourceMd5(self):
"""合同文件MD5哈希值
:rtype: str
"""
return self._PdfResourceMd5
@PdfResourceMd5.setter
def PdfResourceMd5(self, PdfResourceMd5):
self._PdfResourceMd5 = PdfResourceMd5
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._VerifyResult = params.get("VerifyResult")
if params.get("PdfVerifyResults") is not None:
self._PdfVerifyResults = []
for item in params.get("PdfVerifyResults"):
obj = PdfVerifyResult()
obj._deserialize(item)
self._PdfVerifyResults.append(obj)
self._VerifySerialNo = params.get("VerifySerialNo")
self._PdfResourceMd5 = params.get("PdfResourceMd5")
self._RequestId = params.get("RequestId")
class CommonApproverOption(AbstractModel):
"""签署人配置信息
"""
def __init__(self):
r"""
:param _CanEditApprover: 是否允许修改签署人信息
:type CanEditApprover: bool
"""
self._CanEditApprover = None
@property
def CanEditApprover(self):
"""是否允许修改签署人信息
:rtype: bool
"""
return self._CanEditApprover
@CanEditApprover.setter
def CanEditApprover(self, CanEditApprover):
self._CanEditApprover = CanEditApprover
def _deserialize(self, params):
self._CanEditApprover = params.get("CanEditApprover")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CommonFlowApprover(AbstractModel):
"""通用签署人信息
"""
def __init__(self):
r"""
:param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。
<ul>
<li>false: 默认值，第三方平台子客企业下员工</li>
<li>true: SaaS平台企业下的员工</li>
</ul>
:type NotChannelOrganization: bool
:param _ApproverType: 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
**0** :企业/企业员工（企业签署方或模板发起时的企业静默签）
**1** :个人/自然人
**3** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）
注：类型为3（企业/企业员工自动签）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
使用自动签时，请确保企业已经开通自动签功能，开通方式：控制台 -> 企业设置 -> 扩展服务 -> 企业自动签。
使用文件发起自动签时使用前请联系对接的客户经理沟通。
:type ApproverType: int
:param _OrganizationId: 电子签平台给企业生成的企业id
:type OrganizationId: str
:param _OrganizationOpenId: 企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传
:type OrganizationOpenId: str
:param _OrganizationName: 企业名称，第三方应用集成非静默签子客企业签署人必传，saas企业签署人必传
:type OrganizationName: str
:param _UserId: 电子签平台给企业员工或者自热人生成的用户id
:type UserId: str
:param _OpenId: 第三方平台子客企业员工的唯一标识
:type OpenId: str
:param _ApproverName: 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:type ApproverName: str
:param _ApproverMobile: 签署人手机号，saas企业签署人，个人签署人必传
:type ApproverMobile: str
:param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE : 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:type ApproverIdCardType: str
:param _ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type ApproverIdCardNumber: str
:param _RecipientId: 签署人Id，使用模板发起是，对应模板配置中的签署人RecipientId
注意：模板发起时该字段必填
:type RecipientId: str
:param _PreReadTime: 签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s
:type PreReadTime: int
:param _IsFullText: 签署前置条件：阅读全文限制
:type IsFullText: bool
:param _NotifyType: 通知签署方经办人的方式, 有以下途径:
<ul><li> **SMS** :(默认)短信</li>
<li> **NONE** : 不通知</li></ul>
注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
:type NotifyType: str
:param _ApproverOption: 签署人配置，用于控制签署人相关属性
:type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.CommonApproverOption`
:param _SignComponents: 使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
:type SignComponents: list of Component
:param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
<ul><li> **1** : （默认）人脸识别,人脸识别后才能合同内容</li>
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
</li></ul>
注:
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
<li>此字段可传多个校验方式</li></ul>
:type ApproverVerifyTypes: list of int
:param _ApproverSignTypes: 签署人签署合同时的认证方式
<ul><li> **1** :人脸认证</li>
<li> **2** :签署密码</li>
<li> **3** :运营商三要素</li>
<li> **5** :设备指纹识别</li>
<li> **6** :设备面容识别</li></ul>
默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
注:
1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>，至少需要再增加一种其他校验方式。
4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用，其他端暂不支持。
:type ApproverSignTypes: list of int
"""
self._NotChannelOrganization = None
self._ApproverType = None
self._OrganizationId = None
self._OrganizationOpenId = None
self._OrganizationName = None
self._UserId = None
self._OpenId = None
self._ApproverName = None
self._ApproverMobile = None
self._ApproverIdCardType = None
self._ApproverIdCardNumber = None
self._RecipientId = None
self._PreReadTime = None
self._IsFullText = None
self._NotifyType = None
self._ApproverOption = None
self._SignComponents = None
self._ApproverVerifyTypes = None
self._ApproverSignTypes = None
@property
def NotChannelOrganization(self):
"""指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。
<ul>
<li>false: 默认值，第三方平台子客企业下员工</li>
<li>true: SaaS平台企业下的员工</li>
</ul>
:rtype: bool
"""
return self._NotChannelOrganization
@NotChannelOrganization.setter
def NotChannelOrganization(self, NotChannelOrganization):
self._NotChannelOrganization = NotChannelOrganization
@property
def ApproverType(self):
"""在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
**0** :企业/企业员工（企业签署方或模板发起时的企业静默签）
**1** :个人/自然人
**3** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）
注：类型为3（企业/企业员工自动签）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
使用自动签时，请确保企业已经开通自动签功能，开通方式：控制台 -> 企业设置 -> 扩展服务 -> 企业自动签。
使用文件发起自动签时使用前请联系对接的客户经理沟通。
:rtype: int
"""
return self._ApproverType
@ApproverType.setter
def ApproverType(self, ApproverType):
self._ApproverType = ApproverType
@property
def OrganizationId(self):
"""电子签平台给企业生成的企业id
:rtype: str
"""
return self._OrganizationId
@OrganizationId.setter
def OrganizationId(self, OrganizationId):
self._OrganizationId = OrganizationId
@property
def OrganizationOpenId(self):
"""企业OpenId，第三方应用集成非静默签子客企业签署人发起合同必传
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OrganizationName(self):
"""企业名称，第三方应用集成非静默签子客企业签署人必传，saas企业签署人必传
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def UserId(self):
"""电子签平台给企业员工或者自热人生成的用户id
:rtype: str
"""
return self._UserId
@UserId.setter
def UserId(self, UserId):
self._UserId = UserId
@property
def OpenId(self):
"""第三方平台子客企业员工的唯一标识
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def ApproverName(self):
"""签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:rtype: str
"""
return self._ApproverName
@ApproverName.setter
def ApproverName(self, ApproverName):
self._ApproverName = ApproverName
@property
def ApproverMobile(self):
"""签署人手机号，saas企业签署人，个人签署人必传
:rtype: str
"""
return self._ApproverMobile
@ApproverMobile.setter
def ApproverMobile(self, ApproverMobile):
self._ApproverMobile = ApproverMobile
@property
def ApproverIdCardType(self):
"""签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE : 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:rtype: str
"""
return self._ApproverIdCardType
@ApproverIdCardType.setter
def ApproverIdCardType(self, ApproverIdCardType):
self._ApproverIdCardType = ApproverIdCardType
@property
def ApproverIdCardNumber(self):
"""签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._ApproverIdCardNumber
@ApproverIdCardNumber.setter
def ApproverIdCardNumber(self, ApproverIdCardNumber):
self._ApproverIdCardNumber = ApproverIdCardNumber
@property
def RecipientId(self):
"""签署人Id，使用模板发起是，对应模板配置中的签署人RecipientId
注意：模板发起时该字段必填
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def PreReadTime(self):
"""签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s
:rtype: int
"""
return self._PreReadTime
@PreReadTime.setter
def PreReadTime(self, PreReadTime):
self._PreReadTime = PreReadTime
@property
def IsFullText(self):
"""签署前置条件：阅读全文限制
:rtype: bool
"""
return self._IsFullText
@IsFullText.setter
def IsFullText(self, IsFullText):
self._IsFullText = IsFullText
@property
def NotifyType(self):
"""通知签署方经办人的方式, 有以下途径:
<ul><li> **SMS** :(默认)短信</li>
<li> **NONE** : 不通知</li></ul>
注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
:rtype: str
"""
return self._NotifyType
@NotifyType.setter
def NotifyType(self, NotifyType):
self._NotifyType = NotifyType
@property
def ApproverOption(self):
"""签署人配置，用于控制签署人相关属性
:rtype: :class:`tencentcloud.essbasic.v20210526.models.CommonApproverOption`
"""
return self._ApproverOption
@ApproverOption.setter
def ApproverOption(self, ApproverOption):
self._ApproverOption = ApproverOption
@property
def SignComponents(self):
"""使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
:rtype: list of Component
"""
return self._SignComponents
@SignComponents.setter
def SignComponents(self, SignComponents):
self._SignComponents = SignComponents
@property
def ApproverVerifyTypes(self):
"""指定个人签署方查看合同的校验方式,可以传值如下:
<ul><li> **1** : （默认）人脸识别,人脸识别后才能合同内容</li>
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
</li></ul>
注:
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
<li>此字段可传多个校验方式</li></ul>
:rtype: list of int
"""
return self._ApproverVerifyTypes
@ApproverVerifyTypes.setter
def ApproverVerifyTypes(self, ApproverVerifyTypes):
self._ApproverVerifyTypes = ApproverVerifyTypes
@property
def ApproverSignTypes(self):
"""签署人签署合同时的认证方式
<ul><li> **1** :人脸认证</li>
<li> **2** :签署密码</li>
<li> **3** :运营商三要素</li>
<li> **5** :设备指纹识别</li>
<li> **6** :设备面容识别</li></ul>
默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
注:
1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>，至少需要再增加一种其他校验方式。
4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用，其他端暂不支持。
:rtype: list of int
"""
return self._ApproverSignTypes
@ApproverSignTypes.setter
def ApproverSignTypes(self, ApproverSignTypes):
self._ApproverSignTypes = ApproverSignTypes
def _deserialize(self, params):
self._NotChannelOrganization = params.get("NotChannelOrganization")
self._ApproverType = params.get("ApproverType")
self._OrganizationId = params.get("OrganizationId")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OrganizationName = params.get("OrganizationName")
self._UserId = params.get("UserId")
self._OpenId = params.get("OpenId")
self._ApproverName = params.get("ApproverName")
self._ApproverMobile = params.get("ApproverMobile")
self._ApproverIdCardType = params.get("ApproverIdCardType")
self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
self._RecipientId = params.get("RecipientId")
self._PreReadTime = params.get("PreReadTime")
self._IsFullText = params.get("IsFullText")
self._NotifyType = params.get("NotifyType")
if params.get("ApproverOption") is not None:
self._ApproverOption = CommonApproverOption()
self._ApproverOption._deserialize(params.get("ApproverOption"))
if params.get("SignComponents") is not None:
self._SignComponents = []
for item in params.get("SignComponents"):
obj = Component()
obj._deserialize(item)
self._SignComponents.append(obj)
self._ApproverVerifyTypes = params.get("ApproverVerifyTypes")
self._ApproverSignTypes = params.get("ApproverSignTypes")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Component(AbstractModel):
"""此结构体 (Component) 用于描述控件属性。
在通过文件发起合同时，对应的component有三种定位方式
1. 绝对定位方式 （可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标）
2. 表单域(FIELD)定位方式
3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
"""
def __init__(self):
r"""
:param _ComponentId: 控件唯一ID。
**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
例：
- 如传入的关键字<font color="red">"^甲方签署^"</font >，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符</font >）进行对应操作。
- 如传入的关键字为<font color="red">"甲方签署</font >"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符</font >）都会执行相应操作。
注：`控件ID可以在一个PDF中不可重复`
<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板页面的位置</a>
:type ComponentId: str
:param _ComponentType: **如果是Component填写控件类型，则可选的字段为**：
<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>
<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>
<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>
<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>
<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>
<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>
<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>
<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
**如果是SignComponent签署控件类型，
需要根据签署人的类型可选的字段为**
* 企业方
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
<li> <b>SIGN_DATE</b> : 签署日期控件；</li>
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>
<li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
* 个人方
<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>
<li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>
</ul>
注：` 表单域的控件不能作为印章和签名控件`
:type ComponentType: str
:param _ComponentName: **在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
**在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。
注：`控件名可以在一个PDF中可以重复`
<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a>
:type ComponentName: str
:param _ComponentRequired: 如果是<b>填写控件</b>，ComponentRequired表示在填写页面此控件是否必填
<ul><li>false（默认）：可以不填写</li>
<li>true ：必须填写此填写控件</li></ul>
如果是<b>签署控件</b>，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响
:type ComponentRequired: bool
:param _ComponentRecipientId: **在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**
:type ComponentRecipientId: str
:param _FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0
:type FileIndex: int
:param _GenerateMode: 控件生成的方式：
<ul><li> <b>NORMAL</b> : 绝对定位控件</li>
<li> <b>FIELD</b> : 表单域</li>
<li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
:type GenerateMode: str
:param _ComponentWidth: **在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。
:type ComponentWidth: float
:param _ComponentHeight: **在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。
:type ComponentHeight: float
:param _ComponentPage: **在绝对定位方式方式下**，指定控件所在PDF文件上的页码
**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。
注：
1. 页码编号是从<font color="red">1</font>开始编号的。
2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。
:type ComponentPage: int
:param _ComponentPosX: **在绝对定位方式和关键字定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。
:type ComponentPosX: float
:param _ComponentPosY: **在绝对定位方式和关键字定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。
:type ComponentPosY: float
:param _ComponentExtra: **在所有的定位方式下**，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。
<font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：
<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>
<li> <b>FontSize</b>： 范围12 :72</li>
<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>
<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>
<b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
<font color="red">ComponentType为DATE时</font>，支持以下参数：
<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>
<li> <b>FontSize</b>： 范围12 :72</li></ul>
<b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
<font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：
<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>
<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>
<font color="red">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式
<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
<li> <b>ESIGN</b> : 个人印章类型</li>
<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>
<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
<b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
印章的对应关系参考下图
<br><br>
<font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
<li> <b>CONTRACT</b> : 合同专用章</li>
<li> <b>FINANCE</b> : 财务专用章</li>
<li> <b>PERSONNEL</b> : 人事专用章</li>
<li> <b>OTHER</b> : 其他</li>
</ul>
<b>参考样例</b>：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
<font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
<ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"</li>
<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>
<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>
<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>
<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
<b>参数样例</b>： ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
<font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：
<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
<b>参数样例</b>：` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
<font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：
<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>
<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>
<b>参数样例</b>：`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
<font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：
<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>
<b>参数样例</b>：`{"Opacity":0.7}`
<font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：
<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>
<b>参数样例</b>：`{"UseSealSize":true}`
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。
<b>参数样例</b>：` "{"IgnoreKeywordError":1}"`
<font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：
<ul>
<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>
<b>参数样例</b>：<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>
ChildrenComponent结构体定义:
<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>
<b>参数样例</b>：
<pre>
{
"ChildrenComponents": [
{
"ComponentType": "SIGN_SIGNATURE",
"ComponentName": "个人签名",
"Placeholder": "请签名",
"ComponentOffsetX": 10,
"ComponentOffsetY": 30,
"ComponentWidth": 119,
"ComponentHeight": 43,
"ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"
},
{
"ComponentType": "SIGN_SELECTOR",
"ComponentName": "是否同意此协议",
"Placeholder": "",
"ComponentOffsetX": 50,
"ComponentOffsetY": 130,
"ComponentWidth": 120,
"ComponentHeight": 43,
"ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"
},
{
"ComponentType": "SIGN_MULTI_LINE_TEXT",
"ComponentName": "批注附言",
"Placeholder": "",
"ComponentOffsetX": 150,
"ComponentOffsetY": 300,
"ComponentWidth": 200,
"ComponentHeight": 86,
"ComponentExtra": ""
}
]
}</pre>
</ul>
:type ComponentExtra: str
:param _ComponentValue: 控件填充vaule，ComponentType和传入值类型对应关系：
<ul><li> <b>TEXT</b> : 文本内容</li>
<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用 \n 来控制换行位置</li>
<li> <b>CHECK_BOX</b> : true/false</li>
<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
<li> <b>SELECTOR</b> : 选项值</li>
<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
<li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>
<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>
<b>控件值约束说明</b>：
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr><tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
注： `部分特殊控件需要在控制台配置模板形式创建`
:type ComponentValue: str
:param _ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12
:type ComponentDateFontSize: int
:param _DocumentId: <font color="red">【暂未使用】</font>控件归属的文档的ID， **发起合同时候不要填写此字段留空即可**
:type DocumentId: str
:param _ComponentDescription: <font color="red">【暂未使用】</font>控件描述，用户自定义，不影响合同发起流程
:type ComponentDescription: str
:param _OffsetX: **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
注意： `向左调整设置为负数， 向右调整设置成正数`
:type OffsetX: float
:param _OffsetY: **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
注意： `向上调整设置为负数， 向下调整设置成正数`
:type OffsetY: float
:param _ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
:type ChannelComponentId: str
:param _KeywordOrder: **如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。
<ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li>
<li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul>
在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。
:type KeywordOrder: str
:param _KeywordPage: **如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
:type KeywordPage: int
:param _RelativeLocation: **如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值
<ul><li> <b>Middle</b> :居中</li>
<li> <b>Below</b> :正下方</li>
<li> <b>Right</b> :正右方</li>
<li> <b>LowerRight</b> :右下角</li>
<li> <b>UpperRight</b> :右上角。</li></ul>
示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
:type RelativeLocation: str
:param _KeywordIndexes: **如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
注意：关键字索引是从0开始计数的
:type KeywordIndexes: list of int
:param _Placeholder: 填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
注：`签署控件设置此字段无效`
:type Placeholder: str
:param _LockComponentValue: **web嵌入发起合同场景下**， 是否锁定填写和签署控件值不允许嵌入页面进行编辑
<ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li>
<li>true：锁定控件值，在页面编辑控件值</li></ul>
:type LockComponentValue: bool
:param _ForbidMoveAndDelete: **web嵌入发起合同场景下**，是否禁止移动和删除填写和签署控件
<ul><li> <b>false（默认）</b> :不禁止移动和删除控件</li>
<li> <b>true</b> : 可以移动和删除控件</li></ul>
:type ForbidMoveAndDelete: bool
"""
self._ComponentId = None
self._ComponentType = None
self._ComponentName = None
self._ComponentRequired = None
self._ComponentRecipientId = None
self._FileIndex = None
self._GenerateMode = None
self._ComponentWidth = None
self._ComponentHeight = None
self._ComponentPage = None
self._ComponentPosX = None
self._ComponentPosY = None
self._ComponentExtra = None
self._ComponentValue = None
self._ComponentDateFontSize = None
self._DocumentId = None
self._ComponentDescription = None
self._OffsetX = None
self._OffsetY = None
self._ChannelComponentId = None
self._KeywordOrder = None
self._KeywordPage = None
self._RelativeLocation = None
self._KeywordIndexes = None
self._Placeholder = None
self._LockComponentValue = None
self._ForbidMoveAndDelete = None
@property
def ComponentId(self):
"""控件唯一ID。
**在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
**在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
例：
- 如传入的关键字<font color="red">"^甲方签署^"</font >，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符</font >）进行对应操作。
- 如传入的关键字为<font color="red">"甲方签署</font >"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符</font >）都会执行相应操作。
注：`控件ID可以在一个PDF中不可重复`
<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板页面的位置</a>
:rtype: str
"""
return self._ComponentId
@ComponentId.setter
def ComponentId(self, ComponentId):
self._ComponentId = ComponentId
@property
def ComponentType(self):
"""**如果是Component填写控件类型，则可选的字段为**：
<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>
<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>
<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>
<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>
<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>
<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>
<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>
<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
**如果是SignComponent签署控件类型，
需要根据签署人的类型可选的字段为**
* 企业方
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
<li> <b>SIGN_DATE</b> : 签署日期控件；</li>
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>
<li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
* 个人方
<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>
<li> <b>SIGN_SELECTOR</b> : 选择器，<font color="red">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>
</ul>
注：` 表单域的控件不能作为印章和签名控件`
:rtype: str
"""
return self._ComponentType
@ComponentType.setter
def ComponentType(self, ComponentType):
self._ComponentType = ComponentType
@property
def ComponentName(self):
"""**在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
**在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。
注：`控件名可以在一个PDF中可以重复`
<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a>
:rtype: str
"""
return self._ComponentName
@ComponentName.setter
def ComponentName(self, ComponentName):
self._ComponentName = ComponentName
@property
def ComponentRequired(self):
"""如果是<b>填写控件</b>，ComponentRequired表示在填写页面此控件是否必填
<ul><li>false（默认）：可以不填写</li>
<li>true ：必须填写此填写控件</li></ul>
如果是<b>签署控件</b>，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响
:rtype: bool
"""
return self._ComponentRequired
@ComponentRequired.setter
def ComponentRequired(self, ComponentRequired):
self._ComponentRequired = ComponentRequired
@property
def ComponentRecipientId(self):
"""**在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**
:rtype: str
"""
return self._ComponentRecipientId
@ComponentRecipientId.setter
def ComponentRecipientId(self, ComponentRecipientId):
self._ComponentRecipientId = ComponentRecipientId
@property
def FileIndex(self):
"""<font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0
:rtype: int
"""
return self._FileIndex
@FileIndex.setter
def FileIndex(self, FileIndex):
self._FileIndex = FileIndex
@property
def GenerateMode(self):
"""控件生成的方式：
<ul><li> <b>NORMAL</b> : 绝对定位控件</li>
<li> <b>FIELD</b> : 表单域</li>
<li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
:rtype: str
"""
return self._GenerateMode
@GenerateMode.setter
def GenerateMode(self, GenerateMode):
self._GenerateMode = GenerateMode
@property
def ComponentWidth(self):
"""**在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。
:rtype: float
"""
return self._ComponentWidth
@ComponentWidth.setter
def ComponentWidth(self, ComponentWidth):
self._ComponentWidth = ComponentWidth
@property
def ComponentHeight(self):
"""**在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。
:rtype: float
"""
return self._ComponentHeight
@ComponentHeight.setter
def ComponentHeight(self, ComponentHeight):
self._ComponentHeight = ComponentHeight
@property
def ComponentPage(self):
"""**在绝对定位方式方式下**，指定控件所在PDF文件上的页码
**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。
注：
1. 页码编号是从<font color="red">1</font>开始编号的。
2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。
:rtype: int
"""
return self._ComponentPage
@ComponentPage.setter
def ComponentPage(self, ComponentPage):
self._ComponentPage = ComponentPage
@property
def ComponentPosX(self):
"""**在绝对定位方式和关键字定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。
:rtype: float
"""
return self._ComponentPosX
@ComponentPosX.setter
def ComponentPosX(self, ComponentPosX):
self._ComponentPosX = ComponentPosX
@property
def ComponentPosY(self):
"""**在绝对定位方式和关键字定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。
:rtype: float
"""
return self._ComponentPosY
@ComponentPosY.setter
def ComponentPosY(self, ComponentPosY):
self._ComponentPosY = ComponentPosY
@property
def ComponentExtra(self):
"""**在所有的定位方式下**，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。
<font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：
<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>
<li> <b>FontSize</b>： 范围12 :72</li>
<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>
<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>
<b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
<font color="red">ComponentType为DATE时</font>，支持以下参数：
<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>
<li> <b>FontSize</b>： 范围12 :72</li></ul>
<b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
<font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：
<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>
<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>
<font color="red">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式
<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
<li> <b>ESIGN</b> : 个人印章类型</li>
<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>
<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
<b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
印章的对应关系参考下图
<br><br>
<font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
<li> <b>CONTRACT</b> : 合同专用章</li>
<li> <b>FINANCE</b> : 财务专用章</li>
<li> <b>PERSONNEL</b> : 人事专用章</li>
<li> <b>OTHER</b> : 其他</li>
</ul>
<b>参考样例</b>：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
<font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
<ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"</li>
<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>
<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>
<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>
<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
<b>参数样例</b>： ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
<font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：
<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
<b>参数样例</b>：` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
<font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：
<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>
<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>
<b>参数样例</b>：`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
<font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：
<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>
<b>参数样例</b>：`{"Opacity":0.7}`
<font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：
<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>
<b>参数样例</b>：`{"UseSealSize":true}`
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。
<b>参数样例</b>：` "{"IgnoreKeywordError":1}"`
<font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：
<ul>
<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>
<b>参数样例</b>：<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>
ChildrenComponent结构体定义:
<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>
<b>参数样例</b>：
<pre>
{
"ChildrenComponents": [
{
"ComponentType": "SIGN_SIGNATURE",
"ComponentName": "个人签名",
"Placeholder": "请签名",
"ComponentOffsetX": 10,
"ComponentOffsetY": 30,
"ComponentWidth": 119,
"ComponentHeight": 43,
"ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"
},
{
"ComponentType": "SIGN_SELECTOR",
"ComponentName": "是否同意此协议",
"Placeholder": "",
"ComponentOffsetX": 50,
"ComponentOffsetY": 130,
"ComponentWidth": 120,
"ComponentHeight": 43,
"ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"
},
{
"ComponentType": "SIGN_MULTI_LINE_TEXT",
"ComponentName": "批注附言",
"Placeholder": "",
"ComponentOffsetX": 150,
"ComponentOffsetY": 300,
"ComponentWidth": 200,
"ComponentHeight": 86,
"ComponentExtra": ""
}
]
}</pre>
</ul>
:rtype: str
"""
return self._ComponentExtra
@ComponentExtra.setter
def ComponentExtra(self, ComponentExtra):
self._ComponentExtra = ComponentExtra
@property
def ComponentValue(self):
"""控件填充vaule，ComponentType和传入值类型对应关系：
<ul><li> <b>TEXT</b> : 文本内容</li>
<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用 \n 来控制换行位置</li>
<li> <b>CHECK_BOX</b> : true/false</li>
<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
<li> <b>SELECTOR</b> : 选项值</li>
<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
<li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>
<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>
<b>控件值约束说明</b>：
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr><tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
注： `部分特殊控件需要在控制台配置模板形式创建`
:rtype: str
"""
return self._ComponentValue
@ComponentValue.setter
def ComponentValue(self, ComponentValue):
self._ComponentValue = ComponentValue
@property
def ComponentDateFontSize(self):
"""<font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12
:rtype: int
"""
return self._ComponentDateFontSize
@ComponentDateFontSize.setter
def ComponentDateFontSize(self, ComponentDateFontSize):
self._ComponentDateFontSize = ComponentDateFontSize
@property
def DocumentId(self):
"""<font color="red">【暂未使用】</font>控件归属的文档的ID， **发起合同时候不要填写此字段留空即可**
:rtype: str
"""
return self._DocumentId
@DocumentId.setter
def DocumentId(self, DocumentId):
self._DocumentId = DocumentId
@property
def ComponentDescription(self):
"""<font color="red">【暂未使用】</font>控件描述，用户自定义，不影响合同发起流程
:rtype: str
"""
return self._ComponentDescription
@ComponentDescription.setter
def ComponentDescription(self, ComponentDescription):
self._ComponentDescription = ComponentDescription
@property
def OffsetX(self):
"""**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
注意： `向左调整设置为负数， 向右调整设置成正数`
:rtype: float
"""
return self._OffsetX
@OffsetX.setter
def OffsetX(self, OffsetX):
self._OffsetX = OffsetX
@property
def OffsetY(self):
"""**如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
注意： `向上调整设置为负数， 向下调整设置成正数`
:rtype: float
"""
return self._OffsetY
@OffsetY.setter
def OffsetY(self, OffsetY):
self._OffsetY = OffsetY
@property
def ChannelComponentId(self):
"""<font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
:rtype: str
"""
return self._ChannelComponentId
@ChannelComponentId.setter
def ChannelComponentId(self, ChannelComponentId):
self._ChannelComponentId = ChannelComponentId
@property
def KeywordOrder(self):
"""**如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。
<ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li>
<li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul>
在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。
:rtype: str
"""
return self._KeywordOrder
@KeywordOrder.setter
def KeywordOrder(self, KeywordOrder):
self._KeywordOrder = KeywordOrder
@property
def KeywordPage(self):
"""**如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
:rtype: int
"""
return self._KeywordPage
@KeywordPage.setter
def KeywordPage(self, KeywordPage):
self._KeywordPage = KeywordPage
@property
def RelativeLocation(self):
"""**如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值
<ul><li> <b>Middle</b> :居中</li>
<li> <b>Below</b> :正下方</li>
<li> <b>Right</b> :正右方</li>
<li> <b>LowerRight</b> :右下角</li>
<li> <b>UpperRight</b> :右上角。</li></ul>
示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
:rtype: str
"""
return self._RelativeLocation
@RelativeLocation.setter
def RelativeLocation(self, RelativeLocation):
self._RelativeLocation = RelativeLocation
@property
def KeywordIndexes(self):
"""**如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
注意：关键字索引是从0开始计数的
:rtype: list of int
"""
return self._KeywordIndexes
@KeywordIndexes.setter
def KeywordIndexes(self, KeywordIndexes):
self._KeywordIndexes = KeywordIndexes
@property
def Placeholder(self):
"""填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
注：`签署控件设置此字段无效`
:rtype: str
"""
return self._Placeholder
@Placeholder.setter
def Placeholder(self, Placeholder):
self._Placeholder = Placeholder
@property
def LockComponentValue(self):
"""**web嵌入发起合同场景下**， 是否锁定填写和签署控件值不允许嵌入页面进行编辑
<ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li>
<li>true：锁定控件值，在页面编辑控件值</li></ul>
:rtype: bool
"""
return self._LockComponentValue
@LockComponentValue.setter
def LockComponentValue(self, LockComponentValue):
self._LockComponentValue = LockComponentValue
@property
def ForbidMoveAndDelete(self):
"""**web嵌入发起合同场景下**，是否禁止移动和删除填写和签署控件
<ul><li> <b>false（默认）</b> :不禁止移动和删除控件</li>
<li> <b>true</b> : 可以移动和删除控件</li></ul>
:rtype: bool
"""
return self._ForbidMoveAndDelete
@ForbidMoveAndDelete.setter
def ForbidMoveAndDelete(self, ForbidMoveAndDelete):
self._ForbidMoveAndDelete = ForbidMoveAndDelete
def _deserialize(self, params):
self._ComponentId = params.get("ComponentId")
self._ComponentType = params.get("ComponentType")
self._ComponentName = params.get("ComponentName")
self._ComponentRequired = params.get("ComponentRequired")
self._ComponentRecipientId = params.get("ComponentRecipientId")
self._FileIndex = params.get("FileIndex")
self._GenerateMode = params.get("GenerateMode")
self._ComponentWidth = params.get("ComponentWidth")
self._ComponentHeight = params.get("ComponentHeight")
self._ComponentPage = params.get("ComponentPage")
self._ComponentPosX = params.get("ComponentPosX")
self._ComponentPosY = params.get("ComponentPosY")
self._ComponentExtra = params.get("ComponentExtra")
self._ComponentValue = params.get("ComponentValue")
self._ComponentDateFontSize = params.get("ComponentDateFontSize")
self._DocumentId = params.get("DocumentId")
self._ComponentDescription = params.get("ComponentDescription")
self._OffsetX = params.get("OffsetX")
self._OffsetY = params.get("OffsetY")
self._ChannelComponentId = params.get("ChannelComponentId")
self._KeywordOrder = params.get("KeywordOrder")
self._KeywordPage = params.get("KeywordPage")
self._RelativeLocation = params.get("RelativeLocation")
self._KeywordIndexes = params.get("KeywordIndexes")
self._Placeholder = params.get("Placeholder")
self._LockComponentValue = params.get("LockComponentValue")
self._ForbidMoveAndDelete = params.get("ForbidMoveAndDelete")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ComponentLimit(AbstractModel):
"""签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
"""
def __init__(self):
r"""
:param _ComponentType: 控件类型，支持以下类型
<ul><li>SIGN_SEAL : 印章控件</li>
<li>SIGN_PAGING_SEAL : 骑缝章控件</li>
<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
<li>SIGN_SIGNATURE : 用户签名控件</li></ul>
:type ComponentType: str
:param _ComponentValue: 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
<li> <b>CONTRACT</b> : 合同专用章</li>
<li> <b>FINANCE</b> : 财务专用章</li>
<li> <b>PERSONNEL</b> : 人事专用章</li>
<li> <b>OTHER</b> : 其他</li>
</ul>
注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
<ul><li>HANDWRITE : 需要实时手写的手写签名</li>
<li>HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
<li>OCR_ESIGN : OCR印章（智慧手写签名）</li>
<li>ESIGN : 个人印章</li>
<li>SYSTEM_ESIGN : 系统印章</li></ul>
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
:type ComponentValue: list of str
"""
self._ComponentType = None
self._ComponentValue = None
@property
def ComponentType(self):
"""控件类型，支持以下类型
<ul><li>SIGN_SEAL : 印章控件</li>
<li>SIGN_PAGING_SEAL : 骑缝章控件</li>
<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
<li>SIGN_SIGNATURE : 用户签名控件</li></ul>
:rtype: str
"""
return self._ComponentType
@ComponentType.setter
def ComponentType(self, ComponentType):
self._ComponentType = ComponentType
@property
def ComponentValue(self):
"""签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型
<ul><li> <b>OFFICIAL</b> : 企业公章</li>
<li> <b>CONTRACT</b> : 合同专用章</li>
<li> <b>FINANCE</b> : 财务专用章</li>
<li> <b>PERSONNEL</b> : 人事专用章</li>
<li> <b>OTHER</b> : 其他</li>
</ul>
注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
<ul><li>HANDWRITE : 需要实时手写的手写签名</li>
<li>HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
<li>OCR_ESIGN : OCR印章（智慧手写签名）</li>
<li>ESIGN : 个人印章</li>
<li>SYSTEM_ESIGN : 系统印章</li></ul>
3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
:rtype: list of str
"""
return self._ComponentValue
@ComponentValue.setter
def ComponentValue(self, ComponentValue):
self._ComponentValue = ComponentValue
def _deserialize(self, params):
self._ComponentType = params.get("ComponentType")
self._ComponentValue = params.get("ComponentValue")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateBatchInitOrganizationUrlRequest(AbstractModel):
"""CreateBatchInitOrganizationUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 应用相关信息。 此接口Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _OperateTypes: 初始化操作类型
<ul>
<li>CREATE_SEAL : 创建印章</li>
<li>OPEN_AUTO_SIGN :开通企业自动签署</li>
<li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>
</ul>
:type OperateTypes: list of str
:param _ProxyOrganizationOpenIds: 批量操作的企业列表在第三方平台的企业Id列表，即ProxyOrganizationOpenId列表,最大支持50个
:type ProxyOrganizationOpenIds: list of str
:param _IsAuthorizePlatformApplication: 当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
:type IsAuthorizePlatformApplication: bool
:param _AuthorizedProxyOrganizationOpenId: 被授权的合作方企业在第三方平台子客企业标识，即ProxyOrganizationOpenId，当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。
:type AuthorizedProxyOrganizationOpenId: str
"""
self._Agent = None
self._OperateTypes = None
self._ProxyOrganizationOpenIds = None
self._IsAuthorizePlatformApplication = None
self._AuthorizedProxyOrganizationOpenId = None
@property
def Agent(self):
"""应用相关信息。 此接口Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def OperateTypes(self):
"""初始化操作类型
<ul>
<li>CREATE_SEAL : 创建印章</li>
<li>OPEN_AUTO_SIGN :开通企业自动签署</li>
<li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>
</ul>
:rtype: list of str
"""
return self._OperateTypes
@OperateTypes.setter
def OperateTypes(self, OperateTypes):
self._OperateTypes = OperateTypes
@property
def ProxyOrganizationOpenIds(self):
"""批量操作的企业列表在第三方平台的企业Id列表，即ProxyOrganizationOpenId列表,最大支持50个
:rtype: list of str
"""
return self._ProxyOrganizationOpenIds
@ProxyOrganizationOpenIds.setter
def ProxyOrganizationOpenIds(self, ProxyOrganizationOpenIds):
self._ProxyOrganizationOpenIds = ProxyOrganizationOpenIds
@property
def IsAuthorizePlatformApplication(self):
"""当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
:rtype: bool
"""
return self._IsAuthorizePlatformApplication
@IsAuthorizePlatformApplication.setter
def IsAuthorizePlatformApplication(self, IsAuthorizePlatformApplication):
self._IsAuthorizePlatformApplication = IsAuthorizePlatformApplication
@property
def AuthorizedProxyOrganizationOpenId(self):
"""被授权的合作方企业在第三方平台子客企业标识，即ProxyOrganizationOpenId，当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。
:rtype: str
"""
return self._AuthorizedProxyOrganizationOpenId
@AuthorizedProxyOrganizationOpenId.setter
def AuthorizedProxyOrganizationOpenId(self, AuthorizedProxyOrganizationOpenId):
self._AuthorizedProxyOrganizationOpenId = AuthorizedProxyOrganizationOpenId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._OperateTypes = params.get("OperateTypes")
self._ProxyOrganizationOpenIds = params.get("ProxyOrganizationOpenIds")
self._IsAuthorizePlatformApplication = params.get("IsAuthorizePlatformApplication")
self._AuthorizedProxyOrganizationOpenId = params.get("AuthorizedProxyOrganizationOpenId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateBatchInitOrganizationUrlResponse(AbstractModel):
"""CreateBatchInitOrganizationUrl返回参数结构体
"""
def __init__(self):
r"""
:param _MiniAppPath: 小程序路径，有效时间为7天
:type MiniAppPath: str
:param _OperateLongUrl: 操作长链，有效时间为7天
:type OperateLongUrl: str
:param _OperateShortUrl: 操作短链，有效时间为7天
:type OperateShortUrl: str
:param _QRCodeUrl: 操作二维码，有效时间为7天
:type QRCodeUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._MiniAppPath = None
self._OperateLongUrl = None
self._OperateShortUrl = None
self._QRCodeUrl = None
self._RequestId = None
@property
def MiniAppPath(self):
"""小程序路径，有效时间为7天
:rtype: str
"""
return self._MiniAppPath
@MiniAppPath.setter
def MiniAppPath(self, MiniAppPath):
self._MiniAppPath = MiniAppPath
@property
def OperateLongUrl(self):
"""操作长链，有效时间为7天
:rtype: str
"""
return self._OperateLongUrl
@OperateLongUrl.setter
def OperateLongUrl(self, OperateLongUrl):
self._OperateLongUrl = OperateLongUrl
@property
def OperateShortUrl(self):
"""操作短链，有效时间为7天
:rtype: str
"""
return self._OperateShortUrl
@OperateShortUrl.setter
def OperateShortUrl(self, OperateShortUrl):
self._OperateShortUrl = OperateShortUrl
@property
def QRCodeUrl(self):
"""操作二维码，有效时间为7天
:rtype: str
"""
return self._QRCodeUrl
@QRCodeUrl.setter
def QRCodeUrl(self, QRCodeUrl):
self._QRCodeUrl = QRCodeUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._MiniAppPath = params.get("MiniAppPath")
self._OperateLongUrl = params.get("OperateLongUrl")
self._OperateShortUrl = params.get("OperateShortUrl")
self._QRCodeUrl = params.get("QRCodeUrl")
self._RequestId = params.get("RequestId")
class CreateBatchOrganizationAuthorizationUrlRequest(AbstractModel):
"""CreateBatchOrganizationAuthorizationUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 应用相关信息。 此接口Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _AdminName: 组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
:type AdminName: str
:param _AdminMobile: 组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。
:type AdminMobile: str
:param _SubTaskIds: 企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素（AdminName，AdminMobile，AdminIdCardNumber）配合使用。若 SubTaskId 不属于传入的超级管理员，将进行筛选。
:type SubTaskIds: list of str
:param _AdminIdCardType: 组织机构超管证件类型支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
:type AdminIdCardType: str
:param _AdminIdCardNumber: 组织机构超管证件号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
:type AdminIdCardNumber: str
:param _Endpoint: 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**： 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>
:type Endpoint: str
"""
self._Agent = None
self._AdminName = None
self._AdminMobile = None
self._SubTaskIds = None
self._AdminIdCardType = None
self._AdminIdCardNumber = None
self._Endpoint = None
@property
def Agent(self):
"""应用相关信息。 此接口Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def AdminName(self):
"""组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
:rtype: str
"""
return self._AdminName
@AdminName.setter
def AdminName(self, AdminName):
self._AdminName = AdminName
@property
def AdminMobile(self):
"""组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。
:rtype: str
"""
return self._AdminMobile
@AdminMobile.setter
def AdminMobile(self, AdminMobile):
self._AdminMobile = AdminMobile
@property
def SubTaskIds(self):
"""企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素（AdminName，AdminMobile，AdminIdCardNumber）配合使用。若 SubTaskId 不属于传入的超级管理员，将进行筛选。
:rtype: list of str
"""
return self._SubTaskIds
@SubTaskIds.setter
def SubTaskIds(self, SubTaskIds):
self._SubTaskIds = SubTaskIds
@property
def AdminIdCardType(self):
"""组织机构超管证件类型支持以下类型
- ID_CARD : 居民身份证 (默认值)
- HONGKONG_AND_MACAO : 港澳居民来往内地通行证
- HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
:rtype: str
"""
return self._AdminIdCardType
@AdminIdCardType.setter
def AdminIdCardType(self, AdminIdCardType):
self._AdminIdCardType = AdminIdCardType
@property
def AdminIdCardNumber(self):
"""组织机构超管证件号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
:rtype: str
"""
return self._AdminIdCardNumber
@AdminIdCardNumber.setter
def AdminIdCardNumber(self, AdminIdCardNumber):
self._AdminIdCardNumber = AdminIdCardNumber
@property
def Endpoint(self):
"""要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**： 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._AdminName = params.get("AdminName")
self._AdminMobile = params.get("AdminMobile")
self._SubTaskIds = params.get("SubTaskIds")
self._AdminIdCardType = params.get("AdminIdCardType")
self._AdminIdCardNumber = params.get("AdminIdCardNumber")
self._Endpoint = params.get("Endpoint")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateBatchOrganizationAuthorizationUrlResponse(AbstractModel):
"""CreateBatchOrganizationAuthorizationUrl返回参数结构体
"""
def __init__(self):
r"""
:param _AuthUrl: 批量企业注册链接-单链接包含多条认证流，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表<table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>HTTP</td> <td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa</td> <td>7天</td> </tr> <tr> <td>HTTP_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr> <tr> <td>APP</td> <td>pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde</td> <td>7天</td> </tr><tr> <td>QR_CODE</td> <td>https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png</td> <td>7天</td> </tr> </tbody> </table>注： `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
:type AuthUrl: str
:param _ErrorMessages: 认证流认证失败信息
:type ErrorMessages: list of str
:param _ExpireTime: 链接过期时间，为 7 天后，创建时间，格式为Unix标准时间戳（秒）。
:type ExpireTime: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._AuthUrl = None
self._ErrorMessages = None
self._ExpireTime = None
self._RequestId = None
@property
def AuthUrl(self):
"""批量企业注册链接-单链接包含多条认证流，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表<table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>HTTP</td> <td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa</td> <td>7天</td> </tr> <tr> <td>HTTP_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr> <tr> <td>APP</td> <td>pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde</td> <td>7天</td> </tr><tr> <td>QR_CODE</td> <td>https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png</td> <td>7天</td> </tr> </tbody> </table>注： `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
:rtype: str
"""
return self._AuthUrl
@AuthUrl.setter
def AuthUrl(self, AuthUrl):
self._AuthUrl = AuthUrl
@property
def ErrorMessages(self):
"""认证流认证失败信息
:rtype: list of str
"""
return self._ErrorMessages
@ErrorMessages.setter
def ErrorMessages(self, ErrorMessages):
self._ErrorMessages = ErrorMessages
@property
def ExpireTime(self):
"""链接过期时间，为 7 天后，创建时间，格式为Unix标准时间戳（秒）。
:rtype: int
"""
return self._ExpireTime
@ExpireTime.setter
def ExpireTime(self, ExpireTime):
self._ExpireTime = ExpireTime
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._AuthUrl = params.get("AuthUrl")
self._ErrorMessages = params.get("ErrorMessages")
self._ExpireTime = params.get("ExpireTime")
self._RequestId = params.get("RequestId")
class CreateBatchOrganizationRegistrationTasksRequest(AbstractModel):
"""CreateBatchOrganizationRegistrationTasks请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _RegistrationOrganizations: 当前应用下子企业的组织机构注册信息。最多支持查询10子企业。
:type RegistrationOrganizations: list of RegistrationOrganizationInfo
:param _Endpoint: 生成链接的类型：
<ul><li>**PC**：(默认)web控制台链接, 需要在PC浏览器中打开</li>
<li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
<li>**H5**：第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
<li>**SHORT_H5**：第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>
:type Endpoint: str
"""
self._Agent = None
self._RegistrationOrganizations = None
self._Endpoint = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def RegistrationOrganizations(self):
"""当前应用下子企业的组织机构注册信息。最多支持查询10子企业。
:rtype: list of RegistrationOrganizationInfo
"""
return self._RegistrationOrganizations
@RegistrationOrganizations.setter
def RegistrationOrganizations(self, RegistrationOrganizations):
self._RegistrationOrganizations = RegistrationOrganizations
@property
def Endpoint(self):
"""生成链接的类型：
<ul><li>**PC**：(默认)web控制台链接, 需要在PC浏览器中打开</li>
<li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
<li>**H5**：第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
<li>**SHORT_H5**：第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("RegistrationOrganizations") is not None:
self._RegistrationOrganizations = []
for item in params.get("RegistrationOrganizations"):
obj = RegistrationOrganizationInfo()
obj._deserialize(item)
self._RegistrationOrganizations.append(obj)
self._Endpoint = params.get("Endpoint")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateBatchOrganizationRegistrationTasksResponse(AbstractModel):
"""CreateBatchOrganizationRegistrationTasks返回参数结构体
"""
def __init__(self):
r"""
:param _TaskId: 生成注册链接的任务ID，后序根据这个任务ID， 调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls" target="_blank">查询子企业批量认证链接</a>获取生成的链接，发给对应的客户使用。
注：`如果有错误，则不会返回任务ID`
:type TaskId: str
:param _ErrorMessages: 批量生成企业认证链接的详细错误信息，顺序与输入参数子企业列表顺序一致。
<ul>
<li>如果所有企业认证链接都成功生成，将不返回错误信息</li>
<li>如果存在任何错误，将返回具体的错误描述。（没有错误的企业返回空字符串）</li>
</ul>
:type ErrorMessages: list of str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._TaskId = None
self._ErrorMessages = None
self._RequestId = None
@property
def TaskId(self):
"""生成注册链接的任务ID，后序根据这个任务ID， 调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls" target="_blank">查询子企业批量认证链接</a>获取生成的链接，发给对应的客户使用。
注：`如果有错误，则不会返回任务ID`
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def ErrorMessages(self):
"""批量生成企业认证链接的详细错误信息，顺序与输入参数子企业列表顺序一致。
<ul>
<li>如果所有企业认证链接都成功生成，将不返回错误信息</li>
<li>如果存在任何错误，将返回具体的错误描述。（没有错误的企业返回空字符串）</li>
</ul>
:rtype: list of str
"""
return self._ErrorMessages
@ErrorMessages.setter
def ErrorMessages(self, ErrorMessages):
self._ErrorMessages = ErrorMessages
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._TaskId = params.get("TaskId")
self._ErrorMessages = params.get("ErrorMessages")
self._RequestId = params.get("RequestId")
class CreateChannelFlowEvidenceReportRequest(AbstractModel):
"""CreateChannelFlowEvidenceReport请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
:type FlowId: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ReportType: 指定申请的报告类型，可选类型如下：
<ul><li> **0** :合同签署报告（默认）</li>
<li> **1** :公证处核验报告</li></ul>
:type ReportType: int
"""
self._Agent = None
self._FlowId = None
self._Operator = None
self._ReportType = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def ReportType(self):
"""指定申请的报告类型，可选类型如下：
<ul><li> **0** :合同签署报告（默认）</li>
<li> **1** :公证处核验报告</li></ul>
:rtype: int
"""
return self._ReportType
@ReportType.setter
def ReportType(self, ReportType):
self._ReportType = ReportType
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._ReportType = params.get("ReportType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateChannelFlowEvidenceReportResponse(AbstractModel):
"""CreateChannelFlowEvidenceReport返回参数结构体
"""
def __init__(self):
r"""
:param _ReportId: 出证报告 ID，可用于<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
:type ReportId: str
:param _Status: 出证任务执行的状态, 状态含义如下：
<ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
<li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
<li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
:type Status: str
:param _ReportUrl: 废除，字段无效
:type ReportUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ReportId = None
self._Status = None
self._ReportUrl = None
self._RequestId = None
@property
def ReportId(self):
"""出证报告 ID，可用于<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
:rtype: str
"""
return self._ReportId
@ReportId.setter
def ReportId(self, ReportId):
self._ReportId = ReportId
@property
def Status(self):
"""出证任务执行的状态, 状态含义如下：
<ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
<li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
<li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
:rtype: str
"""
return self._Status
@Status.setter
def Status(self, Status):
self._Status = Status
@property
def ReportUrl(self):
"""废除，字段无效
:rtype: str
"""
return self._ReportUrl
@ReportUrl.setter
def ReportUrl(self, ReportUrl):
self._ReportUrl = ReportUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._ReportId = params.get("ReportId")
self._Status = params.get("Status")
self._ReportUrl = params.get("ReportUrl")
self._RequestId = params.get("RequestId")
class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
"""CreateChannelOrganizationInfoChangeUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ChangeType: 企业信息变更类型，可选类型如下：
<ul><li>**1**：企业超管变更, 可以将超管换成同企业的其他员工</li>
<li>**2**：企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
:type ChangeType: int
:param _Endpoint: 变更链接类型：
<ul>
<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。（默认）</li>
<li>**APP** : 创建变更小程序链接，可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>
</ul>
:type Endpoint: str
"""
self._Agent = None
self._ChangeType = None
self._Endpoint = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ChangeType(self):
"""企业信息变更类型，可选类型如下：
<ul><li>**1**：企业超管变更, 可以将超管换成同企业的其他员工</li>
<li>**2**：企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
:rtype: int
"""
return self._ChangeType
@ChangeType.setter
def ChangeType(self, ChangeType):
self._ChangeType = ChangeType
@property
def Endpoint(self):
"""变更链接类型：
<ul>
<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。（默认）</li>
<li>**APP** : 创建变更小程序链接，可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>
</ul>
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ChangeType = params.get("ChangeType")
self._Endpoint = params.get("Endpoint")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateChannelOrganizationInfoChangeUrlResponse(AbstractModel):
"""CreateChannelOrganizationInfoChangeUrl返回参数结构体
"""
def __init__(self):
r"""
:param _Url: 创建的企业信息变更链接。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。
:type Url: str
:param _ExpiredTime: 链接过期时间。链接7天有效。
:type ExpiredTime: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Url = None
self._ExpiredTime = None
self._RequestId = None
@property
def Url(self):
"""创建的企业信息变更链接。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def ExpiredTime(self):
"""链接过期时间。链接7天有效。
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Url = params.get("Url")
self._ExpiredTime = params.get("ExpiredTime")
self._RequestId = params.get("RequestId")
class CreateChannelSubOrganizationActiveRequest(AbstractModel):
"""CreateChannelSubOrganizationActive请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SubOrganizationOpenIds: 要进行激活或者续期的子客企业OrganizationOpenId列表，请确保所有列出的子客企业均已完成认证。
:type SubOrganizationOpenIds: list of str
:param _Renew: 操作类型，可以选择如下：
**false**：（默认）激活子客企业
**true**：续期子客企业
:type Renew: bool
"""
self._Agent = None
self._SubOrganizationOpenIds = None
self._Renew = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SubOrganizationOpenIds(self):
"""要进行激活或者续期的子客企业OrganizationOpenId列表，请确保所有列出的子客企业均已完成认证。
:rtype: list of str
"""
return self._SubOrganizationOpenIds
@SubOrganizationOpenIds.setter
def SubOrganizationOpenIds(self, SubOrganizationOpenIds):
self._SubOrganizationOpenIds = SubOrganizationOpenIds
@property
def Renew(self):
"""操作类型，可以选择如下：
**false**：（默认）激活子客企业
**true**：续期子客企业
:rtype: bool
"""
return self._Renew
@Renew.setter
def Renew(self, Renew):
self._Renew = Renew
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SubOrganizationOpenIds = params.get("SubOrganizationOpenIds")
self._Renew = params.get("Renew")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateChannelSubOrganizationActiveResponse(AbstractModel):
"""CreateChannelSubOrganizationActive返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class CreateCloseOrganizationUrlRequest(AbstractModel):
"""CreateCloseOrganizationUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._Agent = None
@property
def Agent(self):
"""应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateCloseOrganizationUrlResponse(AbstractModel):
"""CreateCloseOrganizationUrl返回参数结构体
"""
def __init__(self):
r"""
:param _ExpiredOn: 链接有效期，unix时间戳，精确到秒
:type ExpiredOn: int
:param _LongUrl: H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
:type LongUrl: str
:param _ShortUrl: H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
:type ShortUrl: str
:param _MiniAppPath: APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
:type MiniAppPath: str
:param _QrcodeUrl: 二维码链接
:type QrcodeUrl: str
:param _WeixinQrcodeUrl: 直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。
:type WeixinQrcodeUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ExpiredOn = None
self._LongUrl = None
self._ShortUrl = None
self._MiniAppPath = None
self._QrcodeUrl = None
self._WeixinQrcodeUrl = None
self._RequestId = None
@property
def ExpiredOn(self):
"""链接有效期，unix时间戳，精确到秒
:rtype: int
"""
return self._ExpiredOn
@ExpiredOn.setter
def ExpiredOn(self, ExpiredOn):
self._ExpiredOn = ExpiredOn
@property
def LongUrl(self):
"""H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
:rtype: str
"""
return self._LongUrl
@LongUrl.setter
def LongUrl(self, LongUrl):
self._LongUrl = LongUrl
@property
def ShortUrl(self):
"""H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
:rtype: str
"""
return self._ShortUrl
@ShortUrl.setter
def ShortUrl(self, ShortUrl):
self._ShortUrl = ShortUrl
@property
def MiniAppPath(self):
"""APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
:rtype: str
"""
return self._MiniAppPath
@MiniAppPath.setter
def MiniAppPath(self, MiniAppPath):
self._MiniAppPath = MiniAppPath
@property
def QrcodeUrl(self):
"""二维码链接
:rtype: str
"""
return self._QrcodeUrl
@QrcodeUrl.setter
def QrcodeUrl(self, QrcodeUrl):
self._QrcodeUrl = QrcodeUrl
@property
def WeixinQrcodeUrl(self):
"""直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。
:rtype: str
"""
return self._WeixinQrcodeUrl
@WeixinQrcodeUrl.setter
def WeixinQrcodeUrl(self, WeixinQrcodeUrl):
self._WeixinQrcodeUrl = WeixinQrcodeUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._ExpiredOn = params.get("ExpiredOn")
self._LongUrl = params.get("LongUrl")
self._ShortUrl = params.get("ShortUrl")
self._MiniAppPath = params.get("MiniAppPath")
self._QrcodeUrl = params.get("QrcodeUrl")
self._WeixinQrcodeUrl = params.get("WeixinQrcodeUrl")
self._RequestId = params.get("RequestId")
class CreateConsoleLoginUrlRequest(AbstractModel):
"""CreateConsoleLoginUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>注:
`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `
`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `
`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ProxyOrganizationName: 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。
<font color="red">
在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。
企业名称请使用以下名称, 以下名称可以不用走收录。
**子客测试专用企业1 - 子客测试专用企业9**</font>
注:
`1. 如果名称中包含英文括号()，请使用中文括号（）代替。`
`2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 `
:type ProxyOrganizationName: str
:param _UniformSocialCreditCode: 子客企业统一社会信用代码，最大长度200个字符
注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。
:type UniformSocialCreditCode: str
:param _ProxyOperatorName: 子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`
:type ProxyOperatorName: str
:param _ProxyOperatorMobile: 子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`
:type ProxyOperatorMobile: str
:param _Module: Web控制台登录后进入的功能模块, 支持的模块包括：
<ul>
<li> **空值** :(默认)企业中心模块</li>
<li> **DOCUMENT** :合同管理模块</li>
<li> **TEMPLATE** :企业模板管理模块</li>
<li> **SEAL** :印章管理模块</li>
<li> **OPERATOR** :组织管理模块</li></ul>
注意：
1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块
2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。
:type Module: str
:param _ModuleId: 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。
根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：
<table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模板的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
:type ModuleId: str
:param _MenuStatus: 是否展示左侧菜单栏
<ul><li> **ENABLE** : (默认)进入web控制台展示左侧菜单栏</li>
<li> **DISABLE** : 进入web控制台不展示左侧菜单栏</li></ul>
注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
:type MenuStatus: str
:param _Endpoint: 生成链接的类型：
<ul><li>**PC**：(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
<li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**SHORT_URL**：<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**WEIXIN_QRCODE_URL**：直接跳转至电子签小程序的二维码链接，无需通过中转页。<font color="red">您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。</font></li>
<li>**APP**：<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
<li>**H5**：<font color="red">H5长链接</font>跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
<li>**SHORT_H5**：<font color="red">H5短链</font>跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面</li></ul>
:type Endpoint: str
:param _AutoJumpBackEvent: 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：
<ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
:type AutoJumpBackEvent: str
:param _AuthorizationTypes: 可选的此企业允许的授权方式, 可以设置的方式有:
<ul><li>1：上传授权书</li>
<li>2：转法定代表人授权</li>
<li>4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式）</li></ul>
注:<ul>
<li>未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效`</li>
<li>选择信任第三方认证源时，请先通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganization" target="_blank">同步企业信息</a>接口同步信息。</li>
<li>该参数仅在企业未激活时生效</li>
</ul>
:type AuthorizationTypes: list of int
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ProxyOperatorIdCardNumber: 子客经办人身份证
注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持中国大陆居民身份证类型`。
:type ProxyOperatorIdCardNumber: str
:param _AutoJumpUrl: 认证完成跳转链接。
注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。
:type AutoJumpUrl: str
:param _TopNavigationStatus: 是否展示头顶导航栏 <ul><li> **ENABLE** : (默认)进入web控制台展示头顶导航栏</li> <li> **DISABLE** : 进入web控制台不展示头顶导航栏</li></ul> 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
<a href="https://qcloudimg.tencent-cloud.cn/raw/dd54f333140c711cf6a88e3801bcd178.png" target="_blank">点击查看头顶导航栏位置</a>
:type TopNavigationStatus: str
:param _AutoActive: 是否自动激活子客企业，有下面两种选项：
**false（默认设置）**：不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。
**true**：若持有的许可证充足，子客户企业注册完成后将自动激活，无需手动操作或访问控制台。
<b>注</b>：如果<b>应用扩展服务</b>中的<b>自动激活子客企业</b>为打开态， 则忽略本接口的AutoActive这个参数（若持有的许可证充足，子客户企业注册完成后将自动激活），具体位置参考下图：
:type AutoActive: bool
:param _BusinessLicense: 营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。
:type BusinessLicense: str
:param _ProxyAddress: 组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。
:type ProxyAddress: str
:param _ProxyLegalName: 组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
:type ProxyLegalName: str
:param _PowerOfAttorneys: 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
p.s. 如果上传授权书 ，需遵循以下条件
1. 超管的信息（超管姓名，超管手机号）必须为必填参数。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式
:type PowerOfAttorneys: list of str
:param _OrganizationAuthorizationOptions: 企业认证时个性化能力信息
:type OrganizationAuthorizationOptions: :class:`tencentcloud.essbasic.v20210526.models.OrganizationAuthorizationOptions`
"""
self._Agent = None
self._ProxyOrganizationName = None
self._UniformSocialCreditCode = None
self._ProxyOperatorName = None
self._ProxyOperatorMobile = None
self._Module = None
self._ModuleId = None
self._MenuStatus = None
self._Endpoint = None
self._AutoJumpBackEvent = None
self._AuthorizationTypes = None
self._Operator = None
self._ProxyOperatorIdCardNumber = None
self._AutoJumpUrl = None
self._TopNavigationStatus = None
self._AutoActive = None
self._BusinessLicense = None
self._ProxyAddress = None
self._ProxyLegalName = None
self._PowerOfAttorneys = None
self._OrganizationAuthorizationOptions = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>注:
`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `
`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `
`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ProxyOrganizationName(self):
"""第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。
<font color="red">
在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。
企业名称请使用以下名称, 以下名称可以不用走收录。
**子客测试专用企业1 - 子客测试专用企业9**</font>
注:
`1. 如果名称中包含英文括号()，请使用中文括号（）代替。`
`2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 `
:rtype: str
"""
return self._ProxyOrganizationName
@ProxyOrganizationName.setter
def ProxyOrganizationName(self, ProxyOrganizationName):
self._ProxyOrganizationName = ProxyOrganizationName
@property
def UniformSocialCreditCode(self):
"""子客企业统一社会信用代码，最大长度200个字符
注意：`如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效`。
:rtype: str
"""
return self._UniformSocialCreditCode
@UniformSocialCreditCode.setter
def UniformSocialCreditCode(self, UniformSocialCreditCode):
self._UniformSocialCreditCode = UniformSocialCreditCode
@property
def ProxyOperatorName(self):
"""子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`
:rtype: str
"""
return self._ProxyOperatorName
@ProxyOperatorName.setter
def ProxyOperatorName(self, ProxyOperatorName):
self._ProxyOperatorName = ProxyOperatorName
@property
def ProxyOperatorMobile(self):
"""子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`
:rtype: str
"""
return self._ProxyOperatorMobile
@ProxyOperatorMobile.setter
def ProxyOperatorMobile(self, ProxyOperatorMobile):
self._ProxyOperatorMobile = ProxyOperatorMobile
@property
def Module(self):
"""Web控制台登录后进入的功能模块, 支持的模块包括：
<ul>
<li> **空值** :(默认)企业中心模块</li>
<li> **DOCUMENT** :合同管理模块</li>
<li> **TEMPLATE** :企业模板管理模块</li>
<li> **SEAL** :印章管理模块</li>
<li> **OPERATOR** :组织管理模块</li></ul>
注意：
1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块
2、该参数**仅在企业和员工激活已经完成，登录控制台场景才生效**。
:rtype: str
"""
return self._Module
@Module.setter
def Module(self, Module):
self._Module = Module
@property
def ModuleId(self):
"""该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。
根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持：
<table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模板的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
注意：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
:rtype: str
"""
return self._ModuleId
@ModuleId.setter
def ModuleId(self, ModuleId):
self._ModuleId = ModuleId
@property
def MenuStatus(self):
"""是否展示左侧菜单栏
<ul><li> **ENABLE** : (默认)进入web控制台展示左侧菜单栏</li>
<li> **DISABLE** : 进入web控制台不展示左侧菜单栏</li></ul>
注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
:rtype: str
"""
return self._MenuStatus
@MenuStatus.setter
def MenuStatus(self, MenuStatus):
self._MenuStatus = MenuStatus
@property
def Endpoint(self):
"""生成链接的类型：
<ul><li>**PC**：(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
<li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**SHORT_URL**：<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
<li>**WEIXIN_QRCODE_URL**：直接跳转至电子签小程序的二维码链接，无需通过中转页。<font color="red">您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。</font></li>
<li>**APP**：<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
<li>**H5**：<font color="red">H5长链接</font>跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
<li>**SHORT_H5**：<font color="red">H5短链</font>跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面</li></ul>
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
@property
def AutoJumpBackEvent(self):
"""触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：
<ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
:rtype: str
"""
return self._AutoJumpBackEvent
@AutoJumpBackEvent.setter
def AutoJumpBackEvent(self, AutoJumpBackEvent):
self._AutoJumpBackEvent = AutoJumpBackEvent
@property
def AuthorizationTypes(self):
"""可选的此企业允许的授权方式, 可以设置的方式有:
<ul><li>1：上传授权书</li>
<li>2：转法定代表人授权</li>
<li>4：企业实名认证（信任第三方认证源）（此项有排他性, 选择后不能增添其他的方式）</li></ul>
注:<ul>
<li>未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不对此法人生效`</li>
<li>选择信任第三方认证源时，请先通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganization" target="_blank">同步企业信息</a>接口同步信息。</li>
<li>该参数仅在企业未激活时生效</li>
</ul>
:rtype: list of int
"""
return self._AuthorizationTypes
@AuthorizationTypes.setter
def AuthorizationTypes(self, AuthorizationTypes):
self._AuthorizationTypes = AuthorizationTypes
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def ProxyOperatorIdCardNumber(self):
"""子客经办人身份证
注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持中国大陆居民身份证类型`。
:rtype: str
"""
return self._ProxyOperatorIdCardNumber
@ProxyOperatorIdCardNumber.setter
def ProxyOperatorIdCardNumber(self, ProxyOperatorIdCardNumber):
self._ProxyOperatorIdCardNumber = ProxyOperatorIdCardNumber
@property
def AutoJumpUrl(self):
"""认证完成跳转链接。
注意：`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。
:rtype: str
"""
return self._AutoJumpUrl
@AutoJumpUrl.setter
def AutoJumpUrl(self, AutoJumpUrl):
self._AutoJumpUrl = AutoJumpUrl
@property
def TopNavigationStatus(self):
"""是否展示头顶导航栏 <ul><li> **ENABLE** : (默认)进入web控制台展示头顶导航栏</li> <li> **DISABLE** : 进入web控制台不展示头顶导航栏</li></ul> 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
<a href="https://qcloudimg.tencent-cloud.cn/raw/dd54f333140c711cf6a88e3801bcd178.png" target="_blank">点击查看头顶导航栏位置</a>
:rtype: str
"""
return self._TopNavigationStatus
@TopNavigationStatus.setter
def TopNavigationStatus(self, TopNavigationStatus):
self._TopNavigationStatus = TopNavigationStatus
@property
def AutoActive(self):
"""是否自动激活子客企业，有下面两种选项：
**false（默认设置）**：不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。
**true**：若持有的许可证充足，子客户企业注册完成后将自动激活，无需手动操作或访问控制台。
<b>注</b>：如果<b>应用扩展服务</b>中的<b>自动激活子客企业</b>为打开态， 则忽略本接口的AutoActive这个参数（若持有的许可证充足，子客户企业注册完成后将自动激活），具体位置参考下图：
:rtype: bool
"""
return self._AutoActive
@AutoActive.setter
def AutoActive(self, AutoActive):
self._AutoActive = AutoActive
@property
def BusinessLicense(self):
"""营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。
:rtype: str
"""
return self._BusinessLicense
@BusinessLicense.setter
def BusinessLicense(self, BusinessLicense):
self._BusinessLicense = BusinessLicense
@property
def ProxyAddress(self):
"""组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。
:rtype: str
"""
return self._ProxyAddress
@ProxyAddress.setter
def ProxyAddress(self, ProxyAddress):
self._ProxyAddress = ProxyAddress
@property
def ProxyLegalName(self):
"""组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
:rtype: str
"""
return self._ProxyLegalName
@ProxyLegalName.setter
def ProxyLegalName(self, ProxyLegalName):
self._ProxyLegalName = ProxyLegalName
@property
def PowerOfAttorneys(self):
"""授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
p.s. 如果上传授权书 ，需遵循以下条件
1. 超管的信息（超管姓名，超管手机号）必须为必填参数。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式
:rtype: list of str
"""
return self._PowerOfAttorneys
@PowerOfAttorneys.setter
def PowerOfAttorneys(self, PowerOfAttorneys):
self._PowerOfAttorneys = PowerOfAttorneys
@property
def OrganizationAuthorizationOptions(self):
"""企业认证时个性化能力信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationAuthorizationOptions`
"""
return self._OrganizationAuthorizationOptions
@OrganizationAuthorizationOptions.setter
def OrganizationAuthorizationOptions(self, OrganizationAuthorizationOptions):
self._OrganizationAuthorizationOptions = OrganizationAuthorizationOptions
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ProxyOrganizationName = params.get("ProxyOrganizationName")
self._UniformSocialCreditCode = params.get("UniformSocialCreditCode")
self._ProxyOperatorName = params.get("ProxyOperatorName")
self._ProxyOperatorMobile = params.get("ProxyOperatorMobile")
self._Module = params.get("Module")
self._ModuleId = params.get("ModuleId")
self._MenuStatus = params.get("MenuStatus")
self._Endpoint = params.get("Endpoint")
self._AutoJumpBackEvent = params.get("AutoJumpBackEvent")
self._AuthorizationTypes = params.get("AuthorizationTypes")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._ProxyOperatorIdCardNumber = params.get("ProxyOperatorIdCardNumber")
self._AutoJumpUrl = params.get("AutoJumpUrl")
self._TopNavigationStatus = params.get("TopNavigationStatus")
self._AutoActive = params.get("AutoActive")
self._BusinessLicense = params.get("BusinessLicense")
self._ProxyAddress = params.get("ProxyAddress")
self._ProxyLegalName = params.get("ProxyLegalName")
self._PowerOfAttorneys = params.get("PowerOfAttorneys")
if params.get("OrganizationAuthorizationOptions") is not None:
self._OrganizationAuthorizationOptions = OrganizationAuthorizationOptions()
self._OrganizationAuthorizationOptions._deserialize(params.get("OrganizationAuthorizationOptions"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateConsoleLoginUrlResponse(AbstractModel):
"""CreateConsoleLoginUrl返回参数结构体
"""
def __init__(self):
r"""
:param _ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> </tbody> </table>
注：
1. <font color="red">链接仅单次有效</font>，每次登录需要需要重新创建新的链接
2. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type ConsoleUrl: str
:param _IsActivated: 子客企业是否已开通腾讯电子签，
<ul><li> **true** :已经开通腾讯电子签</li>
<li> **false** :还未开通腾讯电子签</li></ul>
注：`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断，非企业名称或者社会信用代码`
:type IsActivated: bool
:param _ProxyOperatorIsVerified: 当前经办人是否已认证并加入功能
<ul><li> **true** : 已经认证加入公司</li>
<li> **false** : 还未认证加入公司</li></ul>
注意：**员工是否实名是根据Agent.ProxyOperator.OpenId判断，非经办人姓名**
:type ProxyOperatorIsVerified: bool
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ConsoleUrl = None
self._IsActivated = None
self._ProxyOperatorIsVerified = None
self._RequestId = None
@property
def ConsoleUrl(self):
"""跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5/WEIXIN_QRCODE_URL</td> <td>30天</td> </tr> </tbody> </table>
注：
1. <font color="red">链接仅单次有效</font>，每次登录需要需要重新创建新的链接
2. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._ConsoleUrl
@ConsoleUrl.setter
def ConsoleUrl(self, ConsoleUrl):
self._ConsoleUrl = ConsoleUrl
@property
def IsActivated(self):
"""子客企业是否已开通腾讯电子签，
<ul><li> **true** :已经开通腾讯电子签</li>
<li> **false** :还未开通腾讯电子签</li></ul>
注：`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断，非企业名称或者社会信用代码`
:rtype: bool
"""
return self._IsActivated
@IsActivated.setter
def IsActivated(self, IsActivated):
self._IsActivated = IsActivated
@property
def ProxyOperatorIsVerified(self):
"""当前经办人是否已认证并加入功能
<ul><li> **true** : 已经认证加入公司</li>
<li> **false** : 还未认证加入公司</li></ul>
注意：**员工是否实名是根据Agent.ProxyOperator.OpenId判断，非经办人姓名**
:rtype: bool
"""
return self._ProxyOperatorIsVerified
@ProxyOperatorIsVerified.setter
def ProxyOperatorIsVerified(self, ProxyOperatorIsVerified):
self._ProxyOperatorIsVerified = ProxyOperatorIsVerified
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._ConsoleUrl = params.get("ConsoleUrl")
self._IsActivated = params.get("IsActivated")
self._ProxyOperatorIsVerified = params.get("ProxyOperatorIsVerified")
self._RequestId = params.get("RequestId")
class CreateEmployeeChangeUrlRequest(AbstractModel):
"""CreateEmployeeChangeUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _OpenId: 待修改的员工OpenId
:type OpenId: str
:param _NewMobile: 待修改的员工手机号，支持海外格式
:type NewMobile: str
"""
self._Agent = None
self._OpenId = None
self._NewMobile = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def OpenId(self):
"""待修改的员工OpenId
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def NewMobile(self):
"""待修改的员工手机号，支持海外格式
:rtype: str
"""
return self._NewMobile
@NewMobile.setter
def NewMobile(self, NewMobile):
self._NewMobile = NewMobile
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._OpenId = params.get("OpenId")
self._NewMobile = params.get("NewMobile")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateEmployeeChangeUrlResponse(AbstractModel):
"""CreateEmployeeChangeUrl返回参数结构体
"""
def __init__(self):
r"""
:param _MiniAppPath: 修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a>
:type MiniAppPath: str
:param _ExpireTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:type ExpireTime: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._MiniAppPath = None
self._ExpireTime = None
self._RequestId = None
@property
def MiniAppPath(self):
"""修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a>
:rtype: str
"""
return self._MiniAppPath
@MiniAppPath.setter
def MiniAppPath(self, MiniAppPath):
self._MiniAppPath = MiniAppPath
@property
def ExpireTime(self):
"""链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:rtype: int
"""
return self._ExpireTime
@ExpireTime.setter
def ExpireTime(self, ExpireTime):
self._ExpireTime = ExpireTime
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._MiniAppPath = params.get("MiniAppPath")
self._ExpireTime = params.get("ExpireTime")
self._RequestId = params.get("RequestId")
class CreateEmployeeQualificationSealQrCodeRequest(AbstractModel):
"""CreateEmployeeQualificationSealQrCode请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _HintText: 提示信息，扫码后此信息会展示给扫描用户，用来提示用户授权操作的目的，会在授权界面下面的位置展示。
:type HintText: str
"""
self._Agent = None
self._HintText = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def HintText(self):
"""提示信息，扫码后此信息会展示给扫描用户，用来提示用户授权操作的目的，会在授权界面下面的位置展示。
:rtype: str
"""
return self._HintText
@HintText.setter
def HintText(self, HintText):
self._HintText = HintText
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._HintText = params.get("HintText")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateEmployeeQualificationSealQrCodeResponse(AbstractModel):
"""CreateEmployeeQualificationSealQrCode返回参数结构体
"""
def __init__(self):
r"""
:param _QrcodeBase64: 二维码图片的Base64 注: `此二维码的有效时间为7天，过期后需要重新生成新的二维码图片`
:type QrcodeBase64: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._QrcodeBase64 = None
self._RequestId = None
@property
def QrcodeBase64(self):
"""二维码图片的Base64 注: `此二维码的有效时间为7天，过期后需要重新生成新的二维码图片`
:rtype: str
"""
return self._QrcodeBase64
@QrcodeBase64.setter
def QrcodeBase64(self, QrcodeBase64):
self._QrcodeBase64 = QrcodeBase64
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._QrcodeBase64 = params.get("QrcodeBase64")
self._RequestId = params.get("RequestId")
class CreateFlowBlockchainEvidenceUrlRequest(AbstractModel):
"""CreateFlowBlockchainEvidenceUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
:type FlowId: str
:param _ExpiredOn: 链接/二维码的有效截止时间，格式为unix时间戳。最长不超过 2099年12月31日（4102415999）。
默认值为有效期为当前时间后7天。
:type ExpiredOn: int
"""
self._Agent = None
self._FlowId = None
self._ExpiredOn = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""合同流程ID，为32位字符串。建议开发者妥善保存此流程ID，以便于顺利进行后续操作。可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def ExpiredOn(self):
"""链接/二维码的有效截止时间，格式为unix时间戳。最长不超过 2099年12月31日（4102415999）。
默认值为有效期为当前时间后7天。
:rtype: int
"""
return self._ExpiredOn
@ExpiredOn.setter
def ExpiredOn(self, ExpiredOn):
self._ExpiredOn = ExpiredOn
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
self._ExpiredOn = params.get("ExpiredOn")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateFlowBlockchainEvidenceUrlResponse(AbstractModel):
"""CreateFlowBlockchainEvidenceUrl返回参数结构体
"""
def __init__(self):
r"""
:param _QrCode: 二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。
:type QrCode: str
:param _Url: 查看短链，可直接点击短链查看证书。
:type Url: str
:param _ExpiredOn: 二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
:type ExpiredOn: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._QrCode = None
self._Url = None
self._ExpiredOn = None
self._RequestId = None
@property
def QrCode(self):
"""二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。
:rtype: str
"""
return self._QrCode
@QrCode.setter
def QrCode(self, QrCode):
self._QrCode = QrCode
@property
def Url(self):
"""查看短链，可直接点击短链查看证书。
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def ExpiredOn(self):
"""二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
:rtype: int
"""
return self._ExpiredOn
@ExpiredOn.setter
def ExpiredOn(self, ExpiredOn):
self._ExpiredOn = ExpiredOn
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._QrCode = params.get("QrCode")
self._Url = params.get("Url")
self._ExpiredOn = params.get("ExpiredOn")
self._RequestId = params.get("RequestId")
class CreateFlowForwardsRequest(AbstractModel):
"""CreateFlowForwards请求参数结构体
"""
def __init__(self):
r"""
:param _TargetOpenId: 合同对应参与方需要修改的目标经办人对应的OpenId。
注意：`需要保证目标经办人已经加入企业且已实名`
:type TargetOpenId: str
:param _FlowForwardInfos: 企业签署方的合同及对应签署方
:type FlowForwardInfos: list of FlowForwardInfo
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._TargetOpenId = None
self._FlowForwardInfos = None
self._Agent = None
@property
def TargetOpenId(self):
"""合同对应参与方需要修改的目标经办人对应的OpenId。
注意：`需要保证目标经办人已经加入企业且已实名`
:rtype: str
"""
return self._TargetOpenId
@TargetOpenId.setter
def TargetOpenId(self, TargetOpenId):
self._TargetOpenId = TargetOpenId
@property
def FlowForwardInfos(self):
"""企业签署方的合同及对应签署方
:rtype: list of FlowForwardInfo
"""
return self._FlowForwardInfos
@FlowForwardInfos.setter
def FlowForwardInfos(self, FlowForwardInfos):
self._FlowForwardInfos = FlowForwardInfos
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
self._TargetOpenId = params.get("TargetOpenId")
if params.get("FlowForwardInfos") is not None:
self._FlowForwardInfos = []
for item in params.get("FlowForwardInfos"):
obj = FlowForwardInfo()
obj._deserialize(item)
self._FlowForwardInfos.append(obj)
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateFlowForwardsResponse(AbstractModel):
"""CreateFlowForwards返回参数结构体
"""
def __init__(self):
r"""
:param _FailedFlows: 失败的合同id以及错误详情
:type FailedFlows: list of FlowForwardResult
:param _SuccessFlows: 成功的合同id
:type SuccessFlows: list of str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FailedFlows = None
self._SuccessFlows = None
self._RequestId = None
@property
def FailedFlows(self):
"""失败的合同id以及错误详情
:rtype: list of FlowForwardResult
"""
return self._FailedFlows
@FailedFlows.setter
def FailedFlows(self, FailedFlows):
self._FailedFlows = FailedFlows
@property
def SuccessFlows(self):
"""成功的合同id
:rtype: list of str
"""
return self._SuccessFlows
@SuccessFlows.setter
def SuccessFlows(self, SuccessFlows):
self._SuccessFlows = SuccessFlows
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("FailedFlows") is not None:
self._FailedFlows = []
for item in params.get("FailedFlows"):
obj = FlowForwardResult()
obj._deserialize(item)
self._FailedFlows.append(obj)
self._SuccessFlows = params.get("SuccessFlows")
self._RequestId = params.get("RequestId")
class CreateFlowGroupSignReviewRequest(AbstractModel):
"""CreateFlowGroupSignReview请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowGroupId: 合同(流程)组的合同组Id，为32位字符串，通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时返回。
:type FlowGroupId: str
:param _ReviewType: 提交的审核结果，审核结果有下面三种情况
<ul><li><b>PASS</b>: 审核通过，合同流程可以继续执行签署等操作</li>
<li><b>REJECT</b>: 审核拒绝，合同流程不会变动</li>
<li><b>SIGN_REJECT</b>:拒签，合同流程直接结束，合同状态变为**合同拒签**</li></ul>
:type ReviewType: str
:param _ApproverInfo: 需要进行签署审核的签署人的个人信息或企业信息，签署方的匹配方式按照以下规则:
个人：二选一（选择其中任意信息组合即可）
<ul><li>姓名+证件类型+证件号</li>
<li>姓名+手机号</li></ul>
企业：二选一 （选择其中任意信息组合即可）
<ul><li>企业名+姓名+证件类型+证件号</li>
<li>企业名+姓名+手机号</li></ul>
:type ApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.NeedReviewApproverInfo`
:param _ReviewMessage: 审核不通过的原因，该字段的字符串长度不超过200个字符。
注：`当审核类型（ReviewType）为审核拒绝（REJECT）或拒签（SIGN_REJECT）时，审核结果原因字段必须填写`
:type ReviewMessage: str
"""
self._Agent = None
self._FlowGroupId = None
self._ReviewType = None
self._ApproverInfo = None
self._ReviewMessage = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowGroupId(self):
""" 合同(流程)组的合同组Id，为32位字符串，通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时返回。
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def ReviewType(self):
"""提交的审核结果，审核结果有下面三种情况
<ul><li><b>PASS</b>: 审核通过，合同流程可以继续执行签署等操作</li>
<li><b>REJECT</b>: 审核拒绝，合同流程不会变动</li>
<li><b>SIGN_REJECT</b>:拒签，合同流程直接结束，合同状态变为**合同拒签**</li></ul>
:rtype: str
"""
return self._ReviewType
@ReviewType.setter
def ReviewType(self, ReviewType):
self._ReviewType = ReviewType
@property
def ApproverInfo(self):
"""需要进行签署审核的签署人的个人信息或企业信息，签署方的匹配方式按照以下规则:
个人：二选一（选择其中任意信息组合即可）
<ul><li>姓名+证件类型+证件号</li>
<li>姓名+手机号</li></ul>
企业：二选一 （选择其中任意信息组合即可）
<ul><li>企业名+姓名+证件类型+证件号</li>
<li>企业名+姓名+手机号</li></ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.NeedReviewApproverInfo`
"""
return self._ApproverInfo
@ApproverInfo.setter
def ApproverInfo(self, ApproverInfo):
self._ApproverInfo = ApproverInfo
@property
def ReviewMessage(self):
"""审核不通过的原因，该字段的字符串长度不超过200个字符。
注：`当审核类型（ReviewType）为审核拒绝（REJECT）或拒签（SIGN_REJECT）时，审核结果原因字段必须填写`
:rtype: str
"""
return self._ReviewMessage
@ReviewMessage.setter
def ReviewMessage(self, ReviewMessage):
self._ReviewMessage = ReviewMessage
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowGroupId = params.get("FlowGroupId")
self._ReviewType = params.get("ReviewType")
if params.get("ApproverInfo") is not None:
self._ApproverInfo = NeedReviewApproverInfo()
self._ApproverInfo._deserialize(params.get("ApproverInfo"))
self._ReviewMessage = params.get("ReviewMessage")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateFlowGroupSignReviewResponse(AbstractModel):
"""CreateFlowGroupSignReview返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class CreateFlowOption(AbstractModel):
"""创建合同个性化参数
"""
def __init__(self):
r"""
:param _CanEditFlow: 是否允许修改合同信息，
**true**：可以
**false**：（默认）不可以
:type CanEditFlow: bool
:param _HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称
**true**：允许
**false**：（默认）不允许
:type HideShowFlowName: bool
:param _HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型，
**true**：允许
**false**：（默认）不允许
:type HideShowFlowType: bool
:param _HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间
**true**：允许
**false**：（默认）不允许
:type HideShowDeadline: bool
:param _CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤
**true**：允许
**false**：（默认）不允许
:type CanSkipAddApprover: bool
:param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息，长度不能超过500，只能由中文、字母、数字和标点组成。
:type CustomCreateFlowDescription: str
:param _ForbidEditFillComponent: 禁止编辑填写控件
**true**：禁止编辑填写控件
**false**：（默认）允许编辑填写控件
:type ForbidEditFillComponent: bool
:param _SkipUploadFile: 跳过上传文件步骤
**true**：跳过
**false**：（默认）不跳过，需要传ResourceId
:type SkipUploadFile: bool
"""
self._CanEditFlow = None
self._HideShowFlowName = None
self._HideShowFlowType = None
self._HideShowDeadline = None
self._CanSkipAddApprover = None
self._CustomCreateFlowDescription = None
self._ForbidEditFillComponent = None
self._SkipUploadFile = None
@property
def CanEditFlow(self):
"""是否允许修改合同信息，
**true**：可以
**false**：（默认）不可以
:rtype: bool
"""
return self._CanEditFlow
@CanEditFlow.setter
def CanEditFlow(self, CanEditFlow):
self._CanEditFlow = CanEditFlow
@property
def HideShowFlowName(self):
"""是否允许发起合同弹窗隐藏合同名称
**true**：允许
**false**：（默认）不允许
:rtype: bool
"""
return self._HideShowFlowName
@HideShowFlowName.setter
def HideShowFlowName(self, HideShowFlowName):
self._HideShowFlowName = HideShowFlowName
@property
def HideShowFlowType(self):
"""是否允许发起合同弹窗隐藏合同类型，
**true**：允许
**false**：（默认）不允许
:rtype: bool
"""
return self._HideShowFlowType
@HideShowFlowType.setter
def HideShowFlowType(self, HideShowFlowType):
self._HideShowFlowType = HideShowFlowType
@property
def HideShowDeadline(self):
"""是否允许发起合同弹窗隐藏合同到期时间
**true**：允许
**false**：（默认）不允许
:rtype: bool
"""
return self._HideShowDeadline
@HideShowDeadline.setter
def HideShowDeadline(self, HideShowDeadline):
self._HideShowDeadline = HideShowDeadline
@property
def CanSkipAddApprover(self):
"""是否允许发起合同步骤跳过指定签署方步骤
**true**：允许
**false**：（默认）不允许
:rtype: bool
"""
return self._CanSkipAddApprover
@CanSkipAddApprover.setter
def CanSkipAddApprover(self, CanSkipAddApprover):
self._CanSkipAddApprover = CanSkipAddApprover
@property
def CustomCreateFlowDescription(self):
"""定制化发起合同弹窗的描述信息，长度不能超过500，只能由中文、字母、数字和标点组成。
:rtype: str
"""
return self._CustomCreateFlowDescription
@CustomCreateFlowDescription.setter
def CustomCreateFlowDescription(self, CustomCreateFlowDescription):
self._CustomCreateFlowDescription = CustomCreateFlowDescription
@property
def ForbidEditFillComponent(self):
"""禁止编辑填写控件
**true**：禁止编辑填写控件
**false**：（默认）允许编辑填写控件
:rtype: bool
"""
return self._ForbidEditFillComponent
@ForbidEditFillComponent.setter
def ForbidEditFillComponent(self, ForbidEditFillComponent):
self._ForbidEditFillComponent = ForbidEditFillComponent
@property
def SkipUploadFile(self):
"""跳过上传文件步骤
**true**：跳过
**false**：（默认）不跳过，需要传ResourceId
:rtype: bool
"""
return self._SkipUploadFile
@SkipUploadFile.setter
def SkipUploadFile(self, SkipUploadFile):
self._SkipUploadFile = SkipUploadFile
def _deserialize(self, params):
self._CanEditFlow = params.get("CanEditFlow")
self._HideShowFlowName = params.get("HideShowFlowName")
self._HideShowFlowType = params.get("HideShowFlowType")
self._HideShowDeadline = params.get("HideShowDeadline")
self._CanSkipAddApprover = params.get("CanSkipAddApprover")
self._CustomCreateFlowDescription = params.get("CustomCreateFlowDescription")
self._ForbidEditFillComponent = params.get("ForbidEditFillComponent")
self._SkipUploadFile = params.get("SkipUploadFile")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateFlowsByTemplatesRequest(AbstractModel):
"""CreateFlowsByTemplates请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowInfos: 要创建的合同信息列表，最多支持一次创建20个合同
:type FlowInfos: list of FlowInfo
:param _NeedPreview: 是否为预览模式，取值如下：
<ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
<li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 <font color="red">注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作</font></li></ul>
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
:type NeedPreview: bool
:param _PreviewType: 预览模式下产生的预览链接类型
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
注: `此参数在NeedPreview 为true时有效`
:type PreviewType: int
:param _Operator: 操作者的信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowInfos = None
self._NeedPreview = None
self._PreviewType = None
self._Operator = None
@property
def Agent(self):
"""合同的发起企业和发起人信息，<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a>
此接口下面信息必填。
<ul>
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowInfos(self):
"""要创建的合同信息列表，最多支持一次创建20个合同
:rtype: list of FlowInfo
"""
return self._FlowInfos
@FlowInfos.setter
def FlowInfos(self, FlowInfos):
self._FlowInfos = FlowInfos
@property
def NeedPreview(self):
"""是否为预览模式，取值如下：
<ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
<li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。 <font color="red">注意： 以预览模式创建的合同仅供查看，因此参与方无法进行签署操作</font></li></ul>
注:
`如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
:rtype: bool
"""
return self._NeedPreview
@NeedPreview.setter
def NeedPreview(self, NeedPreview):
self._NeedPreview = NeedPreview
@property
def PreviewType(self):
"""预览模式下产生的预览链接类型
<ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
注: `此参数在NeedPreview 为true时有效`
:rtype: int
"""
return self._PreviewType
@PreviewType.setter
def PreviewType(self, PreviewType):
self._PreviewType = PreviewType
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("FlowInfos") is not None:
self._FlowInfos = []
for item in params.get("FlowInfos"):
obj = FlowInfo()
obj._deserialize(item)
self._FlowInfos.append(obj)
self._NeedPreview = params.get("NeedPreview")
self._PreviewType = params.get("PreviewType")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateFlowsByTemplatesResponse(AbstractModel):
"""CreateFlowsByTemplates返回参数结构体
"""
def __init__(self):
r"""
:param _FlowIds: 生成的合同流程ID数组，合同流程ID为32位字符串。
建议开发者妥善保存此流程ID数组，以便于顺利进行后续操作。
[点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:type FlowIds: list of str
:param _CustomerData: 第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
:type CustomerData: list of str
:param _ErrorMessages: 创建消息，对应多个合同ID，
成功为“”,创建失败则对应失败消息
:type ErrorMessages: list of str
:param _PreviewUrls: 合同预览链接URL数组。
注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过[合同文档合成完成回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取或使用返回的TaskInfo中的TaskId通过[查询转换任务状态
](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi)接口查询得到
:type PreviewUrls: list of str
:param _TaskInfos: 复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
:type TaskInfos: list of TaskInfo
:param _FlowApprovers: 签署方信息，如角色ID、角色名称等
:type FlowApprovers: list of FlowApproverItem
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowIds = None
self._CustomerData = None
self._ErrorMessages = None
self._PreviewUrls = None
self._TaskInfos = None
self._FlowApprovers = None
self._RequestId = None
@property
def FlowIds(self):
"""生成的合同流程ID数组，合同流程ID为32位字符串。
建议开发者妥善保存此流程ID数组，以便于顺利进行后续操作。
[点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def CustomerData(self):
"""第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
:rtype: list of str
"""
return self._CustomerData
@CustomerData.setter
def CustomerData(self, CustomerData):
self._CustomerData = CustomerData
@property
def ErrorMessages(self):
"""创建消息，对应多个合同ID，
成功为“”,创建失败则对应失败消息
:rtype: list of str
"""
return self._ErrorMessages
@ErrorMessages.setter
def ErrorMessages(self, ErrorMessages):
self._ErrorMessages = ErrorMessages
@property
def PreviewUrls(self):
"""合同预览链接URL数组。
注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
如果预览的文件中指定了动态表格控件，此时此接口返回的是合成前的文档预览链接，合成完成后的文档预览链接需要通过[合同文档合成完成回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)获取或使用返回的TaskInfo中的TaskId通过[查询转换任务状态
](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi)接口查询得到
:rtype: list of str
"""
return self._PreviewUrls
@PreviewUrls.setter
def PreviewUrls(self, PreviewUrls):
self._PreviewUrls = PreviewUrls
@property
def TaskInfos(self):
"""复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
:rtype: list of TaskInfo
"""
return self._TaskInfos
@TaskInfos.setter
def TaskInfos(self, TaskInfos):
self._TaskInfos = TaskInfos
@property
def FlowApprovers(self):
"""签署方信息，如角色ID、角色名称等
:rtype: list of FlowApproverItem
"""
return self._FlowApprovers
@FlowApprovers.setter
def FlowApprovers(self, FlowApprovers):
self._FlowApprovers = FlowApprovers
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FlowIds = params.get("FlowIds")
self._CustomerData = params.get("CustomerData")
self._ErrorMessages = params.get("ErrorMessages")
self._PreviewUrls = params.get("PreviewUrls")
if params.get("TaskInfos") is not None:
self._TaskInfos = []
for item in params.get("TaskInfos"):
obj = TaskInfo()
obj._deserialize(item)
self._TaskInfos.append(obj)
if params.get("FlowApprovers") is not None:
self._FlowApprovers = []
for item in params.get("FlowApprovers"):
obj = FlowApproverItem()
obj._deserialize(item)
self._FlowApprovers.append(obj)
self._RequestId = params.get("RequestId")
class CreateLegalSealQrCodeRequest(AbstractModel):
"""CreateLegalSealQrCode请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>注:
`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `
`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `
`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Operator: 操作人信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _Organization: 企业信息
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
self._Agent = None
self._Operator = None
self._Organization = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>注:
`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `
`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `
`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作人信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Organization(self):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
"""企业信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
"""
return self._Organization
@Organization.setter
def Organization(self, Organization):
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
self._Organization = Organization
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
if params.get("Organization") is not None:
self._Organization = OrganizationInfo()
self._Organization._deserialize(params.get("Organization"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateLegalSealQrCodeResponse(AbstractModel):
"""CreateLegalSealQrCode返回参数结构体
"""
def __init__(self):
r"""
:param _QrcodeBase64: 二维码图片base64值，二维码有效期7天（604800秒）
二维码图片的样式如下图：
:type QrcodeBase64: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._QrcodeBase64 = None
self._RequestId = None
@property
def QrcodeBase64(self):
"""二维码图片base64值，二维码有效期7天（604800秒）
二维码图片的样式如下图：
:rtype: str
"""
return self._QrcodeBase64
@QrcodeBase64.setter
def QrcodeBase64(self, QrcodeBase64):
self._QrcodeBase64 = QrcodeBase64
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._QrcodeBase64 = params.get("QrcodeBase64")
self._RequestId = params.get("RequestId")
class CreateOrganizationAuthFileRequest(AbstractModel):
"""CreateOrganizationAuthFile请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _OrganizationCommonInfo: 企业授权书信息参数， 需要自行保证这些参数跟营业执照中的信息一致。
:type OrganizationCommonInfo: :class:`tencentcloud.essbasic.v20210526.models.OrganizationCommonInfo`
:param _Type: 授权书类型：
<ul><li>0: 企业认证超管授权书</li><li>1: 超管变更授权书</li><li>2: 企业注销授权书</li></ul>
:type Type: int
"""
self._Agent = None
self._OrganizationCommonInfo = None
self._Type = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def OrganizationCommonInfo(self):
"""企业授权书信息参数， 需要自行保证这些参数跟营业执照中的信息一致。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationCommonInfo`
"""
return self._OrganizationCommonInfo
@OrganizationCommonInfo.setter
def OrganizationCommonInfo(self, OrganizationCommonInfo):
self._OrganizationCommonInfo = OrganizationCommonInfo
@property
def Type(self):
"""授权书类型：
<ul><li>0: 企业认证超管授权书</li><li>1: 超管变更授权书</li><li>2: 企业注销授权书</li></ul>
:rtype: int
"""
return self._Type
@Type.setter
def Type(self, Type):
self._Type = Type
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("OrganizationCommonInfo") is not None:
self._OrganizationCommonInfo = OrganizationCommonInfo()
self._OrganizationCommonInfo._deserialize(params.get("OrganizationCommonInfo"))
self._Type = params.get("Type")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateOrganizationAuthFileResponse(AbstractModel):
"""CreateOrganizationAuthFile返回参数结构体
"""
def __init__(self):
r"""
:param _FileUrl: 授权书链接，有效期5分钟。
:type FileUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FileUrl = None
self._RequestId = None
@property
def FileUrl(self):
"""授权书链接，有效期5分钟。
:rtype: str
"""
return self._FileUrl
@FileUrl.setter
def FileUrl(self, FileUrl):
self._FileUrl = FileUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._FileUrl = params.get("FileUrl")
self._RequestId = params.get("RequestId")
class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
"""CreatePartnerAutoSignAuthUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _AuthorizedOrganizationId: 被授企业id/授权方企业id（即OrganizationId），如果是企业之间授权和AuthorizedOrganizationName二选一传入。
注：`被授权企业必须和当前企业在同一应用号下`
:type AuthorizedOrganizationId: str
:param _AuthorizedOrganizationName: 被授企业名称/授权方企业的名字，如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
注:
1. 如果名称中包含英文括号()，请使用中文括号（）代替。
2. 被授权企业必须和当前企业在同一应用号下
:type AuthorizedOrganizationName: str
:param _PlatformAppAuthorization: 是否给平台应用授权
<ul>
<li><strong>true</strong>: 表示是，授权平台应用。在此情况下，无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>
<li><strong>false</strong>: （默认）表示否，不是授权平台应用。</li>
</ul>
注：授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单，请联系运营经理开通。
:type PlatformAppAuthorization: bool
:param _SealTypes: 在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。支持的印章类型包括：
<ul>
<li><strong>OFFICIAL</strong>：企业公章，用于代表企业对外的正式文件和重要事务的认证。</li>
<li><strong>CONTRACT</strong>：合同专用章，专门用于签署各类合同。</li>
<li><strong>FINANCE</strong>：财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证。</li>
<li><strong>PERSONNEL</strong>：人事专用章，用于人事管理相关文件，如劳动合同、人事任命等。</li>
</ul>
:type SealTypes: list of str
:param _AuthToMe: 在处理授权关系时，授权的方向
<ul>
<li><strong>false</strong>（默认值）：表示我方授权他方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称，即接收授权的企业。</li>
<li><strong>true</strong>：表示他方授权我方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称，即提供授权的企业。</li>
</ul>
:type AuthToMe: bool
"""
self._Agent = None
self._AuthorizedOrganizationId = None
self._AuthorizedOrganizationName = None
self._PlatformAppAuthorization = None
self._SealTypes = None
self._AuthToMe = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def AuthorizedOrganizationId(self):
"""被授企业id/授权方企业id（即OrganizationId），如果是企业之间授权和AuthorizedOrganizationName二选一传入。
注：`被授权企业必须和当前企业在同一应用号下`
:rtype: str
"""
return self._AuthorizedOrganizationId
@AuthorizedOrganizationId.setter
def AuthorizedOrganizationId(self, AuthorizedOrganizationId):
self._AuthorizedOrganizationId = AuthorizedOrganizationId
@property
def AuthorizedOrganizationName(self):
"""被授企业名称/授权方企业的名字，如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
注:
1. 如果名称中包含英文括号()，请使用中文括号（）代替。
2. 被授权企业必须和当前企业在同一应用号下
:rtype: str
"""
return self._AuthorizedOrganizationName
@AuthorizedOrganizationName.setter
def AuthorizedOrganizationName(self, AuthorizedOrganizationName):
self._AuthorizedOrganizationName = AuthorizedOrganizationName
@property
def PlatformAppAuthorization(self):
"""是否给平台应用授权
<ul>
<li><strong>true</strong>: 表示是，授权平台应用。在此情况下，无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>
<li><strong>false</strong>: （默认）表示否，不是授权平台应用。</li>
</ul>
注：授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单，请联系运营经理开通。
:rtype: bool
"""
return self._PlatformAppAuthorization
@PlatformAppAuthorization.setter
def PlatformAppAuthorization(self, PlatformAppAuthorization):
self._PlatformAppAuthorization = PlatformAppAuthorization
@property
def SealTypes(self):
"""在设置印章授权时，可以指定特定的印章类型，以确保在授权过程中只使用相应类型的印章。支持的印章类型包括：
<ul>
<li><strong>OFFICIAL</strong>：企业公章，用于代表企业对外的正式文件和重要事务的认证。</li>
<li><strong>CONTRACT</strong>：合同专用章，专门用于签署各类合同。</li>
<li><strong>FINANCE</strong>：财务专用章，用于企业的财务相关文件，如发票、收据等财务凭证的认证。</li>
<li><strong>PERSONNEL</strong>：人事专用章，用于人事管理相关文件，如劳动合同、人事任命等。</li>
</ul>
:rtype: list of str
"""
return self._SealTypes
@SealTypes.setter
def SealTypes(self, SealTypes):
self._SealTypes = SealTypes
@property
def AuthToMe(self):
"""在处理授权关系时，授权的方向
<ul>
<li><strong>false</strong>（默认值）：表示我方授权他方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称，即接收授权的企业。</li>
<li><strong>true</strong>：表示他方授权我方。在这种情况下，<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称，即提供授权的企业。</li>
</ul>
:rtype: bool
"""
return self._AuthToMe
@AuthToMe.setter
def AuthToMe(self, AuthToMe):
self._AuthToMe = AuthToMe
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._AuthorizedOrganizationId = params.get("AuthorizedOrganizationId")
self._AuthorizedOrganizationName = params.get("AuthorizedOrganizationName")
self._PlatformAppAuthorization = params.get("PlatformAppAuthorization")
self._SealTypes = params.get("SealTypes")
self._AuthToMe = params.get("AuthToMe")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreatePartnerAutoSignAuthUrlResponse(AbstractModel):
"""CreatePartnerAutoSignAuthUrl返回参数结构体
"""
def __init__(self):
r"""
:param _Url: 授权链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
:type Url: str
:param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
:type MiniAppPath: str
:param _ExpireTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:type ExpireTime: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Url = None
self._MiniAppPath = None
self._ExpireTime = None
self._RequestId = None
@property
def Url(self):
"""授权链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def MiniAppPath(self):
"""从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
:rtype: str
"""
return self._MiniAppPath
@MiniAppPath.setter
def MiniAppPath(self, MiniAppPath):
self._MiniAppPath = MiniAppPath
@property
def ExpireTime(self):
"""链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
:rtype: int
"""
return self._ExpireTime
@ExpireTime.setter
def ExpireTime(self, ExpireTime):
self._ExpireTime = ExpireTime
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Url = params.get("Url")
self._MiniAppPath = params.get("MiniAppPath")
self._ExpireTime = params.get("ExpireTime")
self._RequestId = params.get("RequestId")
class CreatePersonAuthCertificateImageRequest(AbstractModel):
"""CreatePersonAuthCertificateImage请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _UserName: 个人用户名称
:type UserName: str
:param _IdCardType: 证件类型，支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:type IdCardType: str
:param _IdCardNumber: 证件号码，应符合以下规则<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type IdCardNumber: str
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
:type SceneKey: str
"""
self._Agent = None
self._UserName = None
self._IdCardType = None
self._IdCardNumber = None
self._SceneKey = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def UserName(self):
"""个人用户名称
:rtype: str
"""
return self._UserName
@UserName.setter
def UserName(self, UserName):
self._UserName = UserName
@property
def IdCardType(self):
"""证件类型，支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""证件号码，应符合以下规则<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def SceneKey(self):
"""自动签使用的场景值, 可以选择的场景值如下:<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN`
:rtype: str
"""
return self._SceneKey
@SceneKey.setter
def SceneKey(self, SceneKey):
self._SceneKey = SceneKey
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._UserName = params.get("UserName")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
self._SceneKey = params.get("SceneKey")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreatePersonAuthCertificateImageResponse(AbstractModel):
"""CreatePersonAuthCertificateImage返回参数结构体
"""
def __init__(self):
r"""
:param _AuthCertUrl: 个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。
:type AuthCertUrl: str
:param _ImageCertId: 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
:type ImageCertId: str
:param _SerialNumber: 在数字证书申请过程中，系统会自动生成一个独一无二的序列号。请注意，当证书到期并自动续期时，该序列号将会发生变化。值得注意的是，此序列号不会被合成至个人用户证书的证明图片中。
:type SerialNumber: str
:param _ValidFrom: CA证书颁发时间，格式为Unix标准时间戳（秒） 该时间格式化后会合成到个人用户证书证明图片
:type ValidFrom: int
:param _ValidTo: CA证书有效截止时间，格式为Unix标准时间戳（秒）该时间格式化后会合成到个人用户证书证明图片
:type ValidTo: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._AuthCertUrl = None
self._ImageCertId = None
self._SerialNumber = None
self._ValidFrom = None
self._ValidTo = None
self._RequestId = None
@property
def AuthCertUrl(self):
"""个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。
:rtype: str
"""
return self._AuthCertUrl
@AuthCertUrl.setter
def AuthCertUrl(self, AuthCertUrl):
self._AuthCertUrl = AuthCertUrl
@property
def ImageCertId(self):
"""个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
:rtype: str
"""
return self._ImageCertId
@ImageCertId.setter
def ImageCertId(self, ImageCertId):
self._ImageCertId = ImageCertId
@property
def SerialNumber(self):
"""在数字证书申请过程中，系统会自动生成一个独一无二的序列号。请注意，当证书到期并自动续期时，该序列号将会发生变化。值得注意的是，此序列号不会被合成至个人用户证书的证明图片中。
:rtype: str
"""
return self._SerialNumber
@SerialNumber.setter
def SerialNumber(self, SerialNumber):
self._SerialNumber = SerialNumber
@property
def ValidFrom(self):
"""CA证书颁发时间，格式为Unix标准时间戳（秒） 该时间格式化后会合成到个人用户证书证明图片
:rtype: int
"""
return self._ValidFrom
@ValidFrom.setter
def ValidFrom(self, ValidFrom):
self._ValidFrom = ValidFrom
@property
def ValidTo(self):
"""CA证书有效截止时间，格式为Unix标准时间戳（秒）该时间格式化后会合成到个人用户证书证明图片
:rtype: int
"""
return self._ValidTo
@ValidTo.setter
def ValidTo(self, ValidTo):
self._ValidTo = ValidTo
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._AuthCertUrl = params.get("AuthCertUrl")
self._ImageCertId = params.get("ImageCertId")
self._SerialNumber = params.get("SerialNumber")
self._ValidFrom = params.get("ValidFrom")
self._ValidTo = params.get("ValidTo")
self._RequestId = params.get("RequestId")
class CreateSealByImageRequest(AbstractModel):
"""CreateSealByImage请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _SealName: 电子印章名字，1-50个中文字符
注:`同一企业下电子印章名字不能相同`
:type SealName: str
:param _SealImage: 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式
注: `通过图片创建的电子印章，需电子签平台人工审核`
:type SealImage: str
:param _Operator: 操作者的信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _GenerateSource: 电子印章生成方式
<ul>
<li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
<li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
</ul>
:type GenerateSource: str
:param _SealType: 电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**OTHER**: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错
:type SealType: str
:param _SealHorizontalText: 企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号)
横向文字的位置如下图中的"印章横向文字在这里"
:type SealHorizontalText: str
:param _SealStyle: 印章样式, 可以选择的样式如下:
<ul><li>**circle**:(默认)圆形印章</li>
<li>**ellipse**:椭圆印章</li></ul>
:type SealStyle: str
:param _SealSize: 印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**（默认）: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>
:type SealSize: str
:param _TaxIdentifyCode: 企业税号
注:
<ul>
<li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li>
<li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（<font color="red">如果是通过授权书授权方式认证的企业，此参数必传不能为空</font>）</li>
</ul>
:type TaxIdentifyCode: str
"""
self._Agent = None
self._SealName = None
self._SealImage = None
self._Operator = None
self._GenerateSource = None
self._SealType = None
self._SealHorizontalText = None
self._SealStyle = None
self._SealSize = None
self._TaxIdentifyCode = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def SealName(self):
"""电子印章名字，1-50个中文字符
注:`同一企业下电子印章名字不能相同`
:rtype: str
"""
return self._SealName
@SealName.setter
def SealName(self, SealName):
self._SealName = SealName
@property
def SealImage(self):
"""电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式
注: `通过图片创建的电子印章，需电子签平台人工审核`
:rtype: str
"""
return self._SealImage
@SealImage.setter
def SealImage(self, SealImage):
self._SealImage = SealImage
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def GenerateSource(self):
"""电子印章生成方式
<ul>
<li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
<li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
</ul>
:rtype: str
"""
return self._GenerateSource
@GenerateSource.setter
def GenerateSource(self, GenerateSource):
self._GenerateSource = GenerateSource
@property
def SealType(self):
"""电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**OTHER**: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错
:rtype: str
"""
return self._SealType
@SealType.setter
def SealType(self, SealType):
self._SealType = SealType
@property
def SealHorizontalText(self):
"""企业印章横向文字，最多可填15个汉字 (若超过印章最大宽度，优先压缩字间距，其次缩小字号)
横向文字的位置如下图中的"印章横向文字在这里"
:rtype: str
"""
return self._SealHorizontalText
@SealHorizontalText.setter
def SealHorizontalText(self, SealHorizontalText):
self._SealHorizontalText = SealHorizontalText
@property
def SealStyle(self):
"""印章样式, 可以选择的样式如下:
<ul><li>**circle**:(默认)圆形印章</li>
<li>**ellipse**:椭圆印章</li></ul>
:rtype: str
"""
return self._SealStyle
@SealStyle.setter
def SealStyle(self, SealStyle):
self._SealStyle = SealStyle
@property
def SealSize(self):
"""印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**（默认）: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>
:rtype: str
"""
return self._SealSize
@SealSize.setter
def SealSize(self, SealSize):
self._SealSize = SealSize
@property
def TaxIdentifyCode(self):
"""企业税号
注:
<ul>
<li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li>
<li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（<font color="red">如果是通过授权书授权方式认证的企业，此参数必传不能为空</font>）</li>
</ul>
:rtype: str
"""
return self._TaxIdentifyCode
@TaxIdentifyCode.setter
def TaxIdentifyCode(self, TaxIdentifyCode):
self._TaxIdentifyCode = TaxIdentifyCode
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._SealName = params.get("SealName")
self._SealImage = params.get("SealImage")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._GenerateSource = params.get("GenerateSource")
self._SealType = params.get("SealType")
self._SealHorizontalText = params.get("SealHorizontalText")
self._SealStyle = params.get("SealStyle")
self._SealSize = params.get("SealSize")
self._TaxIdentifyCode = params.get("TaxIdentifyCode")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateSealByImageResponse(AbstractModel):
"""CreateSealByImage返回参数结构体
"""
def __init__(self):
r"""
:param _SealId: 电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
:type SealId: str
:param _ImageUrl: 电子印章预览链接地址，地址默认失效时间为24小时。
注:`图片上传生成的电子印章无预览链接地址`
:type ImageUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._SealId = None
self._ImageUrl = None
self._RequestId = None
@property
def SealId(self):
"""电子印章ID，为32位字符串。
建议开发者保留此印章ID，后续指定签署区印章或者操作印章需此印章ID。
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def ImageUrl(self):
"""电子印章预览链接地址，地址默认失效时间为24小时。
注:`图片上传生成的电子印章无预览链接地址`
:rtype: str
"""
return self._ImageUrl
@ImageUrl.setter
def ImageUrl(self, ImageUrl):
self._ImageUrl = ImageUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._SealId = params.get("SealId")
self._ImageUrl = params.get("ImageUrl")
self._RequestId = params.get("RequestId")
class CreateSignUrlsRequest(AbstractModel):
"""CreateSignUrls请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 合同流程ID数组，最多支持100个。
注:
1. 必须选择提供此参数或合同组编号中的一个。
2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
:type FlowIds: list of str
:param _FlowGroupId: 合同组编号
注：`该参数和合同流程ID数组必须二选一`
:type FlowGroupId: str
:param _Endpoint: 签署链接类型,可以设置的参数如下
<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li>
<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul>
**注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。
详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
:type Endpoint: str
:param _GenerateType: 签署链接生成类型，可以选择的类型如下
<ul><li><strong>ALL</strong>：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：<strong>此中类型不支持多个合同ID（FlowIds）</strong>。</li>
<li><strong>CHANNEL</strong>：适用于第三方子企业的员工签署方。</li>
<li><strong>NOT_CHANNEL</strong>：适用于SaaS平台企业的员工签署方。</li>
<li><strong>PERSON</strong>：适用于个人或自然人签署方。</li>
<li><strong>FOLLOWER</strong>：适用于关注方，目前指合同的抄送方。</li>
<li><strong>RECIPIENT</strong>：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。</li></ul>
:type GenerateType: str
:param _OrganizationName: SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
:type OrganizationName: str
:param _Name: 合同流程里边参与方的姓名。
注: `GenerateType为"PERSON"(即个人签署方)时必填`
:type Name: str
:param _Mobile: 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
:type Mobile: str
:param _IdCardType: 证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:type IdCardType: str
:param _IdCardNumber: 证件号码，应符合以下规则
<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type IdCardNumber: str
:param _OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
:type OrganizationOpenId: str
:param _OpenId: 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息
注：
如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
:type OpenId: str
:param _AutoJumpBack: 签署完成后是否自动回跳
<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
注:
1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
:type AutoJumpBack: bool
:param _JumpUrl: 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
:type JumpUrl: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _Hides: 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
<ul><li> **0** :合同签署页面更多操作按钮</li>
<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
<li> **2** :合同签署页面更多操作的转他人处理按钮</li>
<li> **3** :签署成功页的查看详情按钮</li></ul>
注: `字段为数组, 可以传值隐藏多个按钮`
:type Hides: list of int
:param _RecipientIds: 参与方角色ID，用于生成动态签署人链接完成领取。
注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
:type RecipientIds: list of str
:param _FlowGroupUrlInfo: 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
:type FlowGroupUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
:param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。
参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
:type UrlUseEnv: str
"""
self._Agent = None
self._FlowIds = None
self._FlowGroupId = None
self._Endpoint = None
self._GenerateType = None
self._OrganizationName = None
self._Name = None
self._Mobile = None
self._IdCardType = None
self._IdCardNumber = None
self._OrganizationOpenId = None
self._OpenId = None
self._AutoJumpBack = None
self._JumpUrl = None
self._Operator = None
self._Hides = None
self._RecipientIds = None
self._FlowGroupUrlInfo = None
self._UrlUseEnv = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""合同流程ID数组，最多支持100个。
注:
1. 必须选择提供此参数或合同组编号中的一个。
2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def FlowGroupId(self):
"""合同组编号
注：`该参数和合同流程ID数组必须二选一`
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def Endpoint(self):
"""签署链接类型,可以设置的参数如下
<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li>
<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul>
**注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。
详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
@property
def GenerateType(self):
"""签署链接生成类型，可以选择的类型如下
<ul><li><strong>ALL</strong>：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：<strong>此中类型不支持多个合同ID（FlowIds）</strong>。</li>
<li><strong>CHANNEL</strong>：适用于第三方子企业的员工签署方。</li>
<li><strong>NOT_CHANNEL</strong>：适用于SaaS平台企业的员工签署方。</li>
<li><strong>PERSON</strong>：适用于个人或自然人签署方。</li>
<li><strong>FOLLOWER</strong>：适用于关注方，目前指合同的抄送方。</li>
<li><strong>RECIPIENT</strong>：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。</li></ul>
:rtype: str
"""
return self._GenerateType
@GenerateType.setter
def GenerateType(self, GenerateType):
self._GenerateType = GenerateType
@property
def OrganizationName(self):
"""SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def Name(self):
"""合同流程里边参与方的姓名。
注: `GenerateType为"PERSON"(即个人签署方)时必填`
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Mobile(self):
"""合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def IdCardType(self):
"""证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""证件号码，应符合以下规则
<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def OrganizationOpenId(self):
"""第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OpenId(self):
"""第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息
注：
如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def AutoJumpBack(self):
"""签署完成后是否自动回跳
<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
注:
1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
:rtype: bool
"""
return self._AutoJumpBack
@AutoJumpBack.setter
def AutoJumpBack(self, AutoJumpBack):
self._AutoJumpBack = AutoJumpBack
@property
def JumpUrl(self):
"""签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
:rtype: str
"""
return self._JumpUrl
@JumpUrl.setter
def JumpUrl(self, JumpUrl):
self._JumpUrl = JumpUrl
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def Hides(self):
"""生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
<ul><li> **0** :合同签署页面更多操作按钮</li>
<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
<li> **2** :合同签署页面更多操作的转他人处理按钮</li>
<li> **3** :签署成功页的查看详情按钮</li></ul>
注: `字段为数组, 可以传值隐藏多个按钮`
:rtype: list of int
"""
return self._Hides
@Hides.setter
def Hides(self, Hides):
self._Hides = Hides
@property
def RecipientIds(self):
"""参与方角色ID，用于生成动态签署人链接完成领取。
注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
:rtype: list of str
"""
return self._RecipientIds
@RecipientIds.setter
def RecipientIds(self, RecipientIds):
self._RecipientIds = RecipientIds
@property
def FlowGroupUrlInfo(self):
"""合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
"""
return self._FlowGroupUrlInfo
@FlowGroupUrlInfo.setter
def FlowGroupUrlInfo(self, FlowGroupUrlInfo):
self._FlowGroupUrlInfo = FlowGroupUrlInfo
@property
def UrlUseEnv(self):
"""<font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。
参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
:rtype: str
"""
return self._UrlUseEnv
@UrlUseEnv.setter
def UrlUseEnv(self, UrlUseEnv):
self._UrlUseEnv = UrlUseEnv
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
self._FlowGroupId = params.get("FlowGroupId")
self._Endpoint = params.get("Endpoint")
self._GenerateType = params.get("GenerateType")
self._OrganizationName = params.get("OrganizationName")
self._Name = params.get("Name")
self._Mobile = params.get("Mobile")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OpenId = params.get("OpenId")
self._AutoJumpBack = params.get("AutoJumpBack")
self._JumpUrl = params.get("JumpUrl")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._Hides = params.get("Hides")
self._RecipientIds = params.get("RecipientIds")
if params.get("FlowGroupUrlInfo") is not None:
self._FlowGroupUrlInfo = FlowGroupUrlInfo()
self._FlowGroupUrlInfo._deserialize(params.get("FlowGroupUrlInfo"))
self._UrlUseEnv = params.get("UrlUseEnv")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateSignUrlsResponse(AbstractModel):
"""CreateSignUrls返回参数结构体
"""
def __init__(self):
r"""
:param _SignUrlInfos: 生成的签署参与者的签署链接信息数组。
:type SignUrlInfos: list of SignUrlInfo
:param _ErrorMessages: 生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致
:type ErrorMessages: list of str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._SignUrlInfos = None
self._ErrorMessages = None
self._RequestId = None
@property
def SignUrlInfos(self):
"""生成的签署参与者的签署链接信息数组。
:rtype: list of SignUrlInfo
"""
return self._SignUrlInfos
@SignUrlInfos.setter
def SignUrlInfos(self, SignUrlInfos):
self._SignUrlInfos = SignUrlInfos
@property
def ErrorMessages(self):
"""生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致
:rtype: list of str
"""
return self._ErrorMessages
@ErrorMessages.setter
def ErrorMessages(self, ErrorMessages):
self._ErrorMessages = ErrorMessages
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("SignUrlInfos") is not None:
self._SignUrlInfos = []
for item in params.get("SignUrlInfos"):
obj = SignUrlInfo()
obj._deserialize(item)
self._SignUrlInfos.append(obj)
self._ErrorMessages = params.get("ErrorMessages")
self._RequestId = params.get("RequestId")
class DeleteOrganizationAuthorizationInfo(AbstractModel):
"""清理的企业认证流信息
"""
def __init__(self):
r"""
:param _AuthorizationId: 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
:type AuthorizationId: str
:param _OrganizationName: 认证的企业名称
:type OrganizationName: str
:param _OrganizationOpenId: 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
:type OrganizationOpenId: str
:param _Errormessage: 清除认证流产生的错误信息
:type Errormessage: str
"""
self._AuthorizationId = None
self._OrganizationName = None
self._OrganizationOpenId = None
self._Errormessage = None
@property
def AuthorizationId(self):
"""认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
:rtype: str
"""
return self._AuthorizationId
@AuthorizationId.setter
def AuthorizationId(self, AuthorizationId):
self._AuthorizationId = AuthorizationId
@property
def OrganizationName(self):
"""认证的企业名称
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def OrganizationOpenId(self):
"""第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def Errormessage(self):
"""清除认证流产生的错误信息
:rtype: str
"""
return self._Errormessage
@Errormessage.setter
def Errormessage(self, Errormessage):
self._Errormessage = Errormessage
def _deserialize(self, params):
self._AuthorizationId = params.get("AuthorizationId")
self._OrganizationName = params.get("OrganizationName")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._Errormessage = params.get("Errormessage")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DeleteOrganizationAuthorizationsRequest(AbstractModel):
"""DeleteOrganizationAuthorizations请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _AdminName: 认证人姓名，组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。
:type AdminName: str
:param _AdminMobile: 认证人手机号，组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。
:type AdminMobile: str
"""
self._Agent = None
self._AdminName = None
self._AdminMobile = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def AdminName(self):
"""认证人姓名，组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。
:rtype: str
"""
return self._AdminName
@AdminName.setter
def AdminName(self, AdminName):
self._AdminName = AdminName
@property
def AdminMobile(self):
"""认证人手机号，组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。
:rtype: str
"""
return self._AdminMobile
@AdminMobile.setter
def AdminMobile(self, AdminMobile):
self._AdminMobile = AdminMobile
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._AdminName = params.get("AdminName")
self._AdminMobile = params.get("AdminMobile")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DeleteOrganizationAuthorizationsResponse(AbstractModel):
"""DeleteOrganizationAuthorizations返回参数结构体
"""
def __init__(self):
r"""
:param _DeleteOrganizationAuthorizationInfos: 清理认证流的详细信息，包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。
:type DeleteOrganizationAuthorizationInfos: list of DeleteOrganizationAuthorizationInfo
:param _Status: 批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败
:type Status: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._DeleteOrganizationAuthorizationInfos = None
self._Status = None
self._RequestId = None
@property
def DeleteOrganizationAuthorizationInfos(self):
"""清理认证流的详细信息，包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。
:rtype: list of DeleteOrganizationAuthorizationInfo
"""
return self._DeleteOrganizationAuthorizationInfos
@DeleteOrganizationAuthorizationInfos.setter
def DeleteOrganizationAuthorizationInfos(self, DeleteOrganizationAuthorizationInfos):
self._DeleteOrganizationAuthorizationInfos = DeleteOrganizationAuthorizationInfos
@property
def Status(self):
"""批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败
:rtype: int
"""
return self._Status
@Status.setter
def Status(self, Status):
self._Status = Status
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("DeleteOrganizationAuthorizationInfos") is not None:
self._DeleteOrganizationAuthorizationInfos = []
for item in params.get("DeleteOrganizationAuthorizationInfos"):
obj = DeleteOrganizationAuthorizationInfo()
obj._deserialize(item)
self._DeleteOrganizationAuthorizationInfos.append(obj)
self._Status = params.get("Status")
self._RequestId = params.get("RequestId")
class Department(AbstractModel):
"""第三方应用集成员工部门信息
"""
def __init__(self):
r"""
:param _DepartmentId: 部门id
:type DepartmentId: str
:param _DepartmentName: 部门名称
:type DepartmentName: str
"""
self._DepartmentId = None
self._DepartmentName = None
@property
def DepartmentId(self):
"""部门id
:rtype: str
"""
return self._DepartmentId
@DepartmentId.setter
def DepartmentId(self, DepartmentId):
self._DepartmentId = DepartmentId
@property
def DepartmentName(self):
"""部门名称
:rtype: str
"""
return self._DepartmentName
@DepartmentName.setter
def DepartmentName(self, DepartmentName):
self._DepartmentName = DepartmentName
def _deserialize(self, params):
self._DepartmentId = params.get("DepartmentId")
self._DepartmentName = params.get("DepartmentName")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeBatchOrganizationRegistrationUrlsRequest(AbstractModel):
"""DescribeBatchOrganizationRegistrationUrls请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _TaskId: 通过接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>调用得到的任务ID。
:type TaskId: str
"""
self._Agent = None
self._TaskId = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def TaskId(self):
"""通过接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>调用得到的任务ID。
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._TaskId = params.get("TaskId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeBatchOrganizationRegistrationUrlsResponse(AbstractModel):
"""DescribeBatchOrganizationRegistrationUrls返回参数结构体
"""
def __init__(self):
r"""
:param _OrganizationAuthUrls: 子企业注册认证的链接列表
:type OrganizationAuthUrls: list of OrganizationAuthUrl
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._OrganizationAuthUrls = None
self._RequestId = None
@property
def OrganizationAuthUrls(self):
"""子企业注册认证的链接列表
:rtype: list of OrganizationAuthUrl
"""
return self._OrganizationAuthUrls
@OrganizationAuthUrls.setter
def OrganizationAuthUrls(self, OrganizationAuthUrls):
self._OrganizationAuthUrls = OrganizationAuthUrls
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("OrganizationAuthUrls") is not None:
self._OrganizationAuthUrls = []
for item in params.get("OrganizationAuthUrls"):
obj = OrganizationAuthUrl()
obj._deserialize(item)
self._OrganizationAuthUrls.append(obj)
self._RequestId = params.get("RequestId")
class DescribeCancelFlowsTaskRequest(AbstractModel):
"""DescribeCancelFlowsTask请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _TaskId: 批量撤销任务编号，为32位字符串，通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。
:type TaskId: str
"""
self._Agent = None
self._TaskId = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def TaskId(self):
"""批量撤销任务编号，为32位字符串，通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._TaskId = params.get("TaskId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeCancelFlowsTaskResponse(AbstractModel):
"""DescribeCancelFlowsTask返回参数结构体
"""
def __init__(self):
r"""
:param _TaskId: 批量撤销任务编号，为32位字符串。
:type TaskId: str
:param _TaskStatus: 任务状态，需要关注的状态<ul><li>**PROCESSING** - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul>
:type TaskStatus: str
:param _SuccessFlowIds: 批量撤销成功的签署流程编号
:type SuccessFlowIds: list of str
:param _FailureFlows: 批量撤销失败的签署流程信息
:type FailureFlows: list of CancelFailureFlow
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._TaskId = None
self._TaskStatus = None
self._SuccessFlowIds = None
self._FailureFlows = None
self._RequestId = None
@property
def TaskId(self):
"""批量撤销任务编号，为32位字符串。
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def TaskStatus(self):
"""任务状态，需要关注的状态<ul><li>**PROCESSING** - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul>
:rtype: str
"""
return self._TaskStatus
@TaskStatus.setter
def TaskStatus(self, TaskStatus):
self._TaskStatus = TaskStatus
@property
def SuccessFlowIds(self):
"""批量撤销成功的签署流程编号
:rtype: list of str
"""
return self._SuccessFlowIds
@SuccessFlowIds.setter
def SuccessFlowIds(self, SuccessFlowIds):
self._SuccessFlowIds = SuccessFlowIds
@property
def FailureFlows(self):
"""批量撤销失败的签署流程信息
:rtype: list of CancelFailureFlow
"""
return self._FailureFlows
@FailureFlows.setter
def FailureFlows(self, FailureFlows):
self._FailureFlows = FailureFlows
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._TaskId = params.get("TaskId")
self._TaskStatus = params.get("TaskStatus")
self._SuccessFlowIds = params.get("SuccessFlowIds")
if params.get("FailureFlows") is not None:
self._FailureFlows = []
for item in params.get("FailureFlows"):
obj = CancelFailureFlow()
obj._deserialize(item)
self._FailureFlows.append(obj)
self._RequestId = params.get("RequestId")
class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
"""DescribeChannelFlowEvidenceReport请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
:type ReportId: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ReportType: 指定申请的报告类型，可选类型如下：
<ul><li> **0** :合同签署报告（默认）</li>
<li> **1** :公证处核验报告</li></ul>
:type ReportType: int
"""
self._Agent = None
self._ReportId = None
self._Operator = None
self._ReportType = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ReportId(self):
"""签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
:rtype: str
"""
return self._ReportId
@ReportId.setter
def ReportId(self, ReportId):
self._ReportId = ReportId
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def ReportType(self):
"""指定申请的报告类型，可选类型如下：
<ul><li> **0** :合同签署报告（默认）</li>
<li> **1** :公证处核验报告</li></ul>
:rtype: int
"""
return self._ReportType
@ReportType.setter
def ReportType(self, ReportType):
self._ReportType = ReportType
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ReportId = params.get("ReportId")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._ReportType = params.get("ReportType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeChannelFlowEvidenceReportResponse(AbstractModel):
"""DescribeChannelFlowEvidenceReport返回参数结构体
"""
def __init__(self):
r"""
:param _ReportUrl: 出证报告PDF的下载 URL，有效期为5分钟，超过有效期后将无法再下载。
:type ReportUrl: str
:param _Status: 出证任务执行的状态, 状态含义如下：
<ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
<li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
<li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
:type Status: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ReportUrl = None
self._Status = None
self._RequestId = None
@property
def ReportUrl(self):
"""出证报告PDF的下载 URL，有效期为5分钟，超过有效期后将无法再下载。
:rtype: str
"""
return self._ReportUrl
@ReportUrl.setter
def ReportUrl(self, ReportUrl):
self._ReportUrl = ReportUrl
@property
def Status(self):
"""出证任务执行的状态, 状态含义如下：
<ul><li>**EvidenceStatusExecuting**： 出证任务在执行中</li>
<li>**EvidenceStatusSuccess**： 出证任务执行成功</li>
<li>**EvidenceStatusFailed** ： 出证任务执行失败</li></ul>
:rtype: str
"""
return self._Status
@Status.setter
def Status(self, Status):
self._Status = Status
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._ReportUrl = params.get("ReportUrl")
self._Status = params.get("Status")
self._RequestId = params.get("RequestId")
class DescribeChannelOrganizationsRequest(AbstractModel):
"""DescribeChannelOrganizations请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
:type Limit: int
:param _OrganizationOpenId: 该字段是指第三方平台子客企业的唯一标识，用于查询单独某个子客的企业数据。
**注**：`如果需要批量查询本应用下的所有企业的信息，则该字段不需要赋值`
:type OrganizationOpenId: str
:param _AuthorizationStatusList: 可以按照当前企业的认证状态进行过滤。可值如下：
<ul><li>**"UNVERIFIED"**： 未认证的企业</li>
<li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
<li>**"VERIFYING"**： 认证进行中的企业</li>
<li>**"VERIFIED"**： 已认证完成的企业</li></ul>
:type AuthorizationStatusList: list of str
:param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。
:type Offset: int
"""
self._Agent = None
self._Limit = None
self._OrganizationOpenId = None
self._AuthorizationStatusList = None
self._Offset = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def Limit(self):
"""指定分页每页返回的数据条数，单页最大支持 200。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def OrganizationOpenId(self):
"""该字段是指第三方平台子客企业的唯一标识，用于查询单独某个子客的企业数据。
**注**：`如果需要批量查询本应用下的所有企业的信息，则该字段不需要赋值`
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def AuthorizationStatusList(self):
"""可以按照当前企业的认证状态进行过滤。可值如下：
<ul><li>**"UNVERIFIED"**： 未认证的企业</li>
<li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
<li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
<li>**"VERIFYING"**： 认证进行中的企业</li>
<li>**"VERIFIED"**： 已认证完成的企业</li></ul>
:rtype: list of str
"""
return self._AuthorizationStatusList
@AuthorizationStatusList.setter
def AuthorizationStatusList(self, AuthorizationStatusList):
self._AuthorizationStatusList = AuthorizationStatusList
@property
def Offset(self):
"""指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._Limit = params.get("Limit")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._AuthorizationStatusList = params.get("AuthorizationStatusList")
self._Offset = params.get("Offset")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeChannelOrganizationsResponse(AbstractModel):
"""DescribeChannelOrganizations返回参数结构体
"""
def __init__(self):
r"""
:param _ChannelOrganizationInfos: 满足查询条件的企业信息列表。
:type ChannelOrganizationInfos: list of ChannelOrganizationInfo
:param _Offset: 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
:type Offset: int
:param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
:type Limit: int
:param _Total: 满足查询条件的企业总数量。
:type Total: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ChannelOrganizationInfos = None
self._Offset = None
self._Limit = None
self._Total = None
self._RequestId = None
@property
def ChannelOrganizationInfos(self):
"""满足查询条件的企业信息列表。
:rtype: list of ChannelOrganizationInfo
"""
return self._ChannelOrganizationInfos
@ChannelOrganizationInfos.setter
def ChannelOrganizationInfos(self, ChannelOrganizationInfos):
self._ChannelOrganizationInfos = ChannelOrganizationInfos
@property
def Offset(self):
"""指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Limit(self):
"""指定分页每页返回的数据条数，单页最大支持 200。
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Total(self):
"""满足查询条件的企业总数量。
:rtype: int
"""
return self._Total
@Total.setter
def Total(self, Total):
self._Total = Total
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("ChannelOrganizationInfos") is not None:
self._ChannelOrganizationInfos = []
for item in params.get("ChannelOrganizationInfos"):
obj = ChannelOrganizationInfo()
obj._deserialize(item)
self._ChannelOrganizationInfos.append(obj)
self._Offset = params.get("Offset")
self._Limit = params.get("Limit")
self._Total = params.get("Total")
self._RequestId = params.get("RequestId")
class DescribeChannelSealPolicyWorkflowUrlRequest(AbstractModel):
"""DescribeChannelSealPolicyWorkflowUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _WorkflowInstanceId: 用印审批单的ID，可通过用印[申请回调](https://qian.tencent.com/developers/partner/callback_types_seals#%E4%B8%89-%E7%94%A8%E5%8D%B0%E7%94%B3%E8%AF%B7%E5%AE%A1%E6%89%B9%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5)获取。
:type WorkflowInstanceId: str
:param _Endpoint: 生成链接的类型：
生成链接的类型
<ul><li>**LongLink**：(默认)长链接，H5跳转到电子签小程序链接，链接有效期为1年</li>
<li>**ShortLink**：H5跳转到电子签小程序链接，一般用于发送短信中带的链接，打开后进入腾讯电子签小程序，链接有效期为7天</li>
<li>**App**：第三方APP或小程序跳转电子签小程序链接，一般用于贵方小程序或者APP跳转过来，打开后进入腾讯电子签小程序，链接有效期为1年</li></ul>
:type Endpoint: str
"""
self._Agent = None
self._WorkflowInstanceId = None
self._Endpoint = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
渠道应用标识: Agent.AppId
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def WorkflowInstanceId(self):
"""用印审批单的ID，可通过用印[申请回调](https://qian.tencent.com/developers/partner/callback_types_seals#%E4%B8%89-%E7%94%A8%E5%8D%B0%E7%94%B3%E8%AF%B7%E5%AE%A1%E6%89%B9%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5)获取。
:rtype: str
"""
return self._WorkflowInstanceId
@WorkflowInstanceId.setter
def WorkflowInstanceId(self, WorkflowInstanceId):
self._WorkflowInstanceId = WorkflowInstanceId
@property
def Endpoint(self):
"""生成链接的类型：
生成链接的类型
<ul><li>**LongLink**：(默认)长链接，H5跳转到电子签小程序链接，链接有效期为1年</li>
<li>**ShortLink**：H5跳转到电子签小程序链接，一般用于发送短信中带的链接，打开后进入腾讯电子签小程序，链接有效期为7天</li>
<li>**App**：第三方APP或小程序跳转电子签小程序链接，一般用于贵方小程序或者APP跳转过来，打开后进入腾讯电子签小程序，链接有效期为1年</li></ul>
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._WorkflowInstanceId = params.get("WorkflowInstanceId")
self._Endpoint = params.get("Endpoint")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeChannelSealPolicyWorkflowUrlResponse(AbstractModel):
"""DescribeChannelSealPolicyWorkflowUrl返回参数结构体
"""
def __init__(self):
r"""
:param _WorkflowUrl: 用印审批小程序链接，链接类型（通过H5唤起小程序或通过APP跳转方式查看）。
:type WorkflowUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._WorkflowUrl = None
self._RequestId = None
@property
def WorkflowUrl(self):
"""用印审批小程序链接，链接类型（通过H5唤起小程序或通过APP跳转方式查看）。
:rtype: str
"""
return self._WorkflowUrl
@WorkflowUrl.setter
def WorkflowUrl(self, WorkflowUrl):
self._WorkflowUrl = WorkflowUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._WorkflowUrl = params.get("WorkflowUrl")
self._RequestId = params.get("RequestId")
class DescribeExtendedServiceAuthDetailRequest(AbstractModel):
"""DescribeExtendedServiceAuthDetail请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ExtendServiceType: 要查询的扩展服务类型。
如下所示：
<ul><li> AUTO_SIGN：企业静默签署</li>
<li>BATCH_SIGN：批量签署</li>
</ul>
:type ExtendServiceType: str
:param _Limit: 指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`
:type Limit: int
:param _Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`
:type Offset: int
"""
self._Agent = None
self._ExtendServiceType = None
self._Limit = None
self._Offset = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ExtendServiceType(self):
"""要查询的扩展服务类型。
如下所示：
<ul><li> AUTO_SIGN：企业静默签署</li>
<li>BATCH_SIGN：批量签署</li>
</ul>
:rtype: str
"""
return self._ExtendServiceType
@ExtendServiceType.setter
def ExtendServiceType(self, ExtendServiceType):
self._ExtendServiceType = ExtendServiceType
@property
def Limit(self):
"""指定每页返回的数据条数，和Offset参数配合使用。 注：`1.默认值为20，单页做大值为200。`
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Offset(self):
"""查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：`1.offset从0开始，即第一页为0。` `2.默认从第一页返回。`
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ExtendServiceType = params.get("ExtendServiceType")
self._Limit = params.get("Limit")
self._Offset = params.get("Offset")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeExtendedServiceAuthDetailResponse(AbstractModel):
"""DescribeExtendedServiceAuthDetail返回参数结构体
"""
def __init__(self):
r"""
:param _AuthInfoDetail: 服务授权的信息列表，根据查询类型返回特定扩展服务的开通和授权状况。
:type AuthInfoDetail: :class:`tencentcloud.essbasic.v20210526.models.AuthInfoDetail`
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._AuthInfoDetail = None
self._RequestId = None
@property
def AuthInfoDetail(self):
"""服务授权的信息列表，根据查询类型返回特定扩展服务的开通和授权状况。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.AuthInfoDetail`
"""
return self._AuthInfoDetail
@AuthInfoDetail.setter
def AuthInfoDetail(self, AuthInfoDetail):
self._AuthInfoDetail = AuthInfoDetail
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("AuthInfoDetail") is not None:
self._AuthInfoDetail = AuthInfoDetail()
self._AuthInfoDetail._deserialize(params.get("AuthInfoDetail"))
self._RequestId = params.get("RequestId")
class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
"""DescribeExtendedServiceAuthInfo请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
self._Agent = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeExtendedServiceAuthInfoResponse(AbstractModel):
"""DescribeExtendedServiceAuthInfo返回参数结构体
"""
def __init__(self):
r"""
:param _AuthInfo: 服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
:type AuthInfo: list of ExtentServiceAuthInfo
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._AuthInfo = None
self._RequestId = None
@property
def AuthInfo(self):
"""服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
:rtype: list of ExtentServiceAuthInfo
"""
return self._AuthInfo
@AuthInfo.setter
def AuthInfo(self, AuthInfo):
self._AuthInfo = AuthInfo
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("AuthInfo") is not None:
self._AuthInfo = []
for item in params.get("AuthInfo"):
obj = ExtentServiceAuthInfo()
obj._deserialize(item)
self._AuthInfo.append(obj)
self._RequestId = params.get("RequestId")
class DescribeFlowDetailInfoRequest(AbstractModel):
"""DescribeFlowDetailInfo请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 需要查询的流程ID列表，最多可传入100个ID。
如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
:type FlowIds: list of str
:param _FlowGroupId: 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。
合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
:type FlowGroupId: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowIds = None
self._FlowGroupId = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""需要查询的流程ID列表，最多可传入100个ID。
如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def FlowGroupId(self):
"""需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。
合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
self._FlowGroupId = params.get("FlowGroupId")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeFlowDetailInfoResponse(AbstractModel):
"""DescribeFlowDetailInfo返回参数结构体
"""
def __init__(self):
r"""
:param _ApplicationId: 合同归属的第三方平台应用号ID
:type ApplicationId: str
:param _ProxyOrganizationOpenId: 合同归属的第三方平台子客企业OpenId
:type ProxyOrganizationOpenId: str
:param _FlowInfo: 合同流程的详细信息。
如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
:type FlowInfo: list of FlowDetailInfo
:param _FlowGroupId: 合同组ID，只有在查询合同组信息时才会返回。
:type FlowGroupId: str
:param _FlowGroupName: 合同组名称，只有在查询合同组信息时才会返回。
:type FlowGroupName: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ApplicationId = None
self._ProxyOrganizationOpenId = None
self._FlowInfo = None
self._FlowGroupId = None
self._FlowGroupName = None
self._RequestId = None
@property
def ApplicationId(self):
"""合同归属的第三方平台应用号ID
:rtype: str
"""
return self._ApplicationId
@ApplicationId.setter
def ApplicationId(self, ApplicationId):
self._ApplicationId = ApplicationId
@property
def ProxyOrganizationOpenId(self):
"""合同归属的第三方平台子客企业OpenId
:rtype: str
"""
return self._ProxyOrganizationOpenId
@ProxyOrganizationOpenId.setter
def ProxyOrganizationOpenId(self, ProxyOrganizationOpenId):
self._ProxyOrganizationOpenId = ProxyOrganizationOpenId
@property
def FlowInfo(self):
"""合同流程的详细信息。
如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
:rtype: list of FlowDetailInfo
"""
return self._FlowInfo
@FlowInfo.setter
def FlowInfo(self, FlowInfo):
self._FlowInfo = FlowInfo
@property
def FlowGroupId(self):
"""合同组ID，只有在查询合同组信息时才会返回。
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def FlowGroupName(self):
"""合同组名称，只有在查询合同组信息时才会返回。
:rtype: str
"""
return self._FlowGroupName
@FlowGroupName.setter
def FlowGroupName(self, FlowGroupName):
self._FlowGroupName = FlowGroupName
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._ApplicationId = params.get("ApplicationId")
self._ProxyOrganizationOpenId = params.get("ProxyOrganizationOpenId")
if params.get("FlowInfo") is not None:
self._FlowInfo = []
for item in params.get("FlowInfo"):
obj = FlowDetailInfo()
obj._deserialize(item)
self._FlowInfo.append(obj)
self._FlowGroupId = params.get("FlowGroupId")
self._FlowGroupName = params.get("FlowGroupName")
self._RequestId = params.get("RequestId")
class DescribeResourceUrlsByFlowsRequest(AbstractModel):
"""DescribeResourceUrlsByFlows请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowIds: 需要下载的合同流程的ID, 至少需要1个, 做多50个
:type FlowIds: list of str
:param _Operator: 操作者的信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowIds = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowIds(self):
"""需要下载的合同流程的ID, 至少需要1个, 做多50个
:rtype: list of str
"""
return self._FlowIds
@FlowIds.setter
def FlowIds(self, FlowIds):
self._FlowIds = FlowIds
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowIds = params.get("FlowIds")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeResourceUrlsByFlowsResponse(AbstractModel):
"""DescribeResourceUrlsByFlows返回参数结构体
"""
def __init__(self):
r"""
:param _FlowResourceUrlInfos: 合同流程PDF下载链接
:type FlowResourceUrlInfos: list of FlowResourceUrlInfo
:param _ErrorMessages: 如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空
如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因
:type ErrorMessages: list of str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._FlowResourceUrlInfos = None
self._ErrorMessages = None
self._RequestId = None
@property
def FlowResourceUrlInfos(self):
"""合同流程PDF下载链接
:rtype: list of FlowResourceUrlInfo
"""
return self._FlowResourceUrlInfos
@FlowResourceUrlInfos.setter
def FlowResourceUrlInfos(self, FlowResourceUrlInfos):
self._FlowResourceUrlInfos = FlowResourceUrlInfos
@property
def ErrorMessages(self):
"""如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空
如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因
:rtype: list of str
"""
return self._ErrorMessages
@ErrorMessages.setter
def ErrorMessages(self, ErrorMessages):
self._ErrorMessages = ErrorMessages
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("FlowResourceUrlInfos") is not None:
self._FlowResourceUrlInfos = []
for item in params.get("FlowResourceUrlInfos"):
obj = FlowResourceUrlInfo()
obj._deserialize(item)
self._FlowResourceUrlInfos.append(obj)
self._ErrorMessages = params.get("ErrorMessages")
self._RequestId = params.get("RequestId")
class DescribeTemplatesRequest(AbstractModel):
"""DescribeTemplates请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _TemplateId: 合同模板ID，为32位字符串。
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
:type TemplateId: str
:param _ContentType: 查询模板的内容
<ul><li>**0**：（默认）模板列表及详情</li>
<li>**1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
:type ContentType: int
:param _TemplateIds: 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。
注意:
1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。`
2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。`
4. `若传递此参数，分页参数(Limit,Offset)无效`
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
:type TemplateIds: list of str
:param _Limit: 指定每页返回的数据条数，和Offset参数配合使用。
注：`1.默认值为20，单页做大值为100。`
:type Limit: int
:param _Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`1.offset从0开始，即第一页为0。`
`2.默认从第一页返回。`
:type Offset: int
:param _TemplateName: 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
:type TemplateName: str
:param _ChannelTemplateId: 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
:type ChannelTemplateId: str
:param _QueryAllComponents: 返回控件的范围, 是只返回发起方自己的还是所有参与方的
<ul><li>**false**：（默认）只返回发起方控件</li>
<li>**true**：返回所有参与方(包括发起方和签署方)控件</li></ul>
:type QueryAllComponents: bool
:param _WithPreviewUrl: 是否获取模板预览链接。
<ul><li>**false**：不获取（默认）</li>
<li>**true**：获取</li></ul>
设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
:type WithPreviewUrl: bool
:param _WithPdfUrl: 是否获取模板的PDF文件链接。
<ul><li>**false**：不获取（默认）</li>
<li>**true**：获取</li></ul>
设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地
注: `此功能需要开通功能白名单【第三方应用集成企业获取模版PDF下载链接】，使用前请联系对接的客户经理沟通。`
:type WithPdfUrl: bool
:param _Operator: 操作者的信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._TemplateId = None
self._ContentType = None
self._TemplateIds = None
self._Limit = None
self._Offset = None
self._TemplateName = None
self._ChannelTemplateId = None
self._QueryAllComponents = None
self._WithPreviewUrl = None
self._WithPdfUrl = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def TemplateId(self):
"""合同模板ID，为32位字符串。
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
:rtype: str
"""
return self._TemplateId
@TemplateId.setter
def TemplateId(self, TemplateId):
self._TemplateId = TemplateId
@property
def ContentType(self):
"""查询模板的内容
<ul><li>**0**：（默认）模板列表及详情</li>
<li>**1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
:rtype: int
"""
return self._ContentType
@ContentType.setter
def ContentType(self, ContentType):
self._ContentType = ContentType
@property
def TemplateIds(self):
"""合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持100个模板的批量查询。
注意:
1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。`
2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。`
4. `若传递此参数，分页参数(Limit,Offset)无效`
[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
:rtype: list of str
"""
return self._TemplateIds
@TemplateIds.setter
def TemplateIds(self, TemplateIds):
self._TemplateIds = TemplateIds
@property
def Limit(self):
"""指定每页返回的数据条数，和Offset参数配合使用。
注：`1.默认值为20，单页做大值为100。`
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Offset(self):
"""查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`1.offset从0开始，即第一页为0。`
`2.默认从第一页返回。`
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def TemplateName(self):
"""模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
:rtype: str
"""
return self._TemplateName
@TemplateName.setter
def TemplateName(self, TemplateName):
self._TemplateName = TemplateName
@property
def ChannelTemplateId(self):
"""对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
:rtype: str
"""
return self._ChannelTemplateId
@ChannelTemplateId.setter
def ChannelTemplateId(self, ChannelTemplateId):
self._ChannelTemplateId = ChannelTemplateId
@property
def QueryAllComponents(self):
"""返回控件的范围, 是只返回发起方自己的还是所有参与方的
<ul><li>**false**：（默认）只返回发起方控件</li>
<li>**true**：返回所有参与方(包括发起方和签署方)控件</li></ul>
:rtype: bool
"""
return self._QueryAllComponents
@QueryAllComponents.setter
def QueryAllComponents(self, QueryAllComponents):
self._QueryAllComponents = QueryAllComponents
@property
def WithPreviewUrl(self):
"""是否获取模板预览链接。
<ul><li>**false**：不获取（默认）</li>
<li>**true**：获取</li></ul>
设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
:rtype: bool
"""
return self._WithPreviewUrl
@WithPreviewUrl.setter
def WithPreviewUrl(self, WithPreviewUrl):
self._WithPreviewUrl = WithPreviewUrl
@property
def WithPdfUrl(self):
"""是否获取模板的PDF文件链接。
<ul><li>**false**：不获取（默认）</li>
<li>**true**：获取</li></ul>
设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地
注: `此功能需要开通功能白名单【第三方应用集成企业获取模版PDF下载链接】，使用前请联系对接的客户经理沟通。`
:rtype: bool
"""
return self._WithPdfUrl
@WithPdfUrl.setter
def WithPdfUrl(self, WithPdfUrl):
self._WithPdfUrl = WithPdfUrl
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._TemplateId = params.get("TemplateId")
self._ContentType = params.get("ContentType")
self._TemplateIds = params.get("TemplateIds")
self._Limit = params.get("Limit")
self._Offset = params.get("Offset")
self._TemplateName = params.get("TemplateName")
self._ChannelTemplateId = params.get("ChannelTemplateId")
self._QueryAllComponents = params.get("QueryAllComponents")
self._WithPreviewUrl = params.get("WithPreviewUrl")
self._WithPdfUrl = params.get("WithPdfUrl")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeTemplatesResponse(AbstractModel):
"""DescribeTemplates返回参数结构体
"""
def __init__(self):
r"""
:param _Templates: 模板详情列表数据
:type Templates: list of TemplateInfo
:param _TotalCount: 查询到的模板总数
:type TotalCount: int
:param _Limit: 每页返回的数据条数
:type Limit: int
:param _Offset: 查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
:type Offset: int
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Templates = None
self._TotalCount = None
self._Limit = None
self._Offset = None
self._RequestId = None
@property
def Templates(self):
"""模板详情列表数据
:rtype: list of TemplateInfo
"""
return self._Templates
@Templates.setter
def Templates(self, Templates):
self._Templates = Templates
@property
def TotalCount(self):
"""查询到的模板总数
:rtype: int
"""
return self._TotalCount
@TotalCount.setter
def TotalCount(self, TotalCount):
self._TotalCount = TotalCount
@property
def Limit(self):
"""每页返回的数据条数
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Offset(self):
"""查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
if params.get("Templates") is not None:
self._Templates = []
for item in params.get("Templates"):
obj = TemplateInfo()
obj._deserialize(item)
self._Templates.append(obj)
self._TotalCount = params.get("TotalCount")
self._Limit = params.get("Limit")
self._Offset = params.get("Offset")
self._RequestId = params.get("RequestId")
class DescribeUsageRequest(AbstractModel):
"""DescribeUsage请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _StartDate: 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
:type StartDate: str
:param _EndDate: 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
:type EndDate: str
:param _NeedAggregate: 是否汇总数据，默认不汇总。
<ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
<li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
:type NeedAggregate: bool
:param _Limit: 指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
:type Limit: int
:param _Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
:type Offset: int
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._StartDate = None
self._EndDate = None
self._NeedAggregate = None
self._Limit = None
self._Offset = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def StartDate(self):
"""查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21)
注: `查询日期范围区间长度大于90天`。
:rtype: str
"""
return self._StartDate
@StartDate.setter
def StartDate(self, StartDate):
self._StartDate = StartDate
@property
def EndDate(self):
"""查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21)
注: `查询日期范围区间长度大于90天`。
:rtype: str
"""
return self._EndDate
@EndDate.setter
def EndDate(self, EndDate):
self._EndDate = EndDate
@property
def NeedAggregate(self):
"""是否汇总数据，默认不汇总。
<ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
<li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
:rtype: bool
"""
return self._NeedAggregate
@NeedAggregate.setter
def NeedAggregate(self, NeedAggregate):
self._NeedAggregate = NeedAggregate
@property
def Limit(self):
"""指定每页返回的数据条数，和Offset参数配合使用。
注: `默认值为1000，单页做大值为1000`
:rtype: int
"""
return self._Limit
@Limit.setter
def Limit(self, Limit):
self._Limit = Limit
@property
def Offset(self):
"""查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
注：`offset从0开始，即第一页为0。`
:rtype: int
"""
return self._Offset
@Offset.setter
def Offset(self, Offset):
self._Offset = Offset
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._StartDate = params.get("StartDate")
self._EndDate = params.get("EndDate")
self._NeedAggregate = params.get("NeedAggregate")
self._Limit = params.get("Limit")
self._Offset = params.get("Offset")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DescribeUsageResponse(AbstractModel):
"""DescribeUsage返回参数结构体
"""
def __init__(self):
r"""
:param _Total: 用量明细条数
:type Total: int
:param _Details: 用量明细
:type Details: list of UsageDetail
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Total = None
self._Details = None
self._RequestId = None
@property
def Total(self):
"""用量明细条数
:rtype: int
"""
return self._Total
@Total.setter
def Total(self, Total):
self._Total = Total
@property
def Details(self):
"""用量明细
:rtype: list of UsageDetail
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Total = params.get("Total")
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = UsageDetail()
obj._deserialize(item)
self._Details.append(obj)
self._RequestId = params.get("RequestId")
class DetectInfoVideoData(AbstractModel):
"""视频认证结果
"""
def __init__(self):
r"""
:param _LiveNessVideo: 活体视频的base64编码，mp4格式
注:`需进行base64解码获取活体视频文件`
:type LiveNessVideo: str
"""
self._LiveNessVideo = None
@property
def LiveNessVideo(self):
"""活体视频的base64编码，mp4格式
注:`需进行base64解码获取活体视频文件`
:rtype: str
"""
return self._LiveNessVideo
@LiveNessVideo.setter
def LiveNessVideo(self, LiveNessVideo):
self._LiveNessVideo = LiveNessVideo
def _deserialize(self, params):
self._LiveNessVideo = params.get("LiveNessVideo")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DownloadFlowInfo(AbstractModel):
"""签署流程下载信息
"""
def __init__(self):
r"""
:param _FileName: 文件夹名称
:type FileName: str
:param _FlowIdList: 签署流程的标识数组
:type FlowIdList: list of str
"""
self._FileName = None
self._FlowIdList = None
@property
def FileName(self):
"""文件夹名称
:rtype: str
"""
return self._FileName
@FileName.setter
def FileName(self, FileName):
self._FileName = FileName
@property
def FlowIdList(self):
"""签署流程的标识数组
:rtype: list of str
"""
return self._FlowIdList
@FlowIdList.setter
def FlowIdList(self, FlowIdList):
self._FlowIdList = FlowIdList
def _deserialize(self, params):
self._FileName = params.get("FileName")
self._FlowIdList = params.get("FlowIdList")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DynamicFlowApproverResult(AbstractModel):
"""动态合同签署人结果
"""
def __init__(self):
r"""
:param _RecipientId: 签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；
:type RecipientId: str
:param _SignId: 签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
:type SignId: str
:param _ApproverStatus: 签署人状态信息
:type ApproverStatus: int
"""
self._RecipientId = None
self._SignId = None
self._ApproverStatus = None
@property
def RecipientId(self):
"""签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def SignId(self):
"""签署ID - 发起流程时系统自动补充 - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def ApproverStatus(self):
"""签署人状态信息
:rtype: int
"""
return self._ApproverStatus
@ApproverStatus.setter
def ApproverStatus(self, ApproverStatus):
self._ApproverStatus = ApproverStatus
def _deserialize(self, params):
self._RecipientId = params.get("RecipientId")
self._SignId = params.get("SignId")
self._ApproverStatus = params.get("ApproverStatus")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DynamicFlowInfo(AbstractModel):
"""动态合同信息
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。 - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 - 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
:type FlowId: str
:param _FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
:type FlowApprovers: list of FlowApproverInfo
:param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
:type AutoSignScene: str
:param _ApproverVerifyType: 签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
:type ApproverVerifyType: str
"""
self._FlowId = None
self._FlowApprovers = None
self._AutoSignScene = None
self._ApproverVerifyType = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。 - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 - 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def FlowApprovers(self):
"""合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
:rtype: list of FlowApproverInfo
"""
return self._FlowApprovers
@FlowApprovers.setter
def FlowApprovers(self, FlowApprovers):
self._FlowApprovers = FlowApprovers
@property
def AutoSignScene(self):
"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
:rtype: str
"""
return self._AutoSignScene
@AutoSignScene.setter
def AutoSignScene(self, AutoSignScene):
self._AutoSignScene = AutoSignScene
@property
def ApproverVerifyType(self):
"""签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
:rtype: str
"""
return self._ApproverVerifyType
@ApproverVerifyType.setter
def ApproverVerifyType(self, ApproverVerifyType):
self._ApproverVerifyType = ApproverVerifyType
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("FlowApprovers") is not None:
self._FlowApprovers = []
for item in params.get("FlowApprovers"):
obj = FlowApproverInfo()
obj._deserialize(item)
self._FlowApprovers.append(obj)
self._AutoSignScene = params.get("AutoSignScene")
self._ApproverVerifyType = params.get("ApproverVerifyType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class DynamicFlowResult(AbstractModel):
"""动态合同补充签署人结果
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:type FlowId: str
:param _DynamicFlowApproverList: 动态合同签署人补充结果信息列表
:type DynamicFlowApproverList: list of DynamicFlowApproverResult
"""
self._FlowId = None
self._DynamicFlowApproverList = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def DynamicFlowApproverList(self):
"""动态合同签署人补充结果信息列表
:rtype: list of DynamicFlowApproverResult
"""
return self._DynamicFlowApproverList
@DynamicFlowApproverList.setter
def DynamicFlowApproverList(self, DynamicFlowApproverList):
self._DynamicFlowApproverList = DynamicFlowApproverList
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("DynamicFlowApproverList") is not None:
self._DynamicFlowApproverList = []
for item in params.get("DynamicFlowApproverList"):
obj = DynamicFlowApproverResult()
obj._deserialize(item)
self._DynamicFlowApproverList.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class EmbedUrlOption(AbstractModel):
"""创建嵌入式页面url个性化参数
"""
def __init__(self):
r"""
:param _ShowFlowDetailComponent: 合同详情预览，允许展示控件信息
<ul>
<li><b>true</b>：允许在合同详情页展示控件</li>
<li><b>false</b>：（默认）不允许在合同详情页展示控件</li>
</ul>
:type ShowFlowDetailComponent: bool
:param _ShowTemplateComponent: 模板预览，允许展示模板控件信息
<ul><li> <b>true</b> :允许在模板预览页展示控件</li>
<li> <b>false</b> :（默认）不允许在模板预览页展示控件</li></ul>
:type ShowTemplateComponent: bool
:param _SkipUploadFile: 跳过上传文件，默认为false(展示上传文件页）
- false: 展示上传文件页
- true: 不展示上传文件页
注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，
:type SkipUploadFile: str
"""
self._ShowFlowDetailComponent = None
self._ShowTemplateComponent = None
self._SkipUploadFile = None
@property
def ShowFlowDetailComponent(self):
"""合同详情预览，允许展示控件信息
<ul>
<li><b>true</b>：允许在合同详情页展示控件</li>
<li><b>false</b>：（默认）不允许在合同详情页展示控件</li>
</ul>
:rtype: bool
"""
return self._ShowFlowDetailComponent
@ShowFlowDetailComponent.setter
def ShowFlowDetailComponent(self, ShowFlowDetailComponent):
self._ShowFlowDetailComponent = ShowFlowDetailComponent
@property
def ShowTemplateComponent(self):
"""模板预览，允许展示模板控件信息
<ul><li> <b>true</b> :允许在模板预览页展示控件</li>
<li> <b>false</b> :（默认）不允许在模板预览页展示控件</li></ul>
:rtype: bool
"""
return self._ShowTemplateComponent
@ShowTemplateComponent.setter
def ShowTemplateComponent(self, ShowTemplateComponent):
self._ShowTemplateComponent = ShowTemplateComponent
@property
def SkipUploadFile(self):
"""跳过上传文件，默认为false(展示上传文件页）
- false: 展示上传文件页
- true: 不展示上传文件页
注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，
:rtype: str
"""
return self._SkipUploadFile
@SkipUploadFile.setter
def SkipUploadFile(self, SkipUploadFile):
self._SkipUploadFile = SkipUploadFile
def _deserialize(self, params):
self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
self._ShowTemplateComponent = params.get("ShowTemplateComponent")
self._SkipUploadFile = params.get("SkipUploadFile")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ExtentServiceAuthInfo(AbstractModel):
"""扩展服务开通和授权的详细信息
"""
def __init__(self):
r"""
:param _Type: 扩展服务类型
<ul>
<li>AUTO_SIGN 企业自动签（自动签署）</li>
<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
</ul>
:type Type: str
:param _Name: 扩展服务名称
:type Name: str
:param _Status: 扩展服务的开通状态
**ENABLE**：开通
**DISABLE**：未开通
:type Status: str
:param _OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
:type OperatorOpenId: str
:param _OperateOn: 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
:type OperateOn: int
"""
self._Type = None
self._Name = None
self._Status = None
self._OperatorOpenId = None
self._OperateOn = None
@property
def Type(self):
"""扩展服务类型
<ul>
<li>AUTO_SIGN 企业自动签（自动签署）</li>
<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
</ul>
:rtype: str
"""
return self._Type
@Type.setter
def Type(self, Type):
self._Type = Type
@property
def Name(self):
"""扩展服务名称
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Status(self):
"""扩展服务的开通状态
**ENABLE**：开通
**DISABLE**：未开通
:rtype: str
"""
return self._Status
@Status.setter
def Status(self, Status):
self._Status = Status
@property
def OperatorOpenId(self):
"""操作扩展服务的操作人第三方应用平台的用户openid
:rtype: str
"""
return self._OperatorOpenId
@OperatorOpenId.setter
def OperatorOpenId(self, OperatorOpenId):
self._OperatorOpenId = OperatorOpenId
@property
def OperateOn(self):
"""扩展服务的操作时间，格式为Unix标准时间戳（秒）。
:rtype: int
"""
return self._OperateOn
@OperateOn.setter
def OperateOn(self, OperateOn):
self._OperateOn = OperateOn
def _deserialize(self, params):
self._Type = params.get("Type")
self._Name = params.get("Name")
self._Status = params.get("Status")
self._OperatorOpenId = params.get("OperatorOpenId")
self._OperateOn = params.get("OperateOn")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FailedCreateRoleData(AbstractModel):
"""绑定失败的用户角色信息
"""
def __init__(self):
r"""
:param _UserId: 用户userId
:type UserId: str
:param _RoleIds: 角色RoleId列表
:type RoleIds: list of str
"""
self._UserId = None
self._RoleIds = None
@property
def UserId(self):
"""用户userId
:rtype: str
"""
return self._UserId
@UserId.setter
def UserId(self, UserId):
self._UserId = UserId
@property
def RoleIds(self):
"""角色RoleId列表
:rtype: list of str
"""
return self._RoleIds
@RoleIds.setter
def RoleIds(self, RoleIds):
self._RoleIds = RoleIds
def _deserialize(self, params):
self._UserId = params.get("UserId")
self._RoleIds = params.get("RoleIds")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FillApproverInfo(AbstractModel):
"""指定补充签署人信息
- RecipientId 必须指定
- 补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充
"""
def __init__(self):
r"""
:param _RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
:type RecipientId: str
:param _OpenId: 指定企业经办签署人OpenId
:type OpenId: str
:param _ApproverName: 签署人姓名
:type ApproverName: str
:param _ApproverMobile: 签署人手机号码
:type ApproverMobile: str
:param _OrganizationName: 企业名称
:type OrganizationName: str
:param _OrganizationOpenId: 企业OpenId
:type OrganizationOpenId: str
:param _NotChannelOrganization: 签署企业非渠道子客，默认为false，即表示同一渠道下的企业；如果为true，则目前表示接收方企业为SaaS企业, 为渠道子客时，OrganizationOpenId 必传
:type NotChannelOrganization: bool
:param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD 中国大陆居民身份证</li>
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE 其他证件</li></ul>
注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
`2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
:type ApproverIdCardType: str
:param _ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
:type ApproverIdCardNumber: str
:param _FlowId: 合同流程ID
- 补充合同组子合同动态签署人时必传。
- 补充正常合同，请阅读：<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口</a>接口使用说明
:type FlowId: str
"""
self._RecipientId = None
self._OpenId = None
self._ApproverName = None
self._ApproverMobile = None
self._OrganizationName = None
self._OrganizationOpenId = None
self._NotChannelOrganization = None
self._ApproverIdCardType = None
self._ApproverIdCardNumber = None
self._FlowId = None
@property
def RecipientId(self):
"""签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def OpenId(self):
"""指定企业经办签署人OpenId
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def ApproverName(self):
"""签署人姓名
:rtype: str
"""
return self._ApproverName
@ApproverName.setter
def ApproverName(self, ApproverName):
self._ApproverName = ApproverName
@property
def ApproverMobile(self):
"""签署人手机号码
:rtype: str
"""
return self._ApproverMobile
@ApproverMobile.setter
def ApproverMobile(self, ApproverMobile):
self._ApproverMobile = ApproverMobile
@property
def OrganizationName(self):
"""企业名称
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def OrganizationOpenId(self):
"""企业OpenId
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def NotChannelOrganization(self):
"""签署企业非渠道子客，默认为false，即表示同一渠道下的企业；如果为true，则目前表示接收方企业为SaaS企业, 为渠道子客时，OrganizationOpenId 必传
:rtype: bool
"""
return self._NotChannelOrganization
@NotChannelOrganization.setter
def NotChannelOrganization(self, NotChannelOrganization):
self._NotChannelOrganization = NotChannelOrganization
@property
def ApproverIdCardType(self):
"""签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD 中国大陆居民身份证</li>
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE 其他证件</li></ul>
注: `1.其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
`2.补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
:rtype: str
"""
return self._ApproverIdCardType
@ApproverIdCardType.setter
def ApproverIdCardType(self, ApproverIdCardType):
self._ApproverIdCardType = ApproverIdCardType
@property
def ApproverIdCardNumber(self):
"""签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
:rtype: str
"""
return self._ApproverIdCardNumber
@ApproverIdCardNumber.setter
def ApproverIdCardNumber(self, ApproverIdCardNumber):
self._ApproverIdCardNumber = ApproverIdCardNumber
@property
def FlowId(self):
"""合同流程ID
- 补充合同组子合同动态签署人时必传。
- 补充正常合同，请阅读：<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口</a>接口使用说明
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
def _deserialize(self, params):
self._RecipientId = params.get("RecipientId")
self._OpenId = params.get("OpenId")
self._ApproverName = params.get("ApproverName")
self._ApproverMobile = params.get("ApproverMobile")
self._OrganizationName = params.get("OrganizationName")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._NotChannelOrganization = params.get("NotChannelOrganization")
self._ApproverIdCardType = params.get("ApproverIdCardType")
self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
self._FlowId = params.get("FlowId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FillError(AbstractModel):
"""批量补充签署人时，补充失败的报错说明
"""
def __init__(self):
r"""
:param _RecipientId: 为签署方经办人在签署合同中的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。与入参中补充的签署人角色ID对应，批量补充部分失败返回对应的错误信息。
:type RecipientId: str
:param _ErrMessage: 补充失败错误说明
:type ErrMessage: str
:param _FlowId: 合同流程ID，为32位字符串。
:type FlowId: str
"""
self._RecipientId = None
self._ErrMessage = None
self._FlowId = None
@property
def RecipientId(self):
"""为签署方经办人在签署合同中的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。与入参中补充的签署人角色ID对应，批量补充部分失败返回对应的错误信息。
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def ErrMessage(self):
"""补充失败错误说明
:rtype: str
"""
return self._ErrMessage
@ErrMessage.setter
def ErrMessage(self, ErrMessage):
self._ErrMessage = ErrMessage
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
def _deserialize(self, params):
self._RecipientId = params.get("RecipientId")
self._ErrMessage = params.get("ErrMessage")
self._FlowId = params.get("FlowId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FilledComponent(AbstractModel):
"""文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
"""
def __init__(self):
r"""
:param _ComponentId: 填写控件ID
:type ComponentId: str
:param _ComponentName: 控件名称
:type ComponentName: str
:param _ComponentFillStatus: 此填写控件的填写状态
**0** : 此填写控件**未填写**
**1** : 此填写控件**已填写**
:type ComponentFillStatus: str
:param _ComponentValue: 控件填写内容
:type ComponentValue: str
:param _ImageUrl: 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
:type ImageUrl: str
"""
self._ComponentId = None
self._ComponentName = None
self._ComponentFillStatus = None
self._ComponentValue = None
self._ImageUrl = None
@property
def ComponentId(self):
"""填写控件ID
:rtype: str
"""
return self._ComponentId
@ComponentId.setter
def ComponentId(self, ComponentId):
self._ComponentId = ComponentId
@property
def ComponentName(self):
"""控件名称
:rtype: str
"""
return self._ComponentName
@ComponentName.setter
def ComponentName(self, ComponentName):
self._ComponentName = ComponentName
@property
def ComponentFillStatus(self):
"""此填写控件的填写状态
**0** : 此填写控件**未填写**
**1** : 此填写控件**已填写**
:rtype: str
"""
return self._ComponentFillStatus
@ComponentFillStatus.setter
def ComponentFillStatus(self, ComponentFillStatus):
self._ComponentFillStatus = ComponentFillStatus
@property
def ComponentValue(self):
"""控件填写内容
:rtype: str
"""
return self._ComponentValue
@ComponentValue.setter
def ComponentValue(self, ComponentValue):
self._ComponentValue = ComponentValue
@property
def ImageUrl(self):
"""图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
:rtype: str
"""
return self._ImageUrl
@ImageUrl.setter
def ImageUrl(self, ImageUrl):
self._ImageUrl = ImageUrl
def _deserialize(self, params):
self._ComponentId = params.get("ComponentId")
self._ComponentName = params.get("ComponentName")
self._ComponentFillStatus = params.get("ComponentFillStatus")
self._ComponentValue = params.get("ComponentValue")
self._ImageUrl = params.get("ImageUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Filter(AbstractModel):
"""此结构体 (Filter) 用于描述查询过滤条件。
"""
def __init__(self):
r"""
:param _Key: 查询过滤条件的Key
:type Key: str
:param _Values: 查询过滤条件的Value列表
:type Values: list of str
"""
self._Key = None
self._Values = None
@property
def Key(self):
"""查询过滤条件的Key
:rtype: str
"""
return self._Key
@Key.setter
def Key(self, Key):
self._Key = Key
@property
def Values(self):
"""查询过滤条件的Value列表
:rtype: list of str
"""
return self._Values
@Values.setter
def Values(self, Values):
self._Values = Values
def _deserialize(self, params):
self._Key = params.get("Key")
self._Values = params.get("Values")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowApproverDetail(AbstractModel):
"""签署人的流程信息明细
"""
def __init__(self):
r"""
:param _ReceiptId: 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
:type ReceiptId: str
:param _ProxyOrganizationOpenId: 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
:type ProxyOrganizationOpenId: str
:param _ProxyOperatorOpenId: 第三方平台子客企业员工的唯一标识
:type ProxyOperatorOpenId: str
:param _ProxyOrganizationName: 第三方平台子客企业名称，与企业营业执照中注册的名称一致。
:type ProxyOrganizationName: str
:param _Mobile: 签署人手机号
:type Mobile: str
:param _SignOrder: 签署顺序，如果是有序签署，签署顺序从小到大
:type SignOrder: int
:param _ApproveName: 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:type ApproveName: str
:param _ApproveStatus: 当前签署人的状态, 状态如下
<ul><li> **PENDING** :待签署</li>
<li> **FILLPENDING** :待填写</li>
<li> **FILLACCEPT** :填写完成</li>
<li> **FILLREJECT** :拒绝填写</li>
<li> **WAITPICKUP** :待领取</li>
<li> **ACCEPT** :已签署</li>
<li> **REJECT** :拒签</li>
<li> **DEADLINE** :过期没人处理</li>
<li> **CANCEL** :流程已撤回</li>
<li> **FORWARD** :已经转他人处理</li>
<li> **STOP** :流程已终止</li>
<li> **RELIEVED** :解除协议（已解除）</li></ul>
:type ApproveStatus: str
:param _ApproveMessage: 签署人拒签等情况的时候填写的原因
:type ApproveMessage: str
:param _ApproveTime: 签署人签署时间戳，单位秒
:type ApproveTime: int
:param _ApproveType: 参与者类型
<ul><li> **ORGANIZATION** :企业签署人</li>
<li> **PERSON** :个人签署人</li></ul>
:type ApproveType: str
:param _ApproverRoleName: 自定义签署人的角色名, 如: 收款人、开具人、见证人等
:type ApproverRoleName: str
:param _SignId: 签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点。
:type SignId: str
:param _RecipientId: 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
:type RecipientId: str
"""
self._ReceiptId = None
self._ProxyOrganizationOpenId = None
self._ProxyOperatorOpenId = None
self._ProxyOrganizationName = None
self._Mobile = None
self._SignOrder = None
self._ApproveName = None
self._ApproveStatus = None
self._ApproveMessage = None
self._ApproveTime = None
self._ApproveType = None
self._ApproverRoleName = None
self._SignId = None
self._RecipientId = None
@property
def ReceiptId(self):
warnings.warn("parameter `ReceiptId` is deprecated", DeprecationWarning)
"""模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
:rtype: str
"""
return self._ReceiptId
@ReceiptId.setter
def ReceiptId(self, ReceiptId):
warnings.warn("parameter `ReceiptId` is deprecated", DeprecationWarning)
self._ReceiptId = ReceiptId
@property
def ProxyOrganizationOpenId(self):
"""第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
:rtype: str
"""
return self._ProxyOrganizationOpenId
@ProxyOrganizationOpenId.setter
def ProxyOrganizationOpenId(self, ProxyOrganizationOpenId):
self._ProxyOrganizationOpenId = ProxyOrganizationOpenId
@property
def ProxyOperatorOpenId(self):
"""第三方平台子客企业员工的唯一标识
:rtype: str
"""
return self._ProxyOperatorOpenId
@ProxyOperatorOpenId.setter
def ProxyOperatorOpenId(self, ProxyOperatorOpenId):
self._ProxyOperatorOpenId = ProxyOperatorOpenId
@property
def ProxyOrganizationName(self):
"""第三方平台子客企业名称，与企业营业执照中注册的名称一致。
:rtype: str
"""
return self._ProxyOrganizationName
@ProxyOrganizationName.setter
def ProxyOrganizationName(self, ProxyOrganizationName):
self._ProxyOrganizationName = ProxyOrganizationName
@property
def Mobile(self):
"""签署人手机号
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def SignOrder(self):
"""签署顺序，如果是有序签署，签署顺序从小到大
:rtype: int
"""
return self._SignOrder
@SignOrder.setter
def SignOrder(self, SignOrder):
self._SignOrder = SignOrder
@property
def ApproveName(self):
"""签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:rtype: str
"""
return self._ApproveName
@ApproveName.setter
def ApproveName(self, ApproveName):
self._ApproveName = ApproveName
@property
def ApproveStatus(self):
"""当前签署人的状态, 状态如下
<ul><li> **PENDING** :待签署</li>
<li> **FILLPENDING** :待填写</li>
<li> **FILLACCEPT** :填写完成</li>
<li> **FILLREJECT** :拒绝填写</li>
<li> **WAITPICKUP** :待领取</li>
<li> **ACCEPT** :已签署</li>
<li> **REJECT** :拒签</li>
<li> **DEADLINE** :过期没人处理</li>
<li> **CANCEL** :流程已撤回</li>
<li> **FORWARD** :已经转他人处理</li>
<li> **STOP** :流程已终止</li>
<li> **RELIEVED** :解除协议（已解除）</li></ul>
:rtype: str
"""
return self._ApproveStatus
@ApproveStatus.setter
def ApproveStatus(self, ApproveStatus):
self._ApproveStatus = ApproveStatus
@property
def ApproveMessage(self):
"""签署人拒签等情况的时候填写的原因
:rtype: str
"""
return self._ApproveMessage
@ApproveMessage.setter
def ApproveMessage(self, ApproveMessage):
self._ApproveMessage = ApproveMessage
@property
def ApproveTime(self):
"""签署人签署时间戳，单位秒
:rtype: int
"""
return self._ApproveTime
@ApproveTime.setter
def ApproveTime(self, ApproveTime):
self._ApproveTime = ApproveTime
@property
def ApproveType(self):
"""参与者类型
<ul><li> **ORGANIZATION** :企业签署人</li>
<li> **PERSON** :个人签署人</li></ul>
:rtype: str
"""
return self._ApproveType
@ApproveType.setter
def ApproveType(self, ApproveType):
self._ApproveType = ApproveType
@property
def ApproverRoleName(self):
"""自定义签署人的角色名, 如: 收款人、开具人、见证人等
:rtype: str
"""
return self._ApproverRoleName
@ApproverRoleName.setter
def ApproverRoleName(self, ApproverRoleName):
self._ApproverRoleName = ApproverRoleName
@property
def SignId(self):
"""签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点。
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def RecipientId(self):
"""模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
def _deserialize(self, params):
self._ReceiptId = params.get("ReceiptId")
self._ProxyOrganizationOpenId = params.get("ProxyOrganizationOpenId")
self._ProxyOperatorOpenId = params.get("ProxyOperatorOpenId")
self._ProxyOrganizationName = params.get("ProxyOrganizationName")
self._Mobile = params.get("Mobile")
self._SignOrder = params.get("SignOrder")
self._ApproveName = params.get("ApproveName")
self._ApproveStatus = params.get("ApproveStatus")
self._ApproveMessage = params.get("ApproveMessage")
self._ApproveTime = params.get("ApproveTime")
self._ApproveType = params.get("ApproveType")
self._ApproverRoleName = params.get("ApproverRoleName")
self._SignId = params.get("SignId")
self._RecipientId = params.get("RecipientId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowApproverInfo(AbstractModel):
"""创建签署流程签署人入参。
**各种场景传参说明**:
<table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（必传）OpenId：企业员工标识</li> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> <li>（固定）ApproverOption.FillType：需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（必传）OpenId：企业员工标识</li> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（固定）ApproverType：需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）OrganizationName：SaaS企业的名字</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（不传）OrganizationOpenId：子企业的标识</li> <li>（不传）OpenId：企业员工标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> <li>（固定）NotChannelOrganization：需设置为True</li> </ul> </td> </tr> </tbody> </table>
**注1**: `使用模板发起合同时，RecipientId（模板发起合同时）必传`
RecipientId参数获取：
从<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates" target="_blank">DescribeFlowTemplates接口</a>接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId。
**注2**: `如果发起的是动态签署方（即ApproverOption.FillType指定为1），可以不指定具体签署人信息`, 动态签署方可以参考<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">此文档</a>
"""
def __init__(self):
r"""
:param _Name: 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:type Name: str
:param _IdCardType: 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE : 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:type IdCardType: str
:param _IdCardNumber: 签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type IdCardNumber: str
:param _Mobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。
请确认手机号所有方为此合同签署方。
:type Mobile: str
:param _OrganizationName: 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
:type OrganizationName: str
:param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。
<ul>
<li>false: 默认值，第三方平台子客企业下员工</li>
<li>true: SaaS平台企业下的员工</li>
</ul>
:type NotChannelOrganization: bool
:param _OpenId: 第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成
当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程
注：
如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
:type OpenId: str
:param _OrganizationOpenId: 同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符
:type OrganizationOpenId: str
:param _ApproverType: 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
<ul><li> **PERSON** :个人/自然人</li>
<li> **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景</li>
<li> **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签）</li>
<li> **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）</li></ul>
注:
`1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
`2. 若要实现他方企业（同一应用下）自动签，需要满足3个条件：`
<ul><li>条件1：ApproverType 设置为ENTERPRISESERVER</li>
<li>条件2：子客之间完成授权</li>
<li>条件3：联系对接的客户经理沟通如何使用</li></ul>
:type ApproverType: str
:param _RecipientId: 签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；
:type RecipientId: str
:param _Deadline: 签署人的签署截止时间，格式为Unix标准时间戳（秒）
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
:type Deadline: int
:param _CallbackUrl: 签署完回调url，最大长度1000个字符
:type CallbackUrl: str
:param _SignComponents: 使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
:type SignComponents: list of Component
:param _ComponentLimitType: 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
<ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>
<li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>
<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
<li> <b>ESIGN</b> :个人印章类型。</li>
<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
各种签名的样式可以参考下图：
:type ComponentLimitType: list of str
:param _PreReadTime: 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
<ul>
<li>合同页数少于等于2页，阅读时间为3秒；</li>
<li>合同页数为3到5页，阅读时间为5秒；</li>
<li>合同页数大于等于6页，阅读时间为10秒。</li>
</ul>
:type PreReadTime: int
:param _JumpUrl: 签署完前端跳转的url，此字段的用法场景请联系客户经理确认
:type JumpUrl: str
:param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。
详细操作可以参考开发者中心的ApproverOption结构体。
:type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
:param _ApproverNeedSignReview: 此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下：
<ul><li>**false**：（默认）不需要审批，直接签署。</li>
<li>**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。</li></ul>
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li>如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li>如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与发起方企业内部的审批流程进行关联，支持手动、静默签署合同`
:type ApproverNeedSignReview: bool
:param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
<ul><li> **1** : （默认）人脸识别,人脸识别后才能合同内容</li>
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
</li></ul>
注:
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
<li>此字段可传多个校验方式</li></ul>
:type ApproverVerifyTypes: list of int
:param _ApproverSignTypes: 签署人签署合同时的认证方式
<ul><li> **1** :人脸认证</li>
<li> **2** :签署密码</li>
<li> **3** :运营商三要素（如果是港澳台客户，建议不要选择这个）</li>
<li>**5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）</li>
<li>**6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）</li></ul>
默认为：
1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
注:
1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>，至少需要再增加一种其他校验方式。
4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用，其他端暂不支持。
:type ApproverSignTypes: list of int
:param _SignId: 签署ID
- 发起流程时系统自动补充
- 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
:type SignId: str
:param _NotifyType: 通知签署方经办人的方式, 有以下途径:
<ul><li> **SMS** :(默认)短信</li>
<li> **NONE** : 不通知</li></ul>
注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
:type NotifyType: str
:param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。
注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
:type AddSignComponentsLimits: list of ComponentLimit
:param _ApproverRoleName: 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
:type ApproverRoleName: str
:param _SignTypeSelector: 生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
<ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li>
<li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>
注：
`不指定该值时，默认为签署方自行选择。`
:type SignTypeSelector: int
:param _Components: 签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
<ul><li>单行文本控件</li>
<li>多行文本控件</li>
<li>勾选框控件</li>
<li>数字控件</li>
<li>图片控件</li>
<li>数据表格等填写控件</li></ul>
具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件)
注：`此参数仅在通过文件发起合同或者合同组时生效`
:type Components: list of Component
:param _Intention: <b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。
2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
:type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
:param _SignEndpoints: 进入签署流程的限制，目前支持以下选项：
<ul><li> <b>空值（默认）</b> :无限制，可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
:type SignEndpoints: list of str
"""
self._Name = None
self._IdCardType = None
self._IdCardNumber = None
self._Mobile = None
self._OrganizationName = None
self._NotChannelOrganization = None
self._OpenId = None
self._OrganizationOpenId = None
self._ApproverType = None
self._RecipientId = None
self._Deadline = None
self._CallbackUrl = None
self._SignComponents = None
self._ComponentLimitType = None
self._PreReadTime = None
self._JumpUrl = None
self._ApproverOption = None
self._ApproverNeedSignReview = None
self._ApproverVerifyTypes = None
self._ApproverSignTypes = None
self._SignId = None
self._NotifyType = None
self._AddSignComponentsLimits = None
self._ApproverRoleName = None
self._SignTypeSelector = None
self._Components = None
self._Intention = None
self._SignEndpoints = None
@property
def Name(self):
"""签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def IdCardType(self):
"""签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE : 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def Mobile(self):
"""签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)， 不支持海外手机号。
请确认手机号所有方为此合同签署方。
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def OrganizationName(self):
"""组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def NotChannelOrganization(self):
"""指定签署人非第三方平台子客企业下员工还是SaaS平台企业，在ApproverType为ORGANIZATION时指定。
<ul>
<li>false: 默认值，第三方平台子客企业下员工</li>
<li>true: SaaS平台企业下的员工</li>
</ul>
:rtype: bool
"""
return self._NotChannelOrganization
@NotChannelOrganization.setter
def NotChannelOrganization(self, NotChannelOrganization):
self._NotChannelOrganization = NotChannelOrganization
@property
def OpenId(self):
"""第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成
当签署方为同一第三方平台下的员工时，该字段若不指定，则发起【待领取】的流程
注：
如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def OrganizationOpenId(self):
"""同应用下第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样，签署方为非发起方企业场景下必传，最大长度64个字符
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def ApproverType(self):
"""在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
<ul><li> **PERSON** :个人/自然人</li>
<li> **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景</li>
<li> **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签）</li>
<li> **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）</li></ul>
注:
`1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
`2. 若要实现他方企业（同一应用下）自动签，需要满足3个条件：`
<ul><li>条件1：ApproverType 设置为ENTERPRISESERVER</li>
<li>条件2：子客之间完成授权</li>
<li>条件3：联系对接的客户经理沟通如何使用</li></ul>
:rtype: str
"""
return self._ApproverType
@ApproverType.setter
def ApproverType(self, ApproverType):
self._ApproverType = ApproverType
@property
def RecipientId(self):
"""签署流程签署人在模板中对应的签署人Id；在非单方签署、以及非B2C签署的场景下必传，用于指定当前签署方在签署流程中的位置；
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def Deadline(self):
"""签署人的签署截止时间，格式为Unix标准时间戳（秒）
注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""签署完回调url，最大长度1000个字符
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def SignComponents(self):
"""使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
:rtype: list of Component
"""
return self._SignComponents
@SignComponents.setter
def SignComponents(self, SignComponents):
self._SignComponents = SignComponents
@property
def ComponentLimitType(self):
"""当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
<ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>
<li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>
<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
<li> <b>ESIGN</b> :个人印章类型。</li>
<li> <b>IMG_ESIGN</b> : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
各种签名的样式可以参考下图：
:rtype: list of str
"""
return self._ComponentLimitType
@ComponentLimitType.setter
def ComponentLimitType(self, ComponentLimitType):
self._ComponentLimitType = ComponentLimitType
@property
def PreReadTime(self):
"""签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
<ul>
<li>合同页数少于等于2页，阅读时间为3秒；</li>
<li>合同页数为3到5页，阅读时间为5秒；</li>
<li>合同页数大于等于6页，阅读时间为10秒。</li>
</ul>
:rtype: int
"""
return self._PreReadTime
@PreReadTime.setter
def PreReadTime(self, PreReadTime):
self._PreReadTime = PreReadTime
@property
def JumpUrl(self):
"""签署完前端跳转的url，此字段的用法场景请联系客户经理确认
:rtype: str
"""
return self._JumpUrl
@JumpUrl.setter
def JumpUrl(self, JumpUrl):
self._JumpUrl = JumpUrl
@property
def ApproverOption(self):
"""可以控制签署方在签署合同时能否进行某些操作，例如拒签、转交他人、是否为动态补充签署人等。
详细操作可以参考开发者中心的ApproverOption结构体。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
"""
return self._ApproverOption
@ApproverOption.setter
def ApproverOption(self, ApproverOption):
self._ApproverOption = ApproverOption
@property
def ApproverNeedSignReview(self):
"""此签署人（员工或者个人）签署前，是否需要发起方企业进行审批，取值如下：
<ul><li>**false**：（默认）不需要审批，直接签署。</li>
<li>**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待发起方企业内部审批完成。</li></ul>
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li>如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li>如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与发起方企业内部的审批流程进行关联，支持手动、静默签署合同`
:rtype: bool
"""
return self._ApproverNeedSignReview
@ApproverNeedSignReview.setter
def ApproverNeedSignReview(self, ApproverNeedSignReview):
self._ApproverNeedSignReview = ApproverNeedSignReview
@property
def ApproverVerifyTypes(self):
"""指定个人签署方查看合同的校验方式,可以传值如下:
<ul><li> **1** : （默认）人脸识别,人脸识别后才能合同内容</li>
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
</li></ul>
注:
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
<li>此字段可传多个校验方式</li></ul>
:rtype: list of int
"""
return self._ApproverVerifyTypes
@ApproverVerifyTypes.setter
def ApproverVerifyTypes(self, ApproverVerifyTypes):
self._ApproverVerifyTypes = ApproverVerifyTypes
@property
def ApproverSignTypes(self):
"""签署人签署合同时的认证方式
<ul><li> **1** :人脸认证</li>
<li> **2** :签署密码</li>
<li> **3** :运营商三要素（如果是港澳台客户，建议不要选择这个）</li>
<li>**5**：设备指纹识别，需要对比手机机主预留的指纹信息，校验一致才能成功进行合同签署。（iOS系统暂不支持该校验方式）</li>
<li>**6**：设备面容识别，需要对比手机机主预留的人脸信息，校验一致才能成功进行合同签署。（Android系统暂不支持该校验方式）</li></ul>
默认为：
1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
注:
1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>，至少需要再增加一种其他校验方式。
4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用，其他端暂不支持。
:rtype: list of int
"""
return self._ApproverSignTypes
@ApproverSignTypes.setter
def ApproverSignTypes(self, ApproverSignTypes):
self._ApproverSignTypes = ApproverSignTypes
@property
def SignId(self):
"""签署ID
- 发起流程时系统自动补充
- 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def NotifyType(self):
"""通知签署方经办人的方式, 有以下途径:
<ul><li> **SMS** :(默认)短信</li>
<li> **NONE** : 不通知</li></ul>
注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
:rtype: str
"""
return self._NotifyType
@NotifyType.setter
def NotifyType(self, NotifyType):
self._NotifyType = NotifyType
@property
def AddSignComponentsLimits(self):
"""[通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。
注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
:rtype: list of ComponentLimit
"""
return self._AddSignComponentsLimits
@AddSignComponentsLimits.setter
def AddSignComponentsLimits(self, AddSignComponentsLimits):
self._AddSignComponentsLimits = AddSignComponentsLimits
@property
def ApproverRoleName(self):
"""可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
:rtype: str
"""
return self._ApproverRoleName
@ApproverRoleName.setter
def ApproverRoleName(self, ApproverRoleName):
self._ApproverRoleName = ApproverRoleName
@property
def SignTypeSelector(self):
"""生成H5签署链接时，您可以指定签署方签署合同的认证校验方式的选择模式，可传递一下值：
<ul><li>**0**：签署方自行选择，签署方可以从预先指定的认证方式中自由选择；</li>
<li>**1**：自动按顺序首位推荐，签署方无需选择，系统会优先推荐使用第一种认证方式。</li></ul>
注：
`不指定该值时，默认为签署方自行选择。`
:rtype: int
"""
return self._SignTypeSelector
@SignTypeSelector.setter
def SignTypeSelector(self, SignTypeSelector):
self._SignTypeSelector = SignTypeSelector
@property
def Components(self):
"""签署人在合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
<ul><li>单行文本控件</li>
<li>多行文本控件</li>
<li>勾选框控件</li>
<li>数字控件</li>
<li>图片控件</li>
<li>数据表格等填写控件</li></ul>
具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件)
注：`此参数仅在通过文件发起合同或者合同组时生效`
:rtype: list of Component
"""
return self._Components
@Components.setter
def Components(self, Components):
self._Components = Components
@property
def Intention(self):
"""<b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。
您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
注意：
1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。
2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。
3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Intention`
"""
return self._Intention
@Intention.setter
def Intention(self, Intention):
self._Intention = Intention
@property
def SignEndpoints(self):
"""进入签署流程的限制，目前支持以下选项：
<ul><li> <b>空值（默认）</b> :无限制，可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后，将无法通过控制台或电子签小程序列表进入填写或签署操作，仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
:rtype: list of str
"""
return self._SignEndpoints
@SignEndpoints.setter
def SignEndpoints(self, SignEndpoints):
self._SignEndpoints = SignEndpoints
def _deserialize(self, params):
self._Name = params.get("Name")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
self._Mobile = params.get("Mobile")
self._OrganizationName = params.get("OrganizationName")
self._NotChannelOrganization = params.get("NotChannelOrganization")
self._OpenId = params.get("OpenId")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._ApproverType = params.get("ApproverType")
self._RecipientId = params.get("RecipientId")
self._Deadline = params.get("Deadline")
self._CallbackUrl = params.get("CallbackUrl")
if params.get("SignComponents") is not None:
self._SignComponents = []
for item in params.get("SignComponents"):
obj = Component()
obj._deserialize(item)
self._SignComponents.append(obj)
self._ComponentLimitType = params.get("ComponentLimitType")
self._PreReadTime = params.get("PreReadTime")
self._JumpUrl = params.get("JumpUrl")
if params.get("ApproverOption") is not None:
self._ApproverOption = ApproverOption()
self._ApproverOption._deserialize(params.get("ApproverOption"))
self._ApproverNeedSignReview = params.get("ApproverNeedSignReview")
self._ApproverVerifyTypes = params.get("ApproverVerifyTypes")
self._ApproverSignTypes = params.get("ApproverSignTypes")
self._SignId = params.get("SignId")
self._NotifyType = params.get("NotifyType")
if params.get("AddSignComponentsLimits") is not None:
self._AddSignComponentsLimits = []
for item in params.get("AddSignComponentsLimits"):
obj = ComponentLimit()
obj._deserialize(item)
self._AddSignComponentsLimits.append(obj)
self._ApproverRoleName = params.get("ApproverRoleName")
self._SignTypeSelector = params.get("SignTypeSelector")
if params.get("Components") is not None:
self._Components = []
for item in params.get("Components"):
obj = Component()
obj._deserialize(item)
self._Components.append(obj)
if params.get("Intention") is not None:
self._Intention = Intention()
self._Intention._deserialize(params.get("Intention"))
self._SignEndpoints = params.get("SignEndpoints")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowApproverItem(AbstractModel):
"""签署方信息，如角色ID、角色名称等
"""
def __init__(self):
r"""
:param _FlowId: 合同编号
:type FlowId: str
:param _Approvers: 签署方信息，如角色ID、角色名称等
:type Approvers: list of ApproverItem
"""
self._FlowId = None
self._Approvers = None
@property
def FlowId(self):
"""合同编号
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Approvers(self):
"""签署方信息，如角色ID、角色名称等
:rtype: list of ApproverItem
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = ApproverItem()
obj._deserialize(item)
self._Approvers.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowApproverUrlInfo(AbstractModel):
"""签署人签署链接信息。
"""
def __init__(self):
r"""
:param _SignUrl: 签署短链接。
注意:
1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type SignUrl: str
:param _ApproverType: 签署人类型。
- **PERSON**: 个人
:type ApproverType: str
:param _Name: 签署人姓名。
:type Name: str
:param _Mobile: 签署人手机号。
:type Mobile: str
:param _LongUrl: 签署长链接。
注意:
1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type LongUrl: str
"""
self._SignUrl = None
self._ApproverType = None
self._Name = None
self._Mobile = None
self._LongUrl = None
@property
def SignUrl(self):
"""签署短链接。
注意:
1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._SignUrl
@SignUrl.setter
def SignUrl(self, SignUrl):
self._SignUrl = SignUrl
@property
def ApproverType(self):
"""签署人类型。
- **PERSON**: 个人
:rtype: str
"""
return self._ApproverType
@ApproverType.setter
def ApproverType(self, ApproverType):
self._ApproverType = ApproverType
@property
def Name(self):
"""签署人姓名。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Mobile(self):
"""签署人手机号。
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def LongUrl(self):
"""签署长链接。
注意:
1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._LongUrl
@LongUrl.setter
def LongUrl(self, LongUrl):
self._LongUrl = LongUrl
def _deserialize(self, params):
self._SignUrl = params.get("SignUrl")
self._ApproverType = params.get("ApproverType")
self._Name = params.get("Name")
self._Mobile = params.get("Mobile")
self._LongUrl = params.get("LongUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowBatchApproverInfo(AbstractModel):
"""批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID。
:type FlowId: str
:param _RecipientId: 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
:type RecipientId: str
"""
self._FlowId = None
self._RecipientId = None
@property
def FlowId(self):
"""合同流程ID。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def RecipientId(self):
"""签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._RecipientId = params.get("RecipientId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowBatchUrlInfo(AbstractModel):
"""批量签署合同相关信息，指定批量签署合同和签署方的信息，用于补充动态签署人。
"""
def __init__(self):
r"""
:param _FlowBatchApproverInfos: 批量签署合同和签署方的信息，用于补充动态签署人。
:type FlowBatchApproverInfos: list of FlowBatchApproverInfo
"""
self._FlowBatchApproverInfos = None
@property
def FlowBatchApproverInfos(self):
"""批量签署合同和签署方的信息，用于补充动态签署人。
:rtype: list of FlowBatchApproverInfo
"""
return self._FlowBatchApproverInfos
@FlowBatchApproverInfos.setter
def FlowBatchApproverInfos(self, FlowBatchApproverInfos):
self._FlowBatchApproverInfos = FlowBatchApproverInfos
def _deserialize(self, params):
if params.get("FlowBatchApproverInfos") is not None:
self._FlowBatchApproverInfos = []
for item in params.get("FlowBatchApproverInfos"):
obj = FlowBatchApproverInfo()
obj._deserialize(item)
self._FlowBatchApproverInfos.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowDetailInfo(AbstractModel):
"""此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。
:type FlowId: str
:param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:type FlowName: str
:param _FlowType: 合同流程的类别分类（如销售合同/入职合同等）。
:type FlowType: str
:param _FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
<ul><li> **INIT** :合同创建</li>
<li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
<li> **REJECT** :合同拒签</li>
<li> **ALL** :合同签署完成</li>
<li> **DEADLINE** :合同流签(合同过期)</li>
<li> **CANCEL** :合同撤回</li>
<li> **RELIEVED** :解除协议（已解除）</li></ul>
:type FlowStatus: str
:param _FlowMessage: 当合同流程状态为已拒签（即 FlowStatus=REJECT）或已撤销（即 FlowStatus=CANCEL ）时，此字段 FlowMessage 为拒签或撤销原因。
:type FlowMessage: str
:param _CreateOn: 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。
:type CreateOn: int
:param _DeadLine: 签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
:type DeadLine: int
:param _CustomData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
:type CustomData: str
:param _FlowApproverInfos: 合同流程的签署方数组
:type FlowApproverInfos: list of FlowApproverDetail
:param _CcInfos: 合同流程的关注方信息数组
:type CcInfos: list of FlowApproverDetail
:param _NeedCreateReview: 是否需要发起前审批
<ul><li>当NeedCreateReview为true，表明当前流程是需要发起前审核的合同，可能无法进行查看，签署操作，需要等审核完成后，才可以继续后续流程</li>
<li>当NeedCreateReview为false，不需要发起前审核的合同</li></ul>
:type NeedCreateReview: bool
"""
self._FlowId = None
self._FlowName = None
self._FlowType = None
self._FlowStatus = None
self._FlowMessage = None
self._CreateOn = None
self._DeadLine = None
self._CustomData = None
self._FlowApproverInfos = None
self._CcInfos = None
self._NeedCreateReview = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def FlowName(self):
"""合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def FlowType(self):
"""合同流程的类别分类（如销售合同/入职合同等）。
:rtype: str
"""
return self._FlowType
@FlowType.setter
def FlowType(self, FlowType):
self._FlowType = FlowType
@property
def FlowStatus(self):
"""合同流程当前的签署状态, 会存在下列的状态值
<ul><li> **INIT** :合同创建</li>
<li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
<li> **REJECT** :合同拒签</li>
<li> **ALL** :合同签署完成</li>
<li> **DEADLINE** :合同流签(合同过期)</li>
<li> **CANCEL** :合同撤回</li>
<li> **RELIEVED** :解除协议（已解除）</li></ul>
:rtype: str
"""
return self._FlowStatus
@FlowStatus.setter
def FlowStatus(self, FlowStatus):
self._FlowStatus = FlowStatus
@property
def FlowMessage(self):
"""当合同流程状态为已拒签（即 FlowStatus=REJECT）或已撤销（即 FlowStatus=CANCEL ）时，此字段 FlowMessage 为拒签或撤销原因。
:rtype: str
"""
return self._FlowMessage
@FlowMessage.setter
def FlowMessage(self, FlowMessage):
self._FlowMessage = FlowMessage
@property
def CreateOn(self):
"""合同流程的创建时间戳，格式为Unix标准时间戳（秒）。
:rtype: int
"""
return self._CreateOn
@CreateOn.setter
def CreateOn(self, CreateOn):
self._CreateOn = CreateOn
@property
def DeadLine(self):
"""签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
:rtype: int
"""
return self._DeadLine
@DeadLine.setter
def DeadLine(self, DeadLine):
self._DeadLine = DeadLine
@property
def CustomData(self):
"""调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
:rtype: str
"""
return self._CustomData
@CustomData.setter
def CustomData(self, CustomData):
self._CustomData = CustomData
@property
def FlowApproverInfos(self):
"""合同流程的签署方数组
:rtype: list of FlowApproverDetail
"""
return self._FlowApproverInfos
@FlowApproverInfos.setter
def FlowApproverInfos(self, FlowApproverInfos):
self._FlowApproverInfos = FlowApproverInfos
@property
def CcInfos(self):
"""合同流程的关注方信息数组
:rtype: list of FlowApproverDetail
"""
return self._CcInfos
@CcInfos.setter
def CcInfos(self, CcInfos):
self._CcInfos = CcInfos
@property
def NeedCreateReview(self):
"""是否需要发起前审批
<ul><li>当NeedCreateReview为true，表明当前流程是需要发起前审核的合同，可能无法进行查看，签署操作，需要等审核完成后，才可以继续后续流程</li>
<li>当NeedCreateReview为false，不需要发起前审核的合同</li></ul>
:rtype: bool
"""
return self._NeedCreateReview
@NeedCreateReview.setter
def NeedCreateReview(self, NeedCreateReview):
self._NeedCreateReview = NeedCreateReview
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._FlowName = params.get("FlowName")
self._FlowType = params.get("FlowType")
self._FlowStatus = params.get("FlowStatus")
self._FlowMessage = params.get("FlowMessage")
self._CreateOn = params.get("CreateOn")
self._DeadLine = params.get("DeadLine")
self._CustomData = params.get("CustomData")
if params.get("FlowApproverInfos") is not None:
self._FlowApproverInfos = []
for item in params.get("FlowApproverInfos"):
obj = FlowApproverDetail()
obj._deserialize(item)
self._FlowApproverInfos.append(obj)
if params.get("CcInfos") is not None:
self._CcInfos = []
for item in params.get("CcInfos"):
obj = FlowApproverDetail()
obj._deserialize(item)
self._CcInfos.append(obj)
self._NeedCreateReview = params.get("NeedCreateReview")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowFileInfo(AbstractModel):
"""合同组中每个子合同的发起信息
"""
def __init__(self):
r"""
:param _FileIds: 签署文件资源Id列表，目前仅支持单个文件
:type FileIds: list of str
:param _FlowName: 签署流程名称，长度不超过200个字符
:type FlowName: str
:param _FlowApprovers: 签署流程签约方列表，最多不超过5个参与方
:type FlowApprovers: list of FlowApproverInfo
:param _Deadline: 签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
:type Deadline: int
:param _FlowDescription: 签署流程的描述，长度不超过1000个字符
:type FlowDescription: str
:param _FlowType: 签署流程的类型，长度不超过255个字符
:type FlowType: str
:param _CallbackUrl: 已废弃，请使用【应用号配置】中的回调地址统一接收消息
:type CallbackUrl: str
:param _CustomerData: 第三方应用的业务信息，最大长度1000个字符。
:type CustomerData: str
:param _Unordered: 合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
:type Unordered: bool
:param _Components: 签署文件中的发起方的填写控件，需要在发起的时候进行填充
:type Components: list of Component
:param _CustomShowMap: 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
:type CustomShowMap: str
:param _NeedSignReview: 本企业(发起方企业)是否需要签署审批
:type NeedSignReview: bool
:param _FlowDisplayType: 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:type FlowDisplayType: int
"""
self._FileIds = None
self._FlowName = None
self._FlowApprovers = None
self._Deadline = None
self._FlowDescription = None
self._FlowType = None
self._CallbackUrl = None
self._CustomerData = None
self._Unordered = None
self._Components = None
self._CustomShowMap = None
self._NeedSignReview = None
self._FlowDisplayType = None
@property
def FileIds(self):
"""签署文件资源Id列表，目前仅支持单个文件
:rtype: list of str
"""
return self._FileIds
@FileIds.setter
def FileIds(self, FileIds):
self._FileIds = FileIds
@property
def FlowName(self):
"""签署流程名称，长度不超过200个字符
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def FlowApprovers(self):
"""签署流程签约方列表，最多不超过5个参与方
:rtype: list of FlowApproverInfo
"""
return self._FlowApprovers
@FlowApprovers.setter
def FlowApprovers(self, FlowApprovers):
self._FlowApprovers = FlowApprovers
@property
def Deadline(self):
"""签署流程截止时间，十位数时间戳，最大值为33162419560，即3020年
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def FlowDescription(self):
"""签署流程的描述，长度不超过1000个字符
:rtype: str
"""
return self._FlowDescription
@FlowDescription.setter
def FlowDescription(self, FlowDescription):
self._FlowDescription = FlowDescription
@property
def FlowType(self):
"""签署流程的类型，长度不超过255个字符
:rtype: str
"""
return self._FlowType
@FlowType.setter
def FlowType(self, FlowType):
self._FlowType = FlowType
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""已废弃，请使用【应用号配置】中的回调地址统一接收消息
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def CustomerData(self):
"""第三方应用的业务信息，最大长度1000个字符。
:rtype: str
"""
return self._CustomerData
@CustomerData.setter
def CustomerData(self, CustomerData):
self._CustomerData = CustomerData
@property
def Unordered(self):
"""合同签署顺序类型(无序签,顺序签)，默认为false，即有序签署
:rtype: bool
"""
return self._Unordered
@Unordered.setter
def Unordered(self, Unordered):
self._Unordered = Unordered
@property
def Components(self):
"""签署文件中的发起方的填写控件，需要在发起的时候进行填充
:rtype: list of Component
"""
return self._Components
@Components.setter
def Components(self, Components):
self._Components = Components
@property
def CustomShowMap(self):
"""合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
:rtype: str
"""
return self._CustomShowMap
@CustomShowMap.setter
def CustomShowMap(self, CustomShowMap):
self._CustomShowMap = CustomShowMap
@property
def NeedSignReview(self):
"""本企业(发起方企业)是否需要签署审批
:rtype: bool
"""
return self._NeedSignReview
@NeedSignReview.setter
def NeedSignReview(self, NeedSignReview):
self._NeedSignReview = NeedSignReview
@property
def FlowDisplayType(self):
"""在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:rtype: int
"""
return self._FlowDisplayType
@FlowDisplayType.setter
def FlowDisplayType(self, FlowDisplayType):
self._FlowDisplayType = FlowDisplayType
def _deserialize(self, params):
self._FileIds = params.get("FileIds")
self._FlowName = params.get("FlowName")
if params.get("FlowApprovers") is not None:
self._FlowApprovers = []
for item in params.get("FlowApprovers"):
obj = FlowApproverInfo()
obj._deserialize(item)
self._FlowApprovers.append(obj)
self._Deadline = params.get("Deadline")
self._FlowDescription = params.get("FlowDescription")
self._FlowType = params.get("FlowType")
self._CallbackUrl = params.get("CallbackUrl")
self._CustomerData = params.get("CustomerData")
self._Unordered = params.get("Unordered")
if params.get("Components") is not None:
self._Components = []
for item in params.get("Components"):
obj = Component()
obj._deserialize(item)
self._Components.append(obj)
self._CustomShowMap = params.get("CustomShowMap")
self._NeedSignReview = params.get("NeedSignReview")
self._FlowDisplayType = params.get("FlowDisplayType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowForwardInfo(AbstractModel):
"""合同转交相关信息
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID，为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
:type FlowId: str
:param _RecipientId: 签署方经办人在合同中的参与方ID，为32位字符串。
:type RecipientId: str
"""
self._FlowId = None
self._RecipientId = None
@property
def FlowId(self):
"""合同流程ID，为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def RecipientId(self):
"""签署方经办人在合同中的参与方ID，为32位字符串。
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._RecipientId = params.get("RecipientId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowForwardResult(AbstractModel):
"""转交合同结果
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID为32位字符串。您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
:type FlowId: str
:param _ErrorDetail: 如果失败，返回的错误细节。
:type ErrorDetail: str
"""
self._FlowId = None
self._ErrorDetail = None
@property
def FlowId(self):
"""合同流程ID为32位字符串。您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def ErrorDetail(self):
"""如果失败，返回的错误细节。
:rtype: str
"""
return self._ErrorDetail
@ErrorDetail.setter
def ErrorDetail(self, ErrorDetail):
self._ErrorDetail = ErrorDetail
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._ErrorDetail = params.get("ErrorDetail")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowGroupApproverInfo(AbstractModel):
"""合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID。
:type FlowId: str
:param _RecipientId: 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
:type RecipientId: str
"""
self._FlowId = None
self._RecipientId = None
@property
def FlowId(self):
"""合同流程ID。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def RecipientId(self):
"""签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
self._RecipientId = params.get("RecipientId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowGroupApprovers(AbstractModel):
"""合同组签署方信息
"""
def __init__(self):
r"""
:param _FlowId: 合同流程ID
:type FlowId: str
:param _Approvers: 签署方信息，包含合同ID和角色ID用于定位RecipientId。
:type Approvers: list of ApproverItem
"""
self._FlowId = None
self._Approvers = None
@property
def FlowId(self):
"""合同流程ID
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Approvers(self):
"""签署方信息，包含合同ID和角色ID用于定位RecipientId。
:rtype: list of ApproverItem
"""
return self._Approvers
@Approvers.setter
def Approvers(self, Approvers):
self._Approvers = Approvers
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("Approvers") is not None:
self._Approvers = []
for item in params.get("Approvers"):
obj = ApproverItem()
obj._deserialize(item)
self._Approvers.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowGroupOptions(AbstractModel):
"""合同组的配置项信息包括：在合同组签署过程中，是否需要对每个子合同进行独立的意愿确认。
"""
def __init__(self):
r"""
:param _SelfOrganizationApproverSignEach: 发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认
<ul><li>**false**（默认）：发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
<li>**true**：发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
:type SelfOrganizationApproverSignEach: bool
:param _OtherApproverSignEach: 非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认
<ul><li>**false**（默认）：非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
<li>**true**：非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
:type OtherApproverSignEach: bool
"""
self._SelfOrganizationApproverSignEach = None
self._OtherApproverSignEach = None
@property
def SelfOrganizationApproverSignEach(self):
"""发起方企业经办人（即签署人为发起方企业员工）是否需要对子合同进行独立的意愿确认
<ul><li>**false**（默认）：发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
<li>**true**：发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
:rtype: bool
"""
return self._SelfOrganizationApproverSignEach
@SelfOrganizationApproverSignEach.setter
def SelfOrganizationApproverSignEach(self, SelfOrganizationApproverSignEach):
self._SelfOrganizationApproverSignEach = SelfOrganizationApproverSignEach
@property
def OtherApproverSignEach(self):
"""非发起方企业经办人（即：签署人为个人或者不为发起方企业的员工）是否需要对子合同进行独立的意愿确认
<ul><li>**false**（默认）：非发起方企业经办人签署时对所有子合同进行统一的意愿确认。</li>
<li>**true**：非发起方企业经办人签署时需要对子合同进行独立的意愿确认。</li></ul>
:rtype: bool
"""
return self._OtherApproverSignEach
@OtherApproverSignEach.setter
def OtherApproverSignEach(self, OtherApproverSignEach):
self._OtherApproverSignEach = OtherApproverSignEach
def _deserialize(self, params):
self._SelfOrganizationApproverSignEach = params.get("SelfOrganizationApproverSignEach")
self._OtherApproverSignEach = params.get("OtherApproverSignEach")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowGroupUrlInfo(AbstractModel):
"""合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
"""
def __init__(self):
r"""
:param _FlowGroupApproverInfos: 合同组子合同和签署方的信息，用于补充动态签署人。
:type FlowGroupApproverInfos: list of FlowGroupApproverInfo
"""
self._FlowGroupApproverInfos = None
@property
def FlowGroupApproverInfos(self):
"""合同组子合同和签署方的信息，用于补充动态签署人。
:rtype: list of FlowGroupApproverInfo
"""
return self._FlowGroupApproverInfos
@FlowGroupApproverInfos.setter
def FlowGroupApproverInfos(self, FlowGroupApproverInfos):
self._FlowGroupApproverInfos = FlowGroupApproverInfos
def _deserialize(self, params):
if params.get("FlowGroupApproverInfos") is not None:
self._FlowGroupApproverInfos = []
for item in params.get("FlowGroupApproverInfos"):
obj = FlowGroupApproverInfo()
obj._deserialize(item)
self._FlowGroupApproverInfos.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowInfo(AbstractModel):
"""此结构体 (FlowInfo) 用于描述签署流程信息。
"""
def __init__(self):
r"""
:param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:type FlowName: str
:param _Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
示例值：1604912664
:type Deadline: int
:param _TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
如果使用模板发起接口，此参数为必填。
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
:type TemplateId: str
:param _FlowApprovers: 合同流程的参与方列表，最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
<font color="red" > <b> 在发起流程时，需要保证 FlowApprovers中的顺序与模板定义顺序一致，否则会发起失败。
例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。</b></font>
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
:type FlowApprovers: list of FlowApproverInfo
:param _FormFields: 发起方角色的填写控件的填充内容。
注：只有在控制台编辑模板时，<font color="red">归属给发起方</font>的填写控件（如下图）才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通，否则模板编辑时无法将填写控件分配给发起方</font>)。
:type FormFields: list of FormField
:param _CallbackUrl: 该字段已废弃，请使用【应用号配置】中的回调地址统一接口消息
:type CallbackUrl: str
:param _FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
:type FlowType: str
:param _FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
:type FlowDescription: str
:param _CustomerData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
:type CustomerData: str
:param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
<ul><li>{合同名称} </li>
<li>{发起方企业} </li>
<li>{发起方姓名} </li>
<li>{签署方N企业}</li>
<li>{签署方N姓名}</li></ul>
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
:type CustomShowMap: str
:param _CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
<b>注</b>
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
:type CcInfos: list of CcInfo
:param _NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
:type NeedSignReview: bool
:param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
<ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
<li> **1** : 签署完成后通知对方来查看合同</li></ul>
:type CcNotifyType: int
:param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
:type AutoSignScene: str
:param _FlowDisplayType: 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:type FlowDisplayType: int
"""
self._FlowName = None
self._Deadline = None
self._TemplateId = None
self._FlowApprovers = None
self._FormFields = None
self._CallbackUrl = None
self._FlowType = None
self._FlowDescription = None
self._CustomerData = None
self._CustomShowMap = None
self._CcInfos = None
self._NeedSignReview = None
self._CcNotifyType = None
self._AutoSignScene = None
self._FlowDisplayType = None
@property
def FlowName(self):
"""合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowName
@FlowName.setter
def FlowName(self, FlowName):
self._FlowName = FlowName
@property
def Deadline(self):
"""合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
示例值：1604912664
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def TemplateId(self):
"""用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
如果使用模板发起接口，此参数为必填。
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
[点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
:rtype: str
"""
return self._TemplateId
@TemplateId.setter
def TemplateId(self, TemplateId):
self._TemplateId = TemplateId
@property
def FlowApprovers(self):
"""合同流程的参与方列表，最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
注:
<font color="red" > <b> 在发起流程时，需要保证 FlowApprovers中的顺序与模板定义顺序一致，否则会发起失败。
例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。</b></font>
[点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
:rtype: list of FlowApproverInfo
"""
return self._FlowApprovers
@FlowApprovers.setter
def FlowApprovers(self, FlowApprovers):
self._FlowApprovers = FlowApprovers
@property
def FormFields(self):
"""发起方角色的填写控件的填充内容。
注：只有在控制台编辑模板时，<font color="red">归属给发起方</font>的填写控件（如下图）才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通，否则模板编辑时无法将填写控件分配给发起方</font>)。
:rtype: list of FormField
"""
return self._FormFields
@FormFields.setter
def FormFields(self, FormFields):
self._FormFields = FormFields
@property
def CallbackUrl(self):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
"""该字段已废弃，请使用【应用号配置】中的回调地址统一接口消息
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
self._CallbackUrl = CallbackUrl
@property
def FlowType(self):
"""合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
:rtype: str
"""
return self._FlowType
@FlowType.setter
def FlowType(self, FlowType):
self._FlowType = FlowType
@property
def FlowDescription(self):
"""合同流程描述信息(可自定义此描述)，最大长度1000个字符。
:rtype: str
"""
return self._FlowDescription
@FlowDescription.setter
def FlowDescription(self, FlowDescription):
self._FlowDescription = FlowDescription
@property
def CustomerData(self):
"""调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
:rtype: str
"""
return self._CustomerData
@CustomerData.setter
def CustomerData(self, CustomerData):
self._CustomerData = CustomerData
@property
def CustomShowMap(self):
"""您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
<ul><li>{合同名称} </li>
<li>{发起方企业} </li>
<li>{发起方姓名} </li>
<li>{签署方N企业}</li>
<li>{签署方N姓名}</li></ul>
其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
合同名称：租房合同
发起方：腾讯公司(张三)
签署方：李四
:rtype: str
"""
return self._CustomShowMap
@CustomShowMap.setter
def CustomShowMap(self, CustomShowMap):
self._CustomShowMap = CustomShowMap
@property
def CcInfos(self):
"""合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
<b>注</b>
1. 抄送人名单中可以包括自然人以及本企业的员工（本企业员工必须已经完成认证并加入企业）。
2. 请确保抄送人列表中的成员不与任何签署人重复。
:rtype: list of CcInfo
"""
return self._CcInfos
@CcInfos.setter
def CcInfos(self, CcInfos):
self._CcInfos = CcInfos
@property
def NeedSignReview(self):
"""发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
:rtype: bool
"""
return self._NeedSignReview
@NeedSignReview.setter
def NeedSignReview(self, NeedSignReview):
self._NeedSignReview = NeedSignReview
@property
def CcNotifyType(self):
"""若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
<ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
<li> **1** : 签署完成后通知对方来查看合同</li></ul>
:rtype: int
"""
return self._CcNotifyType
@CcNotifyType.setter
def CcNotifyType(self, CcNotifyType):
self._CcNotifyType = CcNotifyType
@property
def AutoSignScene(self):
"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
:rtype: str
"""
return self._AutoSignScene
@AutoSignScene.setter
def AutoSignScene(self, AutoSignScene):
self._AutoSignScene = AutoSignScene
@property
def FlowDisplayType(self):
"""在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:
:rtype: int
"""
return self._FlowDisplayType
@FlowDisplayType.setter
def FlowDisplayType(self, FlowDisplayType):
self._FlowDisplayType = FlowDisplayType
def _deserialize(self, params):
self._FlowName = params.get("FlowName")
self._Deadline = params.get("Deadline")
self._TemplateId = params.get("TemplateId")
if params.get("FlowApprovers") is not None:
self._FlowApprovers = []
for item in params.get("FlowApprovers"):
obj = FlowApproverInfo()
obj._deserialize(item)
self._FlowApprovers.append(obj)
if params.get("FormFields") is not None:
self._FormFields = []
for item in params.get("FormFields"):
obj = FormField()
obj._deserialize(item)
self._FormFields.append(obj)
self._CallbackUrl = params.get("CallbackUrl")
self._FlowType = params.get("FlowType")
self._FlowDescription = params.get("FlowDescription")
self._CustomerData = params.get("CustomerData")
self._CustomShowMap = params.get("CustomShowMap")
if params.get("CcInfos") is not None:
self._CcInfos = []
for item in params.get("CcInfos"):
obj = CcInfo()
obj._deserialize(item)
self._CcInfos.append(obj)
self._NeedSignReview = params.get("NeedSignReview")
self._CcNotifyType = params.get("CcNotifyType")
self._AutoSignScene = params.get("AutoSignScene")
self._FlowDisplayType = params.get("FlowDisplayType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FlowResourceUrlInfo(AbstractModel):
"""流程对应资源链接信息
"""
def __init__(self):
r"""
:param _FlowId: 合同流程的ID
:type FlowId: str
:param _ResourceUrlInfos: 对应的合同流程的PDF下载链接
:type ResourceUrlInfos: list of ResourceUrlInfo
"""
self._FlowId = None
self._ResourceUrlInfos = None
@property
def FlowId(self):
"""合同流程的ID
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def ResourceUrlInfos(self):
"""对应的合同流程的PDF下载链接
:rtype: list of ResourceUrlInfo
"""
return self._ResourceUrlInfos
@ResourceUrlInfos.setter
def ResourceUrlInfos(self, ResourceUrlInfos):
self._ResourceUrlInfos = ResourceUrlInfos
def _deserialize(self, params):
self._FlowId = params.get("FlowId")
if params.get("ResourceUrlInfos") is not None:
self._ResourceUrlInfos = []
for item in params.get("ResourceUrlInfos"):
obj = ResourceUrlInfo()
obj._deserialize(item)
self._ResourceUrlInfos.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class FormField(AbstractModel):
"""电子文档的控件填充信息。按照控件类型进行相应的填充。
当控件的 ComponentType='TEXT'时，FormField.ComponentValue填入文本内容
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "文本内容"
}
```
当控件的 ComponentType='MULTI_LINE_TEXT'时，FormField.ComponentValue填入文本内容，支持自动换行。
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "多行文本内容"
}
```
当控件的 ComponentType='CHECK_BOX'时，FormField.ComponentValue填入true或false文本
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "true"
}
```
当控件的 ComponentType='FILL_IMAGE'时，FormField.ComponentValue填入图片的资源ID
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```
当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue填入附件图片的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
}
```
当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "选择的内容"
}
```
当控件的 ComponentType='DATE'时，FormField.ComponentValue填入日期内容；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "2023年01月01日"
}
```
当控件的 ComponentType='DISTRICT'时，FormField.ComponentValue填入省市区内容；
```
FormField输入示例：
{
"ComponentId": "componentId1",
"ComponentValue": "广东省深圳市福田区"
}
```
【数据表格传参说明】
当控件的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
输入示例1：
```
{
"headers":[
{
"content":"head1"
},
{
"content":"head2"
},
{
"content":"head3"
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123"
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456"
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789"
}
]
}
}
```
输入示例2（表格表头宽度比例配置）：
```
{
"headers":[
{
"content":"head1",
"widthPercent": 30
},
{
"content":"head2",
"widthPercent": 30
},
{
"content":"head3",
"widthPercent": 40
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123"
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456"
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789"
}
]
}
}
```
输入示例3（表格设置字体加粗颜色）：
```
{
"headers":[
{
"content":"head1"
},
{
"content":"head2"
},
{
"content":"head3"
}
],
"rowCount":3,
"body":{
"cells":[
{
"rowStart":1,
"rowEnd":1,
"columnStart":1,
"columnEnd":1,
"content":"123",
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
},
{
"rowStart":2,
"rowEnd":3,
"columnStart":1,
"columnEnd":2,
"content":"456",
"style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
},
{
"rowStart":3,
"rowEnd":3,
"columnStart":3,
"columnEnd":3,
"content":"789",
"style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
}
]
}
}
```
表格参数说明
| 名称 | 类型 | 描述 |
| ------------------- | ------- | ------------------------------------------------- |
| headers | Array | 表头：不超过10列，不支持单元格合并，字数不超过100 |
| rowCount | Integer | 表格内容最大行数 |
| cells.N.rowStart | Integer | 单元格坐标：行起始index |
| cells.N.rowEnd | Integer | 单元格坐标：行结束index |
| cells.N.columnStart | Integer | 单元格坐标：列起始index |
| cells.N.columnEnd | Integer | 单元格坐标：列结束index |
| cells.N.content | String | 单元格内容，字数不超过100 |
| cells.N.style | String | 单元格字体风格配置 ，风格配置的json字符串 如： {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
表格参数headers说明
widthPercent Integer 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35
content String 表头单元格内容，字数不超过100
style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF 字符串形如： "#FFFFFF" 或者 "0xFFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
"""
def __init__(self):
r"""
:param _ComponentValue: 控件填充值，ComponentType和传入值格式对应关系如下：
<ul><li> <b>TEXT</b> : 文本内容</li>
<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用 \n 来控制换行位置</li>
<li> <b>CHECK_BOX</b> : true/false</li>
<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
<li> <b>SELECTOR</b> : 选项值</li>
<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
<li> <b>DISTRICT </b> : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容</li>
</ul>
<b>控件值约束说明</b>：
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
:type ComponentValue: str
:param _ComponentId: 表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
:type ComponentId: str
:param _ComponentName: 控件的名字，跟ComponentId二选一，不能全为空
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
:type ComponentName: str
:param _LockComponentValue: 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
:type LockComponentValue: bool
"""
self._ComponentValue = None
self._ComponentId = None
self._ComponentName = None
self._LockComponentValue = None
@property
def ComponentValue(self):
"""控件填充值，ComponentType和传入值格式对应关系如下：
<ul><li> <b>TEXT</b> : 文本内容</li>
<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用 \n 来控制换行位置</li>
<li> <b>CHECK_BOX</b> : true/false</li>
<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
<li> <b>SELECTOR</b> : 选项值</li>
<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
<li> <b>DISTRICT </b> : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容</li>
</ul>
<b>控件值约束说明</b>：
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
:rtype: str
"""
return self._ComponentValue
@ComponentValue.setter
def ComponentValue(self, ComponentValue):
self._ComponentValue = ComponentValue
@property
def ComponentId(self):
"""表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
:rtype: str
"""
return self._ComponentId
@ComponentId.setter
def ComponentId(self, ComponentId):
self._ComponentId = ComponentId
@property
def ComponentName(self):
"""控件的名字，跟ComponentId二选一，不能全为空
<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
:rtype: str
"""
return self._ComponentName
@ComponentName.setter
def ComponentName(self, ComponentName):
self._ComponentName = ComponentName
@property
def LockComponentValue(self):
"""是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
:rtype: bool
"""
return self._LockComponentValue
@LockComponentValue.setter
def LockComponentValue(self, LockComponentValue):
self._LockComponentValue = LockComponentValue
def _deserialize(self, params):
self._ComponentValue = params.get("ComponentValue")
self._ComponentId = params.get("ComponentId")
self._ComponentName = params.get("ComponentName")
self._LockComponentValue = params.get("LockComponentValue")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class GetDownloadFlowUrlRequest(AbstractModel):
"""GetDownloadFlowUrl请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _DownLoadFlows: 程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹最多20个合同, 所有文件夹最多50个合同
如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
**2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
**2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
:type DownLoadFlows: list of DownloadFlowInfo
:param _Operator: 操作者的信息，不用传
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._DownLoadFlows = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def DownLoadFlows(self):
"""程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹最多20个合同, 所有文件夹最多50个合同
如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
**2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
**2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
:rtype: list of DownloadFlowInfo
"""
return self._DownLoadFlows
@DownLoadFlows.setter
def DownLoadFlows(self, DownLoadFlows):
self._DownLoadFlows = DownLoadFlows
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息，不用传
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("DownLoadFlows") is not None:
self._DownLoadFlows = []
for item in params.get("DownLoadFlows"):
obj = DownloadFlowInfo()
obj._deserialize(item)
self._DownLoadFlows.append(obj)
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class GetDownloadFlowUrlResponse(AbstractModel):
"""GetDownloadFlowUrl返回参数结构体
"""
def __init__(self):
r"""
:param _DownLoadUrl: 跳转控制台合同下载页面链接 , 5分钟之内有效，且只能访问一次
:type DownLoadUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._DownLoadUrl = None
self._RequestId = None
@property
def DownLoadUrl(self):
"""跳转控制台合同下载页面链接 , 5分钟之内有效，且只能访问一次
:rtype: str
"""
return self._DownLoadUrl
@DownLoadUrl.setter
def DownLoadUrl(self, DownLoadUrl):
self._DownLoadUrl = DownLoadUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._DownLoadUrl = params.get("DownLoadUrl")
self._RequestId = params.get("RequestId")
class HasAuthOrganization(AbstractModel):
"""授权企业列表（目前仅用于“企业自动签 -> 合作企业授权”）
"""
def __init__(self):
r"""
:param _OrganizationOpenId: 授权企业openid，
:type OrganizationOpenId: str
:param _OrganizationName: 授权企业名称
:type OrganizationName: str
:param _AuthorizedOrganizationOpenId: 被授权企业openid，
:type AuthorizedOrganizationOpenId: str
:param _AuthorizedOrganizationName: 被授权企业名称
:type AuthorizedOrganizationName: str
:param _AuthorizeTime: 授权时间，格式为时间戳，单位s
:type AuthorizeTime: int
"""
self._OrganizationOpenId = None
self._OrganizationName = None
self._AuthorizedOrganizationOpenId = None
self._AuthorizedOrganizationName = None
self._AuthorizeTime = None
@property
def OrganizationOpenId(self):
"""授权企业openid，
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OrganizationName(self):
"""授权企业名称
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def AuthorizedOrganizationOpenId(self):
"""被授权企业openid，
:rtype: str
"""
return self._AuthorizedOrganizationOpenId
@AuthorizedOrganizationOpenId.setter
def AuthorizedOrganizationOpenId(self, AuthorizedOrganizationOpenId):
self._AuthorizedOrganizationOpenId = AuthorizedOrganizationOpenId
@property
def AuthorizedOrganizationName(self):
"""被授权企业名称
:rtype: str
"""
return self._AuthorizedOrganizationName
@AuthorizedOrganizationName.setter
def AuthorizedOrganizationName(self, AuthorizedOrganizationName):
self._AuthorizedOrganizationName = AuthorizedOrganizationName
@property
def AuthorizeTime(self):
"""授权时间，格式为时间戳，单位s
:rtype: int
"""
return self._AuthorizeTime
@AuthorizeTime.setter
def AuthorizeTime(self, AuthorizeTime):
self._AuthorizeTime = AuthorizeTime
def _deserialize(self, params):
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OrganizationName = params.get("OrganizationName")
self._AuthorizedOrganizationOpenId = params.get("AuthorizedOrganizationOpenId")
self._AuthorizedOrganizationName = params.get("AuthorizedOrganizationName")
self._AuthorizeTime = params.get("AuthorizeTime")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class HasAuthUser(AbstractModel):
"""被授权的用户信息
"""
def __init__(self):
r"""
:param _OpenId: 第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。
:type OpenId: str
"""
self._OpenId = None
@property
def OpenId(self):
"""第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
def _deserialize(self, params):
self._OpenId = params.get("OpenId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Intention(AbstractModel):
"""视频核身意图配置，可指定问答模式或者点头模式的语音文本。
注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
"""
def __init__(self):
r"""
:param _IntentionType: 视频认证类型，支持以下类型
<ul><li>1 : 问答模式</li>
<li>2 : 点头模式</li></ul>
注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
:type IntentionType: int
:param _IntentionQuestions: 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。
注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`
:type IntentionQuestions: list of IntentionQuestion
:param _IntentionActions: 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。
注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`
:type IntentionActions: list of IntentionAction
"""
self._IntentionType = None
self._IntentionQuestions = None
self._IntentionActions = None
@property
def IntentionType(self):
"""视频认证类型，支持以下类型
<ul><li>1 : 问答模式</li>
<li>2 : 点头模式</li></ul>
注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
:rtype: int
"""
return self._IntentionType
@IntentionType.setter
def IntentionType(self, IntentionType):
self._IntentionType = IntentionType
@property
def IntentionQuestions(self):
"""意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。支持传入1～10轮问答，最多支持10轮。
注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`
:rtype: list of IntentionQuestion
"""
return self._IntentionQuestions
@IntentionQuestions.setter
def IntentionQuestions(self, IntentionQuestions):
self._IntentionQuestions = IntentionQuestions
@property
def IntentionActions(self):
"""意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。支持传入1～10轮点头确认文本，最多支持10轮。
注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`
:rtype: list of IntentionAction
"""
return self._IntentionActions
@IntentionActions.setter
def IntentionActions(self, IntentionActions):
self._IntentionActions = IntentionActions
def _deserialize(self, params):
self._IntentionType = params.get("IntentionType")
if params.get("IntentionQuestions") is not None:
self._IntentionQuestions = []
for item in params.get("IntentionQuestions"):
obj = IntentionQuestion()
obj._deserialize(item)
self._IntentionQuestions.append(obj)
if params.get("IntentionActions") is not None:
self._IntentionActions = []
for item in params.get("IntentionActions"):
obj = IntentionAction()
obj._deserialize(item)
self._IntentionActions.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class IntentionAction(AbstractModel):
"""意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
"""
def __init__(self):
r"""
:param _Text: 点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
:type Text: str
"""
self._Text = None
@property
def Text(self):
"""点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
:rtype: str
"""
return self._Text
@Text.setter
def Text(self, Text):
self._Text = Text
def _deserialize(self, params):
self._Text = params.get("Text")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class IntentionActionResult(AbstractModel):
"""意愿核身点头确认模式结果
"""
def __init__(self):
r"""
:param _Details: 意愿核身结果详细数据，与每段点头确认过程一一对应
:type Details: list of IntentionActionResultDetail
"""
self._Details = None
@property
def Details(self):
"""意愿核身结果详细数据，与每段点头确认过程一一对应
:rtype: list of IntentionActionResultDetail
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
def _deserialize(self, params):
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = IntentionActionResultDetail()
obj._deserialize(item)
self._Details.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class IntentionActionResultDetail(AbstractModel):
"""意愿核身点头确认模式结果详细数据
"""
def __init__(self):
r"""
:param _Video: 视频base64编码（其中包含全程提示文本和点头音频，mp4格式）
:type Video: str
"""
self._Video = None
@property
def Video(self):
"""视频base64编码（其中包含全程提示文本和点头音频，mp4格式）
:rtype: str
"""
return self._Video
@Video.setter
def Video(self, Video):
self._Video = Video
def _deserialize(self, params):
self._Video = params.get("Video")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class IntentionQuestion(AbstractModel):
"""意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
"""
def __init__(self):
r"""
:param _Question: 当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。
:type Question: str
:param _Answers: 当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。
:type Answers: list of str
"""
self._Question = None
self._Answers = None
@property
def Question(self):
"""当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。
:rtype: str
"""
return self._Question
@Question.setter
def Question(self, Question):
self._Question = Question
@property
def Answers(self):
""" 当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。
:rtype: list of str
"""
return self._Answers
@Answers.setter
def Answers(self, Answers):
self._Answers = Answers
def _deserialize(self, params):
self._Question = params.get("Question")
self._Answers = params.get("Answers")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class IntentionQuestionResult(AbstractModel):
"""意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
"""
def __init__(self):
r"""
:param _Video: 视频base64（其中包含全程问题和回答音频，mp4格式）
注：`需进行base64解码获取视频文件`
:type Video: str
:param _ResultCode: 和答案匹配结果列表
:type ResultCode: list of str
:param _AsrResult: 回答问题语音识别结果列表
:type AsrResult: list of str
"""
self._Video = None
self._ResultCode = None
self._AsrResult = None
@property
def Video(self):
"""视频base64（其中包含全程问题和回答音频，mp4格式）
注：`需进行base64解码获取视频文件`
:rtype: str
"""
return self._Video
@Video.setter
def Video(self, Video):
self._Video = Video
@property
def ResultCode(self):
""" 和答案匹配结果列表
:rtype: list of str
"""
return self._ResultCode
@ResultCode.setter
def ResultCode(self, ResultCode):
self._ResultCode = ResultCode
@property
def AsrResult(self):
"""回答问题语音识别结果列表
:rtype: list of str
"""
return self._AsrResult
@AsrResult.setter
def AsrResult(self, AsrResult):
self._AsrResult = AsrResult
def _deserialize(self, params):
self._Video = params.get("Video")
self._ResultCode = params.get("ResultCode")
self._AsrResult = params.get("AsrResult")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ModifyExtendedServiceRequest(AbstractModel):
"""ModifyExtendedService请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ServiceType: 扩展服务类型
<ul>
<li>AUTO_SIGN 企业自动签（自动签署）</li>
<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
</ul>
:type ServiceType: str
:param _Operate: 操作类型
<ul>
<li>OPEN : 开通</li>
<li>CLOSE : 关闭</li>
</ul>
:type Operate: str
:param _Endpoint: 链接跳转类型，支持以下类型
<ul>
<li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
<li>APP : 第三方APP或小程序跳转电子签小程序</li>
<li>WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。<font color="red">您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。</font></li>
</ul>
:type Endpoint: str
"""
self._Agent = None
self._ServiceType = None
self._Operate = None
self._Endpoint = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ServiceType(self):
""" 扩展服务类型
<ul>
<li>AUTO_SIGN 企业自动签（自动签署）</li>
<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
</ul>
:rtype: str
"""
return self._ServiceType
@ServiceType.setter
def ServiceType(self, ServiceType):
self._ServiceType = ServiceType
@property
def Operate(self):
"""操作类型
<ul>
<li>OPEN : 开通</li>
<li>CLOSE : 关闭</li>
</ul>
:rtype: str
"""
return self._Operate
@Operate.setter
def Operate(self, Operate):
self._Operate = Operate
@property
def Endpoint(self):
"""链接跳转类型，支持以下类型
<ul>
<li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
<li>APP : 第三方APP或小程序跳转电子签小程序</li>
<li>WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。<font color="red">您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。</font></li>
</ul>
:rtype: str
"""
return self._Endpoint
@Endpoint.setter
def Endpoint(self, Endpoint):
self._Endpoint = Endpoint
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ServiceType = params.get("ServiceType")
self._Operate = params.get("Operate")
self._Endpoint = params.get("Endpoint")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ModifyExtendedServiceResponse(AbstractModel):
"""ModifyExtendedService返回参数结构体
"""
def __init__(self):
r"""
:param _OperateUrl: 操作跳转链接
<ul><li><strong>链接有效期：</strong> 跳转链接的有效期为24小时。</li>
<li><strong>没有返回链接的情形：</strong> 如果在操作时没有返回跳转链接，说明此次操作无需进行跳转，服务将会直接被开通或关闭。</li>
<li><strong>返回链接的情形：</strong> 当操作类型为<b>OPEN（开通服务）</b>，并且扩展服务类型为<b>AUTO_SIGN（ 企业自动签署）</b>、<b>DOWNLOAD_FLOW（授权渠道下载合同）</b>时，系统将返回一个操作链接。收到操作链接后，贵方需主动联系超级管理员（超管）或法人。<font color="red"><b>由超管或法人点击链接</b></font>，以完成服务的开通操作。</li>
</ul>
:type OperateUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._OperateUrl = None
self._RequestId = None
@property
def OperateUrl(self):
"""操作跳转链接
<ul><li><strong>链接有效期：</strong> 跳转链接的有效期为24小时。</li>
<li><strong>没有返回链接的情形：</strong> 如果在操作时没有返回跳转链接，说明此次操作无需进行跳转，服务将会直接被开通或关闭。</li>
<li><strong>返回链接的情形：</strong> 当操作类型为<b>OPEN（开通服务）</b>，并且扩展服务类型为<b>AUTO_SIGN（ 企业自动签署）</b>、<b>DOWNLOAD_FLOW（授权渠道下载合同）</b>时，系统将返回一个操作链接。收到操作链接后，贵方需主动联系超级管理员（超管）或法人。<font color="red"><b>由超管或法人点击链接</b></font>，以完成服务的开通操作。</li>
</ul>
:rtype: str
"""
return self._OperateUrl
@OperateUrl.setter
def OperateUrl(self, OperateUrl):
self._OperateUrl = OperateUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._OperateUrl = params.get("OperateUrl")
self._RequestId = params.get("RequestId")
class ModifyFlowDeadlineRequest(AbstractModel):
"""ModifyFlowDeadline请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowId: 合同流程ID，为32位字符串。
<ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
<li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
:type FlowId: str
:param _Deadline: 签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）
:type Deadline: int
:param _RecipientId: 签署方角色编号，为32位字符串
<ul><li>若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）</li>
<li>通过[用PDF文件创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)发起合同，或通过[用模板创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/CreateFlowsByTemplates)时，返回参数[FlowApprovers](https://test.qian.tencent.cn/developers/partnerApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
<li>也可通过[获取合同信息](https://test.qian.tencent.cn/developers/partnerApis/flows/DescribeFlowDetailInfo)接口查询签署人的RecipientId编号</li></ul>
:type RecipientId: str
"""
self._Agent = None
self._FlowId = None
self._Deadline = None
self._RecipientId = None
@property
def Agent(self):
"""应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
<ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
<li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def Deadline(self):
"""签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def RecipientId(self):
"""签署方角色编号，为32位字符串
<ul><li>若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）</li>
<li>通过[用PDF文件创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)发起合同，或通过[用模板创建签署流程](https://test.qian.tencent.cn/developers/partnerApis/startFlows/CreateFlowsByTemplates)时，返回参数[FlowApprovers](https://test.qian.tencent.cn/developers/partnerApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
<li>也可通过[获取合同信息](https://test.qian.tencent.cn/developers/partnerApis/flows/DescribeFlowDetailInfo)接口查询签署人的RecipientId编号</li></ul>
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._FlowId = params.get("FlowId")
self._Deadline = params.get("Deadline")
self._RecipientId = params.get("RecipientId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ModifyFlowDeadlineResponse(AbstractModel):
"""ModifyFlowDeadline返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class NeedReviewApproverInfo(AbstractModel):
"""需要进行签署审核的签署人信息
"""
def __init__(self):
r"""
:param _ApproverType: 签署方经办人的类型，支持以下类型
<ul><li> ORGANIZATION 企业（含企业自动签）</li>
<li>PERSON 个人（含个人自动签）</li></ul>
:type ApproverType: str
:param _ApproverName: 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:type ApproverName: str
:param _ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
:type ApproverMobile: str
:param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:type ApproverIdCardType: str
:param _ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type ApproverIdCardNumber: str
:param _OrganizationName: 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
:type OrganizationName: str
"""
self._ApproverType = None
self._ApproverName = None
self._ApproverMobile = None
self._ApproverIdCardType = None
self._ApproverIdCardNumber = None
self._OrganizationName = None
@property
def ApproverType(self):
"""签署方经办人的类型，支持以下类型
<ul><li> ORGANIZATION 企业（含企业自动签）</li>
<li>PERSON 个人（含个人自动签）</li></ul>
:rtype: str
"""
return self._ApproverType
@ApproverType.setter
def ApproverType(self, ApproverType):
self._ApproverType = ApproverType
@property
def ApproverName(self):
"""签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:rtype: str
"""
return self._ApproverName
@ApproverName.setter
def ApproverName(self, ApproverName):
self._ApproverName = ApproverName
@property
def ApproverMobile(self):
"""签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
:rtype: str
"""
return self._ApproverMobile
@ApproverMobile.setter
def ApproverMobile(self, ApproverMobile):
self._ApproverMobile = ApproverMobile
@property
def ApproverIdCardType(self):
"""签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
<li>OTHER_CARD_TYPE 其他证件</li></ul>
注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
:rtype: str
"""
return self._ApproverIdCardType
@ApproverIdCardType.setter
def ApproverIdCardType(self, ApproverIdCardType):
self._ApproverIdCardType = ApproverIdCardType
@property
def ApproverIdCardNumber(self):
"""签署方经办人的证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。。</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._ApproverIdCardNumber
@ApproverIdCardNumber.setter
def ApproverIdCardNumber(self, ApproverIdCardNumber):
self._ApproverIdCardNumber = ApproverIdCardNumber
@property
def OrganizationName(self):
"""组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
def _deserialize(self, params):
self._ApproverType = params.get("ApproverType")
self._ApproverName = params.get("ApproverName")
self._ApproverMobile = params.get("ApproverMobile")
self._ApproverIdCardType = params.get("ApproverIdCardType")
self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
self._OrganizationName = params.get("OrganizationName")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OccupiedSeal(AbstractModel):
"""持有的电子印章信息
"""
def __init__(self):
r"""
:param _SealId: 电子印章编号
:type SealId: str
:param _SealName: 电子印章名称
:type SealName: str
:param _CreateOn: 电子印章授权时间戳，单位秒
:type CreateOn: int
:param _Creator: 电子印章授权人，电子签的UserId
:type Creator: str
:param _SealPolicyId: 电子印章策略Id
:type SealPolicyId: str
:param _SealStatus: 印章状态，有以下六种：CHECKING（审核中）SUCCESS（已启用）FAIL（审核拒绝）CHECKING-SADM（待超管审核）DISABLE（已停用）STOPPED（已终止）
:type SealStatus: str
:param _FailReason: 审核失败原因
:type FailReason: str
:param _Url: 印章图片url，5分钟内有效
:type Url: str
:param _SealType: 电子印章类型 , 可选类型如下:
<ul><li>**OFFICIAL**: (默认)公章</li>
<li>**CONTRACT**: 合同专用章;</li>
<li>**FINANCE**: 财务专用章;</li>
<li>**PERSONNEL**: 人事专用章</li>
<li>**INVOICE**: 发票专用章</li>
</ul>
:type SealType: str
:param _IsAllTime: 用印申请是否为永久授权
:type IsAllTime: bool
:param _AuthorizedUsers: 授权人列表
:type AuthorizedUsers: list of AuthorizedUser
"""
self._SealId = None
self._SealName = None
self._CreateOn = None
self._Creator = None
self._SealPolicyId = None
self._SealStatus = None
self._FailReason = None
self._Url = None
self._SealType = None
self._IsAllTime = None
self._AuthorizedUsers = None
@property
def SealId(self):
"""电子印章编号
:rtype: str
"""
return self._SealId
@SealId.setter
def SealId(self, SealId):
self._SealId = SealId
@property
def SealName(self):
"""电子印章名称
:rtype: str
"""
return self._SealName
@SealName.setter
def SealName(self, SealName):
self._SealName = SealName
@property
def CreateOn(self):
"""电子印章授权时间戳，单位秒
:rtype: int
"""
return self._CreateOn
@CreateOn.setter
def CreateOn(self, CreateOn):
self._CreateOn = CreateOn
@property
def Creator(self):
"""电子印章授权人，电子签的UserId
:rtype: str
"""
return self._Creator
@Creator.setter
def Creator(self, Creator):
self._Creator = Creator
@property
def SealPolicyId(self):
"""电子印章策略Id
:rtype: str
"""
return self._SealPolicyId
@SealPolicyId.setter
def SealPolicyId(self, SealPolicyId):
self._SealPolicyId = SealPolicyId
@property
def SealStatus(self):
"""印章状态，有以下六种：CHECKING（审核中）SUCCESS（已启用）FAIL（审核拒绝）CHECKING-SADM（待超管审核）DISABLE（已停用）STOPPED（已终止）
:rtype: str
"""
return self._SealStatus
@SealStatus.setter
def SealStatus(self, SealStatus):
self._SealStatus = SealStatus
@property
def FailReason(self):
"""审核失败原因
:rtype: str
"""
return self._FailReason
@FailReason.setter
def FailReason(self, FailReason):
self._FailReason = FailReason
@property
def Url(self):
"""印章图片url，5分钟内有效
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def SealType(self):
"""电子印章类型 , 可选类型如下:
<ul><li>**OFFICIAL**: (默认)公章</li>
<li>**CONTRACT**: 合同专用章;</li>
<li>**FINANCE**: 财务专用章;</li>
<li>**PERSONNEL**: 人事专用章</li>
<li>**INVOICE**: 发票专用章</li>
</ul>
:rtype: str
"""
return self._SealType
@SealType.setter
def SealType(self, SealType):
self._SealType = SealType
@property
def IsAllTime(self):
"""用印申请是否为永久授权
:rtype: bool
"""
return self._IsAllTime
@IsAllTime.setter
def IsAllTime(self, IsAllTime):
self._IsAllTime = IsAllTime
@property
def AuthorizedUsers(self):
"""授权人列表
:rtype: list of AuthorizedUser
"""
return self._AuthorizedUsers
@AuthorizedUsers.setter
def AuthorizedUsers(self, AuthorizedUsers):
self._AuthorizedUsers = AuthorizedUsers
def _deserialize(self, params):
self._SealId = params.get("SealId")
self._SealName = params.get("SealName")
self._CreateOn = params.get("CreateOn")
self._Creator = params.get("Creator")
self._SealPolicyId = params.get("SealPolicyId")
self._SealStatus = params.get("SealStatus")
self._FailReason = params.get("FailReason")
self._Url = params.get("Url")
self._SealType = params.get("SealType")
self._IsAllTime = params.get("IsAllTime")
if params.get("AuthorizedUsers") is not None:
self._AuthorizedUsers = []
for item in params.get("AuthorizedUsers"):
obj = AuthorizedUser()
obj._deserialize(item)
self._AuthorizedUsers.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OperateChannelTemplateRequest(AbstractModel):
"""OperateChannelTemplate请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _OperateType: 操作类型，可取值如下:
<ul>
<li>SELECT: 查询</li>
<li>DELETE: 删除</li>
<li>UPDATE: 更新</li>
</ul>
:type OperateType: str
:param _TemplateId: 合同模板ID，为32位字符串。
注: ` 此处为第三方应用平台模板库模板ID，非子客模板ID`
:type TemplateId: str
:param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识，支持批量(用,分割)，
:type ProxyOrganizationOpenIds: str
:param _AuthTag: 模板可见范围, 可以设置的值如下:
**all**: 所有本第三方应用合作企业可见
**part**: 指定的本第三方应用合作企业
对应控制台的位置
:type AuthTag: str
:param _Available: 当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。
<ul>
<li>0: 不修改模板可用状态</li>
<li>1: 启用模板</li>
<li>2: 停用模板</li>
</ul>
启用后模板可以正常领取。
停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
如果Available更新失败，会直接返回错误。
:type Available: int
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._OperateType = None
self._TemplateId = None
self._ProxyOrganizationOpenIds = None
self._AuthTag = None
self._Available = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def OperateType(self):
"""操作类型，可取值如下:
<ul>
<li>SELECT: 查询</li>
<li>DELETE: 删除</li>
<li>UPDATE: 更新</li>
</ul>
:rtype: str
"""
return self._OperateType
@OperateType.setter
def OperateType(self, OperateType):
self._OperateType = OperateType
@property
def TemplateId(self):
"""合同模板ID，为32位字符串。
注: ` 此处为第三方应用平台模板库模板ID，非子客模板ID`
:rtype: str
"""
return self._TemplateId
@TemplateId.setter
def TemplateId(self, TemplateId):
self._TemplateId = TemplateId
@property
def ProxyOrganizationOpenIds(self):
"""第三方平台子客企业的唯一标识，支持批量(用,分割)，
:rtype: str
"""
return self._ProxyOrganizationOpenIds
@ProxyOrganizationOpenIds.setter
def ProxyOrganizationOpenIds(self, ProxyOrganizationOpenIds):
self._ProxyOrganizationOpenIds = ProxyOrganizationOpenIds
@property
def AuthTag(self):
"""模板可见范围, 可以设置的值如下:
**all**: 所有本第三方应用合作企业可见
**part**: 指定的本第三方应用合作企业
对应控制台的位置
:rtype: str
"""
return self._AuthTag
@AuthTag.setter
def AuthTag(self, AuthTag):
self._AuthTag = AuthTag
@property
def Available(self):
"""当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。
<ul>
<li>0: 不修改模板可用状态</li>
<li>1: 启用模板</li>
<li>2: 停用模板</li>
</ul>
启用后模板可以正常领取。
停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
如果Available更新失败，会直接返回错误。
:rtype: int
"""
return self._Available
@Available.setter
def Available(self, Available):
self._Available = Available
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._OperateType = params.get("OperateType")
self._TemplateId = params.get("TemplateId")
self._ProxyOrganizationOpenIds = params.get("ProxyOrganizationOpenIds")
self._AuthTag = params.get("AuthTag")
self._Available = params.get("Available")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OperateChannelTemplateResponse(AbstractModel):
"""OperateChannelTemplate返回参数结构体
"""
def __init__(self):
r"""
:param _AppId: 第三方应用平台的应用ID
:type AppId: str
:param _TemplateId: 合同模板ID
:type TemplateId: str
:param _OperateResult: 描述模板可见性更改的结果。
<ul>
<li>all-success: 全部成功</li>
<li>part-success: 部分成功,失败的会在FailMessageList中展示</li>
<li>fail:全部失败, 失败的会在FailMessageList中展示</li>
</ul>
:type OperateResult: str
:param _AuthTag: 模板可见范围:
**all**: 所有本第三方应用合作企业可见
**part**: 指定的本第三方应用合作企业
:type AuthTag: str
:param _ProxyOrganizationOpenIds: 第三方平台子客企业标识列表
:type ProxyOrganizationOpenIds: list of str
:param _FailMessageList: 操作失败信息数组
:type FailMessageList: list of AuthFailMessage
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._AppId = None
self._TemplateId = None
self._OperateResult = None
self._AuthTag = None
self._ProxyOrganizationOpenIds = None
self._FailMessageList = None
self._RequestId = None
@property
def AppId(self):
"""第三方应用平台的应用ID
:rtype: str
"""
return self._AppId
@AppId.setter
def AppId(self, AppId):
self._AppId = AppId
@property
def TemplateId(self):
"""合同模板ID
:rtype: str
"""
return self._TemplateId
@TemplateId.setter
def TemplateId(self, TemplateId):
self._TemplateId = TemplateId
@property
def OperateResult(self):
"""描述模板可见性更改的结果。
<ul>
<li>all-success: 全部成功</li>
<li>part-success: 部分成功,失败的会在FailMessageList中展示</li>
<li>fail:全部失败, 失败的会在FailMessageList中展示</li>
</ul>
:rtype: str
"""
return self._OperateResult
@OperateResult.setter
def OperateResult(self, OperateResult):
self._OperateResult = OperateResult
@property
def AuthTag(self):
"""模板可见范围:
**all**: 所有本第三方应用合作企业可见
**part**: 指定的本第三方应用合作企业
:rtype: str
"""
return self._AuthTag
@AuthTag.setter
def AuthTag(self, AuthTag):
self._AuthTag = AuthTag
@property
def ProxyOrganizationOpenIds(self):
"""第三方平台子客企业标识列表
:rtype: list of str
"""
return self._ProxyOrganizationOpenIds
@ProxyOrganizationOpenIds.setter
def ProxyOrganizationOpenIds(self, ProxyOrganizationOpenIds):
self._ProxyOrganizationOpenIds = ProxyOrganizationOpenIds
@property
def FailMessageList(self):
"""操作失败信息数组
:rtype: list of AuthFailMessage
"""
return self._FailMessageList
@FailMessageList.setter
def FailMessageList(self, FailMessageList):
self._FailMessageList = FailMessageList
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._AppId = params.get("AppId")
self._TemplateId = params.get("TemplateId")
self._OperateResult = params.get("OperateResult")
self._AuthTag = params.get("AuthTag")
self._ProxyOrganizationOpenIds = params.get("ProxyOrganizationOpenIds")
if params.get("FailMessageList") is not None:
self._FailMessageList = []
for item in params.get("FailMessageList"):
obj = AuthFailMessage()
obj._deserialize(item)
self._FailMessageList.append(obj)
self._RequestId = params.get("RequestId")
class OrganizationAuthUrl(AbstractModel):
"""企业批量注册链接信息
"""
def __init__(self):
r"""
:param _AuthUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> </tbody> </table>
注：
`1.链接仅单次有效，每次登录需要需要重新创建新的链接`
`2.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
:type AuthUrl: str
:param _ErrorMessage: 企业批量注册的错误信息，例如：企业三要素不通过
:type ErrorMessage: str
"""
self._AuthUrl = None
self._ErrorMessage = None
@property
def AuthUrl(self):
"""跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/SHORT_URL/APP</td> <td>一年</td> </tr> </tbody> </table>
注：
`1.链接仅单次有效，每次登录需要需要重新创建新的链接`
`2.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
:rtype: str
"""
return self._AuthUrl
@AuthUrl.setter
def AuthUrl(self, AuthUrl):
self._AuthUrl = AuthUrl
@property
def ErrorMessage(self):
"""企业批量注册的错误信息，例如：企业三要素不通过
:rtype: str
"""
return self._ErrorMessage
@ErrorMessage.setter
def ErrorMessage(self, ErrorMessage):
self._ErrorMessage = ErrorMessage
def _deserialize(self, params):
self._AuthUrl = params.get("AuthUrl")
self._ErrorMessage = params.get("ErrorMessage")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OrganizationAuthorizationOptions(AbstractModel):
"""企业认证可选项，其中包括 社会信用代码是否一致，企业名称是否一致，法人是否一致等信息。
代表生成链接的时候指定的这些信息不能被用户修改。
p.s. 注意这些选项一旦传递，相关的信息也不会被上传的营业执照里面包含的信息所覆盖。
"""
def __init__(self):
r"""
:param _UniformSocialCreditCodeSame: 对方打开链接认证时，对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
:type UniformSocialCreditCodeSame: bool
:param _OrganizationNameSame: 对方打开链接认证时，企业名称是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>p.s. 仅在企业名称不为空时有效
:type OrganizationNameSame: bool
:param _LegalNameSame: 对方打开链接认证时，法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>p.s. 仅在法人姓名不为空时有效
:type LegalNameSame: bool
"""
self._UniformSocialCreditCodeSame = None
self._OrganizationNameSame = None
self._LegalNameSame = None
@property
def UniformSocialCreditCodeSame(self):
"""对方打开链接认证时，对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>
:rtype: bool
"""
return self._UniformSocialCreditCodeSame
@UniformSocialCreditCodeSame.setter
def UniformSocialCreditCodeSame(self, UniformSocialCreditCodeSame):
self._UniformSocialCreditCodeSame = UniformSocialCreditCodeSame
@property
def OrganizationNameSame(self):
"""对方打开链接认证时，企业名称是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>p.s. 仅在企业名称不为空时有效
:rtype: bool
"""
return self._OrganizationNameSame
@OrganizationNameSame.setter
def OrganizationNameSame(self, OrganizationNameSame):
self._OrganizationNameSame = OrganizationNameSame
@property
def LegalNameSame(self):
"""对方打开链接认证时，法人姓名是否要与接口传递上来的保持一致。<ul><li><b>false（默认值）</b>：关闭状态，实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>：启用状态，实际认证时必须与接口传递的信息完全相符。</li></ul>p.s. 仅在法人姓名不为空时有效
:rtype: bool
"""
return self._LegalNameSame
@LegalNameSame.setter
def LegalNameSame(self, LegalNameSame):
self._LegalNameSame = LegalNameSame
def _deserialize(self, params):
self._UniformSocialCreditCodeSame = params.get("UniformSocialCreditCodeSame")
self._OrganizationNameSame = params.get("OrganizationNameSame")
self._LegalNameSame = params.get("LegalNameSame")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OrganizationCommonInfo(AbstractModel):
"""企业认证信息参数， 需要保证这些参数跟营业执照中的信息一致。
"""
def __init__(self):
r"""
:param _OrganizationName: 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
:type OrganizationName: str
:param _UniformSocialCreditCode: 组织机构企业统一社会信用代码。
请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
:type UniformSocialCreditCode: str
:param _LegalName: 组织机构法人的姓名。
请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
:type LegalName: str
:param _LegalIdCardType: 组织机构法人的证件类型
:type LegalIdCardType: str
:param _LegalIdCardNumber: 组织机构法人的证件号码
:type LegalIdCardNumber: str
:param _AdminName: 组织机构超管姓名。
:type AdminName: str
:param _AdminMobile: 组织机构超管手机号。
:type AdminMobile: str
:param _AdminIdCardType: 组织机构超管证件类型
:type AdminIdCardType: str
:param _AdminIdCardNumber: 组织机构超管证件号码
:type AdminIdCardNumber: str
:param _OldAdminName: 原超管姓名
:type OldAdminName: str
:param _OldAdminMobile: 原超管手机号
:type OldAdminMobile: str
:param _OldAdminIdCardType: 原超管证件类型
:type OldAdminIdCardType: str
:param _OldAdminIdCardNumber: 原超管证件号码
:type OldAdminIdCardNumber: str
"""
self._OrganizationName = None
self._UniformSocialCreditCode = None
self._LegalName = None
self._LegalIdCardType = None
self._LegalIdCardNumber = None
self._AdminName = None
self._AdminMobile = None
self._AdminIdCardType = None
self._AdminIdCardNumber = None
self._OldAdminName = None
self._OldAdminMobile = None
self._OldAdminIdCardType = None
self._OldAdminIdCardNumber = None
@property
def OrganizationName(self):
"""组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def UniformSocialCreditCode(self):
"""组织机构企业统一社会信用代码。
请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
:rtype: str
"""
return self._UniformSocialCreditCode
@UniformSocialCreditCode.setter
def UniformSocialCreditCode(self, UniformSocialCreditCode):
self._UniformSocialCreditCode = UniformSocialCreditCode
@property
def LegalName(self):
"""组织机构法人的姓名。
请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
:rtype: str
"""
return self._LegalName
@LegalName.setter
def LegalName(self, LegalName):
self._LegalName = LegalName
@property
def LegalIdCardType(self):
"""组织机构法人的证件类型
:rtype: str
"""
return self._LegalIdCardType
@LegalIdCardType.setter
def LegalIdCardType(self, LegalIdCardType):
self._LegalIdCardType = LegalIdCardType
@property
def LegalIdCardNumber(self):
"""组织机构法人的证件号码
:rtype: str
"""
return self._LegalIdCardNumber
@LegalIdCardNumber.setter
def LegalIdCardNumber(self, LegalIdCardNumber):
self._LegalIdCardNumber = LegalIdCardNumber
@property
def AdminName(self):
"""组织机构超管姓名。
:rtype: str
"""
return self._AdminName
@AdminName.setter
def AdminName(self, AdminName):
self._AdminName = AdminName
@property
def AdminMobile(self):
"""组织机构超管手机号。
:rtype: str
"""
return self._AdminMobile
@AdminMobile.setter
def AdminMobile(self, AdminMobile):
self._AdminMobile = AdminMobile
@property
def AdminIdCardType(self):
"""组织机构超管证件类型
:rtype: str
"""
return self._AdminIdCardType
@AdminIdCardType.setter
def AdminIdCardType(self, AdminIdCardType):
self._AdminIdCardType = AdminIdCardType
@property
def AdminIdCardNumber(self):
"""组织机构超管证件号码
:rtype: str
"""
return self._AdminIdCardNumber
@AdminIdCardNumber.setter
def AdminIdCardNumber(self, AdminIdCardNumber):
self._AdminIdCardNumber = AdminIdCardNumber
@property
def OldAdminName(self):
"""原超管姓名
:rtype: str
"""
return self._OldAdminName
@OldAdminName.setter
def OldAdminName(self, OldAdminName):
self._OldAdminName = OldAdminName
@property
def OldAdminMobile(self):
"""原超管手机号
:rtype: str
"""
return self._OldAdminMobile
@OldAdminMobile.setter
def OldAdminMobile(self, OldAdminMobile):
self._OldAdminMobile = OldAdminMobile
@property
def OldAdminIdCardType(self):
"""原超管证件类型
:rtype: str
"""
return self._OldAdminIdCardType
@OldAdminIdCardType.setter
def OldAdminIdCardType(self, OldAdminIdCardType):
self._OldAdminIdCardType = OldAdminIdCardType
@property
def OldAdminIdCardNumber(self):
"""原超管证件号码
:rtype: str
"""
return self._OldAdminIdCardNumber
@OldAdminIdCardNumber.setter
def OldAdminIdCardNumber(self, OldAdminIdCardNumber):
self._OldAdminIdCardNumber = OldAdminIdCardNumber
def _deserialize(self, params):
self._OrganizationName = params.get("OrganizationName")
self._UniformSocialCreditCode = params.get("UniformSocialCreditCode")
self._LegalName = params.get("LegalName")
self._LegalIdCardType = params.get("LegalIdCardType")
self._LegalIdCardNumber = params.get("LegalIdCardNumber")
self._AdminName = params.get("AdminName")
self._AdminMobile = params.get("AdminMobile")
self._AdminIdCardType = params.get("AdminIdCardType")
self._AdminIdCardNumber = params.get("AdminIdCardNumber")
self._OldAdminName = params.get("OldAdminName")
self._OldAdminMobile = params.get("OldAdminMobile")
self._OldAdminIdCardType = params.get("OldAdminIdCardType")
self._OldAdminIdCardNumber = params.get("OldAdminIdCardNumber")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OrganizationInfo(AbstractModel):
"""机构信息
"""
def __init__(self):
r"""
:param _OrganizationOpenId: 用户在渠道的机构编号
:type OrganizationOpenId: str
:param _OrganizationId: 机构在平台的编号
:type OrganizationId: str
:param _Channel: 用户渠道
:type Channel: str
:param _ClientIp: 用户真实的IP
:type ClientIp: str
:param _ProxyIp: 机构的代理IP
:type ProxyIp: str
"""
self._OrganizationOpenId = None
self._OrganizationId = None
self._Channel = None
self._ClientIp = None
self._ProxyIp = None
@property
def OrganizationOpenId(self):
"""用户在渠道的机构编号
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OrganizationId(self):
"""机构在平台的编号
:rtype: str
"""
return self._OrganizationId
@OrganizationId.setter
def OrganizationId(self, OrganizationId):
self._OrganizationId = OrganizationId
@property
def Channel(self):
"""用户渠道
:rtype: str
"""
return self._Channel
@Channel.setter
def Channel(self, Channel):
self._Channel = Channel
@property
def ClientIp(self):
warnings.warn("parameter `ClientIp` is deprecated", DeprecationWarning)
"""用户真实的IP
:rtype: str
"""
return self._ClientIp
@ClientIp.setter
def ClientIp(self, ClientIp):
warnings.warn("parameter `ClientIp` is deprecated", DeprecationWarning)
self._ClientIp = ClientIp
@property
def ProxyIp(self):
warnings.warn("parameter `ProxyIp` is deprecated", DeprecationWarning)
"""机构的代理IP
:rtype: str
"""
return self._ProxyIp
@ProxyIp.setter
def ProxyIp(self, ProxyIp):
warnings.warn("parameter `ProxyIp` is deprecated", DeprecationWarning)
self._ProxyIp = ProxyIp
def _deserialize(self, params):
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OrganizationId = params.get("OrganizationId")
self._Channel = params.get("Channel")
self._ClientIp = params.get("ClientIp")
self._ProxyIp = params.get("ProxyIp")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class PdfVerifyResult(AbstractModel):
"""合同验签每个签署区的信息
"""
def __init__(self):
r"""
:param _VerifyResult: 验签结果详情，每个签名域对应的验签结果。状态值如下
<ul><li> **1** :验签成功，在电子签签署</li>
<li> **2** :验签成功，在其他平台签署</li>
<li> **3** :验签失败</li>
<li> **4** :pdf文件没有签名域</li>
<li> **5** :文件签名格式错误</li></ul>
:type VerifyResult: int
:param _SignPlatform: 签署平台
如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
如果文件不在腾讯电子签平台签署，则为**其他平台**。
:type SignPlatform: str
:param _SignerName: 申请证书的主体的名字
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
**企业**: ESS@企业名称@平台生成的数字编码
**个人**: ESS@个人姓名@证件号@平台生成的数字编码
如果在其他平台签署的, 主体的名字参考其他平台的说明
:type SignerName: str
:param _SignTime: 签署时间的Unix时间戳，单位毫秒
:type SignTime: int
:param _SignAlgorithm: 证书签名算法, 如SHA1withRSA等算法
:type SignAlgorithm: str
:param _CertSn: 在数字证书申请过程中，系统会自动生成一个独一无二的序列号。
:type CertSn: str
:param _CertNotBefore: 证书起始时间的Unix时间戳，单位毫秒
:type CertNotBefore: int
:param _CertNotAfter: 证书过期时间的时间戳，单位毫秒
:type CertNotAfter: int
:param _SignType: 签名类型, 保留字段, 现在全部为0
:type SignType: int
:param _ComponentPosX: 签名域横坐标，单位px
:type ComponentPosX: float
:param _ComponentPosY: 签名域纵坐标，单位px
:type ComponentPosY: float
:param _ComponentWidth: 签名域宽度，单位px
:type ComponentWidth: float
:param _ComponentHeight: 签名域高度，单位px
:type ComponentHeight: float
:param _ComponentPage: 签名域所在页码，1～N
:type ComponentPage: int
"""
self._VerifyResult = None
self._SignPlatform = None
self._SignerName = None
self._SignTime = None
self._SignAlgorithm = None
self._CertSn = None
self._CertNotBefore = None
self._CertNotAfter = None
self._SignType = None
self._ComponentPosX = None
self._ComponentPosY = None
self._ComponentWidth = None
self._ComponentHeight = None
self._ComponentPage = None
@property
def VerifyResult(self):
"""验签结果详情，每个签名域对应的验签结果。状态值如下
<ul><li> **1** :验签成功，在电子签签署</li>
<li> **2** :验签成功，在其他平台签署</li>
<li> **3** :验签失败</li>
<li> **4** :pdf文件没有签名域</li>
<li> **5** :文件签名格式错误</li></ul>
:rtype: int
"""
return self._VerifyResult
@VerifyResult.setter
def VerifyResult(self, VerifyResult):
self._VerifyResult = VerifyResult
@property
def SignPlatform(self):
"""签署平台
如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
如果文件不在腾讯电子签平台签署，则为**其他平台**。
:rtype: str
"""
return self._SignPlatform
@SignPlatform.setter
def SignPlatform(self, SignPlatform):
self._SignPlatform = SignPlatform
@property
def SignerName(self):
"""申请证书的主体的名字
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
**企业**: ESS@企业名称@平台生成的数字编码
**个人**: ESS@个人姓名@证件号@平台生成的数字编码
如果在其他平台签署的, 主体的名字参考其他平台的说明
:rtype: str
"""
return self._SignerName
@SignerName.setter
def SignerName(self, SignerName):
self._SignerName = SignerName
@property
def SignTime(self):
"""签署时间的Unix时间戳，单位毫秒
:rtype: int
"""
return self._SignTime
@SignTime.setter
def SignTime(self, SignTime):
self._SignTime = SignTime
@property
def SignAlgorithm(self):
"""证书签名算法, 如SHA1withRSA等算法
:rtype: str
"""
return self._SignAlgorithm
@SignAlgorithm.setter
def SignAlgorithm(self, SignAlgorithm):
self._SignAlgorithm = SignAlgorithm
@property
def CertSn(self):
"""在数字证书申请过程中，系统会自动生成一个独一无二的序列号。
:rtype: str
"""
return self._CertSn
@CertSn.setter
def CertSn(self, CertSn):
self._CertSn = CertSn
@property
def CertNotBefore(self):
"""证书起始时间的Unix时间戳，单位毫秒
:rtype: int
"""
return self._CertNotBefore
@CertNotBefore.setter
def CertNotBefore(self, CertNotBefore):
self._CertNotBefore = CertNotBefore
@property
def CertNotAfter(self):
"""证书过期时间的时间戳，单位毫秒
:rtype: int
"""
return self._CertNotAfter
@CertNotAfter.setter
def CertNotAfter(self, CertNotAfter):
self._CertNotAfter = CertNotAfter
@property
def SignType(self):
"""签名类型, 保留字段, 现在全部为0
:rtype: int
"""
return self._SignType
@SignType.setter
def SignType(self, SignType):
self._SignType = SignType
@property
def ComponentPosX(self):
"""签名域横坐标，单位px
:rtype: float
"""
return self._ComponentPosX
@ComponentPosX.setter
def ComponentPosX(self, ComponentPosX):
self._ComponentPosX = ComponentPosX
@property
def ComponentPosY(self):
"""签名域纵坐标，单位px
:rtype: float
"""
return self._ComponentPosY
@ComponentPosY.setter
def ComponentPosY(self, ComponentPosY):
self._ComponentPosY = ComponentPosY
@property
def ComponentWidth(self):
"""签名域宽度，单位px
:rtype: float
"""
return self._ComponentWidth
@ComponentWidth.setter
def ComponentWidth(self, ComponentWidth):
self._ComponentWidth = ComponentWidth
@property
def ComponentHeight(self):
"""签名域高度，单位px
:rtype: float
"""
return self._ComponentHeight
@ComponentHeight.setter
def ComponentHeight(self, ComponentHeight):
self._ComponentHeight = ComponentHeight
@property
def ComponentPage(self):
"""签名域所在页码，1～N
:rtype: int
"""
return self._ComponentPage
@ComponentPage.setter
def ComponentPage(self, ComponentPage):
self._ComponentPage = ComponentPage
def _deserialize(self, params):
self._VerifyResult = params.get("VerifyResult")
self._SignPlatform = params.get("SignPlatform")
self._SignerName = params.get("SignerName")
self._SignTime = params.get("SignTime")
self._SignAlgorithm = params.get("SignAlgorithm")
self._CertSn = params.get("CertSn")
self._CertNotBefore = params.get("CertNotBefore")
self._CertNotAfter = params.get("CertNotAfter")
self._SignType = params.get("SignType")
self._ComponentPosX = params.get("ComponentPosX")
self._ComponentPosY = params.get("ComponentPosY")
self._ComponentWidth = params.get("ComponentWidth")
self._ComponentHeight = params.get("ComponentHeight")
self._ComponentPage = params.get("ComponentPage")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Permission(AbstractModel):
"""权限树节点权限
"""
def __init__(self):
r"""
:param _Name: 权限名称
:type Name: str
:param _Key: 权限key
:type Key: str
:param _Type: 权限类型 1前端，2后端
:type Type: int
:param _Hide: 是否隐藏
:type Hide: int
:param _DataLabel: 数据权限标签 1:表示根节点，2:表示叶子结点
:type DataLabel: int
:param _DataType: 数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权
:type DataType: int
:param _DataRange: 数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己
:type DataRange: int
:param _DataTo: 关联权限, 表示这个功能权限要受哪个数据权限管控
:type DataTo: str
:param _ParentKey: 父级权限key
:type ParentKey: str
:param _IsChecked: 是否选中
:type IsChecked: bool
:param _Children: 子权限集合
:type Children: list of Permission
"""
self._Name = None
self._Key = None
self._Type = None
self._Hide = None
self._DataLabel = None
self._DataType = None
self._DataRange = None
self._DataTo = None
self._ParentKey = None
self._IsChecked = None
self._Children = None
@property
def Name(self):
"""权限名称
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Key(self):
"""权限key
:rtype: str
"""
return self._Key
@Key.setter
def Key(self, Key):
self._Key = Key
@property
def Type(self):
"""权限类型 1前端，2后端
:rtype: int
"""
return self._Type
@Type.setter
def Type(self, Type):
self._Type = Type
@property
def Hide(self):
"""是否隐藏
:rtype: int
"""
return self._Hide
@Hide.setter
def Hide(self, Hide):
self._Hide = Hide
@property
def DataLabel(self):
"""数据权限标签 1:表示根节点，2:表示叶子结点
:rtype: int
"""
return self._DataLabel
@DataLabel.setter
def DataLabel(self, DataLabel):
self._DataLabel = DataLabel
@property
def DataType(self):
"""数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权
:rtype: int
"""
return self._DataType
@DataType.setter
def DataType(self, DataType):
self._DataType = DataType
@property
def DataRange(self):
"""数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己
:rtype: int
"""
return self._DataRange
@DataRange.setter
def DataRange(self, DataRange):
self._DataRange = DataRange
@property
def DataTo(self):
"""关联权限, 表示这个功能权限要受哪个数据权限管控
:rtype: str
"""
return self._DataTo
@DataTo.setter
def DataTo(self, DataTo):
self._DataTo = DataTo
@property
def ParentKey(self):
"""父级权限key
:rtype: str
"""
return self._ParentKey
@ParentKey.setter
def ParentKey(self, ParentKey):
self._ParentKey = ParentKey
@property
def IsChecked(self):
"""是否选中
:rtype: bool
"""
return self._IsChecked
@IsChecked.setter
def IsChecked(self, IsChecked):
self._IsChecked = IsChecked
@property
def Children(self):
"""子权限集合
:rtype: list of Permission
"""
return self._Children
@Children.setter
def Children(self, Children):
self._Children = Children
def _deserialize(self, params):
self._Name = params.get("Name")
self._Key = params.get("Key")
self._Type = params.get("Type")
self._Hide = params.get("Hide")
self._DataLabel = params.get("DataLabel")
self._DataType = params.get("DataType")
self._DataRange = params.get("DataRange")
self._DataTo = params.get("DataTo")
self._ParentKey = params.get("ParentKey")
self._IsChecked = params.get("IsChecked")
if params.get("Children") is not None:
self._Children = []
for item in params.get("Children"):
obj = Permission()
obj._deserialize(item)
self._Children.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class PermissionGroup(AbstractModel):
"""权限树中的权限组
"""
def __init__(self):
r"""
:param _GroupName: 权限组名称
:type GroupName: str
:param _GroupKey: 权限组key
:type GroupKey: str
:param _Hide: 是否隐藏分组，0否1是
:type Hide: int
:param _Permissions: 权限集合
:type Permissions: list of Permission
"""
self._GroupName = None
self._GroupKey = None
self._Hide = None
self._Permissions = None
@property
def GroupName(self):
"""权限组名称
:rtype: str
"""
return self._GroupName
@GroupName.setter
def GroupName(self, GroupName):
self._GroupName = GroupName
@property
def GroupKey(self):
"""权限组key
:rtype: str
"""
return self._GroupKey
@GroupKey.setter
def GroupKey(self, GroupKey):
self._GroupKey = GroupKey
@property
def Hide(self):
"""是否隐藏分组，0否1是
:rtype: int
"""
return self._Hide
@Hide.setter
def Hide(self, Hide):
self._Hide = Hide
@property
def Permissions(self):
"""权限集合
:rtype: list of Permission
"""
return self._Permissions
@Permissions.setter
def Permissions(self, Permissions):
self._Permissions = Permissions
def _deserialize(self, params):
self._GroupName = params.get("GroupName")
self._GroupKey = params.get("GroupKey")
self._Hide = params.get("Hide")
if params.get("Permissions") is not None:
self._Permissions = []
for item in params.get("Permissions"):
obj = Permission()
obj._deserialize(item)
self._Permissions.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class PrepareFlowsRequest(AbstractModel):
"""PrepareFlows请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _FlowInfos: 多个合同（签署流程）信息，最大支持20个签署流程。
:type FlowInfos: list of FlowInfo
:param _JumpUrl: 操作完成后的跳转地址，最大长度200
:type JumpUrl: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._FlowInfos = None
self._JumpUrl = None
self._Operator = None
@property
def Agent(self):
"""应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def FlowInfos(self):
"""多个合同（签署流程）信息，最大支持20个签署流程。
:rtype: list of FlowInfo
"""
return self._FlowInfos
@FlowInfos.setter
def FlowInfos(self, FlowInfos):
self._FlowInfos = FlowInfos
@property
def JumpUrl(self):
"""操作完成后的跳转地址，最大长度200
:rtype: str
"""
return self._JumpUrl
@JumpUrl.setter
def JumpUrl(self, JumpUrl):
self._JumpUrl = JumpUrl
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
if params.get("FlowInfos") is not None:
self._FlowInfos = []
for item in params.get("FlowInfos"):
obj = FlowInfo()
obj._deserialize(item)
self._FlowInfos.append(obj)
self._JumpUrl = params.get("JumpUrl")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class PrepareFlowsResponse(AbstractModel):
"""PrepareFlows返回参数结构体
"""
def __init__(self):
r"""
:param _ConfirmUrl: 待发起文件确认页
:type ConfirmUrl: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._ConfirmUrl = None
self._RequestId = None
@property
def ConfirmUrl(self):
"""待发起文件确认页
:rtype: str
"""
return self._ConfirmUrl
@ConfirmUrl.setter
def ConfirmUrl(self, ConfirmUrl):
self._ConfirmUrl = ConfirmUrl
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._ConfirmUrl = params.get("ConfirmUrl")
self._RequestId = params.get("RequestId")
class ProxyOrganizationOperator(AbstractModel):
"""同步的员工的信息
"""
def __init__(self):
r"""
:param _Id: 员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
:type Id: str
:param _Name: 员工的姓名，最大长度50个字符
员工的姓名将用于身份认证和电子签名，请确保填写的姓名为真实姓名，而非昵称等代名。
:type Name: str
:param _IdCardType: 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:type IdCardType: str
:param _IdCardNumber: 经办人证件号
:type IdCardNumber: str
:param _Mobile: 员工的手机号，支持国内手机号11位数字(无需加+86前缀或其他字符)，不支持海外手机号。
:type Mobile: str
:param _DefaultRole: 预先分配员工的角色, 可以分配的角色如下:
<table> <thead> <tr> <th>可以分配的角色</th> <th>角色名称</th> <th>角色描述</th> </tr> </thead> <tbody> <tr> <td>admin</td> <td>业务管理员（IT 系统负责人，e.g. CTO）</td> <td>有企业合同模块、印章模块、模板模块等全量功能及数据权限。</td> </tr> <tr> <td>channel-normal-operator</td> <td>经办人（企业法务负责人）</td> <td>有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。</td> </tr> <tr> <td>channel-sales-man</td> <td>业务员（一般为销售员、采购员）</td> <td>有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。</td> </tr> </tbody> </table>
:type DefaultRole: str
"""
self._Id = None
self._Name = None
self._IdCardType = None
self._IdCardNumber = None
self._Mobile = None
self._DefaultRole = None
@property
def Id(self):
"""员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
:rtype: str
"""
return self._Id
@Id.setter
def Id(self, Id):
self._Id = Id
@property
def Name(self):
"""员工的姓名，最大长度50个字符
员工的姓名将用于身份认证和电子签名，请确保填写的姓名为真实姓名，而非昵称等代名。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def IdCardType(self):
"""签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""经办人证件号
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def Mobile(self):
"""员工的手机号，支持国内手机号11位数字(无需加+86前缀或其他字符)，不支持海外手机号。
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def DefaultRole(self):
"""预先分配员工的角色, 可以分配的角色如下:
<table> <thead> <tr> <th>可以分配的角色</th> <th>角色名称</th> <th>角色描述</th> </tr> </thead> <tbody> <tr> <td>admin</td> <td>业务管理员（IT 系统负责人，e.g. CTO）</td> <td>有企业合同模块、印章模块、模板模块等全量功能及数据权限。</td> </tr> <tr> <td>channel-normal-operator</td> <td>经办人（企业法务负责人）</td> <td>有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。</td> </tr> <tr> <td>channel-sales-man</td> <td>业务员（一般为销售员、采购员）</td> <td>有发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。</td> </tr> </tbody> </table>
:rtype: str
"""
return self._DefaultRole
@DefaultRole.setter
def DefaultRole(self, DefaultRole):
self._DefaultRole = DefaultRole
def _deserialize(self, params):
self._Id = params.get("Id")
self._Name = params.get("Name")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
self._Mobile = params.get("Mobile")
self._DefaultRole = params.get("DefaultRole")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Recipient(AbstractModel):
"""流程中签署方和填写方(如果有填写控件存证时)的信息
"""
def __init__(self):
r"""
:param _RecipientId: 合同参与方的角色ID
:type RecipientId: str
:param _RecipientType: 参与者类型, 可以选择的类型如下:
<ul><li> **ENTERPRISE** :此角色为企业参与方</li>
<li> **INDIVIDUAL** :此角色为个人参与方</li>
<li> **PROMOTER** :此角色是发起方</li></ul>
:type RecipientType: str
:param _Description: 合同参与方的角色描述，长度不能超过100，只能由中文、字母、数字和下划线组成。
:type Description: str
:param _RoleName: 合同参与方的角色名字，长度不能超过20，只能由中文、字母、数字和下划线组成。
:type RoleName: str
:param _RequireValidation: 是否需要校验，
true-是，
false-否
:type RequireValidation: bool
:param _RequireSign: 是否必须填写，
true-是，
false-否
:type RequireSign: bool
:param _SignType: 内部字段，签署类型
:type SignType: int
:param _RoutingOrder: 签署顺序：数字越小优先级越高
:type RoutingOrder: int
:param _IsPromoter: 是否是发起方，
true-是
false-否
:type IsPromoter: bool
:param _ApproverVerifyTypes: 签署人查看合同校验方式, 支持的类型如下:
<ul><li> 1 :实名认证查看</li>
<li> 2 :手机号校验查看</li></ul>
:type ApproverVerifyTypes: list of int
:param _ApproverSignTypes: 签署人进行合同签署时的认证方式，支持的类型如下:
<ul><li> 1 :人脸认证</li>
<li> 2 :签署密码</li>
<li> 3 :运营商三要素认证</li>
<li> 4 :UKey认证</li>
<li> 5 :设备指纹识别</li>
<li> 6 :设备面容识别</li></ul>
:type ApproverSignTypes: list of int
:param _NoTransfer: 签署方是否可以转他人处理
<ul><li> **false** : ( 默认)可以转他人处理</li>
<li> **true** :不可以转他人处理</li></ul>
:type NoTransfer: bool
"""
self._RecipientId = None
self._RecipientType = None
self._Description = None
self._RoleName = None
self._RequireValidation = None
self._RequireSign = None
self._SignType = None
self._RoutingOrder = None
self._IsPromoter = None
self._ApproverVerifyTypes = None
self._ApproverSignTypes = None
self._NoTransfer = None
@property
def RecipientId(self):
"""合同参与方的角色ID
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def RecipientType(self):
"""参与者类型, 可以选择的类型如下:
<ul><li> **ENTERPRISE** :此角色为企业参与方</li>
<li> **INDIVIDUAL** :此角色为个人参与方</li>
<li> **PROMOTER** :此角色是发起方</li></ul>
:rtype: str
"""
return self._RecipientType
@RecipientType.setter
def RecipientType(self, RecipientType):
self._RecipientType = RecipientType
@property
def Description(self):
"""合同参与方的角色描述，长度不能超过100，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._Description
@Description.setter
def Description(self, Description):
self._Description = Description
@property
def RoleName(self):
"""合同参与方的角色名字，长度不能超过20，只能由中文、字母、数字和下划线组成。
:rtype: str
"""
return self._RoleName
@RoleName.setter
def RoleName(self, RoleName):
self._RoleName = RoleName
@property
def RequireValidation(self):
"""是否需要校验，
true-是，
false-否
:rtype: bool
"""
return self._RequireValidation
@RequireValidation.setter
def RequireValidation(self, RequireValidation):
self._RequireValidation = RequireValidation
@property
def RequireSign(self):
"""是否必须填写，
true-是，
false-否
:rtype: bool
"""
return self._RequireSign
@RequireSign.setter
def RequireSign(self, RequireSign):
self._RequireSign = RequireSign
@property
def SignType(self):
"""内部字段，签署类型
:rtype: int
"""
return self._SignType
@SignType.setter
def SignType(self, SignType):
self._SignType = SignType
@property
def RoutingOrder(self):
"""签署顺序：数字越小优先级越高
:rtype: int
"""
return self._RoutingOrder
@RoutingOrder.setter
def RoutingOrder(self, RoutingOrder):
self._RoutingOrder = RoutingOrder
@property
def IsPromoter(self):
"""是否是发起方，
true-是
false-否
:rtype: bool
"""
return self._IsPromoter
@IsPromoter.setter
def IsPromoter(self, IsPromoter):
self._IsPromoter = IsPromoter
@property
def ApproverVerifyTypes(self):
"""签署人查看合同校验方式, 支持的类型如下:
<ul><li> 1 :实名认证查看</li>
<li> 2 :手机号校验查看</li></ul>
:rtype: list of int
"""
return self._ApproverVerifyTypes
@ApproverVerifyTypes.setter
def ApproverVerifyTypes(self, ApproverVerifyTypes):
self._ApproverVerifyTypes = ApproverVerifyTypes
@property
def ApproverSignTypes(self):
"""签署人进行合同签署时的认证方式，支持的类型如下:
<ul><li> 1 :人脸认证</li>
<li> 2 :签署密码</li>
<li> 3 :运营商三要素认证</li>
<li> 4 :UKey认证</li>
<li> 5 :设备指纹识别</li>
<li> 6 :设备面容识别</li></ul>
:rtype: list of int
"""
return self._ApproverSignTypes
@ApproverSignTypes.setter
def ApproverSignTypes(self, ApproverSignTypes):
self._ApproverSignTypes = ApproverSignTypes
@property
def NoTransfer(self):
"""签署方是否可以转他人处理
<ul><li> **false** : ( 默认)可以转他人处理</li>
<li> **true** :不可以转他人处理</li></ul>
:rtype: bool
"""
return self._NoTransfer
@NoTransfer.setter
def NoTransfer(self, NoTransfer):
self._NoTransfer = NoTransfer
def _deserialize(self, params):
self._RecipientId = params.get("RecipientId")
self._RecipientType = params.get("RecipientType")
self._Description = params.get("Description")
self._RoleName = params.get("RoleName")
self._RequireValidation = params.get("RequireValidation")
self._RequireSign = params.get("RequireSign")
self._SignType = params.get("SignType")
self._RoutingOrder = params.get("RoutingOrder")
self._IsPromoter = params.get("IsPromoter")
self._ApproverVerifyTypes = params.get("ApproverVerifyTypes")
self._ApproverSignTypes = params.get("ApproverSignTypes")
self._NoTransfer = params.get("NoTransfer")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class RecipientComponentInfo(AbstractModel):
"""参与方填写控件信息
"""
def __init__(self):
r"""
:param _RecipientId: 参与方的角色ID
:type RecipientId: str
:param _RecipientFillStatus: 参与方填写状态
<ul><li> **0** : 还没有填写</li>
<li> **1** : 已经填写</li></ul>
:type RecipientFillStatus: str
:param _IsPromoter: 此角色是否是发起方角色
<ul><li> **true** : 是发起方角色</li>
<li> **false** : 不是发起方角色</li></ul>
:type IsPromoter: bool
:param _Components: 此角色的填写控件列表
:type Components: list of FilledComponent
"""
self._RecipientId = None
self._RecipientFillStatus = None
self._IsPromoter = None
self._Components = None
@property
def RecipientId(self):
"""参与方的角色ID
:rtype: str
"""
return self._RecipientId
@RecipientId.setter
def RecipientId(self, RecipientId):
self._RecipientId = RecipientId
@property
def RecipientFillStatus(self):
"""参与方填写状态
<ul><li> **0** : 还没有填写</li>
<li> **1** : 已经填写</li></ul>
:rtype: str
"""
return self._RecipientFillStatus
@RecipientFillStatus.setter
def RecipientFillStatus(self, RecipientFillStatus):
self._RecipientFillStatus = RecipientFillStatus
@property
def IsPromoter(self):
"""此角色是否是发起方角色
<ul><li> **true** : 是发起方角色</li>
<li> **false** : 不是发起方角色</li></ul>
:rtype: bool
"""
return self._IsPromoter
@IsPromoter.setter
def IsPromoter(self, IsPromoter):
self._IsPromoter = IsPromoter
@property
def Components(self):
"""此角色的填写控件列表
:rtype: list of FilledComponent
"""
return self._Components
@Components.setter
def Components(self, Components):
self._Components = Components
def _deserialize(self, params):
self._RecipientId = params.get("RecipientId")
self._RecipientFillStatus = params.get("RecipientFillStatus")
self._IsPromoter = params.get("IsPromoter")
if params.get("Components") is not None:
self._Components = []
for item in params.get("Components"):
obj = FilledComponent()
obj._deserialize(item)
self._Components.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class RegistrationOrganizationInfo(AbstractModel):
"""企业认证信息参数， 需要保证这些参数跟营业执照中的信息一致。
"""
def __init__(self):
r"""
:param _OrganizationName: 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
:type OrganizationName: str
:param _OrganizationOpenId: 机构在贵司业务系统中的唯一标识，用于与腾讯电子签企业账号进行映射，确保在同一应用内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
:type OrganizationOpenId: str
:param _OpenId: 员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一应用内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
:type OpenId: str
:param _UniformSocialCreditCode: 组织机构企业统一社会信用代码。
请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
:type UniformSocialCreditCode: str
:param _LegalName: 组织机构法人的姓名。
请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
:type LegalName: str
:param _Address: 组织机构企业注册地址。
请确认该企业注册地址与企业营业执照中注册的地址一致。
:type Address: str
:param _AdminName: 组织机构超管姓名。
在注册流程中，必须是超管本人进行操作。
如果法人作为超管管理组织机构,超管姓名就是法人姓名
:type AdminName: str
:param _AdminMobile: 组织机构超管手机号。
在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。
:type AdminMobile: str
:param _AuthorizationTypes: 可选的此企业允许的授权方式, 可以设置的方式有:
1：上传授权书
2：法人授权超管
5：授权书+对公打款
注:
`1. 当前仅支持一种认证方式`
`2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
`3. 如果当前操作人是法人,则是法人认证`
:type AuthorizationTypes: list of int non-negative
:param _AdminIdCardType: 经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:type AdminIdCardType: str
:param _AdminIdCardNumber: 经办人的证件号
:type AdminIdCardNumber: str
:param _BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
:type BusinessLicense: str
:param _PowerOfAttorneys: 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
p.s. 如果上传授权书 ，需遵循以下条件
1. 超管的信息（超管姓名，超管身份证，超管手机号）必须为必填参数。
2. 超管的个人身份必须在电子签已经实名。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式
:type PowerOfAttorneys: list of str
:param _AutoJumpUrl: 认证完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 [跳转电子签H5](https://qian.tencent.com/developers/company/openqianh5/)
:type AutoJumpUrl: str
"""
self._OrganizationName = None
self._OrganizationOpenId = None
self._OpenId = None
self._UniformSocialCreditCode = None
self._LegalName = None
self._Address = None
self._AdminName = None
self._AdminMobile = None
self._AuthorizationTypes = None
self._AdminIdCardType = None
self._AdminIdCardNumber = None
self._BusinessLicense = None
self._PowerOfAttorneys = None
self._AutoJumpUrl = None
@property
def OrganizationName(self):
"""组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def OrganizationOpenId(self):
"""机构在贵司业务系统中的唯一标识，用于与腾讯电子签企业账号进行映射，确保在同一应用内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OpenId(self):
"""员工在贵司业务系统中的唯一身份标识，用于与腾讯电子签账号进行映射，确保在同一应用内不会出现重复。
该标识最大长度为64位字符串，仅支持包含26个英文字母和数字0-9的字符。
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def UniformSocialCreditCode(self):
"""组织机构企业统一社会信用代码。
请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
:rtype: str
"""
return self._UniformSocialCreditCode
@UniformSocialCreditCode.setter
def UniformSocialCreditCode(self, UniformSocialCreditCode):
self._UniformSocialCreditCode = UniformSocialCreditCode
@property
def LegalName(self):
"""组织机构法人的姓名。
请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
:rtype: str
"""
return self._LegalName
@LegalName.setter
def LegalName(self, LegalName):
self._LegalName = LegalName
@property
def Address(self):
"""组织机构企业注册地址。
请确认该企业注册地址与企业营业执照中注册的地址一致。
:rtype: str
"""
return self._Address
@Address.setter
def Address(self, Address):
self._Address = Address
@property
def AdminName(self):
"""组织机构超管姓名。
在注册流程中，必须是超管本人进行操作。
如果法人作为超管管理组织机构,超管姓名就是法人姓名
:rtype: str
"""
return self._AdminName
@AdminName.setter
def AdminName(self, AdminName):
self._AdminName = AdminName
@property
def AdminMobile(self):
"""组织机构超管手机号。
在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。
:rtype: str
"""
return self._AdminMobile
@AdminMobile.setter
def AdminMobile(self, AdminMobile):
self._AdminMobile = AdminMobile
@property
def AuthorizationTypes(self):
"""可选的此企业允许的授权方式, 可以设置的方式有:
1：上传授权书
2：法人授权超管
5：授权书+对公打款
注:
`1. 当前仅支持一种认证方式`
`2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
`3. 如果当前操作人是法人,则是法人认证`
:rtype: list of int non-negative
"""
return self._AuthorizationTypes
@AuthorizationTypes.setter
def AuthorizationTypes(self, AuthorizationTypes):
self._AuthorizationTypes = AuthorizationTypes
@property
def AdminIdCardType(self):
"""经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:rtype: str
"""
return self._AdminIdCardType
@AdminIdCardType.setter
def AdminIdCardType(self, AdminIdCardType):
self._AdminIdCardType = AdminIdCardType
@property
def AdminIdCardNumber(self):
"""经办人的证件号
:rtype: str
"""
return self._AdminIdCardNumber
@AdminIdCardNumber.setter
def AdminIdCardNumber(self, AdminIdCardNumber):
self._AdminIdCardNumber = AdminIdCardNumber
@property
def BusinessLicense(self):
"""营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
:rtype: str
"""
return self._BusinessLicense
@BusinessLicense.setter
def BusinessLicense(self, BusinessLicense):
self._BusinessLicense = BusinessLicense
@property
def PowerOfAttorneys(self):
"""授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
p.s. 如果上传授权书 ，需遵循以下条件
1. 超管的信息（超管姓名，超管身份证，超管手机号）必须为必填参数。
2. 超管的个人身份必须在电子签已经实名。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式
:rtype: list of str
"""
return self._PowerOfAttorneys
@PowerOfAttorneys.setter
def PowerOfAttorneys(self, PowerOfAttorneys):
self._PowerOfAttorneys = PowerOfAttorneys
@property
def AutoJumpUrl(self):
"""认证完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 [跳转电子签H5](https://qian.tencent.com/developers/company/openqianh5/)
:rtype: str
"""
return self._AutoJumpUrl
@AutoJumpUrl.setter
def AutoJumpUrl(self, AutoJumpUrl):
self._AutoJumpUrl = AutoJumpUrl
def _deserialize(self, params):
self._OrganizationName = params.get("OrganizationName")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OpenId = params.get("OpenId")
self._UniformSocialCreditCode = params.get("UniformSocialCreditCode")
self._LegalName = params.get("LegalName")
self._Address = params.get("Address")
self._AdminName = params.get("AdminName")
self._AdminMobile = params.get("AdminMobile")
self._AuthorizationTypes = params.get("AuthorizationTypes")
self._AdminIdCardType = params.get("AdminIdCardType")
self._AdminIdCardNumber = params.get("AdminIdCardNumber")
self._BusinessLicense = params.get("BusinessLicense")
self._PowerOfAttorneys = params.get("PowerOfAttorneys")
self._AutoJumpUrl = params.get("AutoJumpUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ReleasedApprover(AbstractModel):
"""解除协议的签署人，如不指定，默认使用待解除流程(原流程)中的签署人。</br>
`注意`:
- 不支持更换C端(个人身份类型)签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。
- 目前不支持替换C端(个人身份类型)签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。
- 当指定C端签署人的签署方自定义控件别名不空时，除参数ApproverNumber外，可以只传参数ApproverSignRole。
如果需要指定B端(企业身份类型)签署人，其中ReleasedApprover需要传递的参数如下：
(`ApproverNumber`, `ReleasedApproverRecipientId`这两个二选一), `OrganizationName`, `ApproverType`必传。</br>
对于其他身份标识：
- **子客企业指定经办人**：OpenId必传，OrganizationOpenId必传；
- **非子客企业经办人**：Name、Mobile必传。
"""
def __init__(self):
r"""
:param _ApproverNumber: 签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。
可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
:type ApproverNumber: int
:param _ApproverType: 指定签署人类型，目前支持
<ul><li> **ORGANIZATION**：企业(默认值)</li>
<li> **ENTERPRISESERVER**：企业静默签</li></ul>
:type ApproverType: str
:param _ReleasedApproverRecipientId: 签署人在原合同中的RecipientId，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人信息，可参考返回结构体<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverdetail" target="_blank">FlowApproverDetail</a>中的RecipientId。
**注意**：当指定了此参数后，ApproverNumber即失效，会以本参数作为原合同参与人的选取。与ApproverNumber二选一。
:type ReleasedApproverRecipientId: str
:param _Name: 签署人姓名，最大长度50个字。
:type Name: str
:param _IdCardType: 签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:type IdCardType: str
:param _IdCardNumber: 证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type IdCardNumber: str
:param _Mobile: 签署人手机号。
:type Mobile: str
:param _OrganizationName: 组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
:type OrganizationName: str
:param _OrganizationOpenId: 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。
<font color="red">当为子客企业指定经办人时，此OrganizationOpenId必传。</font>
:type OrganizationOpenId: str
:param _OpenId: 第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。
<font color="red">当签署方为同一第三方平台下的员工时，此OpenId必传。</font>
:type OpenId: str
:param _ApproverSignComponentType: 签署控件类型，支持自定义企业签署方的签署控件类型
<ul><li> **SIGN_SEAL**：默认为印章控件类型(默认值)</li>
<li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
:type ApproverSignComponentType: str
:param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。
如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
:type ApproverSignRole: str
:param _ApproverSignSealId: 印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署
:type ApproverSignSealId: str
"""
self._ApproverNumber = None
self._ApproverType = None
self._ReleasedApproverRecipientId = None
self._Name = None
self._IdCardType = None
self._IdCardNumber = None
self._Mobile = None
self._OrganizationName = None
self._OrganizationOpenId = None
self._OpenId = None
self._ApproverSignComponentType = None
self._ApproverSignRole = None
self._ApproverSignSealId = None
@property
def ApproverNumber(self):
"""签署人在原合同签署人列表中的顺序序号(从0开始，按顺序依次递增)。
可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
:rtype: int
"""
return self._ApproverNumber
@ApproverNumber.setter
def ApproverNumber(self, ApproverNumber):
self._ApproverNumber = ApproverNumber
@property
def ApproverType(self):
"""指定签署人类型，目前支持
<ul><li> **ORGANIZATION**：企业(默认值)</li>
<li> **ENTERPRISESERVER**：企业静默签</li></ul>
:rtype: str
"""
return self._ApproverType
@ApproverType.setter
def ApproverType(self, ApproverType):
self._ApproverType = ApproverType
@property
def ReleasedApproverRecipientId(self):
"""签署人在原合同中的RecipientId，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人信息，可参考返回结构体<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverdetail" target="_blank">FlowApproverDetail</a>中的RecipientId。
**注意**：当指定了此参数后，ApproverNumber即失效，会以本参数作为原合同参与人的选取。与ApproverNumber二选一。
:rtype: str
"""
return self._ReleasedApproverRecipientId
@ReleasedApproverRecipientId.setter
def ReleasedApproverRecipientId(self, ReleasedApproverRecipientId):
self._ReleasedApproverRecipientId = ReleasedApproverRecipientId
@property
def Name(self):
"""签署人姓名，最大长度50个字。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def IdCardType(self):
"""签署方经办人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""证件号码，应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。
</li>
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def Mobile(self):
"""签署人手机号。
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def OrganizationName(self):
"""组织机构名称。
请确认该名称与企业营业执照中注册的名称一致。
如果名称中包含英文括号()，请使用中文括号（）代替。
如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def OrganizationOpenId(self):
"""第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。
<font color="red">当为子客企业指定经办人时，此OrganizationOpenId必传。</font>
:rtype: str
"""
return self._OrganizationOpenId
@OrganizationOpenId.setter
def OrganizationOpenId(self, OrganizationOpenId):
self._OrganizationOpenId = OrganizationOpenId
@property
def OpenId(self):
"""第三方平台子客企业员工的唯一标识，长度不能超过64，只能由字母和数字组成。
<font color="red">当签署方为同一第三方平台下的员工时，此OpenId必传。</font>
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def ApproverSignComponentType(self):
"""签署控件类型，支持自定义企业签署方的签署控件类型
<ul><li> **SIGN_SEAL**：默认为印章控件类型(默认值)</li>
<li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
:rtype: str
"""
return self._ApproverSignComponentType
@ApproverSignComponentType.setter
def ApproverSignComponentType(self, ApproverSignComponentType):
self._ApproverSignComponentType = ApproverSignComponentType
@property
def ApproverSignRole(self):
"""参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`，以此类推。
如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
:rtype: str
"""
return self._ApproverSignRole
@ApproverSignRole.setter
def ApproverSignRole(self, ApproverSignRole):
self._ApproverSignRole = ApproverSignRole
@property
def ApproverSignSealId(self):
"""印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署
:rtype: str
"""
return self._ApproverSignSealId
@ApproverSignSealId.setter
def ApproverSignSealId(self, ApproverSignSealId):
self._ApproverSignSealId = ApproverSignSealId
def _deserialize(self, params):
self._ApproverNumber = params.get("ApproverNumber")
self._ApproverType = params.get("ApproverType")
self._ReleasedApproverRecipientId = params.get("ReleasedApproverRecipientId")
self._Name = params.get("Name")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
self._Mobile = params.get("Mobile")
self._OrganizationName = params.get("OrganizationName")
self._OrganizationOpenId = params.get("OrganizationOpenId")
self._OpenId = params.get("OpenId")
self._ApproverSignComponentType = params.get("ApproverSignComponentType")
self._ApproverSignRole = params.get("ApproverSignRole")
self._ApproverSignSealId = params.get("ApproverSignSealId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class RelieveInfo(AbstractModel):
"""解除协议文档中内容信息，包括但不限于：解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。下面各种字段在解除协议中的位置参考：
"""
def __init__(self):
r"""
:param _Reason: 解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:type Reason: str
:param _RemainInForceItem: 解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:type RemainInForceItem: str
:param _OriginalExpenseSettlement: 原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:type OriginalExpenseSettlement: str
:param _OriginalOtherSettlement: 原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:type OriginalOtherSettlement: str
:param _OtherDeals: 其他约定（如约定的与解除协议存在冲突的，以【其他约定】为准），最大支持200个字，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:type OtherDeals: str
"""
self._Reason = None
self._RemainInForceItem = None
self._OriginalExpenseSettlement = None
self._OriginalOtherSettlement = None
self._OtherDeals = None
@property
def Reason(self):
"""解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:rtype: str
"""
return self._Reason
@Reason.setter
def Reason(self, Reason):
self._Reason = Reason
@property
def RemainInForceItem(self):
"""解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:rtype: str
"""
return self._RemainInForceItem
@RemainInForceItem.setter
def RemainInForceItem(self, RemainInForceItem):
self._RemainInForceItem = RemainInForceItem
@property
def OriginalExpenseSettlement(self):
"""原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:rtype: str
"""
return self._OriginalExpenseSettlement
@OriginalExpenseSettlement.setter
def OriginalExpenseSettlement(self, OriginalExpenseSettlement):
self._OriginalExpenseSettlement = OriginalExpenseSettlement
@property
def OriginalOtherSettlement(self):
"""原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:rtype: str
"""
return self._OriginalOtherSettlement
@OriginalOtherSettlement.setter
def OriginalOtherSettlement(self, OriginalOtherSettlement):
self._OriginalOtherSettlement = OriginalOtherSettlement
@property
def OtherDeals(self):
"""其他约定（如约定的与解除协议存在冲突的，以【其他约定】为准），最大支持200个字，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
:rtype: str
"""
return self._OtherDeals
@OtherDeals.setter
def OtherDeals(self, OtherDeals):
self._OtherDeals = OtherDeals
def _deserialize(self, params):
self._Reason = params.get("Reason")
self._RemainInForceItem = params.get("RemainInForceItem")
self._OriginalExpenseSettlement = params.get("OriginalExpenseSettlement")
self._OriginalOtherSettlement = params.get("OriginalOtherSettlement")
self._OtherDeals = params.get("OtherDeals")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class RemindFlowRecords(AbstractModel):
"""催办接口返回的详细信息。
"""
def __init__(self):
r"""
:param _CanRemind: 合同流程是否可以催办： true - 可以，false - 不可以。 若无法催办，将返回RemindMessage以解释原因。
:type CanRemind: bool
:param _FlowId: 合同流程ID，为32位字符串。
:type FlowId: str
:param _RemindMessage: 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
:type RemindMessage: str
"""
self._CanRemind = None
self._FlowId = None
self._RemindMessage = None
@property
def CanRemind(self):
"""合同流程是否可以催办： true - 可以，false - 不可以。 若无法催办，将返回RemindMessage以解释原因。
:rtype: bool
"""
return self._CanRemind
@CanRemind.setter
def CanRemind(self, CanRemind):
self._CanRemind = CanRemind
@property
def FlowId(self):
"""合同流程ID，为32位字符串。
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def RemindMessage(self):
"""在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
:rtype: str
"""
return self._RemindMessage
@RemindMessage.setter
def RemindMessage(self, RemindMessage):
self._RemindMessage = RemindMessage
def _deserialize(self, params):
self._CanRemind = params.get("CanRemind")
self._FlowId = params.get("FlowId")
self._RemindMessage = params.get("RemindMessage")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ResourceUrlInfo(AbstractModel):
"""资源链接信息
"""
def __init__(self):
r"""
:param _Url: 资源链接地址，过期时间5分钟
:type Url: str
:param _Name: 资源名称
:type Name: str
:param _Type: 资源类型
:type Type: str
"""
self._Url = None
self._Name = None
self._Type = None
@property
def Url(self):
"""资源链接地址，过期时间5分钟
:rtype: str
"""
return self._Url
@Url.setter
def Url(self, Url):
self._Url = Url
@property
def Name(self):
"""资源名称
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Type(self):
"""资源类型
:rtype: str
"""
return self._Type
@Type.setter
def Type(self, Type):
self._Type = Type
def _deserialize(self, params):
self._Url = params.get("Url")
self._Name = params.get("Name")
self._Type = params.get("Type")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SignQrCode(AbstractModel):
"""签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
"""
def __init__(self):
r"""
:param _QrCodeId: 二维码ID，为32位字符串。
注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
:type QrCodeId: str
:param _QrCodeUrl: 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
:type QrCodeUrl: str
:param _ExpiredTime: 二维码的有截止时间，格式为Unix标准时间戳（秒），可以通过入参的QrEffectiveDay来设置有效期，默认为7天有效期。
一旦超过二维码的有效期限，该二维码将自动失效。
:type ExpiredTime: int
:param _WeixinQrCodeUrl: 微信小程序二维码
:type WeixinQrCodeUrl: str
"""
self._QrCodeId = None
self._QrCodeUrl = None
self._ExpiredTime = None
self._WeixinQrCodeUrl = None
@property
def QrCodeId(self):
"""二维码ID，为32位字符串。
注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
:rtype: str
"""
return self._QrCodeId
@QrCodeId.setter
def QrCodeId(self, QrCodeId):
self._QrCodeId = QrCodeId
@property
def QrCodeUrl(self):
"""二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
:rtype: str
"""
return self._QrCodeUrl
@QrCodeUrl.setter
def QrCodeUrl(self, QrCodeUrl):
self._QrCodeUrl = QrCodeUrl
@property
def ExpiredTime(self):
"""二维码的有截止时间，格式为Unix标准时间戳（秒），可以通过入参的QrEffectiveDay来设置有效期，默认为7天有效期。
一旦超过二维码的有效期限，该二维码将自动失效。
:rtype: int
"""
return self._ExpiredTime
@ExpiredTime.setter
def ExpiredTime(self, ExpiredTime):
self._ExpiredTime = ExpiredTime
@property
def WeixinQrCodeUrl(self):
"""微信小程序二维码
:rtype: str
"""
return self._WeixinQrCodeUrl
@WeixinQrCodeUrl.setter
def WeixinQrCodeUrl(self, WeixinQrCodeUrl):
self._WeixinQrCodeUrl = WeixinQrCodeUrl
def _deserialize(self, params):
self._QrCodeId = params.get("QrCodeId")
self._QrCodeUrl = params.get("QrCodeUrl")
self._ExpiredTime = params.get("ExpiredTime")
self._WeixinQrCodeUrl = params.get("WeixinQrCodeUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SignUrl(AbstractModel):
"""流程签署二维码的签署信息，适用于客户系统整合二维码功能。 通过链接，用户可直接访问电子签名小程序并签署合同。
"""
def __init__(self):
r"""
:param _AppSignUrl: 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
:type AppSignUrl: str
:param _EffectiveTime: 签署链接有效时间，格式类似"2022-08-05 15:55:01"
:type EffectiveTime: str
:param _HttpSignUrl: 跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
:type HttpSignUrl: str
"""
self._AppSignUrl = None
self._EffectiveTime = None
self._HttpSignUrl = None
@property
def AppSignUrl(self):
"""跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
:rtype: str
"""
return self._AppSignUrl
@AppSignUrl.setter
def AppSignUrl(self, AppSignUrl):
self._AppSignUrl = AppSignUrl
@property
def EffectiveTime(self):
"""签署链接有效时间，格式类似"2022-08-05 15:55:01"
:rtype: str
"""
return self._EffectiveTime
@EffectiveTime.setter
def EffectiveTime(self, EffectiveTime):
self._EffectiveTime = EffectiveTime
@property
def HttpSignUrl(self):
"""跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
:rtype: str
"""
return self._HttpSignUrl
@HttpSignUrl.setter
def HttpSignUrl(self, HttpSignUrl):
self._HttpSignUrl = HttpSignUrl
def _deserialize(self, params):
self._AppSignUrl = params.get("AppSignUrl")
self._EffectiveTime = params.get("EffectiveTime")
self._HttpSignUrl = params.get("HttpSignUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SignUrlInfo(AbstractModel):
"""签署链接内容
"""
def __init__(self):
r"""
:param _SignUrl: 签署链接，过期时间为90天
注：<font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:type SignUrl: str
:param _Deadline: 合同过期时间戳，单位秒
:type Deadline: int
:param _SignOrder: 当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选
:type SignOrder: int
:param _SignId: 签署人编号
:type SignId: str
:param _CustomUserId: 自定义用户编号
注意：此字段可能返回 null，表示取不到有效值。
:type CustomUserId: str
:param _Name: 用户姓名
:type Name: str
:param _Mobile: 用户手机号码
:type Mobile: str
:param _OrganizationName: 签署参与者机构名字
:type OrganizationName: str
:param _ApproverType: 参与者类型, 类型如下:
**ORGANIZATION**:企业经办人
**PERSON**: 自然人
:type ApproverType: str
:param _IdCardNumber: 经办人身份证号
:type IdCardNumber: str
:param _FlowId: 签署链接对应流程Id
:type FlowId: str
:param _OpenId: 企业经办人 用户在渠道的编号
:type OpenId: str
:param _FlowGroupId: 合同组签署链接对应的合同组id
:type FlowGroupId: str
:param _SignQrcodeUrl: 二维码，在生成动态签署人跳转封面页链接时返回
:type SignQrcodeUrl: str
"""
self._SignUrl = None
self._Deadline = None
self._SignOrder = None
self._SignId = None
self._CustomUserId = None
self._Name = None
self._Mobile = None
self._OrganizationName = None
self._ApproverType = None
self._IdCardNumber = None
self._FlowId = None
self._OpenId = None
self._FlowGroupId = None
self._SignQrcodeUrl = None
@property
def SignUrl(self):
"""签署链接，过期时间为90天
注：<font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
:rtype: str
"""
return self._SignUrl
@SignUrl.setter
def SignUrl(self, SignUrl):
self._SignUrl = SignUrl
@property
def Deadline(self):
"""合同过期时间戳，单位秒
:rtype: int
"""
return self._Deadline
@Deadline.setter
def Deadline(self, Deadline):
self._Deadline = Deadline
@property
def SignOrder(self):
"""当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选
:rtype: int
"""
return self._SignOrder
@SignOrder.setter
def SignOrder(self, SignOrder):
self._SignOrder = SignOrder
@property
def SignId(self):
"""签署人编号
:rtype: str
"""
return self._SignId
@SignId.setter
def SignId(self, SignId):
self._SignId = SignId
@property
def CustomUserId(self):
warnings.warn("parameter `CustomUserId` is deprecated", DeprecationWarning)
"""自定义用户编号
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._CustomUserId
@CustomUserId.setter
def CustomUserId(self, CustomUserId):
warnings.warn("parameter `CustomUserId` is deprecated", DeprecationWarning)
self._CustomUserId = CustomUserId
@property
def Name(self):
"""用户姓名
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Mobile(self):
"""用户手机号码
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def OrganizationName(self):
"""签署参与者机构名字
:rtype: str
"""
return self._OrganizationName
@OrganizationName.setter
def OrganizationName(self, OrganizationName):
self._OrganizationName = OrganizationName
@property
def ApproverType(self):
"""参与者类型, 类型如下:
**ORGANIZATION**:企业经办人
**PERSON**: 自然人
:rtype: str
"""
return self._ApproverType
@ApproverType.setter
def ApproverType(self, ApproverType):
self._ApproverType = ApproverType
@property
def IdCardNumber(self):
"""经办人身份证号
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
@property
def FlowId(self):
"""签署链接对应流程Id
:rtype: str
"""
return self._FlowId
@FlowId.setter
def FlowId(self, FlowId):
self._FlowId = FlowId
@property
def OpenId(self):
"""企业经办人 用户在渠道的编号
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def FlowGroupId(self):
"""合同组签署链接对应的合同组id
:rtype: str
"""
return self._FlowGroupId
@FlowGroupId.setter
def FlowGroupId(self, FlowGroupId):
self._FlowGroupId = FlowGroupId
@property
def SignQrcodeUrl(self):
"""二维码，在生成动态签署人跳转封面页链接时返回
:rtype: str
"""
return self._SignQrcodeUrl
@SignQrcodeUrl.setter
def SignQrcodeUrl(self, SignQrcodeUrl):
self._SignQrcodeUrl = SignQrcodeUrl
def _deserialize(self, params):
self._SignUrl = params.get("SignUrl")
self._Deadline = params.get("Deadline")
self._SignOrder = params.get("SignOrder")
self._SignId = params.get("SignId")
self._CustomUserId = params.get("CustomUserId")
self._Name = params.get("Name")
self._Mobile = params.get("Mobile")
self._OrganizationName = params.get("OrganizationName")
self._ApproverType = params.get("ApproverType")
self._IdCardNumber = params.get("IdCardNumber")
self._FlowId = params.get("FlowId")
self._OpenId = params.get("OpenId")
self._FlowGroupId = params.get("FlowGroupId")
self._SignQrcodeUrl = params.get("SignQrcodeUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Staff(AbstractModel):
"""企业员工信息
"""
def __init__(self):
r"""
:param _UserId: 员工在电子签平台的用户ID
:type UserId: str
:param _DisplayName: 显示的员工名
注意：2024-07-08 及之后创建的应用号，该字段返回的是打码信息
:type DisplayName: str
:param _Mobile: 员工手机号
注意：2024-07-08 及之后创建的应用号，该字段返回的是打码信息
:type Mobile: str
:param _Email: 员工邮箱
:type Email: str
:param _OpenId: 员工在第三方应用平台的用户ID
:type OpenId: str
:param _Roles: 员工角色
:type Roles: list of StaffRole
:param _Department: 员工部门
:type Department: :class:`tencentcloud.essbasic.v20210526.models.Department`
:param _Verified: 员工是否实名
:type Verified: bool
:param _CreatedOn: 员工创建时间戳，单位秒
:type CreatedOn: int
:param _VerifiedOn: 员工实名时间戳，单位秒
:type VerifiedOn: int
:param _QuiteJob: 员工是否离职：0-未离职，1-离职
:type QuiteJob: int
"""
self._UserId = None
self._DisplayName = None
self._Mobile = None
self._Email = None
self._OpenId = None
self._Roles = None
self._Department = None
self._Verified = None
self._CreatedOn = None
self._VerifiedOn = None
self._QuiteJob = None
@property
def UserId(self):
"""员工在电子签平台的用户ID
:rtype: str
"""
return self._UserId
@UserId.setter
def UserId(self, UserId):
self._UserId = UserId
@property
def DisplayName(self):
"""显示的员工名
注意：2024-07-08 及之后创建的应用号，该字段返回的是打码信息
:rtype: str
"""
return self._DisplayName
@DisplayName.setter
def DisplayName(self, DisplayName):
self._DisplayName = DisplayName
@property
def Mobile(self):
"""员工手机号
注意：2024-07-08 及之后创建的应用号，该字段返回的是打码信息
:rtype: str
"""
return self._Mobile
@Mobile.setter
def Mobile(self, Mobile):
self._Mobile = Mobile
@property
def Email(self):
"""员工邮箱
:rtype: str
"""
return self._Email
@Email.setter
def Email(self, Email):
self._Email = Email
@property
def OpenId(self):
"""员工在第三方应用平台的用户ID
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def Roles(self):
"""员工角色
:rtype: list of StaffRole
"""
return self._Roles
@Roles.setter
def Roles(self, Roles):
self._Roles = Roles
@property
def Department(self):
"""员工部门
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Department`
"""
return self._Department
@Department.setter
def Department(self, Department):
self._Department = Department
@property
def Verified(self):
"""员工是否实名
:rtype: bool
"""
return self._Verified
@Verified.setter
def Verified(self, Verified):
self._Verified = Verified
@property
def CreatedOn(self):
"""员工创建时间戳，单位秒
:rtype: int
"""
return self._CreatedOn
@CreatedOn.setter
def CreatedOn(self, CreatedOn):
self._CreatedOn = CreatedOn
@property
def VerifiedOn(self):
"""员工实名时间戳，单位秒
:rtype: int
"""
return self._VerifiedOn
@VerifiedOn.setter
def VerifiedOn(self, VerifiedOn):
self._VerifiedOn = VerifiedOn
@property
def QuiteJob(self):
"""员工是否离职：0-未离职，1-离职
:rtype: int
"""
return self._QuiteJob
@QuiteJob.setter
def QuiteJob(self, QuiteJob):
self._QuiteJob = QuiteJob
def _deserialize(self, params):
self._UserId = params.get("UserId")
self._DisplayName = params.get("DisplayName")
self._Mobile = params.get("Mobile")
self._Email = params.get("Email")
self._OpenId = params.get("OpenId")
if params.get("Roles") is not None:
self._Roles = []
for item in params.get("Roles"):
obj = StaffRole()
obj._deserialize(item)
self._Roles.append(obj)
if params.get("Department") is not None:
self._Department = Department()
self._Department._deserialize(params.get("Department"))
self._Verified = params.get("Verified")
self._CreatedOn = params.get("CreatedOn")
self._VerifiedOn = params.get("VerifiedOn")
self._QuiteJob = params.get("QuiteJob")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class StaffRole(AbstractModel):
"""第三方应用集成员工角色信息
"""
def __init__(self):
r"""
:param _RoleId: 角色id
:type RoleId: str
:param _RoleName: 角色名称
:type RoleName: str
"""
self._RoleId = None
self._RoleName = None
@property
def RoleId(self):
"""角色id
:rtype: str
"""
return self._RoleId
@RoleId.setter
def RoleId(self, RoleId):
self._RoleId = RoleId
@property
def RoleName(self):
"""角色名称
:rtype: str
"""
return self._RoleName
@RoleName.setter
def RoleName(self, RoleName):
self._RoleName = RoleName
def _deserialize(self, params):
self._RoleId = params.get("RoleId")
self._RoleName = params.get("RoleName")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SyncFailReason(AbstractModel):
"""同步员工失败原因
"""
def __init__(self):
r"""
:param _Id: 企业员工标识(即OpenId)
:type Id: str
:param _Message: 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
:type Message: str
"""
self._Id = None
self._Message = None
@property
def Id(self):
"""企业员工标识(即OpenId)
:rtype: str
"""
return self._Id
@Id.setter
def Id(self, Id):
self._Id = Id
@property
def Message(self):
"""新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
:rtype: str
"""
return self._Message
@Message.setter
def Message(self, Message):
self._Message = Message
def _deserialize(self, params):
self._Id = params.get("Id")
self._Message = params.get("Message")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SyncProxyOrganizationOperatorsRequest(AbstractModel):
"""SyncProxyOrganizationOperators请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
</ul>
第三方平台子客企业必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _OperatorType: 操作类型，对应的操作
<ul><li> **CREATE** :新增员工</li>
<li> **UPDATE** :修改员工</li>
<li> **RESIGN** :离职员工</li></ul>
:type OperatorType: str
:param _ProxyOrganizationOperators: 员工信息列表，最多支持200个
:type ProxyOrganizationOperators: list of ProxyOrganizationOperator
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._OperatorType = None
self._ProxyOrganizationOperators = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
</ul>
第三方平台子客企业必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def OperatorType(self):
"""操作类型，对应的操作
<ul><li> **CREATE** :新增员工</li>
<li> **UPDATE** :修改员工</li>
<li> **RESIGN** :离职员工</li></ul>
:rtype: str
"""
return self._OperatorType
@OperatorType.setter
def OperatorType(self, OperatorType):
self._OperatorType = OperatorType
@property
def ProxyOrganizationOperators(self):
"""员工信息列表，最多支持200个
:rtype: list of ProxyOrganizationOperator
"""
return self._ProxyOrganizationOperators
@ProxyOrganizationOperators.setter
def ProxyOrganizationOperators(self, ProxyOrganizationOperators):
self._ProxyOrganizationOperators = ProxyOrganizationOperators
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._OperatorType = params.get("OperatorType")
if params.get("ProxyOrganizationOperators") is not None:
self._ProxyOrganizationOperators = []
for item in params.get("ProxyOrganizationOperators"):
obj = ProxyOrganizationOperator()
obj._deserialize(item)
self._ProxyOrganizationOperators.append(obj)
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SyncProxyOrganizationOperatorsResponse(AbstractModel):
"""SyncProxyOrganizationOperators返回参数结构体
"""
def __init__(self):
r"""
:param _Status: 同步的状态, 全部同步失败接口是接口会直接报错
<ul><li> **1** :全部成功</li>
<li> **2** :部分成功</li></ul>
:type Status: int
:param _FailedList: 同步失败员工ID及其失败原因
:type FailedList: list of SyncFailReason
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Status = None
self._FailedList = None
self._RequestId = None
@property
def Status(self):
""" 同步的状态, 全部同步失败接口是接口会直接报错
<ul><li> **1** :全部成功</li>
<li> **2** :部分成功</li></ul>
:rtype: int
"""
return self._Status
@Status.setter
def Status(self, Status):
self._Status = Status
@property
def FailedList(self):
"""同步失败员工ID及其失败原因
:rtype: list of SyncFailReason
"""
return self._FailedList
@FailedList.setter
def FailedList(self, FailedList):
self._FailedList = FailedList
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Status = params.get("Status")
if params.get("FailedList") is not None:
self._FailedList = []
for item in params.get("FailedList"):
obj = SyncFailReason()
obj._deserialize(item)
self._FailedList.append(obj)
self._RequestId = params.get("RequestId")
class SyncProxyOrganizationRequest(AbstractModel):
"""SyncProxyOrganization请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
</ul>
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _ProxyOrganizationName: 第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。
注: `如果名称中包含英文括号()，请使用中文括号（）代替。`
:type ProxyOrganizationName: str
:param _BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
:type BusinessLicense: str
:param _UniformSocialCreditCode: 第三方平台子客企业统一社会信用代码，最大长度200个字符
:type UniformSocialCreditCode: str
:param _ProxyLegalName: 第三方平台子客企业法定代表人的名字
:type ProxyLegalName: str
:param _Operator: 暂未开放
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
:param _ProxyLegalIdCardType: 第三方平台子客企业法定代表人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>
注: `现在仅支持ID_CARD中国大陆居民身份证类型`
:type ProxyLegalIdCardType: str
:param _ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li></ul>
:type ProxyLegalIdCardNumber: str
:param _ProxyAddress: 第三方平台子客企业详细住所，最大长度500个字符
注：`需要符合省市区详情的格式例如： XX省XX市XX区街道具体地址`
:type ProxyAddress: str
"""
self._Agent = None
self._ProxyOrganizationName = None
self._BusinessLicense = None
self._UniformSocialCreditCode = None
self._ProxyLegalName = None
self._Operator = None
self._ProxyLegalIdCardType = None
self._ProxyLegalIdCardNumber = None
self._ProxyAddress = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
</ul>
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def ProxyOrganizationName(self):
"""第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。
注: `如果名称中包含英文括号()，请使用中文括号（）代替。`
:rtype: str
"""
return self._ProxyOrganizationName
@ProxyOrganizationName.setter
def ProxyOrganizationName(self, ProxyOrganizationName):
self._ProxyOrganizationName = ProxyOrganizationName
@property
def BusinessLicense(self):
"""营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
:rtype: str
"""
return self._BusinessLicense
@BusinessLicense.setter
def BusinessLicense(self, BusinessLicense):
self._BusinessLicense = BusinessLicense
@property
def UniformSocialCreditCode(self):
"""第三方平台子客企业统一社会信用代码，最大长度200个字符
:rtype: str
"""
return self._UniformSocialCreditCode
@UniformSocialCreditCode.setter
def UniformSocialCreditCode(self, UniformSocialCreditCode):
self._UniformSocialCreditCode = UniformSocialCreditCode
@property
def ProxyLegalName(self):
"""第三方平台子客企业法定代表人的名字
:rtype: str
"""
return self._ProxyLegalName
@ProxyLegalName.setter
def ProxyLegalName(self, ProxyLegalName):
self._ProxyLegalName = ProxyLegalName
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""暂未开放
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
@property
def ProxyLegalIdCardType(self):
"""第三方平台子客企业法定代表人的证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>
注: `现在仅支持ID_CARD中国大陆居民身份证类型`
:rtype: str
"""
return self._ProxyLegalIdCardType
@ProxyLegalIdCardType.setter
def ProxyLegalIdCardType(self, ProxyLegalIdCardType):
self._ProxyLegalIdCardType = ProxyLegalIdCardType
@property
def ProxyLegalIdCardNumber(self):
"""第三方平台子客企业法定代表人的证件号码, 应符合以下规则
<ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li></ul>
:rtype: str
"""
return self._ProxyLegalIdCardNumber
@ProxyLegalIdCardNumber.setter
def ProxyLegalIdCardNumber(self, ProxyLegalIdCardNumber):
self._ProxyLegalIdCardNumber = ProxyLegalIdCardNumber
@property
def ProxyAddress(self):
"""第三方平台子客企业详细住所，最大长度500个字符
注：`需要符合省市区详情的格式例如： XX省XX市XX区街道具体地址`
:rtype: str
"""
return self._ProxyAddress
@ProxyAddress.setter
def ProxyAddress(self, ProxyAddress):
self._ProxyAddress = ProxyAddress
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._ProxyOrganizationName = params.get("ProxyOrganizationName")
self._BusinessLicense = params.get("BusinessLicense")
self._UniformSocialCreditCode = params.get("UniformSocialCreditCode")
self._ProxyLegalName = params.get("ProxyLegalName")
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
self._ProxyLegalIdCardType = params.get("ProxyLegalIdCardType")
self._ProxyLegalIdCardNumber = params.get("ProxyLegalIdCardNumber")
self._ProxyAddress = params.get("ProxyAddress")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class SyncProxyOrganizationResponse(AbstractModel):
"""SyncProxyOrganization返回参数结构体
"""
def __init__(self):
r"""
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._RequestId = None
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._RequestId = params.get("RequestId")
class TaskInfo(AbstractModel):
"""复杂文档合成任务的任务信息
"""
def __init__(self):
r"""
:param _TaskId: 合成任务Id，可以通过 ChannelGetTaskResultApi 接口获取任务信息
:type TaskId: str
:param _TaskStatus: 任务状态：READY - 任务已完成；NOTREADY - 任务未完成；
:type TaskStatus: str
"""
self._TaskId = None
self._TaskStatus = None
@property
def TaskId(self):
"""合成任务Id，可以通过 ChannelGetTaskResultApi 接口获取任务信息
:rtype: str
"""
return self._TaskId
@TaskId.setter
def TaskId(self, TaskId):
self._TaskId = TaskId
@property
def TaskStatus(self):
"""任务状态：READY - 任务已完成；NOTREADY - 任务未完成；
:rtype: str
"""
return self._TaskStatus
@TaskStatus.setter
def TaskStatus(self, TaskStatus):
self._TaskStatus = TaskStatus
def _deserialize(self, params):
self._TaskId = params.get("TaskId")
self._TaskStatus = params.get("TaskStatus")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class TemplateInfo(AbstractModel):
"""此结构体 (TemplateInfo) 用于描述模板的信息。
> **模板组成**
>
> 一个模板通常会包含以下结构信息
>- 模板基本信息
>- 签署参与方 Recipients，在模板发起合同时用于指定参与方
>- 填写控件 Components
>- 签署控件 SignComponents
"""
def __init__(self):
r"""
:param _TemplateId: 模板ID，模板的唯一标识
:type TemplateId: str
:param _TemplateName: 模板名
:type TemplateName: str
:param _Description: 模板描述信息
:type Description: str
:param _Components: 模板的填充控件列表
[点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
:type Components: list of Component
:param _Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
[点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
:type Recipients: list of Recipient
:param _SignComponents: 此模板中的签署控件列表
[点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
:type SignComponents: list of Component
:param _TemplateType: 模板类型可以分为以下两种：
<b>1</b>：带有<b>本企业自动签署</b>的模板，即签署过程无需签署人手动操作，系统自动完成签署。
<b>3</b>：普通模板，即签署人需要手动进行签署操作。
:type TemplateType: int
:param _IsPromoter: 是否是发起人 ,已弃用
:type IsPromoter: bool
:param _Creator: 模板的创建者名字
:type Creator: str
:param _CreatedOn: 模板创建的时间戳，格式为Unix标准时间戳（秒）
:type CreatedOn: int
:param _PreviewUrl: 模板的 H5 预览链接，有效期为 5 分钟。
您可以通过浏览器直接打开此链接预览模板，或将其嵌入到 iframe 中进行预览。
注意：只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true，才会生成预览链接。
:type PreviewUrl: str
:param _PdfUrl: 第三方应用集成-模板PDF文件链接，有效期5分钟。
请求参数WithPdfUrl=true时返回
（此功能开放需要联系客户经理）。
:type PdfUrl: str
:param _ChannelTemplateId: 本模板关联的第三方应用平台企业模板ID
:type ChannelTemplateId: str
:param _ChannelTemplateName: 本模板关联的三方应用平台平台企业模板名称
:type ChannelTemplateName: str
:param _ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认);
1-平台自动设置子客模板
:type ChannelAutoSave: int
:param _TemplateVersion: 模板版本，由全数字字符组成。
默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。
:type TemplateVersion: str
:param _Available: 模板可用状态的取值通常为以下两种：
<ul><li>1：启用（默认），表示模板处于启用状态，可以被用户正常使用。</li>
<li>2：停用，表示模板处于停用状态，禁止用户使用该模板。</li></ul>
:type Available: int
"""
self._TemplateId = None
self._TemplateName = None
self._Description = None
self._Components = None
self._Recipients = None
self._SignComponents = None
self._TemplateType = None
self._IsPromoter = None
self._Creator = None
self._CreatedOn = None
self._PreviewUrl = None
self._PdfUrl = None
self._ChannelTemplateId = None
self._ChannelTemplateName = None
self._ChannelAutoSave = None
self._TemplateVersion = None
self._Available = None
@property
def TemplateId(self):
"""模板ID，模板的唯一标识
:rtype: str
"""
return self._TemplateId
@TemplateId.setter
def TemplateId(self, TemplateId):
self._TemplateId = TemplateId
@property
def TemplateName(self):
"""模板名
:rtype: str
"""
return self._TemplateName
@TemplateName.setter
def TemplateName(self, TemplateName):
self._TemplateName = TemplateName
@property
def Description(self):
"""模板描述信息
:rtype: str
"""
return self._Description
@Description.setter
def Description(self, Description):
self._Description = Description
@property
def Components(self):
"""模板的填充控件列表
[点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
:rtype: list of Component
"""
return self._Components
@Components.setter
def Components(self, Components):
self._Components = Components
@property
def Recipients(self):
"""此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符，用于确定此角色的信息。
[点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
:rtype: list of Recipient
"""
return self._Recipients
@Recipients.setter
def Recipients(self, Recipients):
self._Recipients = Recipients
@property
def SignComponents(self):
"""此模板中的签署控件列表
[点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
:rtype: list of Component
"""
return self._SignComponents
@SignComponents.setter
def SignComponents(self, SignComponents):
self._SignComponents = SignComponents
@property
def TemplateType(self):
"""模板类型可以分为以下两种：
<b>1</b>：带有<b>本企业自动签署</b>的模板，即签署过程无需签署人手动操作，系统自动完成签署。
<b>3</b>：普通模板，即签署人需要手动进行签署操作。
:rtype: int
"""
return self._TemplateType
@TemplateType.setter
def TemplateType(self, TemplateType):
self._TemplateType = TemplateType
@property
def IsPromoter(self):
warnings.warn("parameter `IsPromoter` is deprecated", DeprecationWarning)
"""是否是发起人 ,已弃用
:rtype: bool
"""
return self._IsPromoter
@IsPromoter.setter
def IsPromoter(self, IsPromoter):
warnings.warn("parameter `IsPromoter` is deprecated", DeprecationWarning)
self._IsPromoter = IsPromoter
@property
def Creator(self):
"""模板的创建者名字
:rtype: str
"""
return self._Creator
@Creator.setter
def Creator(self, Creator):
self._Creator = Creator
@property
def CreatedOn(self):
"""模板创建的时间戳，格式为Unix标准时间戳（秒）
:rtype: int
"""
return self._CreatedOn
@CreatedOn.setter
def CreatedOn(self, CreatedOn):
self._CreatedOn = CreatedOn
@property
def PreviewUrl(self):
"""模板的 H5 预览链接，有效期为 5 分钟。
您可以通过浏览器直接打开此链接预览模板，或将其嵌入到 iframe 中进行预览。
注意：只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true，才会生成预览链接。
:rtype: str
"""
return self._PreviewUrl
@PreviewUrl.setter
def PreviewUrl(self, PreviewUrl):
self._PreviewUrl = PreviewUrl
@property
def PdfUrl(self):
"""第三方应用集成-模板PDF文件链接，有效期5分钟。
请求参数WithPdfUrl=true时返回
（此功能开放需要联系客户经理）。
:rtype: str
"""
return self._PdfUrl
@PdfUrl.setter
def PdfUrl(self, PdfUrl):
self._PdfUrl = PdfUrl
@property
def ChannelTemplateId(self):
"""本模板关联的第三方应用平台企业模板ID
:rtype: str
"""
return self._ChannelTemplateId
@ChannelTemplateId.setter
def ChannelTemplateId(self, ChannelTemplateId):
self._ChannelTemplateId = ChannelTemplateId
@property
def ChannelTemplateName(self):
"""本模板关联的三方应用平台平台企业模板名称
:rtype: str
"""
return self._ChannelTemplateName
@ChannelTemplateName.setter
def ChannelTemplateName(self, ChannelTemplateName):
self._ChannelTemplateName = ChannelTemplateName
@property
def ChannelAutoSave(self):
"""0-需要子客企业手动领取平台企业的模板(默认);
1-平台自动设置子客模板
:rtype: int
"""
return self._ChannelAutoSave
@ChannelAutoSave.setter
def ChannelAutoSave(self, ChannelAutoSave):
self._ChannelAutoSave = ChannelAutoSave
@property
def TemplateVersion(self):
"""模板版本，由全数字字符组成。
默认为空，模板版本号由日期和序号组成，初始版本为yyyyMMdd001，yyyyMMdd002表示第二个版本，以此类推。
:rtype: str
"""
return self._TemplateVersion
@TemplateVersion.setter
def TemplateVersion(self, TemplateVersion):
self._TemplateVersion = TemplateVersion
@property
def Available(self):
"""模板可用状态的取值通常为以下两种：
<ul><li>1：启用（默认），表示模板处于启用状态，可以被用户正常使用。</li>
<li>2：停用，表示模板处于停用状态，禁止用户使用该模板。</li></ul>
:rtype: int
"""
return self._Available
@Available.setter
def Available(self, Available):
self._Available = Available
def _deserialize(self, params):
self._TemplateId = params.get("TemplateId")
self._TemplateName = params.get("TemplateName")
self._Description = params.get("Description")
if params.get("Components") is not None:
self._Components = []
for item in params.get("Components"):
obj = Component()
obj._deserialize(item)
self._Components.append(obj)
if params.get("Recipients") is not None:
self._Recipients = []
for item in params.get("Recipients"):
obj = Recipient()
obj._deserialize(item)
self._Recipients.append(obj)
if params.get("SignComponents") is not None:
self._SignComponents = []
for item in params.get("SignComponents"):
obj = Component()
obj._deserialize(item)
self._SignComponents.append(obj)
self._TemplateType = params.get("TemplateType")
self._IsPromoter = params.get("IsPromoter")
self._Creator = params.get("Creator")
self._CreatedOn = params.get("CreatedOn")
self._PreviewUrl = params.get("PreviewUrl")
self._PdfUrl = params.get("PdfUrl")
self._ChannelTemplateId = params.get("ChannelTemplateId")
self._ChannelTemplateName = params.get("ChannelTemplateName")
self._ChannelAutoSave = params.get("ChannelAutoSave")
self._TemplateVersion = params.get("TemplateVersion")
self._Available = params.get("Available")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class UploadFile(AbstractModel):
"""此结构体 (UploadFile) 用于描述多文件上传的文件信息。
"""
def __init__(self):
r"""
:param _FileBody: Base64编码后的文件内容
:type FileBody: str
:param _FileName: 文件的名字。
文件名的最大长度应不超过200个字符，并且文件名的后缀必须反映其文件类型。
例如，PDF文件应以“.pdf”结尾，如“XXX.pdf”，而Word文件应以“.doc”或“.docx”结尾，如“XXX.doc”或“XXX.docx”。
:type FileName: str
"""
self._FileBody = None
self._FileName = None
@property
def FileBody(self):
"""Base64编码后的文件内容
:rtype: str
"""
return self._FileBody
@FileBody.setter
def FileBody(self, FileBody):
self._FileBody = FileBody
@property
def FileName(self):
"""文件的名字。
文件名的最大长度应不超过200个字符，并且文件名的后缀必须反映其文件类型。
例如，PDF文件应以“.pdf”结尾，如“XXX.pdf”，而Word文件应以“.doc”或“.docx”结尾，如“XXX.doc”或“XXX.docx”。
:rtype: str
"""
return self._FileName
@FileName.setter
def FileName(self, FileName):
self._FileName = FileName
def _deserialize(self, params):
self._FileBody = params.get("FileBody")
self._FileName = params.get("FileName")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class UploadFilesRequest(AbstractModel):
"""UploadFiles请求参数结构体
"""
def __init__(self):
r"""
:param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
:param _BusinessType:
文件对应业务类型,可以选择的类型如下
<ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
<li> **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li></ul>
:type BusinessType: str
:param _FileInfos: 上传文件内容数组，一次最多可上传20个文件。
<b>若上传多个文件，所有文件必须为相同类型</b>，例如全部为PDF或全部为Word文件。不支持混合文件类型的上传。
:type FileInfos: list of UploadFile
:param _Operator: 操作者的信息
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
self._Agent = None
self._BusinessType = None
self._FileInfos = None
self._Operator = None
@property
def Agent(self):
"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
此接口下面信息必填。
<ul>
<li>渠道应用标识: Agent.AppId</li>
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
</ul>
第三方平台子客企业和员工必须已经经过实名认证
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
"""
return self._Agent
@Agent.setter
def Agent(self, Agent):
self._Agent = Agent
@property
def BusinessType(self):
"""
文件对应业务类型,可以选择的类型如下
<ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
<li> **DOCUMENT** : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li></ul>
:rtype: str
"""
return self._BusinessType
@BusinessType.setter
def BusinessType(self, BusinessType):
self._BusinessType = BusinessType
@property
def FileInfos(self):
"""上传文件内容数组，一次最多可上传20个文件。
<b>若上传多个文件，所有文件必须为相同类型</b>，例如全部为PDF或全部为Word文件。不支持混合文件类型的上传。
:rtype: list of UploadFile
"""
return self._FileInfos
@FileInfos.setter
def FileInfos(self, FileInfos):
self._FileInfos = FileInfos
@property
def Operator(self):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
"""操作者的信息
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
"""
return self._Operator
@Operator.setter
def Operator(self, Operator):
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
self._Operator = Operator
def _deserialize(self, params):
if params.get("Agent") is not None:
self._Agent = Agent()
self._Agent._deserialize(params.get("Agent"))
self._BusinessType = params.get("BusinessType")
if params.get("FileInfos") is not None:
self._FileInfos = []
for item in params.get("FileInfos"):
obj = UploadFile()
obj._deserialize(item)
self._FileInfos.append(obj)
if params.get("Operator") is not None:
self._Operator = UserInfo()
self._Operator._deserialize(params.get("Operator"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class UploadFilesResponse(AbstractModel):
"""UploadFiles返回参数结构体
"""
def __init__(self):
r"""
:param _TotalCount: 上传成功文件数量
注: `如果一个文件上传失败, 则全部文件皆上传失败`
:type TotalCount: int
:param _FileIds: 文件资源ID数组，每个文件资源ID为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
注:`有效期一个小时（超过一小时后系统不定期清理，会有部分时间差）, 有效期内此文件id可以反复使用, 超过有效期无法使用`
:type FileIds: list of str
:param _FileUrls: 对应上传文件的下载链接，过期时间5分钟
:type FileUrls: list of str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._TotalCount = None
self._FileIds = None
self._FileUrls = None
self._RequestId = None
@property
def TotalCount(self):
"""上传成功文件数量
注: `如果一个文件上传失败, 则全部文件皆上传失败`
:rtype: int
"""
return self._TotalCount
@TotalCount.setter
def TotalCount(self, TotalCount):
self._TotalCount = TotalCount
@property
def FileIds(self):
"""文件资源ID数组，每个文件资源ID为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
注:`有效期一个小时（超过一小时后系统不定期清理，会有部分时间差）, 有效期内此文件id可以反复使用, 超过有效期无法使用`
:rtype: list of str
"""
return self._FileIds
@FileIds.setter
def FileIds(self, FileIds):
self._FileIds = FileIds
@property
def FileUrls(self):
"""对应上传文件的下载链接，过期时间5分钟
:rtype: list of str
"""
return self._FileUrls
@FileUrls.setter
def FileUrls(self, FileUrls):
self._FileUrls = FileUrls
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._TotalCount = params.get("TotalCount")
self._FileIds = params.get("FileIds")
self._FileUrls = params.get("FileUrls")
self._RequestId = params.get("RequestId")
class UsageDetail(AbstractModel):
"""用量明细
"""
def __init__(self):
r"""
:param _ProxyOrganizationOpenId: 子客企业标识
:type ProxyOrganizationOpenId: str
:param _ProxyOrganizationName: 子客企业名
:type ProxyOrganizationName: str
:param _Date: 对应的消耗日期, **如果是汇总数据则为1970-01-01**
:type Date: str
:param _Usage: 消耗合同数量
:type Usage: int
:param _Cancel: 撤回合同数量
:type Cancel: int
:param _FlowChannel: 消耗渠道
:type FlowChannel: str
"""
self._ProxyOrganizationOpenId = None
self._ProxyOrganizationName = None
self._Date = None
self._Usage = None
self._Cancel = None
self._FlowChannel = None
@property
def ProxyOrganizationOpenId(self):
"""子客企业标识
:rtype: str
"""
return self._ProxyOrganizationOpenId
@ProxyOrganizationOpenId.setter
def ProxyOrganizationOpenId(self, ProxyOrganizationOpenId):
self._ProxyOrganizationOpenId = ProxyOrganizationOpenId
@property
def ProxyOrganizationName(self):
"""子客企业名
:rtype: str
"""
return self._ProxyOrganizationName
@ProxyOrganizationName.setter
def ProxyOrganizationName(self, ProxyOrganizationName):
self._ProxyOrganizationName = ProxyOrganizationName
@property
def Date(self):
"""对应的消耗日期, **如果是汇总数据则为1970-01-01**
:rtype: str
"""
return self._Date
@Date.setter
def Date(self, Date):
self._Date = Date
@property
def Usage(self):
"""消耗合同数量
:rtype: int
"""
return self._Usage
@Usage.setter
def Usage(self, Usage):
self._Usage = Usage
@property
def Cancel(self):
"""撤回合同数量
:rtype: int
"""
return self._Cancel
@Cancel.setter
def Cancel(self, Cancel):
self._Cancel = Cancel
@property
def FlowChannel(self):
"""消耗渠道
:rtype: str
"""
return self._FlowChannel
@FlowChannel.setter
def FlowChannel(self, FlowChannel):
self._FlowChannel = FlowChannel
def _deserialize(self, params):
self._ProxyOrganizationOpenId = params.get("ProxyOrganizationOpenId")
self._ProxyOrganizationName = params.get("ProxyOrganizationName")
self._Date = params.get("Date")
self._Usage = params.get("Usage")
self._Cancel = params.get("Cancel")
self._FlowChannel = params.get("FlowChannel")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class UserInfo(AbstractModel):
"""接口调用的员工信息
"""
def __init__(self):
r"""
:param _OpenId: 第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。
注意:
1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
:type OpenId: str
:param _Channel: 内部参数，暂未开放使用
:type Channel: str
:param _CustomUserId: 内部参数，暂未开放使用
:type CustomUserId: str
:param _ClientIp: 内部参数，暂未开放使用
:type ClientIp: str
:param _ProxyIp: 内部参数，暂未开放使用
:type ProxyIp: str
"""
self._OpenId = None
self._Channel = None
self._CustomUserId = None
self._ClientIp = None
self._ProxyIp = None
@property
def OpenId(self):
"""第三方应用平台自定义，对应第三方平台子客企业员工的唯一标识。
注意:
1. OpenId在子客企业对应一个真实员工，**本应用唯一, 不可重复使用**，最大64位字符串
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
:rtype: str
"""
return self._OpenId
@OpenId.setter
def OpenId(self, OpenId):
self._OpenId = OpenId
@property
def Channel(self):
warnings.warn("parameter `Channel` is deprecated", DeprecationWarning)
"""内部参数，暂未开放使用
:rtype: str
"""
return self._Channel
@Channel.setter
def Channel(self, Channel):
warnings.warn("parameter `Channel` is deprecated", DeprecationWarning)
self._Channel = Channel
@property
def CustomUserId(self):
warnings.warn("parameter `CustomUserId` is deprecated", DeprecationWarning)
"""内部参数，暂未开放使用
:rtype: str
"""
return self._CustomUserId
@CustomUserId.setter
def CustomUserId(self, CustomUserId):
warnings.warn("parameter `CustomUserId` is deprecated", DeprecationWarning)
self._CustomUserId = CustomUserId
@property
def ClientIp(self):
warnings.warn("parameter `ClientIp` is deprecated", DeprecationWarning)
"""内部参数，暂未开放使用
:rtype: str
"""
return self._ClientIp
@ClientIp.setter
def ClientIp(self, ClientIp):
warnings.warn("parameter `ClientIp` is deprecated", DeprecationWarning)
self._ClientIp = ClientIp
@property
def ProxyIp(self):
warnings.warn("parameter `ProxyIp` is deprecated", DeprecationWarning)
"""内部参数，暂未开放使用
:rtype: str
"""
return self._ProxyIp
@ProxyIp.setter
def ProxyIp(self, ProxyIp):
warnings.warn("parameter `ProxyIp` is deprecated", DeprecationWarning)
self._ProxyIp = ProxyIp
def _deserialize(self, params):
self._OpenId = params.get("OpenId")
self._Channel = params.get("Channel")
self._CustomUserId = params.get("CustomUserId")
self._ClientIp = params.get("ClientIp")
self._ProxyIp = params.get("ProxyIp")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class UserThreeFactor(AbstractModel):
"""用户的三要素：姓名，证件号，证件类型
"""
def __init__(self):
r"""
:param _Name: 签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:type Name: str
:param _IdCardType: 证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:type IdCardType: str
:param _IdCardNumber: 证件号码，应符合以下规则
<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:type IdCardNumber: str
"""
self._Name = None
self._IdCardType = None
self._IdCardNumber = None
@property
def Name(self):
"""签署方经办人的姓名。
经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def IdCardType(self):
"""证件类型，支持以下类型
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
:rtype: str
"""
return self._IdCardType
@IdCardType.setter
def IdCardType(self, IdCardType):
self._IdCardType = IdCardType
@property
def IdCardNumber(self):
"""证件号码，应符合以下规则
<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
:rtype: str
"""
return self._IdCardNumber
@IdCardNumber.setter
def IdCardNumber(self, IdCardNumber):
self._IdCardNumber = IdCardNumber
def _deserialize(self, params):
self._Name = params.get("Name")
self._IdCardType = params.get("IdCardType")
self._IdCardNumber = params.get("IdCardNumber")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class WebThemeConfig(AbstractModel):
"""主题配置
"""
def __init__(self):
r"""
:param _DisplaySignBrandLogo: 是否显示页面底部电子签logo，取值如下：
<ul><li> **true**：页面底部显示电子签logo</li>
<li> **false**：页面底部不显示电子签logo（默认）</li></ul>
:type DisplaySignBrandLogo: bool
:param _WebEmbedThemeColor: 主题颜色：
支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
<br/>
:type WebEmbedThemeColor: str
:param _AuthenticateBackground: 企业认证页背景图（base64图片）
:type AuthenticateBackground: str
:param _HideAuthenticateNavigationBar: 隐藏企业认证页面导航栏，取值如下：
<ul><li> **true**：隐藏企业认证页面导航栏</li>
<li> **false**：显示企业认证页面导航栏（默认）</li></ul>
:type HideAuthenticateNavigationBar: bool
:param _HideAuthenticateTopLogo: 隐藏企业认证顶部logo，取值如下：
<ul><li> **true**：隐藏企业认证顶部logo</li>
<li> **false**：显示企业认证顶部logo（默认）</li></ul>
:type HideAuthenticateTopLogo: bool
"""
self._DisplaySignBrandLogo = None
self._WebEmbedThemeColor = None
self._AuthenticateBackground = None
self._HideAuthenticateNavigationBar = None
self._HideAuthenticateTopLogo = None
@property
def DisplaySignBrandLogo(self):
"""是否显示页面底部电子签logo，取值如下：
<ul><li> **true**：页面底部显示电子签logo</li>
<li> **false**：页面底部不显示电子签logo（默认）</li></ul>
:rtype: bool
"""
return self._DisplaySignBrandLogo
@DisplaySignBrandLogo.setter
def DisplaySignBrandLogo(self, DisplaySignBrandLogo):
self._DisplaySignBrandLogo = DisplaySignBrandLogo
@property
def WebEmbedThemeColor(self):
"""主题颜色：
支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
<br/>
:rtype: str
"""
return self._WebEmbedThemeColor
@WebEmbedThemeColor.setter
def WebEmbedThemeColor(self, WebEmbedThemeColor):
self._WebEmbedThemeColor = WebEmbedThemeColor
@property
def AuthenticateBackground(self):
"""企业认证页背景图（base64图片）
:rtype: str
"""
return self._AuthenticateBackground
@AuthenticateBackground.setter
def AuthenticateBackground(self, AuthenticateBackground):
self._AuthenticateBackground = AuthenticateBackground
@property
def HideAuthenticateNavigationBar(self):
"""隐藏企业认证页面导航栏，取值如下：
<ul><li> **true**：隐藏企业认证页面导航栏</li>
<li> **false**：显示企业认证页面导航栏（默认）</li></ul>
:rtype: bool
"""
return self._HideAuthenticateNavigationBar
@HideAuthenticateNavigationBar.setter
def HideAuthenticateNavigationBar(self, HideAuthenticateNavigationBar):
self._HideAuthenticateNavigationBar = HideAuthenticateNavigationBar
@property
def HideAuthenticateTopLogo(self):
"""隐藏企业认证顶部logo，取值如下：
<ul><li> **true**：隐藏企业认证顶部logo</li>
<li> **false**：显示企业认证顶部logo（默认）</li></ul>
:rtype: bool
"""
return self._HideAuthenticateTopLogo
@HideAuthenticateTopLogo.setter
def HideAuthenticateTopLogo(self, HideAuthenticateTopLogo):
self._HideAuthenticateTopLogo = HideAuthenticateTopLogo
def _deserialize(self, params):
self._DisplaySignBrandLogo = params.get("DisplaySignBrandLogo")
self._WebEmbedThemeColor = params.get("WebEmbedThemeColor")
self._AuthenticateBackground = params.get("AuthenticateBackground")
self._HideAuthenticateNavigationBar = params.get("HideAuthenticateNavigationBar")
self._HideAuthenticateTopLogo = params.get("HideAuthenticateTopLogo")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))