tencentcloud-sdk-python-essbasic 3.0.1027__py2.py3-none-any.whl → 3.0.1031__py2.py3-none-any.whl

tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1027'
+__version__ = '3.0.1031'

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -364,7 +364,7 @@ class EssbasicClient(AbstractClient):
         <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。整体的逻辑如下图</li>
         </ul>
 
-        ![image](https://dyn.ess.tencent.cn/guide/capi/ChannelCreateFlowByFiles.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/bf86248a2c163228c4e894cf5926af69/ChannelCreateFlowByFiles.png)
 
         **可以作为发起方和签署方的角色列表**
         <table>
@@ -1392,7 +1392,7 @@ class EssbasicClient(AbstractClient):
         - 出证过程需一定时间，建议在**提交出证任务后的24小时之后**，通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
 
 
-        ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/1b4307ed143a992940c41d61192d3a0f/channel_CreateChannelFlowEvidenceReport.png)
 
         :param request: Request instance for CreateChannelFlowEvidenceReport.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelFlowEvidenceReportRequest`
@@ -1535,7 +1535,7 @@ class EssbasicClient(AbstractClient):
 
         **整体的逻辑如下**
 
-        ![image](https://dyn.ess.tencent.cn/guide/capi/CreateFlowsByTemplates.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)
 
         **可以作为发起方和签署方的角色列表**
         <table>
@@ -1704,7 +1704,7 @@ class EssbasicClient(AbstractClient):
         - 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
         - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
 
-        ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/1b4307ed143a992940c41d61192d3a0f/channel_CreateChannelFlowEvidenceReport.png)
 
         :param request: Request instance for DescribeChannelFlowEvidenceReport.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeChannelFlowEvidenceReportRequest`
@@ -1823,23 +1823,23 @@ class EssbasicClient(AbstractClient):
 
         **适用场景**
          该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口，作为创建合同的前置接口使用。
-        通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
+        通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的创建。
 
-        **模版的来源**
+        **模板的来源**
         子客企业的模板有两种途径获取
         - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
         - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
 
         **一个模板通常会包含以下结构信息**
 
-        - 模板模版ID, 模板名字等基本信息
+        - 模板ID, 模板名字等基本信息
         - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
         - 发起方和签署方的填写控件 Components
         - 签署方的签署控件 SignComponents
 
-        ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/ab81fa948a0a6fea14f48cac91d0e36a/channel_DescribeTemplates.png)
 
-        模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+        模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
 
         ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
 
@@ -1974,23 +1974,24 @@ class EssbasicClient(AbstractClient):
 
 
     def OperateChannelTemplate(self, request):
