tencentcloud-sdk-python 3.0.1202__py2.py3-none-any.whl → 3.0.1233__py2.py3-none-any.whl

tencentcloud/ess/v20201111/errorcodes.py

@@ -260,6 +260,9 @@ INVALIDPARAMETER_INVALIDVERIFYCHANNEL = 'InvalidParameter.InvalidVerifyChannel'
 # 不合法的跳转链接，请联系电子签客服添加链接白名单。
 INVALIDPARAMETER_JUMPURL = 'InvalidParameter.JumpUrl'
 
+# 关键字格式错误或者不存在。
+INVALIDPARAMETER_KEYWORD = 'InvalidParameter.Keyword'
+
 # Limit参数超出最大限制
 INVALIDPARAMETER_LIMIT = 'InvalidParameter.Limit'
 
@@ -386,6 +389,9 @@ MISSINGPARAMETER_FLOWID = 'MissingParameter.FlowId'
 # 未找到关键字配置信息，请检查控件传参，检查文件资源配置，并在修改后重试。
 MISSINGPARAMETER_KEYWORD = 'MissingParameter.KeyWord'
 
+# 参数缺失，企业名称和统一信用代码不能同时为空。
+MISSINGPARAMETER_ORGNAMEORUNIFORMSOCIALCREDITCODE = 'MissingParameter.OrgNameOrUniformSocialCreditCode'
+
 # 缺少机构ID参数。
 MISSINGPARAMETER_ORGANIZATIONID = 'MissingParameter.OrganizationId'
 

tencentcloud/ess/v20201111/ess_client.py

