tencentcloud-sdk-python-essbasic 3.0.1024__py2.py3-none-any.whl → 3.0.1044__py2.py3-none-any.whl

tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1024'
+__version__ = '3.0.1044'

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -302,8 +302,13 @@ class EssbasicClient(AbstractClient):
 
     def ChannelCreateEmbedWebUrl(self, request):
         """本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接
-        本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接
-        进入web连接后与当前控制台操作保持一致
+
+        本接口下面功能的签署页面链接的生成
+        - 创建印章
+        - 创建模板
+        - 修改模板
+        - 预览模板
+        - 预览合同流程
 
         :param request: Request instance for ChannelCreateEmbedWebUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateEmbedWebUrlRequest`
@@ -364,7 +369,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>
@@ -778,11 +783,13 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelCreatePrepareFlow(self, request):
-        """创建预发起合同
-        通过此接口指定：合同，签署人，填写控件信息，生成预创建合同链接，点击后跳转到web页面完成合同创建并发起
-        可指定合同信息不可更改，签署人信息不可更改
-        合同发起后，填写及签署流程与现有操作流程一致
-        注意：目前仅支持模板发起
+        """通过此接口指定合同、签署人、填写控件等信息，生成嵌入式链接，此链接可以嵌入到其他网页或者直接打开，打开后进入发起页面。在此页面上，合同信息和签署人信息均不可更改。
+
+        注意：
+        1. 只支持PC浏览器操作使用
+
+        嵌入的页面样式如下：
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
 
         :param request: Request instance for ChannelCreatePrepareFlow.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreatePrepareFlowRequest`
@@ -965,7 +972,8 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelCreateUserRoles(self, request):
-        """通过此接口，绑定员工角色，支持以电子签userId、客户系统userId两种方式调用。
+        """使用此接口，用来绑定企业实名员工的角色，
+        支持以电子签userId、客户系统openId两种方式进行绑定。
 
         :param request: Request instance for ChannelCreateUserRoles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateUserRolesRequest`
@@ -1060,7 +1068,7 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelDeleteSealPolicies(self, request):
-        """删除指定印章下多个授权信息
+        """此接口（ChannelDeleteSealPolicies）用于删除已指定员工印章授权信息，删除员工的印章授权后，该员工使用印章进行盖章时，将需要提交印章授权申请且通过审核后才能使用该印章进行签署。
 
         :param request: Request instance for ChannelDeleteSealPolicies.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDeleteSealPoliciesRequest`
@@ -1168,8 +1176,11 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelDescribeOrganizationSeals(self, request):
-        """查询子客企业电子印章，需要操作者具有管理印章权限
-        客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数，只返回启用的印章。
+        """此接口（ChannelDescribeOrganizationSeals）查询子客企业电子印章。<br />
+        注:
+        1. `查询子客企业电子印章，需要操作者具有管理印章权限`
+        2. `客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理`
+        3. `此接口只能查询启用的印章`
 
         :param request: Request instance for ChannelDescribeOrganizationSeals.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeOrganizationSealsRequest`
@@ -1193,7 +1204,16 @@ class EssbasicClient(AbstractClient):
 
     def ChannelDescribeRoles(self, request):
         """分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
-        相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355
+
+
+        <font color="red">**系统默认角色**</font>说明可参考下表
+
+        | 角色名称| 建议授予对象 | 角色描述 |
+        | --- | --- | --- |
+        | **超级管理员** |电子签业务最高权限，可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限，只能设置一位超管。 |
+        | **业务管理员**|IT 系统负责人，可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
+        | **经办人**|企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
+        | **业务员**|销售员、采购员 等| 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
 
         :param request: Request instance for ChannelDescribeRoles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeRolesRequest`
@@ -1325,7 +1345,7 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelUpdateSealStatus(self, request):
-        """本接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态
+        """此接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态。
 
         :param request: Request instance for ChannelUpdateSealStatus.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelUpdateSealStatusRequest`
@@ -1380,7 +1400,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`
@@ -1438,6 +1458,11 @@ class EssbasicClient(AbstractClient):
         <li>证书:   企业证书会重新请求CA机构用新企业名称生成新的证书</li>
         </ul>
 
+
+        注意：
+        1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作， 其他员工打开后会提示“无权查看该内容”
+        2. 法人可以无需生成链接，直接在电子签小程序中更换本企业的超管
+
         :param request: Request instance for CreateChannelOrganizationInfoChangeUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlResponse`
@@ -1523,7 +1548,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>
@@ -1692,7 +1717,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`
@@ -1714,6 +1739,29 @@ class EssbasicClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def DescribeChannelSealPolicyWorkflowUrl(self, request):
+        """生成渠道子客用印申请审批小程序链接，链接类型（通过H5唤起小程序或通过APP跳转的方式查看）
+
+        :param request: Request instance for DescribeChannelSealPolicyWorkflowUrl.
+        :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeChannelSealPolicyWorkflowUrlRequest`
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeChannelSealPolicyWorkflowUrlResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("DescribeChannelSealPolicyWorkflowUrl", params, headers=headers)
+            response = json.loads(body)
+            model = models.DescribeChannelSealPolicyWorkflowUrlResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def DescribeExtendedServiceAuthInfo(self, request):
         """查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
         1. 企业自动签
@@ -1811,23 +1859,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)
 
@@ -1962,23 +2010,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`
@@ -2068,7 +2117,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), 此白名单需要咨询接入经理