-        """此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。
-
-        > **使用场景**
-        >
-        >  1：查询 OperateType=SELECT
-        > - 查询第三方应用平台模板库的可见性以及授权的子客列表。
-        >
-        >  2：修改部分子客授权 OperateType=UPDATE
-        > - 对子客企业进行模板库中模板可见性的进行修改操作。
-        >- 当模板未发布时，可以修改可见性AuthTag（part/all），当模板发布后，不可做此修改
-        > - 若模板已发布且可见性AuthTag是part，可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板，增加授权范围后会自动下发。
-        >
-        >  3：取消部分子客授权 OperateType=DELETE
-        > - 对子客企业进行模板库中模板可见性的进行删除操作。
-        > - 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
-        > - 对于自动领取的模板，由于已经下发，更改授权不会影响。
-        > - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
+        """此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。
+        平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/7f2b6c94164b3e931efc9a037e0400f7.png)
+
+        # 支持的操作
+
+        ## 1. 查询模板的子客企业授权 (OperateType=SELECT)
+        - 查询模板的授权子企业列表
+
+        ## 2. 修改模板的子客企业授权 (OperateType=UPDATE)
+        - 当模板未发布时，可以修改模板的模板授权范围是**所有第三方应用合作企业**(AuthTag设置为all)或者**指定第三方应用合作企业**(AuthTag设置为part)，**当模板发布后，不可做此修改**
+        - 如果模板是部分授权,  可通过ProxyOrganizationOpenIds增加子客的授权范围。
+
+        ## 3. 取消模板的子客企业授权 (OperateType=DELETE)
+        - 对子客企业进行模板库中模板授权范围的进行删除操作。
+        - 主要对于手动领取的模板，去除授权后子客在模板库中看不到，就无法再领取了。但是**已经领取过成为自有模板的不会同步删除**。
+        - 对于自动领取的模板，由于已经下发，更改授权不会影响。
+        - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
 
         :param request: Request instance for OperateChannelTemplate.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.OperateChannelTemplateRequest`
@@ -2080,7 +2081,7 @@ class EssbasicClient(AbstractClient):
 
         - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
 
-        ![image](https://dyn.ess.tencent.cn/guide/capi/channel_SyncProxyOrganizationOperators.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
 
         **注**:
         -  新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理

tencentcloud/essbasic/v20210526/models.py

@@ -1076,7 +1076,7 @@ class ChannelBatchCancelFlowsRequest(AbstractModel):
 
 注: `CancelMessage为撤销当前合同的理由`
 
-![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
+![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
 
 
         :type CancelMessageFormat: int
@@ -1872,9 +1872,10 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
         :type SignatureTypes: list of int
         :param _ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
 <ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
+<li>**2**：密码认证(默认)，需校验成功后才能签署合同</li>
 <li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
 注：
-<ul><li>默认情况下，认证校验方式为人脸认证</li>
+<ul><li>默认情况下，认证校验方式为人脸和密码认证</li>
 <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
         :type ApproverSignTypes: list of int
         """
@@ -7623,21 +7624,23 @@ class ChannelModifyRoleResponse(AbstractModel):
 
 
 class ChannelRole(AbstractModel):
-    """渠道角色信息
+    """角色信息
 
     """
 
     def __init__(self):
         r"""
-        :param _RoleId: 角色id
+        :param _RoleId: 角色ID,为32位字符串
 注意：此字段可能返回 null，表示取不到有效值。
         :type RoleId: str
-        :param _RoleName: 角色名
+        :param _RoleName: 角色的名称
 注意：此字段可能返回 null，表示取不到有效值。
         :type RoleName: str
-        :param _RoleStatus: 角色状态：1-启用；2-禁用
+        :param _RoleStatus: 此角色状态
+1: 已经启用
+2: 已经禁用
         :type RoleStatus: int
-        :param _PermissionGroups: 权限树
+        :param _PermissionGroups: 此角色对应的权限列表
 注意：此字段可能返回 null，表示取不到有效值。
         :type PermissionGroups: list of PermissionGroup
         """
@@ -9444,9 +9447,9 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
 
 此接口下面信息必填。
 <ul>
-<li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
-<li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
-<li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+<li>渠道应用标识:  Agent.AppId</li>
+<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
 </ul>
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
         :param _FlowInfos: 要创建的合同信息列表，最多支持一次创建20个合同
@@ -10934,7 +10937,7 @@ class DescribeTemplatesRequest(AbstractModel):
 
 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
         :type TemplateId: str
-        :param _ContentType: 查询模版的内容
+        :param _ContentType: 查询模板的内容
 
 <ul><li>**0**：（默认）模板列表及详情</li>
 <li>**1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
@@ -12148,7 +12151,7 @@ class FlowApproverInfo(AbstractModel):
 <ul><li> **PERSON** :个人/自然人</li>
 <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署，适用于个人自动签场景</li>
 <li> **ORGANIZATION** :企业/企业员工（企业签署方或模板发起时的企业静默签）</li>
-<li> **ENTERPRISESERVER** :企业/企业员自动签（他方企业自动签署或文件发起时的本方企业自动签）</li></ul>
+<li> **ENTERPRISESERVER** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）</li></ul>
 
 注:  
 `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
@@ -14123,32 +14126,35 @@ class OperateChannelTemplateRequest(AbstractModel):
 <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
 </ul>
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
-        :param _OperateType: 操作类型，
+        :param _OperateType: 操作类型，可取值如下:
 <ul>
-<li>查询:"SELECT"</li>
-<li>删除:"DELETE"</li>
-<li>更新:"UPDATE"</li>
+<li>SELECT:  查询</li>
+<li>DELETE:  删除</li>
+<li>UPDATE: 更新</li>
 </ul>
         :type OperateType: str
-        :param _TemplateId: 合同模板ID，为32位字符串。此处为第三方应用平台模板库模板ID，非子客模板ID。
+        :param _TemplateId: 合同模板ID，为32位字符串。
+注: ` 此处为第三方应用平台模板库模板ID，非子客模板ID`
         :type TemplateId: str
-        :param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
-
-一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
+        :param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识，支持批量(用,分割)，
         :type ProxyOrganizationOpenIds: str
