tencentcloud-sdk-python 3.0.1405__py2.py3-none-any.whl → 3.0.1407__py2.py3-none-any.whl

tencentcloud/ess/v20201111/models.py

@@ -1810,6 +1810,122 @@ class AutoSignConfig(AbstractModel):
         
 
 
+class BatchOrganizationRegistrationTasksDetails(AbstractModel):
+    """批量认证企业任务详情信息，其中包括 TaskId，状态信息等等。
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _TaskId: 生成注册链接的任务Id
+        :type TaskId: str
+        :param _Status: 批量创建企业任务的状态
+<ul>
+<li>Processing</li>
+<li>Create</li>
+<li>Submit</li>
+<li>Authorization</li>
+<li>Failed</li>
+</ul>
+
+各个状态所代表的含义如下表格所示：
+<table>
+<thead align="center" valign="center">
+<tr><th>任务状态名称</th><th>任务状态详情</th></tr>
+</thead>
+<tbody>
+<tr><th align="center" valign="center">Processing</th><th>企业认证任务处理中，用户调用了<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks">CreateBatchOrganizationRegistrationTasks</a>接口，但是任务还在处理中的状态</th></tr>
+<tr><th align="center" valign="center">Create</th><th>创建企业认证链接任务完成，可以调用生成任务链接接口</th></tr>
+<tr><th align="center" valign="center">Submit</th><th>企业认证任务已提交,到如下界面之后，会变为这个状态
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/acbcec8c7a71de14d9c041e3b8ca8b3f.png)</th></tr>
+<tr><th align="center" valign="center">Authorization</th><th>企业认证任务认证成功,点击下图下一步，进入到授权书上传或者法人认证，则会变为这个状态
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/c52448354871cffa729da8db4e3a6f18.png)</th></tr>
+<tr><th align="center" valign="center">Failed</th><th>企业认证任务失败</th></tr>
+</tbody>
+</table>
+        :type Status: str
+        :param _ErrorMessage: 如果任务失败,会返回错误信息
+        :type ErrorMessage: str
+        """
+        self._TaskId = None
+        self._Status = None
+        self._ErrorMessage = None
+
+    @property
+    def TaskId(self):
+        """生成注册链接的任务Id
+        :rtype: str
+        """
+        return self._TaskId
+
+    @TaskId.setter
+    def TaskId(self, TaskId):
+        self._TaskId = TaskId
+
+    @property
+    def Status(self):
+        """批量创建企业任务的状态
+<ul>
+<li>Processing</li>
+<li>Create</li>
+<li>Submit</li>
+<li>Authorization</li>
+<li>Failed</li>
+</ul>
+
+各个状态所代表的含义如下表格所示：
+<table>
+<thead align="center" valign="center">
+<tr><th>任务状态名称</th><th>任务状态详情</th></tr>
+</thead>
+<tbody>
+<tr><th align="center" valign="center">Processing</th><th>企业认证任务处理中，用户调用了<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks">CreateBatchOrganizationRegistrationTasks</a>接口，但是任务还在处理中的状态</th></tr>
+<tr><th align="center" valign="center">Create</th><th>创建企业认证链接任务完成，可以调用生成任务链接接口</th></tr>
+<tr><th align="center" valign="center">Submit</th><th>企业认证任务已提交,到如下界面之后，会变为这个状态
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/acbcec8c7a71de14d9c041e3b8ca8b3f.png)</th></tr>
+<tr><th align="center" valign="center">Authorization</th><th>企业认证任务认证成功,点击下图下一步，进入到授权书上传或者法人认证，则会变为这个状态
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/c52448354871cffa729da8db4e3a6f18.png)</th></tr>
+<tr><th align="center" valign="center">Failed</th><th>企业认证任务失败</th></tr>
+</tbody>
+</table>
+        :rtype: str
+        """
+        return self._Status
+
+    @Status.setter
+    def Status(self, Status):
+        self._Status = Status
+
+    @property
+    def ErrorMessage(self):
+        """如果任务失败,会返回错误信息
+        :rtype: str
+        """
+        return self._ErrorMessage
+
+    @ErrorMessage.setter
+    def ErrorMessage(self, ErrorMessage):
+        self._ErrorMessage = ErrorMessage
+
+
+    def _deserialize(self, params):
+        self._TaskId = params.get("TaskId")
+        self._Status = params.get("Status")
+        self._ErrorMessage = params.get("ErrorMessage")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class BillUsageDetail(AbstractModel):
     """用户计费使用情况详情
 
@@ -4526,11 +4642,22 @@ class CreateBatchOrganizationRegistrationTasksRequest(AbstractModel):
 <li>SHORT_H5：生成H5跳转短链</li>
 </ul>
         :type Endpoint: str
+        :param _BatchAuthMethod: 认证链接使用单链接还是多链接模式
+
+<ul>
+<li>0 - 多链接(默认)，指批量生成链接， 每一个企业会拥有一个认证链接，然后分别认证</li>
+<li>1 - 单链接 ， 指批量生成链接，然后会将多个链接聚合成一个链接，进行认证</li>
+</ul>
+
+p.s.
+请注意， 如果使用单链接的模式并且认证方式是授权书方式的时候，必须在接口中传递超管授权书。
+        :type BatchAuthMethod: int
         """
         self._Operator = None
         self._RegistrationOrganizations = None
         self._Agent = None
         self._Endpoint = None
