tencentcloud-sdk-python-essbasic 3.0.1083__tar.gz → 3.0.1092__tar.gz

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.
Files changed (20) hide show
  1. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/setup.py +1 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20210526/essbasic_client.py +51 -39
  5. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20210526/models.py +67 -368
  6. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
  7. tencentcloud-sdk-python-essbasic-3.0.1092/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  8. tencentcloud-sdk-python-essbasic-3.0.1083/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  9. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/README.rst +0 -0
  10. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/setup.cfg +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.1083 → tencentcloud-sdk-python-essbasic-3.0.1092}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1083
3
+ Version: 3.0.1092
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common==3.0.1083"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1092"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Essbasic SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1083'
17
+ __version__ = '3.0.1092'
@@ -35,7 +35,7 @@ class EssbasicClient(AbstractClient):
35
35
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
36
36
 
37
37
  注:
38
- - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
38
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
39
39
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
40
40
 
41
41
  :param request: Request instance for ChannelBatchCancelFlows.
@@ -67,7 +67,7 @@ class EssbasicClient(AbstractClient):
67
67
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
68
68
 
69
69
  注:
70
- - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
70
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
71
71
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
72
72
 
73
73
  :param request: Request instance for ChannelCancelFlow.
@@ -139,7 +139,7 @@ class EssbasicClient(AbstractClient):
139
139
 
140
140
 
141
141
  def ChannelCreateBatchCancelFlowUrl(self, request):
142
- """通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
142
+ """通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
143
143
 
144
144
  适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
145
145
 
@@ -1692,11 +1692,11 @@ class EssbasicClient(AbstractClient):
1692
1692
  如若在模板中配置了动态表格, 上传的附件必须为A4大小
1693
1693
  合同发起人必须在电子签已经进行实名。
1694
1694
 
1695
- **整体的逻辑如下**
1695
+ ### 一. 整体的逻辑如下
1696
1696
 
1697
1697
  ![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)
1698
1698
 
1699
- **可以作为发起方和签署方的角色列表**
1699
+ ### 二. 可以作为发起方和签署方的角色列表
1700
1700
  <table>
1701
1701
  <thead>
1702
1702
  <tr>
@@ -1739,14 +1739,50 @@ class EssbasicClient(AbstractClient):
1739
1739
  </tbody>
1740
1740
  </table>
1741
1741
 
1742
- **注**:
1743
- `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
1742
+ ### 三. 填充模板中定义的填写控件
1743
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
1744
1744
 
1745
- `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
1745
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
1746
+ 填充的传参示例如下
1746
1747
 
1747
- `3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)`
1748
+ ```
1749
+ request.FormFields = [{
1750
+ "ComponentName": "项目的名字",
1751
+ "ComponentValue": "休闲山庄"
1752
+ }, {
1753
+ "ComponentName": "项目的地址",
1754
+ "ComponentValue": "凤凰山北侧",
1755
+ }, {
1756
+ "ComponentName": "范围",
1757
+ "ComponentValue": "凤凰山至107国道",
1758
+ }, {
1759
+ "ComponentName": "面积",
1760
+ "ComponentValue": "100亩",
1761
+ }, {
1762
+ "ComponentName": "基本情况",
1763
+ "ComponentValue": "完好",
1764
+ }, , {
1765
+ "ComponentName": "用途",
1766
+ "ComponentValue": "经营农家乐",
1767
+ }
1768
+ ]
1769
+ ```
1770
+ 合成后合同样子示例
1748
1771
 
1749
- `4. 静默(自动)签署不支持合同签署方存在填写功能`
1772
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
1773
+
1774
+
1775
+
1776
+ ### 四. 注意
1777
+ 1. 发起合同时候, 作为<font color="red">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名
1778
+
1779
+ 2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
1780
+
1781
+ 3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)
1782
+
1783
+ 4. <font color="red">静默(自动)签署不支持合同签署方存在填写</font>
1784
+
1785
+ 5. <font color="red">在下一步创建签署链接前,建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
1750
1786
 
1751
1787
  :param request: Request instance for CreateFlowsByTemplates.