-        :param _AuthTag: 模板可见性, 
-<ul>
-<li>全部可见-"all"</li>
-<li>部分可见-"part"</li>
-</ul>
+        :param _AuthTag: 模板可见范围, 可以设置的值如下:
+
+**all**: 所有本第三方应用合作企业可见
+**part**: 指定的本第三方应用合作企业
+
+对应控制台的位置
+![image](https://qcloudimg.tencent-cloud.cn/raw/68b97812c68d6af77a5991e3bff5c790.png)
+
         :type AuthTag: str
         :param _Available: 当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。
 <ul>
-<li>若此字段值为0，则不会修改模板Available</li>
-<li>1为启用模板</li>
-<li>2为停用模板</li>
+<li>0: 不修改模板可用状态</li>
+<li>1:  启用模板</li>
+<li>2: 停用模板</li>
 </ul>
 启用后模板可以正常领取。
+
 停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
 如果Available更新失败，会直接返回错误。
         :type Available: int
@@ -14253,30 +14259,26 @@ class OperateChannelTemplateResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _AppId: 腾讯电子签颁发给第三方应用平台的应用ID
+        :param _AppId: 第三方应用平台的应用ID
 注意：此字段可能返回 null，表示取不到有效值。
         :type AppId: str
-        :param _TemplateId: 合同模板ID，为32位字符串。此处为第三方应用平台模板库模板ID，非子客模板ID。
+        :param _TemplateId: 合同模板ID
 注意：此字段可能返回 null，表示取不到有效值。
         :type TemplateId: str
-        :param _OperateResult: 描述模板可见性更改的结果，和参数中Available无关。
+        :param _OperateResult: 描述模板可见性更改的结果。
 <ul>
-<li>全部成功-"all-success"</li>
-<li>部分成功-"part-success"</li>
-<li>全部失败-"fail"，失败的会在FailMessageList中展示</li>
+<li>all-success: 全部成功</li>
+<li>part-success: 部分成功,失败的会在FailMessageList中展示</li>
+<li>fail:全部失败, 失败的会在FailMessageList中展示</li>
 </ul>
 注意：此字段可能返回 null，表示取不到有效值。
         :type OperateResult: str
-        :param _AuthTag: 模板可见性, 
-<ul>
-<li>全部可见-"all"</li>
-<li>部分可见-"part"</li>
-</ul>
+        :param _AuthTag: 模板可见范围:
+**all**: 所有本第三方应用合作企业可见
+**part**: 指定的本第三方应用合作企业
 注意：此字段可能返回 null，表示取不到有效值。
         :type AuthTag: str
-        :param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识，长度不能超过64，只能由字母和数字组成。开发者可自定义此字段的值，并需要保存此 ID 以便进行后续操作。
-
-一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的，不可更改，不可重复使用。例如，可以使用企业名称的哈希值，或者社会统一信用代码的哈希值，或者随机哈希值。
+        :param _ProxyOrganizationOpenIds: 第三方平台子客企业标识列表
 注意：此字段可能返回 null，表示取不到有效值。
         :type ProxyOrganizationOpenIds: list of str
         :param _FailMessageList: 操作失败信息数组

{tencentcloud_sdk_python_essbasic-3.0.1027.dist-info → tencentcloud_sdk_python_essbasic-3.0.1031.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1027
+Version: 3.0.1031
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common (==3.0.1027)
+Requires-Dist: tencentcloud-sdk-python-common (==3.0.1031)
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_essbasic-3.0.1027.dist-info → tencentcloud_sdk_python_essbasic-3.0.1031.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tencentcloud/__init__.py,sha256=7p9ZoFHBfT2R0O4mxlx5Pc9Rn1afl5a5q5uPLxnUGLk,631
+tencentcloud/__init__.py,sha256=SVB4MrTJskNSkJvYY9txEgWmBTECDS04I-Km-Q5s5us,631
 tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/errorcodes.py,sha256=cZPs0vLmArRFQoZqxM4alb0WeBF9f0V0IHmt65dUdxs,5392
@@ -6,9 +6,9 @@ tencentcloud/essbasic/v20201222/essbasic_client.py,sha256=kua9joup-BLKbyITYpVovM
 tencentcloud/essbasic/v20201222/models.py,sha256=Q2E6jmVT1emRziwRN-qj8XpdzpxvqqHTKOEQz8JaM_s,270905
 tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20210526/errorcodes.py,sha256=L7u1uH1UVbsjd_f2RTdpmzKFDQJN-lfFZUyKhBDluxQ,18083
-tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=5U4BbJai3WC962_eUnL5tGQFEkzGWOQPQUt1lUtb0rw,108082
-tencentcloud/essbasic/v20210526/models.py,sha256=F9nlHYjFzaV3oDsMXMcQcPJKBLHNdA05jy0ee_GC5Qo,594760
-tencentcloud_sdk_python_essbasic-3.0.1027.dist-info/METADATA,sha256=5GB74Qo_ohCaNiYXQJrxnYzg-oao7dgSQQEYOxhbmFs,1517
-tencentcloud_sdk_python_essbasic-3.0.1027.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-tencentcloud_sdk_python_essbasic-3.0.1027.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
-tencentcloud_sdk_python_essbasic-3.0.1027.dist-info/RECORD,,
+tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=MCE7Ar4gRsnrEiKbb-Ohf_4AoXBYop9ZfkpKN5XfkbA,108438
+tencentcloud/essbasic/v20210526/models.py,sha256=GWqdfTehW4_oxK2B2gJgMPkKfHImlAQdIzWoVArKXyQ,594256
+tencentcloud_sdk_python_essbasic-3.0.1031.dist-info/METADATA,sha256=6SpenaVqumQCqbGnaVSw43GB1WJDZqIRqxmEbN-5gF4,1517
+tencentcloud_sdk_python_essbasic-3.0.1031.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+tencentcloud_sdk_python_essbasic-3.0.1031.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
+tencentcloud_sdk_python_essbasic-3.0.1031.dist-info/RECORD,,