+        self._BatchAuthMethod = None
 
     @property
     def Operator(self):
@@ -4587,6 +4714,25 @@ class CreateBatchOrganizationRegistrationTasksRequest(AbstractModel):
     def Endpoint(self, Endpoint):
         self._Endpoint = Endpoint
 
+    @property
+    def BatchAuthMethod(self):
+        """认证链接使用单链接还是多链接模式
+
+<ul>
+<li>0 - 多链接(默认)，指批量生成链接， 每一个企业会拥有一个认证链接，然后分别认证</li>
+<li>1 - 单链接 ， 指批量生成链接，然后会将多个链接聚合成一个链接，进行认证</li>
+</ul>
+
+p.s.
+请注意， 如果使用单链接的模式并且认证方式是授权书方式的时候，必须在接口中传递超管授权书。
+        :rtype: int
+        """
+        return self._BatchAuthMethod
+
+    @BatchAuthMethod.setter
+    def BatchAuthMethod(self, BatchAuthMethod):
+        self._BatchAuthMethod = BatchAuthMethod
+
 
     def _deserialize(self, params):
         if params.get("Operator") is not None:
@@ -4602,6 +4748,7 @@ class CreateBatchOrganizationRegistrationTasksRequest(AbstractModel):
             self._Agent = Agent()
             self._Agent._deserialize(params.get("Agent"))
         self._Endpoint = params.get("Endpoint")
+        self._BatchAuthMethod = params.get("BatchAuthMethod")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -11519,6 +11666,146 @@ class CreateLegalSealQrCodeResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class CreateModifyAdminAuthorizationUrlRequest(AbstractModel):
+    """CreateModifyAdminAuthorizationUrl请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Operator: 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _Agent: 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _AuthorizationId: 企业认证流Id，可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)得到
+        :type AuthorizationId: str
+        :param _Endpoint: 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**PC**： 跳转电子签web 端控制台的链接。</li></ul>
+        :type Endpoint: str
+        """
+        self._Operator = None
+        self._Agent = None
+        self._AuthorizationId = None
+        self._Endpoint = None
+
+    @property
+    def Operator(self):
+        """执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        """
+        return self._Operator
+
+    @Operator.setter
+    def Operator(self, Operator):
+        self._Operator = Operator
+
+    @property
+    def Agent(self):
+        """代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
+        """
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def AuthorizationId(self):
+        """企业认证流Id，可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)得到
+        :rtype: str
+        """
+        return self._AuthorizationId
+
+    @AuthorizationId.setter
+    def AuthorizationId(self, AuthorizationId):
+        self._AuthorizationId = AuthorizationId
+
+    @property
+    def Endpoint(self):
+        """要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**PC**： 跳转电子签web 端控制台的链接。</li></ul>
+        :rtype: str
+        """
+        return self._Endpoint
+
+    @Endpoint.setter
+    def Endpoint(self, Endpoint):
+        self._Endpoint = Endpoint
+
+
+    def _deserialize(self, params):
+        if params.get("Operator") is not None:
+            self._Operator = UserInfo()
+            self._Operator._deserialize(params.get("Operator"))
+        if params.get("Agent") is not None:
+            self._Agent = Agent()
+            self._Agent._deserialize(params.get("Agent"))
+        self._AuthorizationId = params.get("AuthorizationId")
+        self._Endpoint = params.get("Endpoint")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class CreateModifyAdminAuthorizationUrlResponse(AbstractModel):
+    """CreateModifyAdminAuthorizationUrl返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Url: 变更企业超管授权书链接。
+没有有效期限制。
+
+注意：
+此链接仅能由当时认证企业的认证人使用。
+        :type Url: str
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._Url = None
+        self._RequestId = None
+
+    @property
+    def Url(self):
+        """变更企业超管授权书链接。
+没有有效期限制。
+
+注意：
+此链接仅能由当时认证企业的认证人使用。
+        :rtype: str
+        """
+        return self._Url
+
+    @Url.setter
+    def Url(self, Url):
+        self._Url = Url
+
+    @property
+    def RequestId(self):
+        """唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :rtype: str
+        """
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._Url = params.get("Url")
+        self._RequestId = params.get("RequestId")
+
+
 class CreateMultiFlowSignQRCodeRequest(AbstractModel):
     """CreateMultiFlowSignQRCode请求参数结构体
 
@@ -18327,6 +18614,128 @@ class Department(AbstractModel):
         
 
 
