tencentcloud-sdk-python 3.0.1061__py2.py3-none-any.whl → 3.0.1075__py2.py3-none-any.whl

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -91,9 +91,9 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelCancelMultiFlowSignQRCode(self, request):
-        """此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
-        该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
-        如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
+        """此接口（CancelMultiFlowSignQRCode）用于废除取消一码多签签署码。
+        该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+        如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。
 
         :param request: Request instance for ChannelCancelMultiFlowSignQRCode.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelMultiFlowSignQRCodeRequest`
@@ -207,7 +207,7 @@ class EssbasicClient(AbstractClient):
         注：
         - 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
         - 参与人点击链接后需短信验证码才能查看合同内容。
-        - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。若为子客企业，请确保员工已经加入企业。
+        - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。
         - 个人批量签署，签名区`仅支持手写签名`。
 
         :param request: Request instance for ChannelCreateBatchSignUrl.
@@ -653,10 +653,21 @@ class EssbasicClient(AbstractClient):
 
     def ChannelCreateFlowSignReview(self, request):
         """提交企业流程审批结果
-        目前存在两种审核操作，签署审核，发起审核
-        签署审核：通过接口（CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow）发起签署流程后，若指定了参数 NeedSignReview 为true,则可以调用此接口，指定operate=SignReview，提交企业内部签署审批结果；若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效
-
-        发起审核：通过接口ChannelCreatePrepareFlow指定发起后需要审核，则可以通过调用此接口，指定operate=CreateReview，提交企业内部审批结果，可多次提交，当通过后，后续提交结果无效
+        **当前存在两种审核操作：**
+        <ul>
+        <li>签署审核
+        <ul>
+        <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li><li>ChannelCreatePrepareFlow</li></ul> 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果</li>
+        <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li></ul>发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果</li>
+        </ul>
+        </li>
+        <li>发起审核
+         <ul>
+        <li>通过接口ChannelCreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
+        </li>
+        </ul>
+        </li>
+        </ul>
 
         :param request: Request instance for ChannelCreateFlowSignReview.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignReviewRequest`
@@ -710,7 +721,7 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelCreateMultiFlowSignQRCode(self, request):
-        """此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+        """此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多签签署码。
 
         **适用场景**:
         签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
@@ -720,11 +731,11 @@ class EssbasicClient(AbstractClient):
             - 模板中配置的签署顺序是无序
             - B端企业的签署方式是静默签署
             - B端企业是非首位签署
-        2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+        2. 通过扫描一码多签签署码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
         ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
-        3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
+        3. 用户通过扫描一码多签签署码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
 
-        二维码的样式如下图:
+        签署码的样式如下图:
         ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
 
         :param request: Request instance for ChannelCreateMultiFlowSignQRCode.
@@ -804,6 +815,41 @@ class EssbasicClient(AbstractClient):
         注意：
         1. 只支持PC浏览器操作使用
 
+        **嵌入式签署人-各种场景传参说明**:
+
+        <table>
+        <thead>
+        <tr>
+        <th>场景编号</th>
+        <th>可作为签署方的类型</th>
+        <th>签署方传参说明</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        <tr>
+        <td>场景一</td>
+        <td>第三方子企业A员工</td>
+        <td>OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
+        </tr>
+        <tr>
+        <td>场景二</td>
+        <td>第三方子企业B员工</td>
+        <td>OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION</td>
+        </tr>
+        <tr>
+        <td>场景三</td>
+        <td>SaaS平台企业员工</td>
+        <td>Name、Mobile、OrganizationName必传，NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
+        </tr>
+        <tr>
+        <td>场景四</td>
+        <td>个人/自然人</td>
+        <td>Name、Mobile必传, ApproverType设置为PERSON</td>
+        </tr>
+        </tbody>
+        </table>
+
         嵌入的页面样式如下：
         ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
 
@@ -1478,16 +1524,26 @@ class EssbasicClient(AbstractClient):
 
 
     def CreateChannelOrganizationInfoChangeUrl(self, request):
-        """此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接（需要在移动端打开，会跳转到微信小程序），支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType 指定。
+        """此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接。
+
+        <h3 id="1">支持变更链接类型，通过入参 Endpoint 指定，默认为WEIXINAPP。</h3>
+
+        <h4 id="WEIXINAPP">WEIXINAPP</h4>
+        <p>创建变更短链。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。</p>
 
+        <h4 id="APP">APP</h4>
+        <p>创建变更小程序链接，可从第三方App跳转到微信腾讯电子签小程序进行更换。</p>
 
-        <h3 id="1-企业超管变更">1. 企业超管变更</h3>
+
+        <h3 id="2">支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType 指定。</h3>
+
+        <h4 id="1-企业超管变更">1. 企业超管变更</h4>
 
         <p>换成企业的其他员工来当超管</p>
 
-        <h3 id="2-企业基础信息变更">2. 企业基础信息变更</h3>
+        <h4 id="2-企业基础信息变更">2. 企业基础信息变更</h4>
 
-        <h4 id="可以变动">可以变动</h4>
+        <h5 id="可以变动">可以变动</h5>
 
         <ul>
         <li>企业名称<br>
@@ -1497,7 +1553,7 @@ class EssbasicClient(AbstractClient):
         <li>企业地址和所在地</li>
         </ul>
 
-        <h4 id="不可变动">不可变动</h4>
+        <h5 id="不可变动">不可变动</h5>
 
         <ul>
         <li>统一社会信用代码<br>