1752
1788
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesRequest`
@@ -1835,7 +1871,7 @@ class EssbasicClient(AbstractClient):
1835
1871
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
1836
1872
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
1837
1873
 
1838
- **主要使用场景可以更加EndPoint分类如下**
1874
+ **主要使用场景EndPoint分类**
1839
1875
 
1840
1876
  |EndPoint| 场景| 说明和示例|
1841
1877
  | ---- | ---- | --- |
@@ -1892,31 +1928,6 @@ class EssbasicClient(AbstractClient):
1892
1928
  raise TencentCloudSDKException(type(e).__name__, str(e))
1893
1929
 
1894
1930
 
1895
- def DescribeBillUsageDetail(self, request):
1896
- """废弃接口
1897
-
1898
- 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1899
-
1900
- :param request: Request instance for DescribeBillUsageDetail.
1901
- :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeBillUsageDetailRequest`
1902
- :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeBillUsageDetailResponse`
1903
-
1904
- """
1905
- try:
1906
- params = request._serialize()
1907
- headers = request.headers
1908
- body = self.call("DescribeBillUsageDetail", params, headers=headers)
1909
- response = json.loads(body)
1910
- model = models.DescribeBillUsageDetailResponse()
1911
- model._deserialize(response["Response"])
1912
- return model
1913
- except Exception as e:
1914
- if isinstance(e, TencentCloudSDKException):
1915
- raise
1916
- else:
1917
- raise TencentCloudSDKException(type(e).__name__, str(e))
1918
-
1919
-
1920
1931
  def DescribeChannelFlowEvidenceReport(self, request):
1921
1932
  """获取出证报告任务执行结果,返回报告 URL。
1922
1933
 
@@ -2407,11 +2418,12 @@ class EssbasicClient(AbstractClient):
2407
2418
 
2408
2419
 
2409
2420
  def SyncProxyOrganizationOperators(self, request):
2410
- """此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
2421
+ """此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。
2422
+ 子客Web控制台的组织架构管理,依赖于第三方应用平台的,无法在页面针对员工做新增/更新/离职等操作, 必须通过 API 来操作。
2411
2423
 
2412
- - **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
2424
+ - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
2413
2425
 
2414
- - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
2426
+ - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
2415
2427
 
2416
2428
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
2417
2429
 
@@ -893,201 +893,6 @@ class BaseFlowInfo(AbstractModel):
893
893
 
894
894
 
895
895
 
896
- class BillUsageDetail(AbstractModel):
897
- """用户计费使用情况详情
898
-
899
- """
900
-
901
- def __init__(self):
902
- r"""
903
- :param _FlowId: 合同流程ID,为32位字符串。
904
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
905
- 注意:此字段可能返回 null,表示取不到有效值。
906
- :type FlowId: str
907
- :param _OperatorName: 合同经办人名称
908
- 如果有多个经办人用分号隔开。
909
- 注意:此字段可能返回 null,表示取不到有效值。
910
- :type OperatorName: str
911
- :param _CreateOrganizationName: 发起方组织机构名称
912
- 注意:此字段可能返回 null,表示取不到有效值。
913
- :type CreateOrganizationName: str
914
- :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
915
- 该名称还将用于合同签署完成后的下载文件名。
916
- 注意:此字段可能返回 null,表示取不到有效值。
917
- :type FlowName: str
918
- :param _Status: 当前合同状态,如下是状态码对应的状态。
919
- 0-还没有发起
920
- 1-等待签署
921
- 2-部分签署
922
- 3-拒签
923
- 4-已签署
924
- 5-已过期
925
- 6-已撤销
926
- 7-还没有预发起
927
- 8-等待填写
928
- 9-部分填写
929
- 10-拒填
930
- 11-已解除
931
- 注意:此字段可能返回 null,表示取不到有效值。
932
- :type Status: int
933
- :param _QuotaType: 套餐类型
934
- 对应关系如下
935
- CloudEnterprise-企业版合同
936
- SingleSignature-单方签章
937
- CloudProve-签署报告
938
- CloudOnlineSign-腾讯会议在线签约
939
- ChannelWeCard-微工卡
940
- SignFlow-合同套餐
941
- SignFace-签署意愿(人脸识别)
942
- SignPassword-签署意愿(密码)
943
- SignSMS-签署意愿(短信)
944
- PersonalEssAuth-签署人实名(腾讯电子签认证)
945
- PersonalThirdAuth-签署人实名(信任第三方认证)
946
- OrgEssAuth-签署企业实名
947
- FlowNotify-短信通知
948
- AuthService-企业工商信息查询
949
- 注意:此字段可能返回 null,表示取不到有效值。
950
- :type QuotaType: str
951
- :param _UseCount: 合同使用量
952
- 注意:此字段可能返回 null,表示取不到有效值。
953
- :type UseCount: int
954
- :param _CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。
955
- 注意:此字段可能返回 null,表示取不到有效值。
956
- :type CostTime: int
957
- :param _QuotaName: 消耗的套餐名称
958
- 注意:此字段可能返回 null,表示取不到有效值。
959
- :type QuotaName: str
960
- :param _CostType: 消耗类型
961
- 1.扣费 2.撤销返还
962
- 注意:此字段可能返回 null,表示取不到有效值。
963
- :type CostType: int
964
- :param _Remark: 备注
965
- 注意:此字段可能返回 null,表示取不到有效值。
966
- :type Remark: str
967
- """
968
- self._FlowId = None
969
- self._OperatorName = None
970
- self._CreateOrganizationName = None
971
- self._FlowName = None
972
- self._Status = None
973
- self._QuotaType = None
974
- self._UseCount = None
975
- self._CostTime = None
976
- self._QuotaName = None
977
- self._CostType = None
978
- self._Remark = None
979
-
980
- @property
981
- def FlowId(self):
982
- return self._FlowId
983
-
984
- @FlowId.setter
985
- def FlowId(self, FlowId):
986
- self._FlowId = FlowId
987
-
988
- @property
989
- def OperatorName(self):
990
- return self._OperatorName
991
-
992
- @OperatorName.setter
993
- def OperatorName(self, OperatorName):
994
- self._OperatorName = OperatorName
995
-
996
- @property
997
- def CreateOrganizationName(self):
998
- return self._CreateOrganizationName
999
-
1000
- @CreateOrganizationName.setter
1001
- def CreateOrganizationName(self, CreateOrganizationName):
1002
- self._CreateOrganizationName = CreateOrganizationName
1003
-
1004
- @property
1005
- def FlowName(self):
1006
- return self._FlowName
1007
-
1008
- @FlowName.setter
1009
- def FlowName(self, FlowName):
1010
- self._FlowName = FlowName
1011
-
1012
- @property
1013
- def Status(self):
1014
- return self._Status
1015
-
1016
- @Status.setter
1017
- def Status(self, Status):
1018
- self._Status = Status
1019
-
1020
- @property
1021
- def QuotaType(self):
1022
- return self._QuotaType
1023
-
1024
- @QuotaType.setter
1025
- def QuotaType(self, QuotaType):
1026
- self._QuotaType = QuotaType
1027
-
1028
- @property
1029
- def UseCount(self):
1030
- return self._UseCount
1031
-
1032
- @UseCount.setter
1033
- def UseCount(self, UseCount):
1034
- self._UseCount = UseCount
1035
-
1036
- @property
1037
- def CostTime(self):
1038
- return self._CostTime
1039
-
1040
- @CostTime.setter
1041
- def CostTime(self, CostTime):
1042
- self._CostTime = CostTime
1043
-
1044
- @property
1045
- def QuotaName(self):
1046
- return self._QuotaName
1047
-
1048
- @QuotaName.setter
1049
- def QuotaName(self, QuotaName):
1050
- self._QuotaName = QuotaName
1051
-
1052
- @property
1053
- def CostType(self):
1054
- return self._CostType
1055
-
1056
- @CostType.setter
1057
- def CostType(self, CostType):
1058
- self._CostType = CostType
1059
-
1060
- @property
1061
- def Remark(self):
1062
- return self._Remark
1063
-
1064
- @Remark.setter
1065
- def Remark(self, Remark):
1066
- self._Remark = Remark
1067
-
1068
-
1069
- def _deserialize(self, params):
1070
- self._FlowId = params.get("FlowId")
1071
- self._OperatorName = params.get("OperatorName")
1072
- self._CreateOrganizationName = params.get("CreateOrganizationName")
1073
- self._FlowName = params.get("FlowName")
1074
- self._Status = params.get("Status")
1075
- self._QuotaType = params.get("QuotaType")
1076
- self._UseCount = params.get("UseCount")
1077
- self._CostTime = params.get("CostTime")
1078
- self._QuotaName = params.get("QuotaName")
1079
- self._CostType = params.get("CostType")
1080
- self._Remark = params.get("Remark")
1081
- memeber_set = set(params.keys())
1082
- for name, value in vars(self).items():
1083
- property_name = name[1:]
1084
- if property_name in memeber_set:
1085
- memeber_set.remove(property_name)
1086
- if len(memeber_set) > 0:
1087
- warnings.warn("%s fileds are useless." % ",".join(memeber_set))
1088
-
1089
-
1090
-
1091
896
  class CcInfo(AbstractModel):
1092
897
  """抄送信息
1093
898
 
@@ -3332,7 +3137,7 @@ class ChannelCreateFlowByFilesResponse(AbstractModel):
3332
3137
  :param _FlowId: 合同流程ID,为32位字符串。
3333
3138
  建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3334
3139
 
3335
- [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
3140
+ [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
3336
3141
  注意:此字段可能返回 null,表示取不到有效值。
3337
3142
  :type FlowId: str
3338
3143
  :param _Approvers: 签署方信息,如角色ID、角色名称等
@@ -5066,7 +4871,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
5066
4871
  :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
5067
4872
 
5068
4873
 
5069
- [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
4874
+ [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
5070
4875
  :type NeedRelievedFlowId: str
5071
4876
  :param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
5072
4877
  :type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
@@ -6088,7 +5893,11 @@ class ChannelCreateWebThemeConfigRequest(AbstractModel):
6088
5893
  :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6089
5894
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6090
5895
  :param _ThemeType: 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
6091
- <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
5896
+ <ul>
5897
+ <li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
5898
+ <li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
5899
+ 目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
5900
+ </ul>
6092
5901
  :type ThemeType: str
6093
5902
  :param _WebThemeConfig: 主题配置
6094
5903
  :type WebThemeConfig: :class:`tencentcloud.essbasic.v20210526.models.WebThemeConfig`
@@ -8885,8 +8694,12 @@ class Component(AbstractModel):
8885
8694
 
8886
8695
  <font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
8887
8696
  <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
8888
- <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
8697
+ <b>参数样例</b>:` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
8889
8698
 