+class DescribeBatchOrganizationRegistrationTasksRequest(AbstractModel):
+    """DescribeBatchOrganizationRegistrationTasks请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Operator: 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _Agent: 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _TaskIds: 企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls)可以得到。
+        :type TaskIds: list of str
+        """
+        self._Operator = None
+        self._Agent = None
+        self._TaskIds = None
+
+    @property
+    def Operator(self):
+        """执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        """
+        return self._Operator
+
+    @Operator.setter
+    def Operator(self, Operator):
+        self._Operator = Operator
+
+    @property
+    def Agent(self):
+        """代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
+        """
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def TaskIds(self):
+        """企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls)可以得到。
+        :rtype: list of str
+        """
+        return self._TaskIds
+
+    @TaskIds.setter
+    def TaskIds(self, TaskIds):
+        self._TaskIds = TaskIds
+
+
+    def _deserialize(self, params):
+        if params.get("Operator") is not None:
+            self._Operator = UserInfo()
+            self._Operator._deserialize(params.get("Operator"))
+        if params.get("Agent") is not None:
+            self._Agent = Agent()
+            self._Agent._deserialize(params.get("Agent"))
+        self._TaskIds = params.get("TaskIds")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class DescribeBatchOrganizationRegistrationTasksResponse(AbstractModel):
+    """DescribeBatchOrganizationRegistrationTasks返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Details: 企业批量任务状态明细
+        :type Details: list of BatchOrganizationRegistrationTasksDetails
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._Details = None
+        self._RequestId = None
+
+    @property
+    def Details(self):
+        """企业批量任务状态明细
+        :rtype: list of BatchOrganizationRegistrationTasksDetails
+        """
+        return self._Details
+
+    @Details.setter
+    def Details(self, Details):
+        self._Details = Details
+
+    @property
+    def RequestId(self):
+        """唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :rtype: str
+        """
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        if params.get("Details") is not None:
+            self._Details = []
+            for item in params.get("Details"):
+                obj = BatchOrganizationRegistrationTasksDetails()
+                obj._deserialize(item)
+                self._Details.append(obj)
+        self._RequestId = params.get("RequestId")
+
+
 class DescribeBatchOrganizationRegistrationUrlsRequest(AbstractModel):
     """DescribeBatchOrganizationRegistrationUrls请求参数结构体
 

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -1760,6 +1760,8 @@ class EssbasicClient(AbstractClient):
     def CreateChannelFlowEvidenceReport(self, request):
         """提交申请出证报告任务并返回报告ID。
 
+        出证报告的示例样式可以参考 [出征报告.PDF](https://qcloudimg.tencent-cloud.cn/raw/a55214fcddaebbd1582cc9c57cc6cf1b.pdf)
+
         注意：
         - 使用此功能**需搭配出证套餐**  ，使用前请联系对接的客户经理沟通。
         - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
@@ -2256,6 +2258,32 @@ class EssbasicClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def CreateModifyAdminAuthorizationUrl(self, request):
+        """本接口（CreateModifyAdminAuthorizationUrl）用于重新上传超管授权书。
+
+        注意:
+        1. 重新上传超管授权书，必须是审核失败的情况下才能重新上传,可以通过回调[!授权书审核结果回调](https://qian.tencent.com/developers/partner/callback_types_staffs#%E5%9B%9B-%E6%8E%88%E6%9D%83%E4%B9%A6%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)得到
+
+        :param request: Request instance for CreateModifyAdminAuthorizationUrl.
+        :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateModifyAdminAuthorizationUrlRequest`
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateModifyAdminAuthorizationUrlResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CreateModifyAdminAuthorizationUrl", params, headers=headers)
+            response = json.loads(body)
+            model = models.CreateModifyAdminAuthorizationUrlResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def CreateOrganizationAuthFile(self, request):
         """生成合成后的各类企业授权书，包括：
         - 企业认证超管授权书
@@ -2448,6 +2476,29 @@ class EssbasicClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def DescribeBatchOrganizationRegistrationTasks(self, request):
+        """本接口（DescribeBatchOrganizationRegistrationTasks）用于查询企业批量认证任务状态。
+
+        :param request: Request instance for DescribeBatchOrganizationRegistrationTasks.
+        :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeBatchOrganizationRegistrationTasksRequest`
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeBatchOrganizationRegistrationTasksResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("DescribeBatchOrganizationRegistrationTasks", params, headers=headers)
+            response = json.loads(body)
+            model = models.DescribeBatchOrganizationRegistrationTasksResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def DescribeBatchOrganizationRegistrationUrls(self, request):
         """此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>获取到任务ID，然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。
         ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
@@ -3007,7 +3058,9 @@ class EssbasicClient(AbstractClient):
 
 
     def PrepareFlows(self, request):
-        """该接口 (PrepareFlows) 用于创建待发起文件
+        """已经不再使用
+
+        该接口 (PrepareFlows) 用于创建待发起文件
         用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
         目前该接口只支持B2C，<font color='red'> **不建议使用**</font>。