tencentcloud-sdk-python 3.0.1075__py2.py3-none-any.whl → 3.0.1077__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.
Potentially problematic release.
This version of tencentcloud-sdk-python might be problematic. Click here for more details.
- tencentcloud/__init__.py +1 -1
- tencentcloud/cdn/v20180606/cdn_client.py +1 -1
- tencentcloud/dasb/v20191018/models.py +12 -0
- tencentcloud/dbbrain/v20210527/models.py +37 -0
- tencentcloud/eb/v20210416/eb_client.py +2 -2
- tencentcloud/eb/v20210416/models.py +4 -4
- tencentcloud/ess/v20201111/ess_client.py +64 -9
- tencentcloud/ess/v20201111/models.py +137 -25
- tencentcloud/essbasic/v20210526/essbasic_client.py +5 -6
- tencentcloud/essbasic/v20210526/models.py +92 -8
- tencentcloud/monitor/v20180724/models.py +51 -0
- tencentcloud/ocr/v20181119/models.py +189 -0
- tencentcloud/ocr/v20181119/ocr_client.py +23 -0
- tencentcloud/organization/v20210331/errorcodes.py +39 -0
- tencentcloud/organization/v20210331/models.py +2447 -877
- tencentcloud/organization/v20210331/organization_client.py +253 -0
- tencentcloud/sqlserver/v20180328/models.py +1 -1
- tencentcloud/sts/v20180813/models.py +3 -4
- tencentcloud/vpc/v20170312/models.py +17 -0
- tencentcloud/wedata/v20210820/models.py +209 -96
- tencentcloud/wedata/v20210820/wedata_client.py +0 -25
- tencentcloud/weilingwith/v20230427/models.py +12 -0
- {tencentcloud_sdk_python-3.0.1075.dist-info → tencentcloud_sdk_python-3.0.1077.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python-3.0.1075.dist-info → tencentcloud_sdk_python-3.0.1077.dist-info}/RECORD +27 -27
- {tencentcloud_sdk_python-3.0.1075.dist-info → tencentcloud_sdk_python-3.0.1077.dist-info}/LICENSE +0 -0
- {tencentcloud_sdk_python-3.0.1075.dist-info → tencentcloud_sdk_python-3.0.1077.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python-3.0.1075.dist-info → tencentcloud_sdk_python-3.0.1077.dist-info}/top_level.txt +0 -0
tencentcloud/__init__.py
CHANGED
|
@@ -1702,7 +1702,7 @@ class CdnClient(AbstractClient):
|
|
|
1702
1702
|
|
|
1703
1703
|
def PushUrlsCache(self, request):
|
|
1704
1704
|
"""PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点,支持指定加速区域预热。
|
|
1705
|
-
默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500
|
|
1705
|
+
默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500 条 URL,每次提交的数量会消耗配额总数。如:1次提交500条URL全球预热,此时境内、境外预热 URL 各剩余 500条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点。
|
|
1706
1706
|
|
|
1707
1707
|
:param request: Request instance for PushUrlsCache.
|
|
1708
1708
|
:type request: :class:`tencentcloud.cdn.v20180606.models.PushUrlsCacheRequest`
|
|
@@ -3192,6 +3192,8 @@ class DeployResourceRequest(AbstractModel):
|
|
|
3192
3192
|
:type VpcCidrBlock: str
|
|
3193
3193
|
:param _SubnetName: 需要开通服务的子网名称
|
|
3194
3194
|
:type SubnetName: str
|
|
3195
|
+
:param _CdcClusterId: 需要开通实例所属的CDC集群ID
|
|
3196
|
+
:type CdcClusterId: str
|
|
3195
3197
|
"""
|
|
3196
3198
|
self._ResourceId = None
|
|
3197
3199
|
self._ApCode = None
|
|
@@ -3202,6 +3204,7 @@ class DeployResourceRequest(AbstractModel):
|
|
|
3202
3204
|
self._VpcName = None
|
|
3203
3205
|
self._VpcCidrBlock = None
|
|
3204
3206
|
self._SubnetName = None
|
|
3207
|
+
self._CdcClusterId = None
|
|
3205
3208
|
|
|
3206
3209
|
@property
|
|
3207
3210
|
def ResourceId(self):
|
|
@@ -3275,6 +3278,14 @@ class DeployResourceRequest(AbstractModel):
|
|
|
3275
3278
|
def SubnetName(self, SubnetName):
|
|
3276
3279
|
self._SubnetName = SubnetName
|
|
3277
3280
|
|
|
3281
|
+
@property
|
|
3282
|
+
def CdcClusterId(self):
|
|
3283
|
+
return self._CdcClusterId
|
|
3284
|
+
|
|
3285
|
+
@CdcClusterId.setter
|
|
3286
|
+
def CdcClusterId(self, CdcClusterId):
|
|
3287
|
+
self._CdcClusterId = CdcClusterId
|
|
3288
|
+
|
|
3278
3289
|
|
|
3279
3290
|
def _deserialize(self, params):
|
|
3280
3291
|
self._ResourceId = params.get("ResourceId")
|
|
@@ -3286,6 +3297,7 @@ class DeployResourceRequest(AbstractModel):
|
|
|
3286
3297
|
self._VpcName = params.get("VpcName")
|
|
3287
3298
|
self._VpcCidrBlock = params.get("VpcCidrBlock")
|
|
3288
3299
|
self._SubnetName = params.get("SubnetName")
|
|
3300
|
+
self._CdcClusterId = params.get("CdcClusterId")
|
|
3289
3301
|
memeber_set = set(params.keys())
|
|
3290
3302
|
for name, value in vars(self).items():
|
|
3291
3303
|
property_name = name[1:]
|
|
@@ -5690,6 +5690,10 @@ class DescribeRedisTopBigKeysRequest(AbstractModel):
|
|
|
5690
5690
|
:type KeyType: str
|
|
5691
5691
|
:param _Limit: 查询数目,默认为20,最大值为100。
|
|
5692
5692
|
:type Limit: int
|
|
5693
|
+
:param _AsyncRequestId: 异步任务ID。当为空时,选择最近任务的ID。
|
|
5694
|
+
:type AsyncRequestId: int
|
|
5695
|
+
:param _ShardIds: 分片节点序号列表。当列表为空时,选择所有分片节点。
|
|
5696
|
+
:type ShardIds: list of int
|
|
5693
5697
|
"""
|
|
5694
5698
|
self._InstanceId = None
|
|
5695
5699
|
self._Date = None
|
|
@@ -5697,6 +5701,8 @@ class DescribeRedisTopBigKeysRequest(AbstractModel):
|
|
|
5697
5701
|
self._SortBy = None
|
|
5698
5702
|
self._KeyType = None
|
|
5699
5703
|
self._Limit = None
|
|
5704
|
+
self._AsyncRequestId = None
|
|
5705
|
+
self._ShardIds = None
|
|
5700
5706
|
|
|
5701
5707
|
@property
|
|
5702
5708
|
def InstanceId(self):
|
|
@@ -5746,6 +5752,22 @@ class DescribeRedisTopBigKeysRequest(AbstractModel):
|
|
|
5746
5752
|
def Limit(self, Limit):
|
|
5747
5753
|
self._Limit = Limit
|
|
5748
5754
|
|
|
5755
|
+
@property
|
|
5756
|
+
def AsyncRequestId(self):
|
|
5757
|
+
return self._AsyncRequestId
|
|
5758
|
+
|
|
5759
|
+
@AsyncRequestId.setter
|
|
5760
|
+
def AsyncRequestId(self, AsyncRequestId):
|
|
5761
|
+
self._AsyncRequestId = AsyncRequestId
|
|
5762
|
+
|
|
5763
|
+
@property
|
|
5764
|
+
def ShardIds(self):
|
|
5765
|
+
return self._ShardIds
|
|
5766
|
+
|
|
5767
|
+
@ShardIds.setter
|
|
5768
|
+
def ShardIds(self, ShardIds):
|
|
5769
|
+
self._ShardIds = ShardIds
|
|
5770
|
+
|
|
5749
5771
|
|
|
5750
5772
|
def _deserialize(self, params):
|
|
5751
5773
|
self._InstanceId = params.get("InstanceId")
|
|
@@ -5754,6 +5776,8 @@ class DescribeRedisTopBigKeysRequest(AbstractModel):
|
|
|
5754
5776
|
self._SortBy = params.get("SortBy")
|
|
5755
5777
|
self._KeyType = params.get("KeyType")
|
|
5756
5778
|
self._Limit = params.get("Limit")
|
|
5779
|
+
self._AsyncRequestId = params.get("AsyncRequestId")
|
|
5780
|
+
self._ShardIds = params.get("ShardIds")
|
|
5757
5781
|
memeber_set = set(params.keys())
|
|
5758
5782
|
for name, value in vars(self).items():
|
|
5759
5783
|
property_name = name[1:]
|
|
@@ -8764,10 +8788,14 @@ class InstanceConfs(AbstractModel):
|
|
|
8764
8788
|
:param _KeyDelimiters: redis大key分析的自定义分割符,仅redis使用
|
|
8765
8789
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8766
8790
|
:type KeyDelimiters: list of str
|
|
8791
|
+
:param _ShardNum: 分片节点数量。
|
|
8792
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8793
|
+
:type ShardNum: str
|
|
8767
8794
|
"""
|
|
8768
8795
|
self._DailyInspection = None
|
|
8769
8796
|
self._OverviewDisplay = None
|
|
8770
8797
|
self._KeyDelimiters = None
|
|
8798
|
+
self._ShardNum = None
|
|
8771
8799
|
|
|
8772
8800
|
@property
|
|
8773
8801
|
def DailyInspection(self):
|
|
@@ -8793,11 +8821,20 @@ class InstanceConfs(AbstractModel):
|
|
|
8793
8821
|
def KeyDelimiters(self, KeyDelimiters):
|
|
8794
8822
|
self._KeyDelimiters = KeyDelimiters
|
|
8795
8823
|
|
|
8824
|
+
@property
|
|
8825
|
+
def ShardNum(self):
|
|
8826
|
+
return self._ShardNum
|
|
8827
|
+
|
|
8828
|
+
@ShardNum.setter
|
|
8829
|
+
def ShardNum(self, ShardNum):
|
|
8830
|
+
self._ShardNum = ShardNum
|
|
8831
|
+
|
|
8796
8832
|
|
|
8797
8833
|
def _deserialize(self, params):
|
|
8798
8834
|
self._DailyInspection = params.get("DailyInspection")
|
|
8799
8835
|
self._OverviewDisplay = params.get("OverviewDisplay")
|
|
8800
8836
|
self._KeyDelimiters = params.get("KeyDelimiters")
|
|
8837
|
+
self._ShardNum = params.get("ShardNum")
|
|
8801
8838
|
memeber_set = set(params.keys())
|
|
8802
8839
|
for name, value in vars(self).items():
|
|
8803
8840
|
property_name = name[1:]
|
|
@@ -303,7 +303,7 @@ class EbClient(AbstractClient):
|
|
|
303
303
|
|
|
304
304
|
|
|
305
305
|
def DescribeLogTagValue(self, request):
|
|
306
|
-
"""
|
|
306
|
+
"""前置条件:需开启事件存储;事件查询维度值
|
|
307
307
|
|
|
308
308
|
:param request: Request instance for DescribeLogTagValue.
|
|
309
309
|
:type request: :class:`tencentcloud.eb.v20210416.models.DescribeLogTagValueRequest`
|
|
@@ -625,7 +625,7 @@ class EbClient(AbstractClient):
|
|
|
625
625
|
|
|
626
626
|
|
|
627
627
|
def SearchLog(self, request):
|
|
628
|
-
"""
|
|
628
|
+
"""前置条件:开启事件存储;查询历史推送事件
|
|
629
629
|
|
|
630
630
|
:param request: Request instance for SearchLog.
|
|
631
631
|
:type request: :class:`tencentcloud.eb.v20210416.models.SearchLogRequest`
|
|
@@ -1797,7 +1797,7 @@ class DescribeLogTagValueResponse(AbstractModel):
|
|
|
1797
1797
|
|
|
1798
1798
|
def __init__(self):
|
|
1799
1799
|
r"""
|
|
1800
|
-
:param _Results:
|
|
1800
|
+
:param _Results: 事件查询维度值结果
|
|
1801
1801
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1802
1802
|
:type Results: list of str
|
|
1803
1803
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -4477,16 +4477,16 @@ class SearchLogResponse(AbstractModel):
|
|
|
4477
4477
|
|
|
4478
4478
|
def __init__(self):
|
|
4479
4479
|
r"""
|
|
4480
|
-
:param _Total:
|
|
4480
|
+
:param _Total: 事件总数
|
|
4481
4481
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4482
4482
|
:type Total: int
|
|
4483
|
-
:param _Limit:
|
|
4483
|
+
:param _Limit: 每页事件条数
|
|
4484
4484
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4485
4485
|
:type Limit: int
|
|
4486
4486
|
:param _Page: 页码
|
|
4487
4487
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4488
4488
|
:type Page: int
|
|
4489
|
-
:param _Results:
|
|
4489
|
+
:param _Results: 事件查询结果
|
|
4490
4490
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4491
4491
|
:type Results: list of SearchLogResult
|
|
4492
4492
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -678,15 +678,14 @@ class EssClient(AbstractClient):
|
|
|
678
678
|
|
|
679
679
|
|
|
680
680
|
def CreateFlowSignUrl(self, request):
|
|
681
|
-
"""
|
|
681
|
+
"""该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
682
682
|
|
|
683
683
|
**注意**
|
|
684
|
-
1.
|
|
685
|
-
2.
|
|
686
|
-
3.
|
|
687
|
-
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
684
|
+
1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
|
|
685
|
+
2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
686
|
+
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
688
687
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
689
|
-
|
|
688
|
+
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
690
689
|
|
|
691
690
|
:param request: Request instance for CreateFlowSignUrl.
|
|
692
691
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignUrlRequest`
|
|
@@ -732,7 +731,36 @@ class EssClient(AbstractClient):
|
|
|
732
731
|
|
|
733
732
|
|
|
734
733
|
def CreateIntegrationEmployees(self, request):
|
|
735
|
-
"""此接口(CreateIntegrationEmployees
|
|
734
|
+
"""此接口(CreateIntegrationEmployees)用于创建企业员工。
|
|
735
|
+
支持以下场景
|
|
736
|
+
<table>
|
|
737
|
+
<tbody>
|
|
738
|
+
<tr>
|
|
739
|
+
<td>生成端</td>
|
|
740
|
+
<td >入参</td>
|
|
741
|
+
<td>提醒方式</td>
|
|
742
|
+
</tr>
|
|
743
|
+
<tr>
|
|
744
|
+
<td>普通saas员工</td>
|
|
745
|
+
<td>不需要传递 InvitationNotifyType</td>
|
|
746
|
+
<td>短信</td>
|
|
747
|
+
</tr>
|
|
748
|
+
<tr>
|
|
749
|
+
<td>企微员工</td>
|
|
750
|
+
<td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
|
|
751
|
+
<td>企微内部实名消息</td>
|
|
752
|
+
</tr>
|
|
753
|
+
<tr>
|
|
754
|
+
<td>H5端 saas员工</td>
|
|
755
|
+
<td>传递 InvitationNotifyType = H5,不支持企微</td>
|
|
756
|
+
<td>生成H5链接</td>
|
|
757
|
+
</tr>
|
|
758
|
+
</tbody>
|
|
759
|
+
</table>
|
|
760
|
+
注意:
|
|
761
|
+
|
|
762
|
+
- <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
|
|
763
|
+
- jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
|
|
736
764
|
|
|
737
765
|
:param request: Request instance for CreateIntegrationEmployees.
|
|
738
766
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationEmployeesRequest`
|
|
@@ -2030,8 +2058,35 @@ class EssClient(AbstractClient):
|
|
|
2030
2058
|
|
|
2031
2059
|
|
|
2032
2060
|
def UpdateIntegrationEmployees(self, request):
|
|
2033
|
-
"""
|
|
2034
|
-
|
|
2061
|
+
"""此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)。
|
|
2062
|
+
修改手机号的时候,支持以下场景进行提醒通知
|
|
2063
|
+
<table>
|
|
2064
|
+
<tbody>
|
|
2065
|
+
<tr>
|
|
2066
|
+
<td>生成端</td>
|
|
2067
|
+
<td>入参</td>
|
|
2068
|
+
<td>提醒方式</td>
|
|
2069
|
+
</tr>
|
|
2070
|
+
<tr>
|
|
2071
|
+
<td>普通saas员工</td>
|
|
2072
|
+
<td>不需要传递 InvitationNotifyType</td>
|
|
2073
|
+
<td>短信</td>
|
|
2074
|
+
</tr>
|
|
2075
|
+
<tr>
|
|
2076
|
+
<td>企微员工</td>
|
|
2077
|
+
<td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
|
|
2078
|
+
<td>企微内部实名消息</td>
|
|
2079
|
+
</tr>
|
|
2080
|
+
<tr>
|
|
2081
|
+
<td>H5端 saas员工</td>
|
|
2082
|
+
<td>传递 InvitationNotifyType = H5,不支持企微</td>
|
|
2083
|
+
<td>生成H5链接</td>
|
|
2084
|
+
</tr>
|
|
2085
|
+
</tbody>
|
|
2086
|
+
</table>
|
|
2087
|
+
注意:
|
|
2088
|
+
|
|
2089
|
+
- jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
|
|
2035
2090
|
|
|
2036
2091
|
:param request: Request instance for UpdateIntegrationEmployees.
|
|
2037
2092
|
:type request: :class:`tencentcloud.ess.v20201111.models.UpdateIntegrationEmployeesRequest`
|
|
@@ -1905,8 +1905,9 @@ class Component(AbstractModel):
|
|
|
1905
1905
|
<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
|
|
1906
1906
|
<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
|
|
1907
1907
|
|
|
1908
|
-
**如果是SignComponent
|
|
1909
|
-
|
|
1908
|
+
**如果是SignComponent签署控件类型,
|
|
1909
|
+
需要根据签署人的类型可选的字段为**
|
|
1910
|
+
* 企业方
|
|
1910
1911
|
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
|
|
1911
1912
|
<li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
1912
1913
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
@@ -1914,6 +1915,12 @@ class Component(AbstractModel):
|
|
|
1914
1915
|
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
1915
1916
|
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
1916
1917
|
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
1918
|
+
|
|
1919
|
+
* 个人方
|
|
1920
|
+
<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
1921
|
+
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
1922
|
+
<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
|
|
1923
|
+
|
|
1917
1924
|
注:` 表单域的控件不能作为印章和签名控件`
|
|
1918
1925
|
:type ComponentType: str
|
|
1919
1926
|
:param _ComponentHeight: **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
|
|
@@ -5562,29 +5569,37 @@ class CreateFlowSignUrlRequest(AbstractModel):
|
|
|
5562
5569
|
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
5563
5570
|
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
5564
5571
|
:type FlowId: str
|
|
5565
|
-
:param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
|
5566
|
-
|
|
5567
|
-
注:
|
|
5568
|
-
`1. ApproverType目前只支持个人类型的签署人。`
|
|
5569
|
-
`2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
5570
|
-
:type FlowApproverInfos: list of FlowCreateApprover
|
|
5571
5572
|
:param _Operator: 执行本接口操作的员工信息。
|
|
5572
5573
|
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
5573
5574
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
5574
5575
|
:param _Agent: 代理企业和员工的信息。
|
|
5575
5576
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
5576
5577
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
5578
|
+
:param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
|
|
5579
|
+
|
|
5580
|
+
注:
|
|
5581
|
+
`1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
5582
|
+
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
5583
|
+
:type FlowApproverInfos: list of FlowCreateApprover
|
|
5577
5584
|
:param _Organization: 机构信息,暂未开放
|
|
5578
5585
|
:type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
|
|
5579
5586
|
:param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
|
5580
5587
|
:type JumpUrl: str
|
|
5588
|
+
:param _UrlType: 链接类型,支持指定以下类型
|
|
5589
|
+
<ul><li>0 : 签署链接 (默认值)</li>
|
|
5590
|
+
<li>1 : 预览链接</li></ul>
|
|
5591
|
+
注:
|
|
5592
|
+
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
5593
|
+
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
5594
|
+
:type UrlType: int
|
|
5581
5595
|
"""
|
|
5582
5596
|
self._FlowId = None
|
|
5583
|
-
self._FlowApproverInfos = None
|
|
5584
5597
|
self._Operator = None
|
|
5585
5598
|
self._Agent = None
|
|
5599
|
+
self._FlowApproverInfos = None
|
|
5586
5600
|
self._Organization = None
|
|
5587
5601
|
self._JumpUrl = None
|
|
5602
|
+
self._UrlType = None
|
|
5588
5603
|
|
|
5589
5604
|
@property
|
|
5590
5605
|
def FlowId(self):
|
|
@@ -5594,14 +5609,6 @@ class CreateFlowSignUrlRequest(AbstractModel):
|
|
|
5594
5609
|
def FlowId(self, FlowId):
|
|
5595
5610
|
self._FlowId = FlowId
|
|
5596
5611
|
|
|
5597
|
-
@property
|
|
5598
|
-
def FlowApproverInfos(self):
|
|
5599
|
-
return self._FlowApproverInfos
|
|
5600
|
-
|
|
5601
|
-
@FlowApproverInfos.setter
|
|
5602
|
-
def FlowApproverInfos(self, FlowApproverInfos):
|
|
5603
|
-
self._FlowApproverInfos = FlowApproverInfos
|
|
5604
|
-
|
|
5605
5612
|
@property
|
|
5606
5613
|
def Operator(self):
|
|
5607
5614
|
return self._Operator
|
|
@@ -5618,6 +5625,14 @@ class CreateFlowSignUrlRequest(AbstractModel):
|
|
|
5618
5625
|
def Agent(self, Agent):
|
|
5619
5626
|
self._Agent = Agent
|
|
5620
5627
|
|
|
5628
|
+
@property
|
|
5629
|
+
def FlowApproverInfos(self):
|
|
5630
|
+
return self._FlowApproverInfos
|
|
5631
|
+
|
|
5632
|
+
@FlowApproverInfos.setter
|
|
5633
|
+
def FlowApproverInfos(self, FlowApproverInfos):
|
|
5634
|
+
self._FlowApproverInfos = FlowApproverInfos
|
|
5635
|
+
|
|
5621
5636
|
@property
|
|
5622
5637
|
def Organization(self):
|
|
5623
5638
|
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
|
|
@@ -5638,25 +5653,34 @@ class CreateFlowSignUrlRequest(AbstractModel):
|
|
|
5638
5653
|
def JumpUrl(self, JumpUrl):
|
|
5639
5654
|
self._JumpUrl = JumpUrl
|
|
5640
5655
|
|
|
5656
|
+
@property
|
|
5657
|
+
def UrlType(self):
|
|
5658
|
+
return self._UrlType
|
|
5659
|
+
|
|
5660
|
+
@UrlType.setter
|
|
5661
|
+
def UrlType(self, UrlType):
|
|
5662
|
+
self._UrlType = UrlType
|
|
5663
|
+
|
|
5641
5664
|
|
|
5642
5665
|
def _deserialize(self, params):
|
|
5643
5666
|
self._FlowId = params.get("FlowId")
|
|
5644
|
-
if params.get("FlowApproverInfos") is not None:
|
|
5645
|
-
self._FlowApproverInfos = []
|
|
5646
|
-
for item in params.get("FlowApproverInfos"):
|
|
5647
|
-
obj = FlowCreateApprover()
|
|
5648
|
-
obj._deserialize(item)
|
|
5649
|
-
self._FlowApproverInfos.append(obj)
|
|
5650
5667
|
if params.get("Operator") is not None:
|
|
5651
5668
|
self._Operator = UserInfo()
|
|
5652
5669
|
self._Operator._deserialize(params.get("Operator"))
|
|
5653
5670
|
if params.get("Agent") is not None:
|
|
5654
5671
|
self._Agent = Agent()
|
|
5655
5672
|
self._Agent._deserialize(params.get("Agent"))
|
|
5673
|
+
if params.get("FlowApproverInfos") is not None:
|
|
5674
|
+
self._FlowApproverInfos = []
|
|
5675
|
+
for item in params.get("FlowApproverInfos"):
|
|
5676
|
+
obj = FlowCreateApprover()
|
|
5677
|
+
obj._deserialize(item)
|
|
5678
|
+
self._FlowApproverInfos.append(obj)
|
|
5656
5679
|
if params.get("Organization") is not None:
|
|
5657
5680
|
self._Organization = OrganizationInfo()
|
|
5658
5681
|
self._Organization._deserialize(params.get("Organization"))
|
|
5659
5682
|
self._JumpUrl = params.get("JumpUrl")
|
|
5683
|
+
self._UrlType = params.get("UrlType")
|
|
5660
5684
|
memeber_set = set(params.keys())
|
|
5661
5685
|
for name, value in vars(self).items():
|
|
5662
5686
|
property_name = name[1:]
|
|
@@ -5875,10 +5899,21 @@ class CreateIntegrationEmployeesRequest(AbstractModel):
|
|
|
5875
5899
|
:param _Agent: 代理企业和员工的信息。
|
|
5876
5900
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
5877
5901
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
5902
|
+
:param _InvitationNotifyType: 员工邀请方式
|
|
5903
|
+
如果是来自H5的,参数需要传递H5
|
|
5904
|
+
短信或者企微 请传递SMS,或者不传递
|
|
5905
|
+
:type InvitationNotifyType: str
|
|
5906
|
+
:param _JumpUrl: 回跳地址,
|
|
5907
|
+
在认证成功之后,进行回跳,请保证回跳地址的可用性。
|
|
5908
|
+
使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置
|
|
5909
|
+
|
|
5910
|
+
:type JumpUrl: str
|
|
5878
5911
|
"""
|
|
5879
5912
|
self._Operator = None
|
|
5880
5913
|
self._Employees = None
|
|
5881
5914
|
self._Agent = None
|
|
5915
|
+
self._InvitationNotifyType = None
|
|
5916
|
+
self._JumpUrl = None
|
|
5882
5917
|
|
|
5883
5918
|
@property
|
|
5884
5919
|
def Operator(self):
|
|
@@ -5904,6 +5939,22 @@ class CreateIntegrationEmployeesRequest(AbstractModel):
|
|
|
5904
5939
|
def Agent(self, Agent):
|
|
5905
5940
|
self._Agent = Agent
|
|
5906
5941
|
|
|
5942
|
+
@property
|
|
5943
|
+
def InvitationNotifyType(self):
|
|
5944
|
+
return self._InvitationNotifyType
|
|
5945
|
+
|
|
5946
|
+
@InvitationNotifyType.setter
|
|
5947
|
+
def InvitationNotifyType(self, InvitationNotifyType):
|
|
5948
|
+
self._InvitationNotifyType = InvitationNotifyType
|
|
5949
|
+
|
|
5950
|
+
@property
|
|
5951
|
+
def JumpUrl(self):
|
|
5952
|
+
return self._JumpUrl
|
|
5953
|
+
|
|
5954
|
+
@JumpUrl.setter
|
|
5955
|
+
def JumpUrl(self, JumpUrl):
|
|
5956
|
+
self._JumpUrl = JumpUrl
|
|
5957
|
+
|
|
5907
5958
|
|
|
5908
5959
|
def _deserialize(self, params):
|
|
5909
5960
|
if params.get("Operator") is not None:
|
|
@@ -5918,6 +5969,8 @@ class CreateIntegrationEmployeesRequest(AbstractModel):
|
|
|
5918
5969
|
if params.get("Agent") is not None:
|
|
5919
5970
|
self._Agent = Agent()
|
|
5920
5971
|
self._Agent._deserialize(params.get("Agent"))
|
|
5972
|
+
self._InvitationNotifyType = params.get("InvitationNotifyType")
|
|
5973
|
+
self._JumpUrl = params.get("JumpUrl")
|
|
5921
5974
|
memeber_set = set(params.keys())
|
|
5922
5975
|
for name, value in vars(self).items():
|
|
5923
5976
|
property_name = name[1:]
|
|
@@ -18292,7 +18345,8 @@ class StartFlowResponse(AbstractModel):
|
|
|
18292
18345
|
|
|
18293
18346
|
|
|
18294
18347
|
class SuccessCreateStaffData(AbstractModel):
|
|
18295
|
-
"""
|
|
18348
|
+
"""创建员工成功返回的信息
|
|
18349
|
+
支持saas/企微/H5端进行加入。
|
|
18296
18350
|
|
|
18297
18351
|
"""
|
|
18298
18352
|
|
|
@@ -18309,12 +18363,17 @@ class SuccessCreateStaffData(AbstractModel):
|
|
|
18309
18363
|
:type Note: str
|
|
18310
18364
|
:param _WeworkOpenId: 传入的企微账号id
|
|
18311
18365
|
:type WeworkOpenId: str
|
|
18366
|
+
:param _Url: H5端员工加入\实名链接
|
|
18367
|
+
|
|
18368
|
+
只有入参 InvitationNotifyType = H5的时候才会进行返回。
|
|
18369
|
+
:type Url: str
|
|
18312
18370
|
"""
|
|
18313
18371
|
self._DisplayName = None
|
|
18314
18372
|
self._Mobile = None
|
|
18315
18373
|
self._UserId = None
|
|
18316
18374
|
self._Note = None
|
|
18317
18375
|
self._WeworkOpenId = None
|
|
18376
|
+
self._Url = None
|
|
18318
18377
|
|
|
18319
18378
|
@property
|
|
18320
18379
|
def DisplayName(self):
|
|
@@ -18356,6 +18415,14 @@ class SuccessCreateStaffData(AbstractModel):
|
|
|
18356
18415
|
def WeworkOpenId(self, WeworkOpenId):
|
|
18357
18416
|
self._WeworkOpenId = WeworkOpenId
|
|
18358
18417
|
|
|
18418
|
+
@property
|
|
18419
|
+
def Url(self):
|
|
18420
|
+
return self._Url
|
|
18421
|
+
|
|
18422
|
+
@Url.setter
|
|
18423
|
+
def Url(self, Url):
|
|
18424
|
+
self._Url = Url
|
|
18425
|
+
|
|
18359
18426
|
|
|
18360
18427
|
def _deserialize(self, params):
|
|
18361
18428
|
self._DisplayName = params.get("DisplayName")
|
|
@@ -18363,6 +18430,7 @@ class SuccessCreateStaffData(AbstractModel):
|
|
|
18363
18430
|
self._UserId = params.get("UserId")
|
|
18364
18431
|
self._Note = params.get("Note")
|
|
18365
18432
|
self._WeworkOpenId = params.get("WeworkOpenId")
|
|
18433
|
+
self._Url = params.get("Url")
|
|
18366
18434
|
memeber_set = set(params.keys())
|
|
18367
18435
|
for name, value in vars(self).items():
|
|
18368
18436
|
property_name = name[1:]
|
|
@@ -18431,7 +18499,9 @@ class SuccessDeleteStaffData(AbstractModel):
|
|
|
18431
18499
|
|
|
18432
18500
|
|
|
18433
18501
|
class SuccessUpdateStaffData(AbstractModel):
|
|
18434
|
-
"""
|
|
18502
|
+
"""更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新
|
|
18503
|
+
会通过短信、企微消息或者H5Url 链接
|
|
18504
|
+
如果是通过H5邀请加入的方式,会返回H5 链接
|
|
18435
18505
|
|
|
18436
18506
|
"""
|
|
18437
18507
|
|
|
@@ -18444,10 +18514,15 @@ class SuccessUpdateStaffData(AbstractModel):
|
|
|
18444
18514
|
:param _UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
|
18445
18515
|
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
18446
18516
|
:type UserId: str
|
|
18517
|
+
:param _Url: H5端员工实名链接
|
|
18518
|
+
|
|
18519
|
+
只有入参 InvitationNotifyType = H5的时候才会进行返回。
|
|
18520
|
+
:type Url: str
|
|
18447
18521
|
"""
|
|
18448
18522
|
self._DisplayName = None
|
|
18449
18523
|
self._Mobile = None
|
|
18450
18524
|
self._UserId = None
|
|
18525
|
+
self._Url = None
|
|
18451
18526
|
|
|
18452
18527
|
@property
|
|
18453
18528
|
def DisplayName(self):
|
|
@@ -18473,11 +18548,20 @@ class SuccessUpdateStaffData(AbstractModel):
|
|
|
18473
18548
|
def UserId(self, UserId):
|
|
18474
18549
|
self._UserId = UserId
|
|
18475
18550
|
|
|
18551
|
+
@property
|
|
18552
|
+
def Url(self):
|
|
18553
|
+
return self._Url
|
|
18554
|
+
|
|
18555
|
+
@Url.setter
|
|
18556
|
+
def Url(self, Url):
|
|
18557
|
+
self._Url = Url
|
|
18558
|
+
|
|
18476
18559
|
|
|
18477
18560
|
def _deserialize(self, params):
|
|
18478
18561
|
self._DisplayName = params.get("DisplayName")
|
|
18479
18562
|
self._Mobile = params.get("Mobile")
|
|
18480
18563
|
self._UserId = params.get("UserId")
|
|
18564
|
+
self._Url = params.get("Url")
|
|
18481
18565
|
memeber_set = set(params.keys())
|
|
18482
18566
|
for name, value in vars(self).items():
|
|
18483
18567
|
property_name = name[1:]
|
|
@@ -18980,10 +19064,20 @@ class UpdateIntegrationEmployeesRequest(AbstractModel):
|
|
|
18980
19064
|
:param _Agent: 代理企业和员工的信息。
|
|
18981
19065
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
18982
19066
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
19067
|
+
:param _InvitationNotifyType: 员工邀请方式
|
|
19068
|
+
如果是来自H5的,参数需要传递H5
|
|
19069
|
+
短信或者企微 请传递SMS,或者不传递
|
|
19070
|
+
:type InvitationNotifyType: str
|
|
19071
|
+
:param _JumpUrl: 回跳地址,
|
|
19072
|
+
在认证成功之后,进行回跳,请保证回跳地址的可用性。
|
|
19073
|
+
使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置。
|
|
19074
|
+
:type JumpUrl: str
|
|
18983
19075
|
"""
|
|
18984
19076
|
self._Operator = None
|
|
18985
19077
|
self._Employees = None
|
|
18986
19078
|
self._Agent = None
|
|
19079
|
+
self._InvitationNotifyType = None
|
|
19080
|
+
self._JumpUrl = None
|
|
18987
19081
|
|
|
18988
19082
|
@property
|
|
18989
19083
|
def Operator(self):
|
|
@@ -19009,6 +19103,22 @@ class UpdateIntegrationEmployeesRequest(AbstractModel):
|
|
|
19009
19103
|
def Agent(self, Agent):
|
|
19010
19104
|
self._Agent = Agent
|
|
19011
19105
|
|
|
19106
|
+
@property
|
|
19107
|
+
def InvitationNotifyType(self):
|
|
19108
|
+
return self._InvitationNotifyType
|
|
19109
|
+
|
|
19110
|
+
@InvitationNotifyType.setter
|
|
19111
|
+
def InvitationNotifyType(self, InvitationNotifyType):
|
|
19112
|
+
self._InvitationNotifyType = InvitationNotifyType
|
|
19113
|
+
|
|
19114
|
+
@property
|
|
19115
|
+
def JumpUrl(self):
|
|
19116
|
+
return self._JumpUrl
|
|
19117
|
+
|
|
19118
|
+
@JumpUrl.setter
|
|
19119
|
+
def JumpUrl(self, JumpUrl):
|
|
19120
|
+
self._JumpUrl = JumpUrl
|
|
19121
|
+
|
|
19012
19122
|
|
|
19013
19123
|
def _deserialize(self, params):
|
|
19014
19124
|
if params.get("Operator") is not None:
|
|
@@ -19023,6 +19133,8 @@ class UpdateIntegrationEmployeesRequest(AbstractModel):
|
|
|
19023
19133
|
if params.get("Agent") is not None:
|
|
19024
19134
|
self._Agent = Agent()
|
|
19025
19135
|
self._Agent._deserialize(params.get("Agent"))
|
|
19136
|
+
self._InvitationNotifyType = params.get("InvitationNotifyType")
|
|
19137
|
+
self._JumpUrl = params.get("JumpUrl")
|
|
19026
19138
|
memeber_set = set(params.keys())
|
|
19027
19139
|
for name, value in vars(self).items():
|
|
19028
19140
|
property_name = name[1:]
|
|
@@ -690,15 +690,14 @@ class EssbasicClient(AbstractClient):
|
|
|
690
690
|
|
|
691
691
|
|
|
692
692
|
def ChannelCreateFlowSignUrl(self, request):
|
|
693
|
-
"""
|
|
693
|
+
"""该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
694
694
|
|
|
695
695
|
**注意**
|
|
696
|
-
1.
|
|
697
|
-
2.
|
|
698
|
-
3.
|
|
699
|
-
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
696
|
+
1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
|
|
697
|
+
2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
698
|
+
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
700
699
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
701
|
-
|
|
700
|
+
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
702
701
|
|
|
703
702
|
:param request: Request instance for ChannelCreateFlowSignUrl.
|
|
704
703
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
|