8699
+ <font color="red">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:
8700
+ <ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>
8701
+ <li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>
8702
+ <b>参数样例</b>:`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
8890
8703
 
8891
8704
  <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
8892
8705
  <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
@@ -9458,10 +9271,15 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
9458
9271
  :type FlowId: str
9459
9272
  :param _Operator: 暂未开放
9460
9273
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
9274
+ :param _ReportType: 指定申请的报告类型,可选类型如下:
9275
+ <ul><li> **0** :合同签署报告(默认)</li>
9276
+ <li> **1** :公证处核验报告</li></ul>
9277
+ :type ReportType: int
9461
9278
  """
9462
9279
  self._Agent = None
9463
9280
  self._FlowId = None
9464
9281
  self._Operator = None
9282
+ self._ReportType = None
9465
9283
 
9466
9284
  @property
9467
9285
  def Agent(self):
@@ -9491,6 +9309,14 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
9491
9309
 
9492
9310
  self._Operator = Operator
9493
9311
 
9312
+ @property
9313
+ def ReportType(self):
9314
+ return self._ReportType
9315
+
9316
+ @ReportType.setter
9317
+ def ReportType(self, ReportType):
9318
+ self._ReportType = ReportType
9319
+
9494
9320
 
9495
9321
  def _deserialize(self, params):
9496
9322
  if params.get("Agent") is not None:
@@ -9500,6 +9326,7 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
9500
9326
  if params.get("Operator") is not None:
9501
9327
  self._Operator = UserInfo()
9502
9328
  self._Operator._deserialize(params.get("Operator"))
9329
+ self._ReportType = params.get("ReportType")
9503
9330
  memeber_set = set(params.keys())
9504
9331
  for name, value in vars(self).items():
9505
9332
  property_name = name[1:]
@@ -10899,7 +10726,10 @@ class CreateSignUrlsRequest(AbstractModel):
10899
10726
  <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
10900
10727
  <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
10901
10728
 
10902
- 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
10729
+ **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
10730
+
10731
+ 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
10732
+
10903
10733
  :type Endpoint: str
10904
10734
  :param _GenerateType: 签署链接生成类型,可以选择的类型如下
10905
10735
 
@@ -11348,170 +11178,6 @@ class DescribeBatchOrganizationRegistrationUrlsResponse(AbstractModel):
11348
11178
  self._RequestId = params.get("RequestId")
11349
11179
 
11350
11180
 
11351
- class DescribeBillUsageDetailRequest(AbstractModel):
11352
- """DescribeBillUsageDetail请求参数结构体
11353
-
11354
- """
11355
-
11356
- def __init__(self):
11357
- r"""
11358
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
11359
- :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
11360
- :param _StartTime: 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
11361
- :type StartTime: str
11362
- :param _EndTime: 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
11363
- :type EndTime: str
11364
- :param _QuotaType: 查询的套餐类型 (选填 )不传则查询所有套餐;
11365
- 对应关系如下
11366
- CloudEnterprise-企业版合同
11367
- SingleSignature-单方签章
11368
- CloudProve-签署报告
11369
- CloudOnlineSign-腾讯会议在线签约
11370
- ChannelWeCard-微工卡
11371
- SignFlow-合同套餐
11372
- SignFace-签署意愿(人脸识别)
11373
- SignPassword-签署意愿(密码)
11374
- SignSMS-签署意愿(短信)
11375
- PersonalEssAuth-签署人实名(腾讯电子签认证)
11376
- PersonalThirdAuth-签署人实名(信任第三方认证)
11377
- OrgEssAuth-签署企业实名
11378
- FlowNotify-短信通知
11379
- AuthService-企业工商信息查询
11380
- :type QuotaType: str
11381
- :param _Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
11382
- :type Offset: int
11383
- :param _Limit: 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
11384
- :type Limit: int
11385
- """
11386
- self._Agent = None
11387
- self._StartTime = None
11388
- self._EndTime = None
11389
- self._QuotaType = None
11390
- self._Offset = None
11391
- self._Limit = None
11392
-
11393
- @property
11394
- def Agent(self):
11395
- return self._Agent
11396
-
11397
- @Agent.setter
11398
- def Agent(self, Agent):
11399
- self._Agent = Agent
11400
-
11401
- @property
11402
- def StartTime(self):
11403
- return self._StartTime
11404
-
11405
- @StartTime.setter
11406
- def StartTime(self, StartTime):
11407
- self._StartTime = StartTime
11408
-
11409
- @property
11410
- def EndTime(self):
11411
- return self._EndTime
11412
-
11413
- @EndTime.setter
11414
- def EndTime(self, EndTime):
11415
- self._EndTime = EndTime
11416
-
11417
- @property
11418
- def QuotaType(self):
11419
- return self._QuotaType
11420
-
11421
- @QuotaType.setter
11422
- def QuotaType(self, QuotaType):
11423
- self._QuotaType = QuotaType
11424
-
11425
- @property
11426
- def Offset(self):
11427
- return self._Offset
11428
-
11429
- @Offset.setter
11430
- def Offset(self, Offset):
11431
- self._Offset = Offset
11432
-
11433
- @property
11434
- def Limit(self):
11435
- return self._Limit
11436
-
11437
- @Limit.setter
11438
- def Limit(self, Limit):
11439
- self._Limit = Limit
11440
-
11441
-
11442
- def _deserialize(self, params):
11443
- if params.get("Agent") is not None:
11444
- self._Agent = Agent()
11445
- self._Agent._deserialize(params.get("Agent"))
11446
- self._StartTime = params.get("StartTime")
11447
- self._EndTime = params.get("EndTime")
11448
- self._QuotaType = params.get("QuotaType")
11449
- self._Offset = params.get("Offset")
11450
- self._Limit = params.get("Limit")
11451
- memeber_set = set(params.keys())
11452
- for name, value in vars(self).items():
11453
- property_name = name[1:]
11454
- if property_name in memeber_set:
11455
- memeber_set.remove(property_name)
11456
- if len(memeber_set) > 0:
11457
- warnings.warn("%s fileds are useless." % ",".join(memeber_set))
11458
-
11459
-
11460
-
11461
- class DescribeBillUsageDetailResponse(AbstractModel):
11462
- """DescribeBillUsageDetail返回参数结构体
11463
-
11464
- """
11465
-
11466
- def __init__(self):
11467
- r"""
11468
- :param _Total: 返回查询记录总数
11469
- :type Total: int
11470
- :param _Details: 消耗记录详情
11471
- :type Details: list of BillUsageDetail
11472
- :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
11473
- :type RequestId: str
11474
- """
11475
- self._Total = None
11476
- self._Details = None
11477
- self._RequestId = None
11478
-
11479
- @property
11480
- def Total(self):
11481
- return self._Total
11482
-
11483
- @Total.setter
11484
- def Total(self, Total):
11485
- self._Total = Total
11486
-
11487
- @property
11488
- def Details(self):
11489
- return self._Details
11490
-
11491
- @Details.setter
11492
- def Details(self, Details):
11493
- self._Details = Details
11494
-
11495
- @property
11496
- def RequestId(self):
11497
- return self._RequestId
11498
-
11499
- @RequestId.setter
11500
- def RequestId(self, RequestId):
11501
- self._RequestId = RequestId
11502
-
11503
-
11504
- def _deserialize(self, params):
11505
- self._Total = params.get("Total")
11506
- if params.get("Details") is not None:
11507
- self._Details = []
11508
- for item in params.get("Details"):
11509
- obj = BillUsageDetail()
11510
- obj._deserialize(item)
11511
- self._Details.append(obj)
11512
- self._RequestId = params.get("RequestId")
11513
-
11514
-
11515
11181
  class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
11516
11182
  """DescribeChannelFlowEvidenceReport请求参数结构体
11517
11183
 
@@ -11533,10 +11199,15 @@ class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
11533
11199
  :type ReportId: str
11534
11200
  :param _Operator: 暂未开放
11535
11201
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
11202
+ :param _ReportType: 指定申请的报告类型,可选类型如下:
11203
+ <ul><li> **0** :合同签署报告(默认)</li>
11204
+ <li> **1** :公证处核验报告</li></ul>
11205
+ :type ReportType: int
11536
11206
  """
11537
11207
  self._Agent = None
11538
11208
  self._ReportId = None
11539
11209
  self._Operator = None
11210
+ self._ReportType = None
11540
11211
 
11541
11212
  @property
11542
11213
  def Agent(self):
@@ -11566,6 +11237,14 @@ class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
11566
11237
 
11567
11238
  self._Operator = Operator
11568
11239
 
11240
+ @property
11241
+ def ReportType(self):
11242
+ return self._ReportType
11243
+
11244
+ @ReportType.setter
11245
+ def ReportType(self, ReportType):
11246
+ self._ReportType = ReportType
11247
+
11569
11248
 
11570
11249
  def _deserialize(self, params):
11571
11250
  if params.get("Agent") is not None:
@@ -11575,6 +11254,7 @@ class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
11575
11254
  if params.get("Operator") is not None:
11576
11255
  self._Operator = UserInfo()
11577
11256
  self._Operator._deserialize(params.get("Operator"))
11257
+ self._ReportType = params.get("ReportType")
11578
11258
  memeber_set = set(params.keys())
11579
11259
  for name, value in vars(self).items():
11580
11260
  property_name = name[1:]
@@ -12464,7 +12144,7 @@ class DescribeTemplatesRequest(AbstractModel):
12464
12144
 
12465
12145
  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
12466
12146
 
12467
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
12147
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
12468
12148
  :type TemplateId: str
12469
12149
  :param _ContentType: 查询模板的内容
12470
12150
 
@@ -12479,7 +12159,7 @@ class DescribeTemplatesRequest(AbstractModel):
12479
12159
  4. `若传递此参数,分页参数(Limit,Offset)无效`
12480
12160
 
12481
12161
 
12482
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
12162
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
12483
12163
 
12484
12164
  :type TemplateIds: list of str
12485
12165
  :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。
@@ -15147,9 +14827,13 @@ class FormField(AbstractModel):
15147
14827
  :type ComponentValue: str
15148
14828
  :param _ComponentId: 表单域或控件的ID,跟ComponentName二选一,不能全为空;
15149
14829
  CreateFlowsByTemplates 接口不使用此字段。
14830
+
14831
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
15150
14832
  注意:此字段可能返回 null,表示取不到有效值。
15151
14833
  :type ComponentId: str
15152
14834
  :param _ComponentName: 控件的名字,跟ComponentId二选一,不能全为空
14835
+
14836
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
15153
14837
  注意:此字段可能返回 null,表示取不到有效值。
15154
14838
  :type ComponentName: str
15155
14839
  :param _LockComponentValue: 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
@@ -17309,12 +16993,15 @@ class RegistrationOrganizationInfo(AbstractModel):
17309
16993
  在注册流程中,这个手机号必须跟操作人在电子签注册的个人手机号一致。
17310
16994
  :type AdminMobile: str
17311
16995
  :param _AuthorizationTypes: 可选的此企业允许的授权方式, 可以设置的方式有:
17312
- 1:上传授权书+对公打款
17313
- 2:法人授权/认证 会根据当前操作人的身份判定,如果当前操作人是法人,则是法人认证, 如果当前操作人不是法人,则走法人授权
16996
+ 1:上传授权书
16997
+ 2:法人授权超管
16998
+ 5:授权书+对公打款
16999
+
17314
17000
 
17315
17001
  注:
17316
17002
  `1. 当前仅支持一种认证方式`
17317
17003
  `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
