tencentcloud-sdk-python-essbasic 3.1.124__py2.py3-none-any.whl → 3.1.127__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tencentcloud/__init__.py +1 -1
- tencentcloud/essbasic/v20210526/essbasic_client.py +63 -0
- tencentcloud/essbasic/v20210526/essbasic_client_async.py +53 -0
- tencentcloud/essbasic/v20210526/models.py +415 -345
- {tencentcloud_sdk_python_essbasic-3.1.124.dist-info → tencentcloud_sdk_python_essbasic-3.1.127.dist-info}/METADATA +2 -2
- {tencentcloud_sdk_python_essbasic-3.1.124.dist-info → tencentcloud_sdk_python_essbasic-3.1.127.dist-info}/RECORD +8 -8
- {tencentcloud_sdk_python_essbasic-3.1.124.dist-info → tencentcloud_sdk_python_essbasic-3.1.127.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_essbasic-3.1.124.dist-info → tencentcloud_sdk_python_essbasic-3.1.127.dist-info}/top_level.txt +0 -0
|
@@ -2843,7 +2843,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2843
2843
|
:type CacheApproverInfo: bool
|
|
2844
2844
|
:param _CanBatchReject: <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。</code></p>
|
|
2845
2845
|
:type CanBatchReject: bool
|
|
2846
|
-
:param _PresetApproverInfo: <p
|
|
2846
|
+
:param _PresetApproverInfo: <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。若为个人动态签署方,支持预设姓名、证件、手机号。若为企业员工动态签署方,仅支持预设企业名称(仅限预设SaaS企业参与方,不支持子客企业)。</p>
|
|
2847
2847
|
:type PresetApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.PresetApproverInfo`
|
|
2848
2848
|
:param _CanSkipReadFlow: <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。</code></p>
|
|
2849
2849
|
:type CanSkipReadFlow: bool
|
|
@@ -3012,7 +3012,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
3012
3012
|
|
|
3013
3013
|
@property
|
|
3014
3014
|
def PresetApproverInfo(self):
|
|
3015
|
-
r"""<p
|
|
3015
|
+
r"""<p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。若为个人动态签署方,支持预设姓名、证件、手机号。若为企业员工动态签署方,仅支持预设企业名称(仅限预设SaaS企业参与方,不支持子客企业)。</p>
|
|
3016
3016
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.PresetApproverInfo`
|
|
3017
3017
|
"""
|
|
3018
3018
|
return self._PresetApproverInfo
|
|
@@ -3133,111 +3133,41 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3133
3133
|
|
|
3134
3134
|
def __init__(self):
|
|
3135
3135
|
r"""
|
|
3136
|
-
:param _Agent:
|
|
3137
|
-
|
|
3138
|
-
此接口下面信息必填。
|
|
3139
|
-
<ul>
|
|
3140
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
3141
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3142
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
3143
|
-
</ul>
|
|
3144
|
-
第三方平台子客企业和员工必须已经过实名认证
|
|
3136
|
+
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
|
|
3145
3137
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
3146
|
-
:param _Name:
|
|
3147
|
-
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
3148
|
-
|
|
3149
|
-
注:
|
|
3150
|
-
<ul>
|
|
3151
|
-
<li>请确保和合同中填入的一致。</li>
|
|
3152
|
-
<li>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
|
|
3153
|
-
</ul>
|
|
3138
|
+
:param _Name: <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p><p>注:</p><ul><li>请确保和合同中填入的一致。</li><li>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li></ul>
|
|
3154
3139
|
:type Name: str
|
|
3155
|
-
:param _Mobile:
|
|
3156
|
-
请确认手机号所有方为此业务通知方。
|
|
3157
|
-
|
|
3158
|
-
注:
|
|
3159
|
-
<ul>
|
|
3160
|
-
<li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li>
|
|
3161
|
-
</ul>
|
|
3162
|
-
|
|
3140
|
+
:param _Mobile: <p>手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>请确认手机号所有方为此业务通知方。</p><p>注:</p><ul><li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
|
|
3163
3141
|
:type Mobile: str
|
|
3164
|
-
:param _Operator:
|
|
3165
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3142
|
+
:param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
3166
3143
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
3167
|
-
:param _IdCardType:
|
|
3168
|
-
<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>
|
|
3169
|
-
<li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>
|
|
3170
|
-
<li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
|
|
3171
|
-
|
|
3172
|
-
注:
|
|
3173
|
-
1. `请确保和合同中填入的一致`。
|
|
3174
|
-
2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
|
|
3144
|
+
:param _IdCardType: <p>证件类型,支持以下类型</p><ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li><li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li><li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p>注:</p><ol><li><code>请确保和合同中填入的一致</code>。</li><li><code>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。</code></li></ol>
|
|
3175
3145
|
:type IdCardType: str
|
|
3176
|
-
:param _IdCardNumber:
|
|
3177
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
3178
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
3179
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3180
|
-
|
|
3181
|
-
注:
|
|
3182
|
-
1. `请确保和合同中填入的一致`。
|
|
3183
|
-
2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
3146
|
+
:param _IdCardNumber: <p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul><p>注:</p><ol><li><code>请确保和合同中填入的一致</code>。</li><li><code>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
|
|
3184
3147
|
:type IdCardNumber: str
|
|
3185
|
-
:param _NotifyType:
|
|
3186
|
-
<ul>
|
|
3187
|
-
<li>**NONE** : 不通知(默认)</li>
|
|
3188
|
-
<li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
|
|
3189
|
-
</ul>
|
|
3148
|
+
:param _NotifyType: <p>通知用户方式:</p><ul><li>**NONE** : 不通知(默认)</li><li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li></ul>
|
|
3190
3149
|
:type NotifyType: str
|
|
3191
|
-
:param _FlowIds:
|
|
3192
|
-
注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
|
|
3150
|
+
:param _FlowIds: <p>批量签署的合同流程ID数组。<font color="red">此参数必传。</font><br>注: <code>在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。</code></p>
|
|
3193
3151
|
:type FlowIds: list of str
|
|
3194
|
-
:param _OrganizationName: SaaS平台企业员工签署方的企业名称。目标签署人如果为saas
|
|
3195
|
-
|
|
3196
|
-
注:
|
|
3197
|
-
<ul>
|
|
3198
|
-
<li>请确认该名称与企业营业执照中注册的名称一致。</li>
|
|
3199
|
-
<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
|
|
3200
|
-
<li>请确保此企业已完成腾讯电子签企业认证。</li>
|
|
3201
|
-
<li>**若为子客企业员工,请使用OpenId,OrganizationOpenId参数。如果此子客企业未认证,则此参数需要传子客企业名称**</li>
|
|
3202
|
-
</ul>
|
|
3152
|
+
:param _OrganizationName: <p>SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份,此参数必填。</p><p>注:</p><ul><li>请确认该名称与企业营业执照中注册的名称一致。</li><li>如果名称中包含英文括号(),请使用中文括号()代替。</li><li>请确保此企业已完成腾讯电子签企业认证。</li><li>**若为子客企业员工,请使用OpenId,OrganizationOpenId参数。如果此子客企业未认证,则此参数需要传子客企业名称**</li></ul>
|
|
3203
3153
|
:type OrganizationName: str
|
|
3204
|
-
:param _SignatureTypes:
|
|
3154
|
+
:param _SignatureTypes: <p>指定批量签署合同的签名类型,可传递以下值:<ul><li><strong>0</strong>:手写签名</li><li><strong>1</strong>:OCR楷体</li><li><strong>2</strong>:姓名印章</li><li><strong>3</strong>:图片印章</li><li><strong>4</strong>:系统签名</li><li><strong>5</strong>:长效手写签名(包含手写签名)</li></ul>注:<ul><li>不传值的情况则计算所有合同中个人签署区的签名类型,规则如下:<ul><li>1.如果所有合同中所有的个人签署区方式包含多种则是手写</li><li>2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式(例如合同1有多个签署区都是指定OCR楷体,合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体)</li></ul></li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul></p>
|
|
3205
3155
|
:type SignatureTypes: list of int
|
|
3206
|
-
:param _JumpToDetail:
|
|
3207
|
-
<ul>
|
|
3208
|
-
<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
|
|
3209
|
-
<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
|
|
3210
|
-
</ul>
|
|
3156
|
+
:param _JumpToDetail: <p>是否直接跳转至合同内容页面进行签署</p><ul><li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li><li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li></ul>
|
|
3211
3157
|
:type JumpToDetail: bool
|
|
3212
|
-
:param _FlowBatchUrlInfo:
|
|
3158
|
+
:param _FlowBatchUrlInfo: <p>批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。</p>
|
|
3213
3159
|
:type FlowBatchUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
|
|
3214
|
-
:param _OpenId:
|
|
3215
|
-
|
|
3216
|
-
注:
|
|
3217
|
-
<ul>
|
|
3218
|
-
<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>
|
|
3219
|
-
<li>传递了此参数可以无需传递Name,Mobile,IdCardNumber,IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>
|
|
3220
|
-
</ul>
|
|
3160
|
+
:param _OpenId: <p>第三方平台子客企业员工的标识OpenId,批签合同经办人为子客员工的情况下为必填。</p><p>注:</p><ul><li>传入的OpenId对应员工在此子客企业下必须已经实名</li><li>传递了此参数可以无需传递Name,Mobile,IdCardNumber,IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li></ul>
|
|
3221
3161
|
:type OpenId: str
|
|
3222
|
-
:param _OrganizationOpenId:
|
|
3162
|
+
:param _OrganizationOpenId: <p>第三方平台子客企业的企业的标识, 即OrganizationOpenId,批签合同经办人为子客企业员工是为必填。</p>
|
|
3223
3163
|
:type OrganizationOpenId: str
|
|
3224
|
-
:param _AutoJumpBack:
|
|
3225
|
-
<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
|
|
3226
|
-
|
|
3227
|
-
注:
|
|
3228
|
-
1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
|
|
3229
|
-
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
3230
|
-
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
3164
|
+
:param _AutoJumpBack: <p>签署完成后是否自动回跳</p><ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
|
|
3231
3165
|
:type AutoJumpBack: bool
|
|
3232
|
-
:param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为
|
|
3233
|
-
|
|
3234
|
-
参考 [公众号 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)。
|
|
3166
|
+
:param _UrlUseEnv: <p><font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 <strong>WeChatOfficialAccounts</strong>,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 </p><p>参考 <a href="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">公众号 H5 跳转电子签小程序</a>。</p>
|
|
3235
3167
|
:type UrlUseEnv: str
|
|
3236
|
-
:param _CanBatchReject:
|
|
3237
|
-
注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`
|
|
3168
|
+
:param _CanBatchReject: <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul><br>注:<code>1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能</code></p>
|
|
3238
3169
|
:type CanBatchReject: bool
|
|
3239
|
-
:param _CanSkipReadFlow:
|
|
3240
|
-
注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名控件的限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。`
|
|
3170
|
+
:param _CanSkipReadFlow: <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul><br>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名控件的限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。</code></p>
|
|
3241
3171
|
:type CanSkipReadFlow: bool
|
|
3242
3172
|
"""
|
|
3243
3173
|
self._Agent = None
|
|
@@ -3261,15 +3191,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3261
3191
|
|
|
3262
3192
|
@property
|
|
3263
3193
|
def Agent(self):
|
|
3264
|
-
r"""
|
|
3265
|
-
|
|
3266
|
-
此接口下面信息必填。
|
|
3267
|
-
<ul>
|
|
3268
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
3269
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3270
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
3271
|
-
</ul>
|
|
3272
|
-
第三方平台子客企业和员工必须已经过实名认证
|
|
3194
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
|
|
3273
3195
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
3274
3196
|
"""
|
|
3275
3197
|
return self._Agent
|
|
@@ -3280,14 +3202,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3280
3202
|
|
|
3281
3203
|
@property
|
|
3282
3204
|
def Name(self):
|
|
3283
|
-
r"""
|
|
3284
|
-
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
3285
|
-
|
|
3286
|
-
注:
|
|
3287
|
-
<ul>
|
|
3288
|
-
<li>请确保和合同中填入的一致。</li>
|
|
3289
|
-
<li>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
|
|
3290
|
-
</ul>
|
|
3205
|
+
r"""<p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p><p>注:</p><ul><li>请确保和合同中填入的一致。</li><li>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li></ul>
|
|
3291
3206
|
:rtype: str
|
|
3292
3207
|
"""
|
|
3293
3208
|
return self._Name
|
|
@@ -3298,14 +3213,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3298
3213
|
|
|
3299
3214
|
@property
|
|
3300
3215
|
def Mobile(self):
|
|
3301
|
-
r"""
|
|
3302
|
-
请确认手机号所有方为此业务通知方。
|
|
3303
|
-
|
|
3304
|
-
注:
|
|
3305
|
-
<ul>
|
|
3306
|
-
<li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li>
|
|
3307
|
-
</ul>
|
|
3308
|
-
|
|
3216
|
+
r"""<p>手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>请确认手机号所有方为此业务通知方。</p><p>注:</p><ul><li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
|
|
3309
3217
|
:rtype: str
|
|
3310
3218
|
"""
|
|
3311
3219
|
return self._Mobile
|
|
@@ -3316,8 +3224,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3316
3224
|
|
|
3317
3225
|
@property
|
|
3318
3226
|
def Operator(self):
|
|
3319
|
-
r"""
|
|
3320
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3227
|
+
r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
3321
3228
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
3322
3229
|
"""
|
|
3323
3230
|
return self._Operator
|
|
@@ -3328,14 +3235,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3328
3235
|
|
|
3329
3236
|
@property
|
|
3330
3237
|
def IdCardType(self):
|
|
3331
|
-
r"""
|
|
3332
|
-
<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>
|
|
3333
|
-
<li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>
|
|
3334
|
-
<li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
|
|
3335
|
-
|
|
3336
|
-
注:
|
|
3337
|
-
1. `请确保和合同中填入的一致`。
|
|
3338
|
-
2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
|
|
3238
|
+
r"""<p>证件类型,支持以下类型</p><ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li><li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li><li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p>注:</p><ol><li><code>请确保和合同中填入的一致</code>。</li><li><code>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。</code></li></ol>
|
|
3339
3239
|
:rtype: str
|
|
3340
3240
|
"""
|
|
3341
3241
|
return self._IdCardType
|
|
@@ -3346,14 +3246,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3346
3246
|
|
|
3347
3247
|
@property
|
|
3348
3248
|
def IdCardNumber(self):
|
|
3349
|
-
r"""
|
|
3350
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
3351
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
3352
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3353
|
-
|
|
3354
|
-
注:
|
|
3355
|
-
1. `请确保和合同中填入的一致`。
|
|
3356
|
-
2. `在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
3249
|
+
r"""<p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul><p>注:</p><ol><li><code>请确保和合同中填入的一致</code>。</li><li><code>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
|
|
3357
3250
|
:rtype: str
|
|
3358
3251
|
"""
|
|
3359
3252
|
return self._IdCardNumber
|
|
@@ -3364,11 +3257,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3364
3257
|
|
|
3365
3258
|
@property
|
|
3366
3259
|
def NotifyType(self):
|
|
3367
|
-
r"""
|
|
3368
|
-
<ul>
|
|
3369
|
-
<li>**NONE** : 不通知(默认)</li>
|
|
3370
|
-
<li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
|
|
3371
|
-
</ul>
|
|
3260
|
+
r"""<p>通知用户方式:</p><ul><li>**NONE** : 不通知(默认)</li><li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li></ul>
|
|
3372
3261
|
:rtype: str
|
|
3373
3262
|
"""
|
|
3374
3263
|
return self._NotifyType
|
|
@@ -3379,8 +3268,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3379
3268
|
|
|
3380
3269
|
@property
|
|
3381
3270
|
def FlowIds(self):
|
|
3382
|
-
r"""
|
|
3383
|
-
注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
|
|
3271
|
+
r"""<p>批量签署的合同流程ID数组。<font color="red">此参数必传。</font><br>注: <code>在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。</code></p>
|
|
3384
3272
|
:rtype: list of str
|
|
3385
3273
|
"""
|
|
3386
3274
|
return self._FlowIds
|
|
@@ -3391,15 +3279,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3391
3279
|
|
|
3392
3280
|
@property
|
|
3393
3281
|
def OrganizationName(self):
|
|
3394
|
-
r"""SaaS平台企业员工签署方的企业名称。目标签署人如果为saas
|
|
3395
|
-
|
|
3396
|
-
注:
|
|
3397
|
-
<ul>
|
|
3398
|
-
<li>请确认该名称与企业营业执照中注册的名称一致。</li>
|
|
3399
|
-
<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
|
|
3400
|
-
<li>请确保此企业已完成腾讯电子签企业认证。</li>
|
|
3401
|
-
<li>**若为子客企业员工,请使用OpenId,OrganizationOpenId参数。如果此子客企业未认证,则此参数需要传子客企业名称**</li>
|
|
3402
|
-
</ul>
|
|
3282
|
+
r"""<p>SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份,此参数必填。</p><p>注:</p><ul><li>请确认该名称与企业营业执照中注册的名称一致。</li><li>如果名称中包含英文括号(),请使用中文括号()代替。</li><li>请确保此企业已完成腾讯电子签企业认证。</li><li>**若为子客企业员工,请使用OpenId,OrganizationOpenId参数。如果此子客企业未认证,则此参数需要传子客企业名称**</li></ul>
|
|
3403
3283
|
:rtype: str
|
|
3404
3284
|
"""
|
|
3405
3285
|
return self._OrganizationName
|
|
@@ -3410,7 +3290,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3410
3290
|
|
|
3411
3291
|
@property
|
|
3412
3292
|
def SignatureTypes(self):
|
|
3413
|
-
r"""
|
|
3293
|
+
r"""<p>指定批量签署合同的签名类型,可传递以下值:<ul><li><strong>0</strong>:手写签名</li><li><strong>1</strong>:OCR楷体</li><li><strong>2</strong>:姓名印章</li><li><strong>3</strong>:图片印章</li><li><strong>4</strong>:系统签名</li><li><strong>5</strong>:长效手写签名(包含手写签名)</li></ul>注:<ul><li>不传值的情况则计算所有合同中个人签署区的签名类型,规则如下:<ul><li>1.如果所有合同中所有的个人签署区方式包含多种则是手写</li><li>2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式(例如合同1有多个签署区都是指定OCR楷体,合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体)</li></ul></li><li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul></p>
|
|
3414
3294
|
:rtype: list of int
|
|
3415
3295
|
"""
|
|
3416
3296
|
return self._SignatureTypes
|
|
@@ -3421,11 +3301,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3421
3301
|
|
|
3422
3302
|
@property
|
|
3423
3303
|
def JumpToDetail(self):
|
|
3424
|
-
r"""
|
|
3425
|
-
<ul>
|
|
3426
|
-
<li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
|
|
3427
|
-
<li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
|
|
3428
|
-
</ul>
|
|
3304
|
+
r"""<p>是否直接跳转至合同内容页面进行签署</p><ul><li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li><li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li></ul>
|
|
3429
3305
|
:rtype: bool
|
|
3430
3306
|
"""
|
|
3431
3307
|
return self._JumpToDetail
|
|
@@ -3436,7 +3312,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3436
3312
|
|
|
3437
3313
|
@property
|
|
3438
3314
|
def FlowBatchUrlInfo(self):
|
|
3439
|
-
r"""
|
|
3315
|
+
r"""<p>批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。</p>
|
|
3440
3316
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
|
|
3441
3317
|
"""
|
|
3442
3318
|
return self._FlowBatchUrlInfo
|
|
@@ -3447,13 +3323,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3447
3323
|
|
|
3448
3324
|
@property
|
|
3449
3325
|
def OpenId(self):
|
|
3450
|
-
r"""
|
|
3451
|
-
|
|
3452
|
-
注:
|
|
3453
|
-
<ul>
|
|
3454
|
-
<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>
|
|
3455
|
-
<li>传递了此参数可以无需传递Name,Mobile,IdCardNumber,IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>
|
|
3456
|
-
</ul>
|
|
3326
|
+
r"""<p>第三方平台子客企业员工的标识OpenId,批签合同经办人为子客员工的情况下为必填。</p><p>注:</p><ul><li>传入的OpenId对应员工在此子客企业下必须已经实名</li><li>传递了此参数可以无需传递Name,Mobile,IdCardNumber,IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li></ul>
|
|
3457
3327
|
:rtype: str
|
|
3458
3328
|
"""
|
|
3459
3329
|
return self._OpenId
|
|
@@ -3464,7 +3334,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3464
3334
|
|
|
3465
3335
|
@property
|
|
3466
3336
|
def OrganizationOpenId(self):
|
|
3467
|
-
r"""
|
|
3337
|
+
r"""<p>第三方平台子客企业的企业的标识, 即OrganizationOpenId,批签合同经办人为子客企业员工是为必填。</p>
|
|
3468
3338
|
:rtype: str
|
|
3469
3339
|
"""
|
|
3470
3340
|
return self._OrganizationOpenId
|
|
@@ -3475,13 +3345,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3475
3345
|
|
|
3476
3346
|
@property
|
|
3477
3347
|
def AutoJumpBack(self):
|
|
3478
|
-
r"""
|
|
3479
|
-
<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
|
|
3480
|
-
|
|
3481
|
-
注:
|
|
3482
|
-
1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
|
|
3483
|
-
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
3484
|
-
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
3348
|
+
r"""<p>签署完成后是否自动回跳</p><ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
|
|
3485
3349
|
:rtype: bool
|
|
3486
3350
|
"""
|
|
3487
3351
|
return self._AutoJumpBack
|
|
@@ -3492,9 +3356,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3492
3356
|
|
|
3493
3357
|
@property
|
|
3494
3358
|
def UrlUseEnv(self):
|
|
3495
|
-
r"""<font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为
|
|
3496
|
-
|
|
3497
|
-
参考 [公众号 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)。
|
|
3359
|
+
r"""<p><font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 <strong>WeChatOfficialAccounts</strong>,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 </p><p>参考 <a href="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">公众号 H5 跳转电子签小程序</a>。</p>
|
|
3498
3360
|
:rtype: str
|
|
3499
3361
|
"""
|
|
3500
3362
|
return self._UrlUseEnv
|
|
@@ -3505,8 +3367,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3505
3367
|
|
|
3506
3368
|
@property
|
|
3507
3369
|
def CanBatchReject(self):
|
|
3508
|
-
r"""
|
|
3509
|
-
注:`1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能`
|
|
3370
|
+
r"""<p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul><br>注:<code>1. 当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。2. 如果是链接直接跳转至详情页(JumpToDetail参数为true),也不支持批量拒签功能</code></p>
|
|
3510
3371
|
:rtype: bool
|
|
3511
3372
|
"""
|
|
3512
3373
|
return self._CanBatchReject
|
|
@@ -3517,8 +3378,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
3517
3378
|
|
|
3518
3379
|
@property
|
|
3519
3380
|
def CanSkipReadFlow(self):
|
|
3520
|
-
r"""
|
|
3521
|
-
注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名控件的限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。`
|
|
3381
|
+
r"""<p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul><br>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名控件的限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。</code></p>
|
|
3522
3382
|
:rtype: bool
|
|
3523
3383
|
"""
|
|
3524
3384
|
return self._CanSkipReadFlow
|
|
@@ -3570,19 +3430,11 @@ class ChannelCreateBatchSignUrlResponse(AbstractModel):
|
|
|
3570
3430
|
|
|
3571
3431
|
def __init__(self):
|
|
3572
3432
|
r"""
|
|
3573
|
-
:param _SignUrl:
|
|
3574
|
-
|
|
3575
|
-
注:
|
|
3576
|
-
1. 非小程序和APP集成使用
|
|
3577
|
-
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
3433
|
+
:param _SignUrl: <p>批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。</p><p>注: </p><ol><li>非小程序和APP集成使用</li><li><font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ol>
|
|
3578
3434
|
:type SignUrl: str
|
|
3579
|
-
:param _ExpiredTime:
|
|
3435
|
+
:param _ExpiredTime: <p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
|
|
3580
3436
|
:type ExpiredTime: int
|
|
3581
|
-
:param _MiniAppPath:
|
|
3582
|
-
|
|
3583
|
-
注:
|
|
3584
|
-
1. 小程序和APP集成使用
|
|
3585
|
-
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
3437
|
+
:param _MiniAppPath: <p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p><p>注: </p><ol><li>小程序和APP集成使用</li><li><font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ol>
|
|
3586
3438
|
:type MiniAppPath: str
|
|
3587
3439
|
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3588
3440
|
:type RequestId: str
|
|
@@ -3594,11 +3446,7 @@ class ChannelCreateBatchSignUrlResponse(AbstractModel):
|
|
|
3594
3446
|
|
|
3595
3447
|
@property
|
|
3596
3448
|
def SignUrl(self):
|
|
3597
|
-
r"""
|
|
3598
|
-
|
|
3599
|
-
注:
|
|
3600
|
-
1. 非小程序和APP集成使用
|
|
3601
|
-
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
3449
|
+
r"""<p>批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。</p><p>注: </p><ol><li>非小程序和APP集成使用</li><li><font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ol>
|
|
3602
3450
|
:rtype: str
|
|
3603
3451
|
"""
|
|
3604
3452
|
return self._SignUrl
|
|
@@ -3609,7 +3457,7 @@ class ChannelCreateBatchSignUrlResponse(AbstractModel):
|
|
|
3609
3457
|
|
|
3610
3458
|
@property
|
|
3611
3459
|
def ExpiredTime(self):
|
|
3612
|
-
r"""
|
|
3460
|
+
r"""<p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
|
|
3613
3461
|
:rtype: int
|
|
3614
3462
|
"""
|
|
3615
3463
|
return self._ExpiredTime
|
|
@@ -3620,11 +3468,7 @@ class ChannelCreateBatchSignUrlResponse(AbstractModel):
|
|
|
3620
3468
|
|
|
3621
3469
|
@property
|
|
3622
3470
|
def MiniAppPath(self):
|
|
3623
|
-
r"""
|
|
3624
|
-
|
|
3625
|
-
注:
|
|
3626
|
-
1. 小程序和APP集成使用
|
|
3627
|
-
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
3471
|
+
r"""<p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p><p>注: </p><ol><li>小程序和APP集成使用</li><li><font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ol>
|
|
3628
3472
|
:rtype: str
|
|
3629
3473
|
"""
|
|
3630
3474
|
return self._MiniAppPath
|
|
@@ -7161,44 +7005,31 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7161
7005
|
|
|
7162
7006
|
def __init__(self):
|
|
7163
7007
|
r"""
|
|
7164
|
-
:param _Agent:
|
|
7008
|
+
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
|
|
7165
7009
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
7166
|
-
:param _UserName:
|
|
7010
|
+
:param _UserName: <p>个人用户姓名</p>
|
|
7167
7011
|
:type UserName: str
|
|
7168
|
-
:param _IdCardNumber:
|
|
7169
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
7170
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
7171
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
7012
|
+
:param _IdCardNumber: <p>证件号码, 应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
7172
7013
|
:type IdCardNumber: str
|
|
7173
|
-
:param _SealName:
|
|
7174
|
-
注:`同一企业下电子印章名字不能相同`
|
|
7014
|
+
:param _SealName: <p>电子印章名字,1-50个中文字符<br>注:<code>同一企业下电子印章名字不能相同</code></p>
|
|
7175
7015
|
:type SealName: str
|
|
7176
|
-
:param _SealImage:
|
|
7177
|
-
|
|
7178
|
-
|
|
7016
|
+
:param _SealImage: <p>电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。</p>
|
|
7179
7017
|
:type SealImage: str
|
|
7180
|
-
:param _Operator:
|
|
7181
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
7018
|
+
:param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
7182
7019
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
7183
|
-
:param _IdCardType:
|
|
7184
|
-
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
|
|
7185
|
-
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
|
|
7186
|
-
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
|
|
7187
|
-
<li>OTHER_CARD_TYPE : 其他</li></ul>
|
|
7188
|
-
|
|
7189
|
-
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
7020
|
+
:param _IdCardType: <p>证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE : 其他</li></ul><p>注: <code>其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
|
|
7190
7021
|
:type IdCardType: str
|
|
7191
|
-
:param _SealImageCompress:
|
|
7022
|
+
:param _SealImageCompress: <p>是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。</p>
|
|
7192
7023
|
:type SealImageCompress: bool
|
|
7193
|
-
:param _Mobile:
|
|
7024
|
+
:param _Mobile: <p>手机号码;当需要开通自动签时,该参数必传</p>
|
|
7194
7025
|
:type Mobile: str
|
|
7195
|
-
:param _EnableAutoSign:
|
|
7026
|
+
:param _EnableAutoSign: <p>该字段已不再使用</p>
|
|
7196
7027
|
:type EnableAutoSign: bool
|
|
7197
|
-
:param _LicenseType:
|
|
7028
|
+
:param _LicenseType: <p>设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减</p>
|
|
7198
7029
|
:type LicenseType: int
|
|
7199
7030
|
:param _SceneKey: <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
7200
7031
|
:type SceneKey: str
|
|
7201
|
-
:param _FileId:
|
|
7032
|
+
:param _FileId: <p>印章图片文件 id取值:填写的FileId通过UploadFiles接口上传文件获取。</p>
|
|
7202
7033
|
:type FileId: str
|
|
7203
7034
|
"""
|
|
7204
7035
|
self._Agent = None
|
|
@@ -7217,7 +7048,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7217
7048
|
|
|
7218
7049
|
@property
|
|
7219
7050
|
def Agent(self):
|
|
7220
|
-
r"""
|
|
7051
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
|
|
7221
7052
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
7222
7053
|
"""
|
|
7223
7054
|
return self._Agent
|
|
@@ -7228,7 +7059,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7228
7059
|
|
|
7229
7060
|
@property
|
|
7230
7061
|
def UserName(self):
|
|
7231
|
-
r"""
|
|
7062
|
+
r"""<p>个人用户姓名</p>
|
|
7232
7063
|
:rtype: str
|
|
7233
7064
|
"""
|
|
7234
7065
|
return self._UserName
|
|
@@ -7239,10 +7070,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7239
7070
|
|
|
7240
7071
|
@property
|
|
7241
7072
|
def IdCardNumber(self):
|
|
7242
|
-
r"""
|
|
7243
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
7244
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
7245
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
7073
|
+
r"""<p>证件号码, 应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
7246
7074
|
:rtype: str
|
|
7247
7075
|
"""
|
|
7248
7076
|
return self._IdCardNumber
|
|
@@ -7253,8 +7081,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7253
7081
|
|
|
7254
7082
|
@property
|
|
7255
7083
|
def SealName(self):
|
|
7256
|
-
r"""
|
|
7257
|
-
注:`同一企业下电子印章名字不能相同`
|
|
7084
|
+
r"""<p>电子印章名字,1-50个中文字符<br>注:<code>同一企业下电子印章名字不能相同</code></p>
|
|
7258
7085
|
:rtype: str
|
|
7259
7086
|
"""
|
|
7260
7087
|
return self._SealName
|
|
@@ -7265,9 +7092,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7265
7092
|
|
|
7266
7093
|
@property
|
|
7267
7094
|
def SealImage(self):
|
|
7268
|
-
r"""
|
|
7269
|
-
|
|
7270
|
-
|
|
7095
|
+
r"""<p>电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。</p>
|
|
7271
7096
|
:rtype: str
|
|
7272
7097
|
"""
|
|
7273
7098
|
return self._SealImage
|
|
@@ -7278,8 +7103,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7278
7103
|
|
|
7279
7104
|
@property
|
|
7280
7105
|
def Operator(self):
|
|
7281
|
-
r"""
|
|
7282
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
7106
|
+
r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
7283
7107
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
7284
7108
|
"""
|
|
7285
7109
|
return self._Operator
|
|
@@ -7290,13 +7114,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7290
7114
|
|
|
7291
7115
|
@property
|
|
7292
7116
|
def IdCardType(self):
|
|
7293
|
-
r"""
|
|
7294
|
-
<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
|
|
7295
|
-
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
|
|
7296
|
-
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
|
|
7297
|
-
<li>OTHER_CARD_TYPE : 其他</li></ul>
|
|
7298
|
-
|
|
7299
|
-
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
7117
|
+
r"""<p>证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE : 其他</li></ul><p>注: <code>其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
|
|
7300
7118
|
:rtype: str
|
|
7301
7119
|
"""
|
|
7302
7120
|
return self._IdCardType
|
|
@@ -7307,7 +7125,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7307
7125
|
|
|
7308
7126
|
@property
|
|
7309
7127
|
def SealImageCompress(self):
|
|
7310
|
-
r"""
|
|
7128
|
+
r"""<p>是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。</p>
|
|
7311
7129
|
:rtype: bool
|
|
7312
7130
|
"""
|
|
7313
7131
|
return self._SealImageCompress
|
|
@@ -7318,7 +7136,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7318
7136
|
|
|
7319
7137
|
@property
|
|
7320
7138
|
def Mobile(self):
|
|
7321
|
-
r"""
|
|
7139
|
+
r"""<p>手机号码;当需要开通自动签时,该参数必传</p>
|
|
7322
7140
|
:rtype: str
|
|
7323
7141
|
"""
|
|
7324
7142
|
return self._Mobile
|
|
@@ -7329,18 +7147,22 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7329
7147
|
|
|
7330
7148
|
@property
|
|
7331
7149
|
def EnableAutoSign(self):
|
|
7332
|
-
|
|
7150
|
+
warnings.warn("parameter `EnableAutoSign` is deprecated", DeprecationWarning)
|
|
7151
|
+
|
|
7152
|
+
r"""<p>该字段已不再使用</p>
|
|
7333
7153
|
:rtype: bool
|
|
7334
7154
|
"""
|
|
7335
7155
|
return self._EnableAutoSign
|
|
7336
7156
|
|
|
7337
7157
|
@EnableAutoSign.setter
|
|
7338
7158
|
def EnableAutoSign(self, EnableAutoSign):
|
|
7159
|
+
warnings.warn("parameter `EnableAutoSign` is deprecated", DeprecationWarning)
|
|
7160
|
+
|
|
7339
7161
|
self._EnableAutoSign = EnableAutoSign
|
|
7340
7162
|
|
|
7341
7163
|
@property
|
|
7342
7164
|
def LicenseType(self):
|
|
7343
|
-
r"""
|
|
7165
|
+
r"""<p>设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减</p>
|
|
7344
7166
|
:rtype: int
|
|
7345
7167
|
"""
|
|
7346
7168
|
return self._LicenseType
|
|
@@ -7362,7 +7184,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7362
7184
|
|
|
7363
7185
|
@property
|
|
7364
7186
|
def FileId(self):
|
|
7365
|
-
r"""
|
|
7187
|
+
r"""<p>印章图片文件 id取值:填写的FileId通过UploadFiles接口上传文件获取。</p>
|
|
7366
7188
|
:rtype: str
|
|
7367
7189
|
"""
|
|
7368
7190
|
return self._FileId
|
|
@@ -7407,9 +7229,7 @@ class ChannelCreatePreparedPersonalEsignResponse(AbstractModel):
|
|
|
7407
7229
|
|
|
7408
7230
|
def __init__(self):
|
|
7409
7231
|
r"""
|
|
7410
|
-
:param _SealId:
|
|
7411
|
-
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
7412
|
-
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
7232
|
+
:param _SealId: <p>电子印章ID,为32位字符串。<br>建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。<br>可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。</p>
|
|
7413
7233
|
:type SealId: str
|
|
7414
7234
|
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
7415
7235
|
:type RequestId: str
|
|
@@ -7419,9 +7239,7 @@ class ChannelCreatePreparedPersonalEsignResponse(AbstractModel):
|
|
|
7419
7239
|
|
|
7420
7240
|
@property
|
|
7421
7241
|
def SealId(self):
|
|
7422
|
-
r"""
|
|
7423
|
-
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
7424
|
-
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
7242
|
+
r"""<p>电子印章ID,为32位字符串。<br>建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。<br>可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。</p>
|
|
7425
7243
|
:rtype: str
|
|
7426
7244
|
"""
|
|
7427
7245
|
return self._SealId
|
|
@@ -14891,19 +14709,11 @@ class CreateEmployeeChangeUrlRequest(AbstractModel):
|
|
|
14891
14709
|
|
|
14892
14710
|
def __init__(self):
|
|
14893
14711
|
r"""
|
|
14894
|
-
:param _Agent:
|
|
14895
|
-
|
|
14896
|
-
此接口下面信息必填。
|
|
14897
|
-
<ul>
|
|
14898
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
14899
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
14900
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
14901
|
-
</ul>
|
|
14902
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
14712
|
+
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
14903
14713
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
14904
|
-
:param _OpenId:
|
|
14714
|
+
:param _OpenId: <p>待修改的员工OpenId</p>
|
|
14905
14715
|
:type OpenId: str
|
|
14906
|
-
:param _NewMobile:
|
|
14716
|
+
:param _NewMobile: <p>待修改的员工手机号,支持海外格式</p>
|
|
14907
14717
|
:type NewMobile: str
|
|
14908
14718
|
"""
|
|
14909
14719
|
self._Agent = None
|
|
@@ -14912,15 +14722,7 @@ class CreateEmployeeChangeUrlRequest(AbstractModel):
|
|
|
14912
14722
|
|
|
14913
14723
|
@property
|
|
14914
14724
|
def Agent(self):
|
|
14915
|
-
r"""
|
|
14916
|
-
|
|
14917
|
-
此接口下面信息必填。
|
|
14918
|
-
<ul>
|
|
14919
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
14920
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
14921
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
14922
|
-
</ul>
|
|
14923
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
14725
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
14924
14726
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
14925
14727
|
"""
|
|
14926
14728
|
return self._Agent
|
|
@@ -14931,7 +14733,7 @@ class CreateEmployeeChangeUrlRequest(AbstractModel):
|
|
|
14931
14733
|
|
|
14932
14734
|
@property
|
|
14933
14735
|
def OpenId(self):
|
|
14934
|
-
r"""
|
|
14736
|
+
r"""<p>待修改的员工OpenId</p>
|
|
14935
14737
|
:rtype: str
|
|
14936
14738
|
"""
|
|
14937
14739
|
return self._OpenId
|
|
@@ -14942,7 +14744,7 @@ class CreateEmployeeChangeUrlRequest(AbstractModel):
|
|
|
14942
14744
|
|
|
14943
14745
|
@property
|
|
14944
14746
|
def NewMobile(self):
|
|
14945
|
-
r"""
|
|
14747
|
+
r"""<p>待修改的员工手机号,支持海外格式</p>
|
|
14946
14748
|
:rtype: str
|
|
14947
14749
|
"""
|
|
14948
14750
|
return self._NewMobile
|
|
@@ -14975,22 +14777,26 @@ class CreateEmployeeChangeUrlResponse(AbstractModel):
|
|
|
14975
14777
|
|
|
14976
14778
|
def __init__(self):
|
|
14977
14779
|
r"""
|
|
14978
|
-
:param _MiniAppPath:
|
|
14780
|
+
:param _MiniAppPath: <p>修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a></p>
|
|
14979
14781
|
:type MiniAppPath: str
|
|
14980
|
-
:param
|
|
14981
|
-
|
|
14982
|
-
|
|
14782
|
+
:param _LongUrl: <p>H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</p>
|
|
14783
|
+
:type LongUrl: str
|
|
14784
|
+
:param _ShortUrl: <p>H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</p>
|
|
14785
|
+
:type ShortUrl: str
|
|
14786
|
+
:param _ExpireTime: <p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
|
|
14983
14787
|
:type ExpireTime: int
|
|
14984
14788
|
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
14985
14789
|
:type RequestId: str
|
|
14986
14790
|
"""
|
|
14987
14791
|
self._MiniAppPath = None
|
|
14792
|
+
self._LongUrl = None
|
|
14793
|
+
self._ShortUrl = None
|
|
14988
14794
|
self._ExpireTime = None
|
|
14989
14795
|
self._RequestId = None
|
|
14990
14796
|
|
|
14991
14797
|
@property
|
|
14992
14798
|
def MiniAppPath(self):
|
|
14993
|
-
r"""
|
|
14799
|
+
r"""<p>修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a></p>
|
|
14994
14800
|
:rtype: str
|
|
14995
14801
|
"""
|
|
14996
14802
|
return self._MiniAppPath
|
|
@@ -15000,10 +14806,30 @@ class CreateEmployeeChangeUrlResponse(AbstractModel):
|
|
|
15000
14806
|
self._MiniAppPath = MiniAppPath
|
|
15001
14807
|
|
|
15002
14808
|
@property
|
|
15003
|
-
def
|
|
15004
|
-
r"""
|
|
14809
|
+
def LongUrl(self):
|
|
14810
|
+
r"""<p>H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</p>
|
|
14811
|
+
:rtype: str
|
|
14812
|
+
"""
|
|
14813
|
+
return self._LongUrl
|
|
15005
14814
|
|
|
14815
|
+
@LongUrl.setter
|
|
14816
|
+
def LongUrl(self, LongUrl):
|
|
14817
|
+
self._LongUrl = LongUrl
|
|
15006
14818
|
|
|
14819
|
+
@property
|
|
14820
|
+
def ShortUrl(self):
|
|
14821
|
+
r"""<p>H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</p>
|
|
14822
|
+
:rtype: str
|
|
14823
|
+
"""
|
|
14824
|
+
return self._ShortUrl
|
|
14825
|
+
|
|
14826
|
+
@ShortUrl.setter
|
|
14827
|
+
def ShortUrl(self, ShortUrl):
|
|
14828
|
+
self._ShortUrl = ShortUrl
|
|
14829
|
+
|
|
14830
|
+
@property
|
|
14831
|
+
def ExpireTime(self):
|
|
14832
|
+
r"""<p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
|
|
15007
14833
|
:rtype: int
|
|
15008
14834
|
"""
|
|
15009
14835
|
return self._ExpireTime
|
|
@@ -15026,6 +14852,8 @@ class CreateEmployeeChangeUrlResponse(AbstractModel):
|
|
|
15026
14852
|
|
|
15027
14853
|
def _deserialize(self, params):
|
|
15028
14854
|
self._MiniAppPath = params.get("MiniAppPath")
|
|
14855
|
+
self._LongUrl = params.get("LongUrl")
|
|
14856
|
+
self._ShortUrl = params.get("ShortUrl")
|
|
15029
14857
|
self._ExpireTime = params.get("ExpireTime")
|
|
15030
14858
|
self._RequestId = params.get("RequestId")
|
|
15031
14859
|
|
|
@@ -15145,6 +14973,132 @@ class CreateEmployeeQualificationSealQrCodeResponse(AbstractModel):
|
|
|
15145
14973
|
self._RequestId = params.get("RequestId")
|
|
15146
14974
|
|
|
15147
14975
|
|
|
14976
|
+
class CreateFileConvertTaskRequest(AbstractModel):
|
|
14977
|
+
r"""CreateFileConvertTask请求参数结构体
|
|
14978
|
+
|
|
14979
|
+
"""
|
|
14980
|
+
|
|
14981
|
+
def __init__(self):
|
|
14982
|
+
r"""
|
|
14983
|
+
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
14984
|
+
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
14985
|
+
:param _ResourceType: <p>需要进行转换的资源文件类型<br>支持的文件类型如下:</p><p>枚举值:</p><ul><li>doc: doc</li><li>docx: docx</li><li>xls: xls</li><li>xlsx: xlsx</li><li>jpg: jpg</li><li>jpeg: jpeg</li><li>png: png</li><li>bmp: bmp</li><li>html: html</li><li>txt: txt</li></ul>
|
|
14986
|
+
:type ResourceType: str
|
|
14987
|
+
:param _ResourceName: <p>需要进行转换操作的文件资源名称,带资源后缀名。</p><p>注: <code>资源名称长度限制为256个字符</code></p>
|
|
14988
|
+
:type ResourceName: str
|
|
14989
|
+
:param _ResourceId: <p>需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。</p><p>注: <code>目前,此接口仅支持单个文件进行转换。</code></p>
|
|
14990
|
+
:type ResourceId: str
|
|
14991
|
+
"""
|
|
14992
|
+
self._Agent = None
|
|
14993
|
+
self._ResourceType = None
|
|
14994
|
+
self._ResourceName = None
|
|
14995
|
+
self._ResourceId = None
|
|
14996
|
+
|
|
14997
|
+
@property
|
|
14998
|
+
def Agent(self):
|
|
14999
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
15000
|
+
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
15001
|
+
"""
|
|
15002
|
+
return self._Agent
|
|
15003
|
+
|
|
15004
|
+
@Agent.setter
|
|
15005
|
+
def Agent(self, Agent):
|
|
15006
|
+
self._Agent = Agent
|
|
15007
|
+
|
|
15008
|
+
@property
|
|
15009
|
+
def ResourceType(self):
|
|
15010
|
+
r"""<p>需要进行转换的资源文件类型<br>支持的文件类型如下:</p><p>枚举值:</p><ul><li>doc: doc</li><li>docx: docx</li><li>xls: xls</li><li>xlsx: xlsx</li><li>jpg: jpg</li><li>jpeg: jpeg</li><li>png: png</li><li>bmp: bmp</li><li>html: html</li><li>txt: txt</li></ul>
|
|
15011
|
+
:rtype: str
|
|
15012
|
+
"""
|
|
15013
|
+
return self._ResourceType
|
|
15014
|
+
|
|
15015
|
+
@ResourceType.setter
|
|
15016
|
+
def ResourceType(self, ResourceType):
|
|
15017
|
+
self._ResourceType = ResourceType
|
|
15018
|
+
|
|
15019
|
+
@property
|
|
15020
|
+
def ResourceName(self):
|
|
15021
|
+
r"""<p>需要进行转换操作的文件资源名称,带资源后缀名。</p><p>注: <code>资源名称长度限制为256个字符</code></p>
|
|
15022
|
+
:rtype: str
|
|
15023
|
+
"""
|
|
15024
|
+
return self._ResourceName
|
|
15025
|
+
|
|
15026
|
+
@ResourceName.setter
|
|
15027
|
+
def ResourceName(self, ResourceName):
|
|
15028
|
+
self._ResourceName = ResourceName
|
|
15029
|
+
|
|
15030
|
+
@property
|
|
15031
|
+
def ResourceId(self):
|
|
15032
|
+
r"""<p>需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。</p><p>注: <code>目前,此接口仅支持单个文件进行转换。</code></p>
|
|
15033
|
+
:rtype: str
|
|
15034
|
+
"""
|
|
15035
|
+
return self._ResourceId
|
|
15036
|
+
|
|
15037
|
+
@ResourceId.setter
|
|
15038
|
+
def ResourceId(self, ResourceId):
|
|
15039
|
+
self._ResourceId = ResourceId
|
|
15040
|
+
|
|
15041
|
+
|
|
15042
|
+
def _deserialize(self, params):
|
|
15043
|
+
if params.get("Agent") is not None:
|
|
15044
|
+
self._Agent = Agent()
|
|
15045
|
+
self._Agent._deserialize(params.get("Agent"))
|
|
15046
|
+
self._ResourceType = params.get("ResourceType")
|
|
15047
|
+
self._ResourceName = params.get("ResourceName")
|
|
15048
|
+
self._ResourceId = params.get("ResourceId")
|
|
15049
|
+
memeber_set = set(params.keys())
|
|
15050
|
+
for name, value in vars(self).items():
|
|
15051
|
+
property_name = name[1:]
|
|
15052
|
+
if property_name in memeber_set:
|
|
15053
|
+
memeber_set.remove(property_name)
|
|
15054
|
+
if len(memeber_set) > 0:
|
|
15055
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
15056
|
+
|
|
15057
|
+
|
|
15058
|
+
|
|
15059
|
+
class CreateFileConvertTaskResponse(AbstractModel):
|
|
15060
|
+
r"""CreateFileConvertTask返回参数结构体
|
|
15061
|
+
|
|
15062
|
+
"""
|
|
15063
|
+
|
|
15064
|
+
def __init__(self):
|
|
15065
|
+
r"""
|
|
15066
|
+
:param _TaskId: <p>接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。</p>
|
|
15067
|
+
:type TaskId: str
|
|
15068
|
+
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
15069
|
+
:type RequestId: str
|
|
15070
|
+
"""
|
|
15071
|
+
self._TaskId = None
|
|
15072
|
+
self._RequestId = None
|
|
15073
|
+
|
|
15074
|
+
@property
|
|
15075
|
+
def TaskId(self):
|
|
15076
|
+
r"""<p>接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。</p>
|
|
15077
|
+
:rtype: str
|
|
15078
|
+
"""
|
|
15079
|
+
return self._TaskId
|
|
15080
|
+
|
|
15081
|
+
@TaskId.setter
|
|
15082
|
+
def TaskId(self, TaskId):
|
|
15083
|
+
self._TaskId = TaskId
|
|
15084
|
+
|
|
15085
|
+
@property
|
|
15086
|
+
def RequestId(self):
|
|
15087
|
+
r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
15088
|
+
:rtype: str
|
|
15089
|
+
"""
|
|
15090
|
+
return self._RequestId
|
|
15091
|
+
|
|
15092
|
+
@RequestId.setter
|
|
15093
|
+
def RequestId(self, RequestId):
|
|
15094
|
+
self._RequestId = RequestId
|
|
15095
|
+
|
|
15096
|
+
|
|
15097
|
+
def _deserialize(self, params):
|
|
15098
|
+
self._TaskId = params.get("TaskId")
|
|
15099
|
+
self._RequestId = params.get("RequestId")
|
|
15100
|
+
|
|
15101
|
+
|
|
15148
15102
|
class CreateFlowBlockchainEvidenceUrlRequest(AbstractModel):
|
|
15149
15103
|
r"""CreateFlowBlockchainEvidenceUrl请求参数结构体
|
|
15150
15104
|
|
|
@@ -19582,6 +19536,147 @@ class DescribeExtendedServiceAuthInfoResponse(AbstractModel):
|
|
|
19582
19536
|
self._RequestId = params.get("RequestId")
|
|
19583
19537
|
|
|
19584
19538
|
|
|
19539
|
+
class DescribeFileConvertTaskRequest(AbstractModel):
|
|
19540
|
+
r"""DescribeFileConvertTask请求参数结构体
|
|
19541
|
+
|
|
19542
|
+
"""
|
|
19543
|
+
|
|
19544
|
+
def __init__(self):
|
|
19545
|
+
r"""
|
|
19546
|
+
:param _TaskId: <p>转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>得到的转换任务id</p>
|
|
19547
|
+
:type TaskId: str
|
|
19548
|
+
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
19549
|
+
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
19550
|
+
"""
|
|
19551
|
+
self._TaskId = None
|
|
19552
|
+
self._Agent = None
|
|
19553
|
+
|
|
19554
|
+
@property
|
|
19555
|
+
def TaskId(self):
|
|
19556
|
+
r"""<p>转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>得到的转换任务id</p>
|
|
19557
|
+
:rtype: str
|
|
19558
|
+
"""
|
|
19559
|
+
return self._TaskId
|
|
19560
|
+
|
|
19561
|
+
@TaskId.setter
|
|
19562
|
+
def TaskId(self, TaskId):
|
|
19563
|
+
self._TaskId = TaskId
|
|
19564
|
+
|
|
19565
|
+
@property
|
|
19566
|
+
def Agent(self):
|
|
19567
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
19568
|
+
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
19569
|
+
"""
|
|
19570
|
+
return self._Agent
|
|
19571
|
+
|
|
19572
|
+
@Agent.setter
|
|
19573
|
+
def Agent(self, Agent):
|
|
19574
|
+
self._Agent = Agent
|
|
19575
|
+
|
|
19576
|
+
|
|
19577
|
+
def _deserialize(self, params):
|
|
19578
|
+
self._TaskId = params.get("TaskId")
|
|
19579
|
+
if params.get("Agent") is not None:
|
|
19580
|
+
self._Agent = Agent()
|
|
19581
|
+
self._Agent._deserialize(params.get("Agent"))
|
|
19582
|
+
memeber_set = set(params.keys())
|
|
19583
|
+
for name, value in vars(self).items():
|
|
19584
|
+
property_name = name[1:]
|
|
19585
|
+
if property_name in memeber_set:
|
|
19586
|
+
memeber_set.remove(property_name)
|
|
19587
|
+
if len(memeber_set) > 0:
|
|
19588
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
19589
|
+
|
|
19590
|
+
|
|
19591
|
+
|
|
19592
|
+
class DescribeFileConvertTaskResponse(AbstractModel):
|
|
19593
|
+
r"""DescribeFileConvertTask返回参数结构体
|
|
19594
|
+
|
|
19595
|
+
"""
|
|
19596
|
+
|
|
19597
|
+
def __init__(self):
|
|
19598
|
+
r"""
|
|
19599
|
+
:param _TaskId: <p>任务Id</p>
|
|
19600
|
+
:type TaskId: str
|
|
19601
|
+
:param _TaskStatus: <p>任务状态,需要关注的状态</p><p>枚举值:</p><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>
|
|
19602
|
+
:type TaskStatus: int
|
|
19603
|
+
:param _TaskMessage: <p>状态描述,需要关注的状态</p><ul><li> **NeedTranform** : 任务已提交</li><li> **Processing** : 文档转换中</li><li> **TaskEnd** : 任务处理完成</li><li> **DownloadFailed** : 下载失败</li><li> **ProcessFailed** : 转换失败</li><li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
19604
|
+
:type TaskMessage: str
|
|
19605
|
+
:param _ResourceId: <p>资源Id(即FileId),用于<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles">用PDF文件创建签署流程</a></p>
|
|
19606
|
+
:type ResourceId: str
|
|
19607
|
+
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
19608
|
+
:type RequestId: str
|
|
19609
|
+
"""
|
|
19610
|
+
self._TaskId = None
|
|
19611
|
+
self._TaskStatus = None
|
|
19612
|
+
self._TaskMessage = None
|
|
19613
|
+
self._ResourceId = None
|
|
19614
|
+
self._RequestId = None
|
|
19615
|
+
|
|
19616
|
+
@property
|
|
19617
|
+
def TaskId(self):
|
|
19618
|
+
r"""<p>任务Id</p>
|
|
19619
|
+
:rtype: str
|
|
19620
|
+
"""
|
|
19621
|
+
return self._TaskId
|
|
19622
|
+
|
|
19623
|
+
@TaskId.setter
|
|
19624
|
+
def TaskId(self, TaskId):
|
|
19625
|
+
self._TaskId = TaskId
|
|
19626
|
+
|
|
19627
|
+
@property
|
|
19628
|
+
def TaskStatus(self):
|
|
19629
|
+
r"""<p>任务状态,需要关注的状态</p><p>枚举值:</p><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>
|
|
19630
|
+
:rtype: int
|
|
19631
|
+
"""
|
|
19632
|
+
return self._TaskStatus
|
|
19633
|
+
|
|
19634
|
+
@TaskStatus.setter
|
|
19635
|
+
def TaskStatus(self, TaskStatus):
|
|
19636
|
+
self._TaskStatus = TaskStatus
|
|
19637
|
+
|
|
19638
|
+
@property
|
|
19639
|
+
def TaskMessage(self):
|
|
19640
|
+
r"""<p>状态描述,需要关注的状态</p><ul><li> **NeedTranform** : 任务已提交</li><li> **Processing** : 文档转换中</li><li> **TaskEnd** : 任务处理完成</li><li> **DownloadFailed** : 下载失败</li><li> **ProcessFailed** : 转换失败</li><li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
19641
|
+
:rtype: str
|
|
19642
|
+
"""
|
|
19643
|
+
return self._TaskMessage
|
|
19644
|
+
|
|
19645
|
+
@TaskMessage.setter
|
|
19646
|
+
def TaskMessage(self, TaskMessage):
|
|
19647
|
+
self._TaskMessage = TaskMessage
|
|
19648
|
+
|
|
19649
|
+
@property
|
|
19650
|
+
def ResourceId(self):
|
|
19651
|
+
r"""<p>资源Id(即FileId),用于<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles">用PDF文件创建签署流程</a></p>
|
|
19652
|
+
:rtype: str
|
|
19653
|
+
"""
|
|
19654
|
+
return self._ResourceId
|
|
19655
|
+
|
|
19656
|
+
@ResourceId.setter
|
|
19657
|
+
def ResourceId(self, ResourceId):
|
|
19658
|
+
self._ResourceId = ResourceId
|
|
19659
|
+
|
|
19660
|
+
@property
|
|
19661
|
+
def RequestId(self):
|
|
19662
|
+
r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
19663
|
+
:rtype: str
|
|
19664
|
+
"""
|
|
19665
|
+
return self._RequestId
|
|
19666
|
+
|
|
19667
|
+
@RequestId.setter
|
|
19668
|
+
def RequestId(self, RequestId):
|
|
19669
|
+
self._RequestId = RequestId
|
|
19670
|
+
|
|
19671
|
+
|
|
19672
|
+
def _deserialize(self, params):
|
|
19673
|
+
self._TaskId = params.get("TaskId")
|
|
19674
|
+
self._TaskStatus = params.get("TaskStatus")
|
|
19675
|
+
self._TaskMessage = params.get("TaskMessage")
|
|
19676
|
+
self._ResourceId = params.get("ResourceId")
|
|
19677
|
+
self._RequestId = params.get("RequestId")
|
|
19678
|
+
|
|
19679
|
+
|
|
19585
19680
|
class DescribeFlowDetailInfoRequest(AbstractModel):
|
|
19586
19681
|
r"""DescribeFlowDetailInfo请求参数结构体
|
|
19587
19682
|
|
|
@@ -26617,27 +26712,13 @@ class OperateTemplateRequest(AbstractModel):
|
|
|
26617
26712
|
|
|
26618
26713
|
def __init__(self):
|
|
26619
26714
|
r"""
|
|
26620
|
-
:param _Agent:
|
|
26621
|
-
|
|
26622
|
-
此接口下面信息必填。
|
|
26623
|
-
<ul>
|
|
26624
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
26625
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(模板的归属企业)</li>
|
|
26626
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (操作人)</li>
|
|
26627
|
-
</ul>
|
|
26715
|
+
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(模板的归属企业)</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (操作人)</li></ul>
|
|
26628
26716
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
26629
|
-
:param _TemplateId:
|
|
26717
|
+
:param _TemplateId: <p>模板ID,为32位字符串。</p>
|
|
26630
26718
|
:type TemplateId: str
|
|
26631
|
-
:param _OperateType:
|
|
26632
|
-
<ul>
|
|
26633
|
-
<li>DELETE: 删除</li>
|
|
26634
|
-
<li>ENABLE: 启用</li>
|
|
26635
|
-
<li>DISABLE: 停用</li>
|
|
26636
|
-
<li>COPY: 复制新建</li>
|
|
26637
|
-
</ul>
|
|
26719
|
+
:param _OperateType: <p>操作类型,可取值如下:</p><ul><li>DELETE: 删除</li><li>ENABLE: 启用</li><li>DISABLE: 停用</li><li>COPY: 复制新建</li></ul>
|
|
26638
26720
|
:type OperateType: str
|
|
26639
|
-
:param _TemplateName:
|
|
26640
|
-
模板复制时指定有效,若为空,则复制后模板名称为 **原模板名称_副本**。
|
|
26721
|
+
:param _TemplateName: <p>模板名称,长度不超过64字符。<br><br>模板复制时指定有效,若为空,则复制后模板名称为 <strong>原模板名称_副本</strong>。</p>
|
|
26641
26722
|
:type TemplateName: str
|
|
26642
26723
|
"""
|
|
26643
26724
|
self._Agent = None
|
|
@@ -26647,14 +26728,7 @@ class OperateTemplateRequest(AbstractModel):
|
|
|
26647
26728
|
|
|
26648
26729
|
@property
|
|
26649
26730
|
def Agent(self):
|
|
26650
|
-
r"""
|
|
26651
|
-
|
|
26652
|
-
此接口下面信息必填。
|
|
26653
|
-
<ul>
|
|
26654
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
26655
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(模板的归属企业)</li>
|
|
26656
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (操作人)</li>
|
|
26657
|
-
</ul>
|
|
26731
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(模板的归属企业)</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (操作人)</li></ul>
|
|
26658
26732
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
26659
26733
|
"""
|
|
26660
26734
|
return self._Agent
|
|
@@ -26665,7 +26739,7 @@ class OperateTemplateRequest(AbstractModel):
|
|
|
26665
26739
|
|
|
26666
26740
|
@property
|
|
26667
26741
|
def TemplateId(self):
|
|
26668
|
-
r"""
|
|
26742
|
+
r"""<p>模板ID,为32位字符串。</p>
|
|
26669
26743
|
:rtype: str
|
|
26670
26744
|
"""
|
|
26671
26745
|
return self._TemplateId
|
|
@@ -26676,13 +26750,7 @@ class OperateTemplateRequest(AbstractModel):
|
|
|
26676
26750
|
|
|
26677
26751
|
@property
|
|
26678
26752
|
def OperateType(self):
|
|
26679
|
-
r"""
|
|
26680
|
-
<ul>
|
|
26681
|
-
<li>DELETE: 删除</li>
|
|
26682
|
-
<li>ENABLE: 启用</li>
|
|
26683
|
-
<li>DISABLE: 停用</li>
|
|
26684
|
-
<li>COPY: 复制新建</li>
|
|
26685
|
-
</ul>
|
|
26753
|
+
r"""<p>操作类型,可取值如下:</p><ul><li>DELETE: 删除</li><li>ENABLE: 启用</li><li>DISABLE: 停用</li><li>COPY: 复制新建</li></ul>
|
|
26686
26754
|
:rtype: str
|
|
26687
26755
|
"""
|
|
26688
26756
|
return self._OperateType
|
|
@@ -26693,8 +26761,7 @@ class OperateTemplateRequest(AbstractModel):
|
|
|
26693
26761
|
|
|
26694
26762
|
@property
|
|
26695
26763
|
def TemplateName(self):
|
|
26696
|
-
r"""
|
|
26697
|
-
模板复制时指定有效,若为空,则复制后模板名称为 **原模板名称_副本**。
|
|
26764
|
+
r"""<p>模板名称,长度不超过64字符。<br><br>模板复制时指定有效,若为空,则复制后模板名称为 <strong>原模板名称_副本</strong>。</p>
|
|
26698
26765
|
:rtype: str
|
|
26699
26766
|
"""
|
|
26700
26767
|
return self._TemplateName
|
|
@@ -26728,9 +26795,9 @@ class OperateTemplateResponse(AbstractModel):
|
|
|
26728
26795
|
|
|
26729
26796
|
def __init__(self):
|
|
26730
26797
|
r"""
|
|
26731
|
-
:param _TemplateId:
|
|
26798
|
+
:param _TemplateId: <p>模板ID,为32位字符串,模板复制新建时返回</p>
|
|
26732
26799
|
:type TemplateId: str
|
|
26733
|
-
:param _TemplateName:
|
|
26800
|
+
:param _TemplateName: <p>模板名称,模板复制新建时返回</p>
|
|
26734
26801
|
:type TemplateName: str
|
|
26735
26802
|
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
26736
26803
|
:type RequestId: str
|
|
@@ -26741,7 +26808,7 @@ class OperateTemplateResponse(AbstractModel):
|
|
|
26741
26808
|
|
|
26742
26809
|
@property
|
|
26743
26810
|
def TemplateId(self):
|
|
26744
|
-
r"""
|
|
26811
|
+
r"""<p>模板ID,为32位字符串,模板复制新建时返回</p>
|
|
26745
26812
|
:rtype: str
|
|
26746
26813
|
"""
|
|
26747
26814
|
return self._TemplateId
|
|
@@ -26752,7 +26819,7 @@ class OperateTemplateResponse(AbstractModel):
|
|
|
26752
26819
|
|
|
26753
26820
|
@property
|
|
26754
26821
|
def TemplateName(self):
|
|
26755
|
-
r"""
|
|
26822
|
+
r"""<p>模板名称,模板复制新建时返回</p>
|
|
26756
26823
|
:rtype: str
|
|
26757
26824
|
"""
|
|
26758
26825
|
return self._TemplateName
|
|
@@ -28009,29 +28076,26 @@ class PresetApproverInfo(AbstractModel):
|
|
|
28009
28076
|
|
|
28010
28077
|
def __init__(self):
|
|
28011
28078
|
r"""
|
|
28012
|
-
:param _Name:
|
|
28079
|
+
:param _Name: <p>预设参与方姓名。</p>
|
|
28013
28080
|
:type Name: str
|
|
28014
|
-
:param _Mobile:
|
|
28081
|
+
:param _Mobile: <p>预设参与方手机号。</p>
|
|
28015
28082
|
:type Mobile: str
|
|
28016
|
-
:param _IdCardNumber:
|
|
28017
|
-
|
|
28018
|
-
证件号码,应符合以下规则
|
|
28019
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
|
|
28083
|
+
:param _IdCardNumber: <p>预设参与方证件号,需要和IdCardType同时传入。</p><p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
|
|
28020
28084
|
:type IdCardNumber: str
|
|
28021
|
-
:param _IdCardType:
|
|
28022
|
-
|
|
28023
|
-
证件类型,支持以下类型
|
|
28024
|
-
<ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
|
|
28085
|
+
:param _IdCardType: <p>预设参与方的证件类型,需要与IdCardNumber同时传入。</p><p>证件类型,支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
|
|
28025
28086
|
:type IdCardType: str
|
|
28087
|
+
:param _OrganizationName: <p>企业用户动态签署方场景指定预设企业名称。<code>注意:1. 若为企业动态签署方场景,此参数必须要指定。2. 企业动态签署方场景暂不支持指定姓名证件手机号等参数,仅支持指定企业名称。3. 暂不支持指定子客企业,此处预设的企业仅支持SaaS企业。</code></p>
|
|
28088
|
+
:type OrganizationName: str
|
|
28026
28089
|
"""
|
|
28027
28090
|
self._Name = None
|
|
28028
28091
|
self._Mobile = None
|
|
28029
28092
|
self._IdCardNumber = None
|
|
28030
28093
|
self._IdCardType = None
|
|
28094
|
+
self._OrganizationName = None
|
|
28031
28095
|
|
|
28032
28096
|
@property
|
|
28033
28097
|
def Name(self):
|
|
28034
|
-
r"""
|
|
28098
|
+
r"""<p>预设参与方姓名。</p>
|
|
28035
28099
|
:rtype: str
|
|
28036
28100
|
"""
|
|
28037
28101
|
return self._Name
|
|
@@ -28042,7 +28106,7 @@ class PresetApproverInfo(AbstractModel):
|
|
|
28042
28106
|
|
|
28043
28107
|
@property
|
|
28044
28108
|
def Mobile(self):
|
|
28045
|
-
r"""
|
|
28109
|
+
r"""<p>预设参与方手机号。</p>
|
|
28046
28110
|
:rtype: str
|
|
28047
28111
|
"""
|
|
28048
28112
|
return self._Mobile
|
|
@@ -28053,10 +28117,7 @@ class PresetApproverInfo(AbstractModel):
|
|
|
28053
28117
|
|
|
28054
28118
|
@property
|
|
28055
28119
|
def IdCardNumber(self):
|
|
28056
|
-
r"""
|
|
28057
|
-
|
|
28058
|
-
证件号码,应符合以下规则
|
|
28059
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
|
|
28120
|
+
r"""<p>预设参与方证件号,需要和IdCardType同时传入。</p><p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
|
|
28060
28121
|
:rtype: str
|
|
28061
28122
|
"""
|
|
28062
28123
|
return self._IdCardNumber
|
|
@@ -28067,10 +28128,7 @@ class PresetApproverInfo(AbstractModel):
|
|
|
28067
28128
|
|
|
28068
28129
|
@property
|
|
28069
28130
|
def IdCardType(self):
|
|
28070
|
-
r"""
|
|
28071
|
-
|
|
28072
|
-
证件类型,支持以下类型
|
|
28073
|
-
<ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
|
|
28131
|
+
r"""<p>预设参与方的证件类型,需要与IdCardNumber同时传入。</p><p>证件类型,支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
|
|
28074
28132
|
:rtype: str
|
|
28075
28133
|
"""
|
|
28076
28134
|
return self._IdCardType
|
|
@@ -28079,12 +28137,24 @@ class PresetApproverInfo(AbstractModel):
|
|
|
28079
28137
|
def IdCardType(self, IdCardType):
|
|
28080
28138
|
self._IdCardType = IdCardType
|
|
28081
28139
|
|
|
28140
|
+
@property
|
|
28141
|
+
def OrganizationName(self):
|
|
28142
|
+
r"""<p>企业用户动态签署方场景指定预设企业名称。<code>注意:1. 若为企业动态签署方场景,此参数必须要指定。2. 企业动态签署方场景暂不支持指定姓名证件手机号等参数,仅支持指定企业名称。3. 暂不支持指定子客企业,此处预设的企业仅支持SaaS企业。</code></p>
|
|
28143
|
+
:rtype: str
|
|
28144
|
+
"""
|
|
28145
|
+
return self._OrganizationName
|
|
28146
|
+
|
|
28147
|
+
@OrganizationName.setter
|
|
28148
|
+
def OrganizationName(self, OrganizationName):
|
|
28149
|
+
self._OrganizationName = OrganizationName
|
|
28150
|
+
|
|
28082
28151
|
|
|
28083
28152
|
def _deserialize(self, params):
|
|
28084
28153
|
self._Name = params.get("Name")
|
|
28085
28154
|
self._Mobile = params.get("Mobile")
|
|
28086
28155
|
self._IdCardNumber = params.get("IdCardNumber")
|
|
28087
28156
|
self._IdCardType = params.get("IdCardType")
|
|
28157
|
+
self._OrganizationName = params.get("OrganizationName")
|
|
28088
28158
|
memeber_set = set(params.keys())
|
|
28089
28159
|
for name, value in vars(self).items():
|
|
28090
28160
|
property_name = name[1:]
|