@@ -178,6 +178,64 @@ class EssClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def CreateBatchInitOrganizationUrl(self, request):
+        """支持企业进行批量初始化操作：
+
+        此接口存在以下限制：
+        1. 若批量操作中包含<font  color="red">加入集团企业</font>操作,则调用此接口的员工须有<font  color="red">集团企业管理权限</font>。
+        2. 批量操作的企业需要已经完成电子签的认证流程。
+        3. 通过此接口生成的链接在小程序端进行操作时，操作人需要是<font  color="red">所有企业的超管或法人</font>。
+        4. 批量操作的企业，需要是<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">通过平台方引导认证</a>的企业。
+        5. <font  color="red">操作链接过期时间默认为生成链接后7天。</font>
+
+        :param request: Request instance for CreateBatchInitOrganizationUrl.
+        :type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchInitOrganizationUrlRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchInitOrganizationUrlResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CreateBatchInitOrganizationUrl", params, headers=headers)
+            response = json.loads(body)
+            model = models.CreateBatchInitOrganizationUrlResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
+    def CreateBatchOrganizationAuthorizationUrl(self, request):
+        """此接口用于获取企业批量认证链接-单链接包含多条认证流。
+
+        前提条件：已调用 [CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经完成。
+
+        异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间。
+        此链接包含多条认证流程，使用该链接可以批量的对企业进行认证。
+
+        :param request: Request instance for CreateBatchOrganizationAuthorizationUrl.
+        :type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchOrganizationAuthorizationUrlRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchOrganizationAuthorizationUrlResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CreateBatchOrganizationAuthorizationUrl", params, headers=headers)
+            response = json.loads(body)
+            model = models.CreateBatchOrganizationAuthorizationUrlResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def CreateBatchOrganizationRegistrationTasks(self, request):
         """本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
         该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
@@ -258,7 +316,7 @@ class EssClient(AbstractClient):
         """通过此接口，可以创建小程序批量签署链接，个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。
 
         注意事项：
-        - 使用此接口生成链接，需要贵企业先开通 <font color="red">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。
+        - 使用此接口生成链接，需要贵企业先开通 <font color="red">个人签署方仅校验手机号 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。
         - 生成批量签署链接时，<font color="red">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。
         - 企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。<font color="red">该签署方企业必须已完成腾讯电子签企业认证</font>
         - 个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。个人批量签署进行的合同的签名区， 全部变成<font color="red">手写签名</font>（不管合同里边设置的签名限制）来进行。
@@ -410,11 +468,20 @@ class EssClient(AbstractClient):
 
 
     def CreateEmployeeQualificationSealQrCode(self, request):
-        """该接口用于获取个人授权执业章给企业的二维码，需要个人用户通过微信扫码。扫描后将跳转到腾讯电子签小程序，进入到授权执业章的流程。个人用户授权成功后，企业印章管理员需对印章进行审核，审核通过后，即可使用个人授权的执业章进行盖章操作。
+        """该接口用于获取个人授权执业章给企业的微信二维码，需要个人用户通过微信扫码。
+
+        扫描后将跳转到腾讯电子签小程序，进入到授权执业章的流程。
+
+        个人用户授权成功后，企业印章管理员需对印章进行审核，审核通过后，即可使用个人授权的执业章进行盖章操作。
+
 
         **注意**
         1. 该二维码**有效期为7天**，过期后将失效，可重新创建。
 
+        整体流程入下图
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/21b6b56dbc796c9d6f402d6ce6febb07.png)
+
         :param request: Request instance for CreateEmployeeQualificationSealQrCode.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateEmployeeQualificationSealQrCodeRequest`
         :rtype: :class:`tencentcloud.ess.v20201111.models.CreateEmployeeQualificationSealQrCodeResponse`
@@ -529,8 +596,11 @@ class EssClient(AbstractClient):
         当通过模板或文件发起合同时， 签署人不制定， 等合同发起后再指定 可以用下面2种方案
 
         <b><font color="red">1. 或签合同</font>: 若未指定企业签署人信息（只指定企业的名字），合同变成或签合同（个人签署方不支持或签合同）</b>。需调用此接口补充或添加签署人。或签签署人在控制台上的展示样式如下（会带有<b>或签</b>标识）：
+
         ![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b.png)
-        <b><font color="red">2. 动态签署人合同</font>: 若未指定具体签署人的信息，则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档  [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/) 。动态签署人在控制台上的展示样式如下：
+
+        <b><font color="red">2. 动态签署人合同</font>: 若未指定具体签署人的信息，则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档    [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/)    。动态签署人在控制台上的展示样式如下：
+
         ![image](https://qcloudimg.tencent-cloud.cn/raw/2729477978e020c3bbb4d2e767bb78eb.png)
 
         实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序，领取合同并签署。同一签署环节可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。
@@ -834,7 +904,7 @@ class EssClient(AbstractClient):
         <li>CreateFlowGroupByFiles</li>
         <li>CreatePrepareFlow</li>
         </ul>
-        发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果</li>
+        发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果（<font color="red">审核对象：本企业合同参与方的签署动作</font>）</li>
         <li>在通过接口
         <ul>
         <li>CreateFlowByFiles</li>
@@ -842,14 +912,23 @@ class EssClient(AbstractClient):
         <li>CreateFlowGroupByTemplates</li>
         <li>CreateFlowGroupByFiles</li>
         </ul>
-        发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果</li>
+        发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果（<font color="red">审核对象：本企业、合同企业、自然人合同参与方的签署动作</font>）</li>
         </ul>
         </li>
+
+        对应签署人在签署页面会看到下面的提示：
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/3bf065bf5afa6de862e80da316be1c53.png)
+
         <li>发起审核
          <ul>
-        <li>通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
+        <li>通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效（<font color="red">审核对象：本企业合同发起方的发起动作</font>）
         </li>
         </ul>
+
+        对应发起人在发起合同的最后环节会有<b>提交审批</b>的按钮：
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/cb4857b7b57302fdcbcf37dad31214a8.png)
+
         </li>
         </ul>
 
@@ -1021,13 +1100,15 @@ class EssClient(AbstractClient):
 
 
     def CreateIntegrationSubOrganizationActiveRecord(self, request):
-        """通过此接口，创建子企业激活记录，集团企业管理员可针对未激活的成员企业进行激活。
-        激活子企业时请保证子企业 lisence 充足。
+        """使用此接口，可创建子企业激活记录。<font color="red">集团企业管理员</font>可以针对尚未激活的成员企业进行激活操作。
+
+
         这个操作与页面端激活成员企业操作类似
         ![image](https://qcloudimg.tencent-cloud.cn/raw/c4e76fbac92e4ce451a03601c964793b.png)
 
-        p.s.
-        此接口只能用于激活，不能用于续期。
+        注意：
+        1. 此接口只能用于激活，**不能用于续期**。
+        2. 在激活子企业时，**请确保子企业的许可证数量充足**。
 
         :param request: Request instance for CreateIntegrationSubOrganizationActiveRecord.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationSubOrganizationActiveRecordRequest`
@@ -1143,10 +1224,22 @@ class EssClient(AbstractClient):
 
 
     def CreateOrganizationAuthUrl(self, request):