17004
+ `3. 如果当前操作人是法人,则是法人认证`
17318
17005
  :type AuthorizationTypes: list of int non-negative
17319
17006
  :param _AdminIdCardType: 经办人的证件类型,支持以下类型
17320
17007
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
@@ -17324,6 +17011,8 @@ class RegistrationOrganizationInfo(AbstractModel):
17324
17011
  :type AdminIdCardType: str
17325
17012
  :param _AdminIdCardNumber: 经办人的证件号
17326
17013
  :type AdminIdCardNumber: str
17014
+ :param _BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
17015
+ :type BusinessLicense: str
17327
17016
  """
17328
17017
  self._OrganizationName = None
17329
17018
  self._OrganizationOpenId = None
@@ -17336,6 +17025,7 @@ class RegistrationOrganizationInfo(AbstractModel):
17336
17025
  self._AuthorizationTypes = None
17337
17026
  self._AdminIdCardType = None
17338
17027
  self._AdminIdCardNumber = None
17028
+ self._BusinessLicense = None
17339
17029
 
17340
17030
  @property
17341
17031
  def OrganizationName(self):
@@ -17425,6 +17115,14 @@ class RegistrationOrganizationInfo(AbstractModel):
17425
17115
  def AdminIdCardNumber(self, AdminIdCardNumber):
17426
17116
  self._AdminIdCardNumber = AdminIdCardNumber
17427
17117
 
17118
+ @property
17119
+ def BusinessLicense(self):
17120
+ return self._BusinessLicense
17121
+
17122
+ @BusinessLicense.setter
17123
+ def BusinessLicense(self, BusinessLicense):
17124
+ self._BusinessLicense = BusinessLicense
17125
+
17428
17126
 
17429
17127
  def _deserialize(self, params):
17430
17128
  self._OrganizationName = params.get("OrganizationName")
@@ -17438,6 +17136,7 @@ class RegistrationOrganizationInfo(AbstractModel):
17438
17136
  self._AuthorizationTypes = params.get("AuthorizationTypes")
17439
17137
  self._AdminIdCardType = params.get("AdminIdCardType")
17440
17138
  self._AdminIdCardNumber = params.get("AdminIdCardNumber")
17139
+ self._BusinessLicense = params.get("BusinessLicense")
17441
17140
  memeber_set = set(params.keys())
17442
17141
  for name, value in vars(self).items():
17443
17142
  property_name = name[1:]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1083
3
+ Version: 3.0.1092
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common==3.0.1092
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.1083