# -*- coding: utf8 -*-
# Copyright (c) 2017-2021 THL A29 Limited, a Tencent company. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.common.abstract_client import AbstractClient
from tencentcloud.ess.v20201111 import models
class EssClient(AbstractClient):
_apiVersion = '2020-11-11'
_endpoint = 'ess.tencentcloudapi.com'
_service = 'ess'
def BindEmployeeUserIdWithClientOpenId(self, request):
"""将电子签系统员工userId与客户系统员工openId进行绑定
:param request: Request instance for BindEmployeeUserIdWithClientOpenId.
:type request: :class:`tencentcloud.ess.v20201111.models.BindEmployeeUserIdWithClientOpenIdRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.BindEmployeeUserIdWithClientOpenIdResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("BindEmployeeUserIdWithClientOpenId", params, headers=headers)
response = json.loads(body)
model = models.BindEmployeeUserIdWithClientOpenIdResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CancelFlow(self, request):
"""用于撤销签署流程
适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
:param request: Request instance for CancelFlow.
:type request: :class:`tencentcloud.ess.v20201111.models.CancelFlowRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CancelFlowResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CancelFlow", params, headers=headers)
response = json.loads(body)
model = models.CancelFlowResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CancelMultiFlowSignQRCode(self, request):
"""此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
:param request: Request instance for CancelMultiFlowSignQRCode.
:type request: :class:`tencentcloud.ess.v20201111.models.CancelMultiFlowSignQRCodeRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CancelMultiFlowSignQRCodeResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CancelMultiFlowSignQRCode", params, headers=headers)
response = json.loads(body)
model = models.CancelMultiFlowSignQRCodeResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateBatchCancelFlowUrl(self, request):
"""注：此接口建会废弃，请使用撤销单个签署流程（CancelFlow）接口。
指定需要批量撤回的签署流程Id，获取批量撤销链接。
客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
:param request: Request instance for CreateBatchCancelFlowUrl.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchCancelFlowUrlRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchCancelFlowUrlResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateBatchCancelFlowUrl", params, headers=headers)
response = json.loads(body)
model = models.CreateBatchCancelFlowUrlResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateConvertTaskApi(self, request):
"""上传了word、excel文件后，通过该接口发起文件转换任务，将word、excel文件转换为pdf文件。
:param request: Request instance for CreateConvertTaskApi.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateConvertTaskApiRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateConvertTaskApiResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateConvertTaskApi", params, headers=headers)
response = json.loads(body)
model = models.CreateConvertTaskApiResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateDocument(self, request):
"""创建签署流程电子文档
适用场景：见创建签署流程接口。
注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
:param request: Request instance for CreateDocument.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateDocumentRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateDocumentResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateDocument", params, headers=headers)
response = json.loads(body)
model = models.CreateDocumentResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlow(self, request):
"""创建签署流程
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
:param request: Request instance for CreateFlow.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlow", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlowApprovers(self, request):
"""补充签署流程本企业签署人信息
适用场景：在通过模板或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。
同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
:param request: Request instance for CreateFlowApprovers.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowApproversRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowApproversResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlowApprovers", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowApproversResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlowByFiles(self, request):
"""此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
:param request: Request instance for CreateFlowByFiles.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowByFilesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowByFilesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlowByFiles", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowByFilesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlowEvidenceReport(self, request):
"""创建出证报告，返回报告 ID。需要配合出证套餐才能调用。
出证需要一定时间，建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
:param request: Request instance for CreateFlowEvidenceReport.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowEvidenceReportRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowEvidenceReportResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlowEvidenceReport", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowEvidenceReportResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlowReminds(self, request):
"""指定需要批量催办的签署流程Id，批量催办合同，最多100个; 接口失败后返回错误信息
注意:
该接口不可直接调用，请联系客户经理申请使用
仅能催办当前状态为“待签署”的签署人，且只能催办一次
发起合同时，签署人的NotifyType需设置为sms，否则无法催办
:param request: Request instance for CreateFlowReminds.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowRemindsRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowRemindsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlowReminds", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowRemindsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlowSignReview(self, request):
"""提交企业签署流程审批结果
适用场景:
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true，且发起方企业作为签署方参与了流程签署，则可以调用此接口提交企业内部签署审批结果。
若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
:param request: Request instance for CreateFlowSignReview.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignReviewRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignReviewResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlowSignReview", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowSignReviewResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateFlowSignUrl(self, request):
"""创建集成页面签署链接，请联系客户经理申请使用
:param request: Request instance for CreateFlowSignUrl.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignUrlRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignUrlResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateFlowSignUrl", params, headers=headers)
response = json.loads(body)
model = models.CreateFlowSignUrlResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateIntegrationEmployees(self, request):
"""创建员工,如需在此接口提醒员工实名，入参Employees的OpenId不传
:param request: Request instance for CreateIntegrationEmployees.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationEmployeesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationEmployeesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateIntegrationEmployees", params, headers=headers)
response = json.loads(body)
model = models.CreateIntegrationEmployeesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateIntegrationUserRoles(self, request):
"""绑定员工与对应角色
:param request: Request instance for CreateIntegrationUserRoles.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationUserRolesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationUserRolesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateIntegrationUserRoles", params, headers=headers)
response = json.loads(body)
model = models.CreateIntegrationUserRolesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateMultiFlowSignQRCode(self, request):
"""此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
**本接口适用于发起方没有填写控件的 B2C或者单C模板**
**若是B2C模板,还要满足以下任意一个条件**
- 模板中配置的签署顺序是无序
- B端企业的签署方式是静默签署
- B端企业是非首位签署
:param request: Request instance for CreateMultiFlowSignQRCode.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateMultiFlowSignQRCodeRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateMultiFlowSignQRCodeResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateMultiFlowSignQRCode", params, headers=headers)
response = json.loads(body)
model = models.CreateMultiFlowSignQRCodeResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreatePrepareFlow(self, request):
"""创建快速发起流程
适用场景：用户通过API 合同文件及签署信息，并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认，快速发起合同.
注：该接口文件的resourceId 是通过上传文件之后获取的。
:param request: Request instance for CreatePrepareFlow.
:type request: :class:`tencentcloud.ess.v20201111.models.CreatePrepareFlowRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreatePrepareFlowResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreatePrepareFlow", params, headers=headers)
response = json.loads(body)
model = models.CreatePrepareFlowResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreatePreparedPersonalEsign(self, request):
"""本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，在开通个人自动签之后调用，使用此接口请与客户经理确认）。
:param request: Request instance for CreatePreparedPersonalEsign.
:type request: :class:`tencentcloud.ess.v20201111.models.CreatePreparedPersonalEsignRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreatePreparedPersonalEsignResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreatePreparedPersonalEsign", params, headers=headers)
response = json.loads(body)
model = models.CreatePreparedPersonalEsignResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateReleaseFlow(self, request):
"""发起解除协议，主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
:param request: Request instance for CreateReleaseFlow.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateReleaseFlow", params, headers=headers)
response = json.loads(body)
model = models.CreateReleaseFlowResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateSchemeUrl(self, request):
"""获取小程序签署链接
适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
如您需要自主配置小程序跳转链接，请参考: 跳转小程序链接配置说明
:param request: Request instance for CreateSchemeUrl.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateSchemeUrlRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateSchemeUrlResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateSchemeUrl", params, headers=headers)
response = json.loads(body)
model = models.CreateSchemeUrlResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateSealPolicy(self, request):
"""对企业员工进行印章授权
:param request: Request instance for CreateSealPolicy.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateSealPolicyRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateSealPolicyResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateSealPolicy", params, headers=headers)
response = json.loads(body)
model = models.CreateSealPolicyResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def CreateUserAutoSignEnableUrl(self, request):
"""企业方可以通过此接口获取个人用户开启自动签的跳转链接（处方单场景专用，使用此接口请与客户经理确认）
:param request: Request instance for CreateUserAutoSignEnableUrl.
:type request: :class:`tencentcloud.ess.v20201111.models.CreateUserAutoSignEnableUrlRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateUserAutoSignEnableUrlResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateUserAutoSignEnableUrl", params, headers=headers)
response = json.loads(body)
model = models.CreateUserAutoSignEnableUrlResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DeleteIntegrationEmployees(self, request):
"""移除员工
:param request: Request instance for DeleteIntegrationEmployees.
:type request: :class:`tencentcloud.ess.v20201111.models.DeleteIntegrationEmployeesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DeleteIntegrationEmployeesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteIntegrationEmployees", params, headers=headers)
response = json.loads(body)
model = models.DeleteIntegrationEmployeesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DeleteIntegrationRoleUsers(self, request):
"""解绑员工与对应角色关系
:param request: Request instance for DeleteIntegrationRoleUsers.
:type request: :class:`tencentcloud.ess.v20201111.models.DeleteIntegrationRoleUsersRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DeleteIntegrationRoleUsersResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteIntegrationRoleUsers", params, headers=headers)
response = json.loads(body)
model = models.DeleteIntegrationRoleUsersResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DeleteSealPolicies(self, request):
"""撤销员工持有的印章权限
:param request: Request instance for DeleteSealPolicies.
:type request: :class:`tencentcloud.ess.v20201111.models.DeleteSealPoliciesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DeleteSealPoliciesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteSealPolicies", params, headers=headers)
response = json.loads(body)
model = models.DeleteSealPoliciesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeFileUrls(self, request):
"""查询文件下载URL
适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
:param request: Request instance for DescribeFileUrls.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFileUrlsRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFileUrlsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeFileUrls", params, headers=headers)
response = json.loads(body)
model = models.DescribeFileUrlsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeFlowBriefs(self, request):
"""查询流程摘要
适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
日调用量默认10W
:param request: Request instance for DescribeFlowBriefs.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowBriefsRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFlowBriefsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeFlowBriefs", params, headers=headers)
response = json.loads(body)
model = models.DescribeFlowBriefsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeFlowEvidenceReport(self, request):
"""查询出证报告，返回报告 URL。
:param request: Request instance for DescribeFlowEvidenceReport.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowEvidenceReportRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFlowEvidenceReportResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeFlowEvidenceReport", params, headers=headers)
response = json.loads(body)
model = models.DescribeFlowEvidenceReportResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeFlowInfo(self, request):
"""查询合同详情
适用场景：可用于主动查询某个合同详情信息。
:param request: Request instance for DescribeFlowInfo.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowInfoRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFlowInfoResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeFlowInfo", params, headers=headers)
response = json.loads(body)
model = models.DescribeFlowInfoResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeFlowTemplates(self, request):
"""当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
:param request: Request instance for DescribeFlowTemplates.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowTemplatesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFlowTemplatesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeFlowTemplates", params, headers=headers)
response = json.loads(body)
model = models.DescribeFlowTemplatesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeIntegrationEmployees(self, request):
"""查询企业员工列表，每次返回的数据量最大为20
:param request: Request instance for DescribeIntegrationEmployees.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeIntegrationEmployeesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeIntegrationEmployeesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeIntegrationEmployees", params, headers=headers)
response = json.loads(body)
model = models.DescribeIntegrationEmployeesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeIntegrationMainOrganizationUser(self, request):
"""通过子企业影子账号查询主企业员工账号
:param request: Request instance for DescribeIntegrationMainOrganizationUser.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeIntegrationMainOrganizationUserRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeIntegrationMainOrganizationUserResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeIntegrationMainOrganizationUser", params, headers=headers)
response = json.loads(body)
model = models.DescribeIntegrationMainOrganizationUserResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeIntegrationRoles(self, request):
"""查询企业角色列表
:param request: Request instance for DescribeIntegrationRoles.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeIntegrationRolesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeIntegrationRolesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeIntegrationRoles", params, headers=headers)
response = json.loads(body)
model = models.DescribeIntegrationRolesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeOrganizationGroupOrganizations(self, request):
"""此API接口用户查询加入集团的成员企业
:param request: Request instance for DescribeOrganizationGroupOrganizations.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationGroupOrganizationsRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationGroupOrganizationsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeOrganizationGroupOrganizations", params, headers=headers)
response = json.loads(body)
model = models.DescribeOrganizationGroupOrganizationsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeOrganizationSeals(self, request):
"""查询企业印章的列表，需要操作者具有查询印章权限
客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
:param request: Request instance for DescribeOrganizationSeals.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationSealsRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationSealsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeOrganizationSeals", params, headers=headers)
response = json.loads(body)
model = models.DescribeOrganizationSealsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeThirdPartyAuthCode(self, request):
"""通过AuthCode查询用户是否实名
:param request: Request instance for DescribeThirdPartyAuthCode.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeThirdPartyAuthCodeRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeThirdPartyAuthCodeResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeThirdPartyAuthCode", params, headers=headers)
response = json.loads(body)
model = models.DescribeThirdPartyAuthCodeResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DescribeUserAutoSignStatus(self, request):
"""企业方可以通过此接口查询个人用户自动签开启状态。（处方单场景专用，使用此接口请与客户经理确认）
:param request: Request instance for DescribeUserAutoSignStatus.
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeUserAutoSignStatusRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeUserAutoSignStatusResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeUserAutoSignStatus", params, headers=headers)
response = json.loads(body)
model = models.DescribeUserAutoSignStatusResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def DisableUserAutoSign(self, request):
"""企业方可以通过此接口关闭个人的自动签功能（处方单场景专用，使用此接口请与客户经理确认）
:param request: Request instance for DisableUserAutoSign.
:type request: :class:`tencentcloud.ess.v20201111.models.DisableUserAutoSignRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.DisableUserAutoSignResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DisableUserAutoSign", params, headers=headers)
response = json.loads(body)
model = models.DisableUserAutoSignResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def GetTaskResultApi(self, request):
"""通过发起转换任务接口（CreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
:param request: Request instance for GetTaskResultApi.
:type request: :class:`tencentcloud.ess.v20201111.models.GetTaskResultApiRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.GetTaskResultApiResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("GetTaskResultApi", params, headers=headers)
response = json.loads(body)
model = models.GetTaskResultApiResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def ModifyApplicationCallbackInfo(self, request):
"""新增/删除应用callbackinfo
callbackinfo包含： 回调地址和签名key
操作：新增/删除
:param request: Request instance for ModifyApplicationCallbackInfo.
:type request: :class:`tencentcloud.ess.v20201111.models.ModifyApplicationCallbackInfoRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.ModifyApplicationCallbackInfoResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyApplicationCallbackInfo", params, headers=headers)
response = json.loads(body)
model = models.ModifyApplicationCallbackInfoResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def StartFlow(self, request):
"""此接口用于发起流程
适用场景：见创建签署流程接口。
注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
:param request: Request instance for StartFlow.
:type request: :class:`tencentcloud.ess.v20201111.models.StartFlowRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.StartFlowResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("StartFlow", params, headers=headers)
response = json.loads(body)
model = models.StartFlowResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def UnbindEmployeeUserIdWithClientOpenId(self, request):
"""将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
:param request: Request instance for UnbindEmployeeUserIdWithClientOpenId.
:type request: :class:`tencentcloud.ess.v20201111.models.UnbindEmployeeUserIdWithClientOpenIdRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.UnbindEmployeeUserIdWithClientOpenIdResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("UnbindEmployeeUserIdWithClientOpenId", params, headers=headers)
response = json.loads(body)
model = models.UnbindEmployeeUserIdWithClientOpenIdResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def UpdateIntegrationEmployees(self, request):
"""更新员工信息(姓名，手机号，邮件)，用户实名后无法更改姓名与手机号
:param request: Request instance for UpdateIntegrationEmployees.
:type request: :class:`tencentcloud.ess.v20201111.models.UpdateIntegrationEmployeesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.UpdateIntegrationEmployeesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("UpdateIntegrationEmployees", params, headers=headers)
response = json.loads(body)
model = models.UpdateIntegrationEmployeesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def UploadFiles(self, request):
"""此接口（UploadFiles）用于文件上传。
适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。
调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn，并设置参数Version/版本号为2020-12-22
:param request: Request instance for UploadFiles.
:type request: :class:`tencentcloud.ess.v20201111.models.UploadFilesRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.UploadFilesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("UploadFiles", params, headers=headers)
response = json.loads(body)
model = models.UploadFilesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)
def VerifyPdf(self, request):
"""对流程的合同文件进行验证，判断文件是否合法。
:param request: Request instance for VerifyPdf.
:type request: :class:`tencentcloud.ess.v20201111.models.VerifyPdfRequest`
:rtype: :class:`tencentcloud.ess.v20201111.models.VerifyPdfResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("VerifyPdf", params, headers=headers)
response = json.loads(body)
model = models.VerifyPdfResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(e.message, e.message)