@@ -1509,7 +1565,7 @@ class EssbasicClient(AbstractClient):
 
         <ul>
         <li>合同:   老合同不做任何处理,   新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>
-        <li>印章:   会删除所有的印章所有的机构公章和合同专用章,  然后用新企业名称生成新的机构公章 和合同专用章,  而法人章, 财务专用章和人事专用章不会处理</li>
+        <li>印章:   会删除所有的印章所有的机构公章，合同专用章，财务专用章和人事专用章,  然后用新企业名称生成新的机构公章，合同专用章，财务专用章和人事专用章,  而法人章不会处理</li>
         <li>证书:   企业证书会重新请求CA机构用新企业名称生成新的证书</li>
         </ul>
 
@@ -1548,6 +1604,7 @@ class EssbasicClient(AbstractClient):
         <th>子客企业状态</th>
         <th>子客企业员工状态</th>
         <th>点击链接进入的流程</th>
+        <th>视频样例</th>
         </tr>
         </thead>
         <tbody>
@@ -1555,16 +1612,19 @@ class EssbasicClient(AbstractClient):
         <td>企业未激活</td>
         <td>员工未认证</td>
         <td>进入企业激活流程，首次完成企业激活流程的员工会成为超管</td>
+        <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
         </tr>
         <tr>
         <td>企业已激活</td>
         <td>员工未认证</td>
         <td>进入员认证并加入企业流程</td>
+        <td>-</td>
         </tr>
         <tr>
         <td>企业已激活</td>
         <td>员工已认证</td>
         <td>进入子客企业Web控制台</td>
+        <td>-</td>
         </tr>
         </tbody>
         </table>
@@ -1596,6 +1656,34 @@ class EssbasicClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def CreateFlowGroupSignReview(self, request):
+        """1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时，若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
+          - [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
+          - [FlowFileInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowfileinfo)
+          - [FlowApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo)
+
+        2. 同一合同组，同一签署人可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
+
+        :param request: Request instance for CreateFlowGroupSignReview.
+        :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowGroupSignReviewRequest`
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowGroupSignReviewResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CreateFlowGroupSignReview", params, headers=headers)
+            response = json.loads(body)
+            model = models.CreateFlowGroupSignReviewResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def CreateFlowsByTemplates(self, request):
         """接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。
         如若在模板中配置了动态表格, 上传的附件必须为A4大小
@@ -1751,8 +1839,8 @@ class EssbasicClient(AbstractClient):
         |  WEIXINAPP  | 短链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）<br> 示例: https://essurl.cn/x9nvWU8fTg|
         |  LONGURL2WEIXINAPP  | 长链跳转腾讯电子签小程序签署场景  |  点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
         |  CHANNEL  | 带有H5引导页的跳转腾讯电子签小程序签署场景 |  点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景;  签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
-        |APP| 贵方App跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
-        |APP| 贵方小程序跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3  |
+        |APP| <font color="red">贵方APP</font>跳转腾讯电子签小程序签署场景|  贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
+        |APP| <font color="red">贵方小程序</font>跳转腾讯电子签小程序签署场景|  贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3  |
 
         :param request: Request instance for CreateSignUrls.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateSignUrlsRequest`
@@ -1937,14 +2025,20 @@ class EssbasicClient(AbstractClient):
 
     def DescribeExtendedServiceAuthInfo(self, request):
         """查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
-        1. 企业自动签
-        2. 企业与港澳台居民签署合同
-        3. 使用手机号验证签署方身份
-        4. 骑缝章
-        5. 拓宽签署方年龄限制
-        6. 下载企业合同/文件
 
-        注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
+        1. **企业自动签**
+        2. **企业与港澳台居民签署合同**
+        3. **使用手机号验证签署方身份**
+        4. **骑缝章**
+        5. **拓宽签署方年龄限制**
+        6. **下载企业合同/文件**
+        7. **隐藏合同经办人姓名**
+
+        对应能力开通页面在子客控制台-企业中心-拓展服务，如下图所示:
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/931a1e02955ab36e5cc69a489af10352.jpg)
+
+        注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
 
         :param request: Request instance for DescribeExtendedServiceAuthInfo.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeExtendedServiceAuthInfoRequest`
@@ -2134,28 +2228,21 @@ class EssbasicClient(AbstractClient):
 
 
     def ModifyExtendedService(self, request):
-        """修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。
+        """管理企业扩展服务 ，企业经办人需要是企业超管或者法人。
 
         跳转小程序的几种方式：主要是设置不同的EndPoint
         1. 通过链接Url直接跳转到小程序，不需要返回
         设置EndPoint为WEIXINAPP，得到链接打开即可。
 
         2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
-        跳转到小程序的实现，参考官方文档
-        https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
-        其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+        跳转到小程序的实现，参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
         设置EndPoint为APP，得到path。
 
-        4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
-        跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
-        全屏方式：
-        （https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
-        半屏方式：
-        （https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
-        其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+        3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
+        跳转到小程序的实现，参考官方文档（分为<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>
         设置EndPoint为APP，得到path。
 
-        其中小程序的原始Id如下，或者查看小程序信息自助获取。
+        4.其中小程序的原始Id如下，或者查看小程序信息自助获取。
 
         | 小程序 | AppID | 原始ID |
         | ------------ | ------------ | ------------ |