-        """本接口（CreateOrganizationAuthUrl）用于生成创建企业认证链接。
-        用于业务方系统自己生成认证链接进行跳转.而不用电子签自带的生成链接
+        """本接口（CreateOrganizationAuthUrl）的主要功能是生成合作企业的认证链接。
+
+        在生成链接的过程中，可以提供一部分已知信息，以便为对方进行认证流程提供便利。
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png)
+
+
+        - **企业统一社会信用代码**: 对应上图中的**1**
+        - **企业名称**: 对应上图中的**2**
+        - **企业法定代表人的名字**:对应上图中的**3**
+        - **企业详细住所**:对应上图中的**4**
+
+
+
 
-        注： **此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估**
+        <b>注</b>：此接口需要 <font  color="red"><b>购买单独的实名套餐包</b></font>方可调用，如有需求请联系对接人员评估
 
         :param request: Request instance for CreateOrganizationAuthUrl.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateOrganizationAuthUrlRequest`
@@ -1602,11 +1695,9 @@ class EssClient(AbstractClient):
 
 
     def CreateUserVerifyUrl(self, request):
-        """客户可以主动调用生成实名链接去做C端用户实名，会对实名的用户进行打标记为调用链接客户的用户
-        使用场景：
-        用户集成场景
-        使用限制：
-        此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估
+        """生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。
+
+        注： 调用此接口需要购买<font color="red"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。
 
         :param request: Request instance for CreateUserVerifyUrl.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateUserVerifyUrlRequest`
@@ -2003,7 +2094,7 @@ class EssClient(AbstractClient):
 
 
     def DescribeFlowComponents(self, request):
-        """查询流程填写控件内容，可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
+        """可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容，包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
 
         :param request: Request instance for DescribeFlowComponents.
         :type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowComponentsRequest`
@@ -2190,6 +2281,29 @@ class EssClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def DescribeOrganizationAuthStatus(self, request):
+        """查询企业认证状态- 仅通过[CreateOrganizationAuthUrl](https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl) 和[CreateBatchOrganizationRegistrationTasks](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)这两个接口进行引导认证的企业，调用方企业可以依据这个接口，查询认证状态。
+
+        :param request: Request instance for DescribeOrganizationAuthStatus.
+        :type request: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationAuthStatusRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationAuthStatusResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("DescribeOrganizationAuthStatus", params, headers=headers)
+            response = json.loads(body)
+            model = models.DescribeOrganizationAuthStatusResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def DescribeOrganizationGroupOrganizations(self, request):
         """此API接口用来查询加入集团的成员企业信息
         适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
@@ -2266,9 +2380,9 @@ class EssClient(AbstractClient):
     def DescribeSignFaceVideo(self, request):
         """该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
 
-        1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸图片。
-        2. 该接口**不支持小程序端**的签署人脸图片获取。
-        3. 请在**签署完成后的三天内**获取人脸图片，**过期后将无法获取**。
+        1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸视频。
+        2. 该接口**不支持小程序端**的签署人脸视频获取。
+        3. 请在**签署完成后的三天内**获取人脸视频，**过期后将无法获取**。
 
         **注意：该接口需要开通白名单，请联系客户经理开通后使用。**
 
@@ -2298,8 +2412,8 @@ class EssClient(AbstractClient):
 
         注意:
         <ul>
-        <li>此接口为合作引流场景使用，使用`有白名单限制`，使用前请联系对接的客户经理沟通。</li>
-        <li>`AuthCode 只能使用一次`，查询一次再次查询会返回错误</li>
+        <li>此接口为合作引流场景使用，使用<b>有白名单限制</b>，使用前请联系对接的客户经理沟通。</li>
+        <li><b>AuthCode 只能使用一次</b>，查询一次再次查询会返回错误</li>
         </ul>
 
         :param request: Request instance for DescribeThirdPartyAuthCode.
@@ -2766,6 +2880,10 @@ class EssClient(AbstractClient):
     def VerifyPdf(self, request):
         """对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
 
+
+        **补充**： 可以到控制台[合同验签](https://qian.tencent.com/verifySign)体验验签功能，界面如下
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/81c333ccb07f0c5fbaf840d9cee61333.png)
+
         :param request: Request instance for VerifyPdf.
         :type request: :class:`tencentcloud.ess.v20201111.models.VerifyPdfRequest`
         :rtype: :class:`tencentcloud.ess.v20201111.models.VerifyPdfResponse`