# frozen_string_literal: true # Copyright (c) 2017-2018 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. require 'json' module TencentCloud module Ess module V20201111 class Client < TencentCloud::Common::AbstractClient def initialize(credential, region, profile = nil) api_version = '2020-11-11' api_endpoint = 'ess.tencentcloudapi.com' sdk_version = 'ESS_' + File.read(File.expand_path('../VERSION', __dir__)).strip super(credential, region, api_version, api_endpoint, sdk_version, profile) end # 此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。 # 此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用 # @param request: Request instance for BindEmployeeUserIdWithClientOpenId. # @type request: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::BindEmployeeUserIdWithClientOpenIdResponse` def BindEmployeeUserIdWithClientOpenId(request) body = send_request('BindEmployeeUserIdWithClientOpenId', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = BindEmployeeUserIdWithClientOpenIdResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 用于撤销合同流程
# 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
# - **可撤回合同状态**：未全部签署完成 # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 # 注: # 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口。 # 2. 有对应合同撤销权限的人: 合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人 # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png) # 3. 撤销合同会返还合同额度 # @param request: Request instance for CancelFlow. # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CancelFlowResponse` def CancelFlow(request) body = send_request('CancelFlow', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CancelFlowResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CancelMultiFlowSignQRCode）用于废除一码多签签署码。 # 该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。 # 如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。 # @param request: Request instance for CancelMultiFlowSignQRCode. # @type request: :class:`Tencentcloud::ess::V20201111::CancelMultiFlowSignQRCodeRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CancelMultiFlowSignQRCodeResponse` def CancelMultiFlowSignQRCode(request) body = send_request('CancelMultiFlowSignQRCode', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CancelMultiFlowSignQRCodeResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。 # 注: # # @param request: Request instance for CancelUserAutoSignEnableUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlResponse` def CancelUserAutoSignEnableUrl(request) body = send_request('CancelUserAutoSignEnableUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CancelUserAutoSignEnableUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 指定需要批量撤回的签署流程Id，以获取批量撤销链接。 # 客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。 # 接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。 # - **可撤回合同状态**：未全部签署完成 # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 # 注： # 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口。 # 2. 有对应合同撤销权限的人: 合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人 # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png) # 3. 撤销合同会返还合同额度 # @param request: Request instance for CreateBatchCancelFlowUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlResponse` def CreateBatchCancelFlowUrl(request) body = send_request('CreateBatchCancelFlowUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateBatchCancelFlowUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。 # **注意：** # 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。 # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。 # 3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。 # 4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。 # 5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。 # 跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置。 # 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此App嵌入H5签署合同需要按照慧眼提供的慧眼人脸核身兼容性文档做兼容性适配。 # @param request: Request instance for CreateBatchQuickSignUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchQuickSignUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchQuickSignUrlResponse` def CreateBatchQuickSignUrl(request) body = send_request('CreateBatchQuickSignUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateBatchQuickSignUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。 # 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。 # 注： # - 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。 # - 参与人点击链接后需短信验证码才能查看合同内容。 # - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。 # - 个人批量签署，签名区`仅支持手写签名`。 # @param request: Request instance for CreateBatchSignUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchSignUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchSignUrlResponse` def CreateBatchSignUrl(request) body = send_request('CreateBatchSignUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateBatchSignUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。
# 前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。
# 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 # 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同
# 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。
# 注: # 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt` # 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果` # @param request: Request instance for CreateConvertTaskApi. # @type request: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiResponse` def CreateConvertTaskApi(request) body = send_request('CreateConvertTaskApi', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateConvertTaskApiResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 创建签署流程电子文档
# ### 调用流程 # 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图: # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png) # ### 填充模板中定义的填写控件 # 模板中配置的发起人填充控件可以通过本接口的**FormFields数组**字段填充 # ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png) # 填充的传参示例如下 # ``` # request.FormFields = [{ # "ComponentName": "项目的名字", # "ComponentValue": "休闲山庄" # }, { # "ComponentName": "项目的地址", # "ComponentValue": "凤凰山北侧", # }, { # "ComponentName": "范围", # "ComponentValue": "凤凰山至107国道", # }, { # "ComponentName": "面积", # "ComponentValue": "100亩", # }, { # "ComponentName": "基本情况", # "ComponentValue": "完好", # }, , { # "ComponentName": "用途", # "ComponentValue": "经营农家乐", # } # ] # ``` # 合成后合同样子示例 # ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png) # @param request: Request instance for CreateDocument. # @type request: :class:`Tencentcloud::ess::V20201111::CreateDocumentRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateDocumentResponse` def CreateDocument(request) body = send_request('CreateDocument', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateDocumentResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建： # 1. 创建印章 # 2. 创建模板 # 3. 修改模板 # 4. 预览模板 # 5. 预览合同流程 # 用户可以通过这些链接快速将其集成到自己的系统中。 # @param request: Request instance for CreateEmbedWebUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateEmbedWebUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateEmbedWebUrlResponse` def CreateEmbedWebUrl(request) body = send_request('CreateEmbedWebUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateEmbedWebUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。 # 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。 # 注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。 # @param request: Request instance for CreateExtendedServiceAuthInfos. # @type request: :class:`Tencentcloud::ess::V20201111::CreateExtendedServiceAuthInfosRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateExtendedServiceAuthInfosResponse` def CreateExtendedServiceAuthInfos(request) body = send_request('CreateExtendedServiceAuthInfos', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateExtendedServiceAuthInfosResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 通过模板创建签署流程
# 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。 # # # # # # # # # # # # # # # # # # # # # # # # # #
签署人类别需要提前准备的信息
自己企业的员工签署（未认证加入或已认证加入）签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）
自己企业的员工签署（已认证加入）签署企业的名字、员工在电子签平台的ID（UserId）
其他企业的员工签署签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）
个人（自然人）签署个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）
# 注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图 # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png) # 注：**静默（自动）签署不支持合同签署方存在填写**功能 #
# 相关视频指引
# 1. 创建静默（自动）签署模板和开通自动签署
# 2. 用模板创建发起合同
# @param request: Request instance for CreateFlow. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowResponse` def CreateFlow(request) body = send_request('CreateFlow', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 适用场景： # 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。 # 限制条件： # 1. 本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。 # 2. 本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。 # 3. 他方企业仅支持通过姓名+手机号进行补充。 # @param request: Request instance for CreateFlowApprovers. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowApproversRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowApproversResponse` def CreateFlowApprovers(request) body = send_request('CreateFlowApprovers', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowApproversResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
# 适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
# # # # # # # # # # # # # # # # # # # # # # # # # #
签署人类别需要提前准备的信息
自己企业的员工签署（未认证加入或已认证加入）签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）
自己企业的员工签署（已认证加入）签署企业的名字、员工在电子签平台的ID（UserId）
其他企业的员工签署签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）
个人（自然人）签署个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）
# 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）
# ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png) # 注： # - 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**） # - **静默（自动）签署不支持合同签署方存在填写**功能 # @param request: Request instance for CreateFlowByFiles. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesResponse` def CreateFlowByFiles(request) body = send_request('CreateFlowByFiles', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowByFilesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 提交申请出证报告任务并返回报告ID。 # 注意： # # CreateFlowEvidenceReport提交申请出证报告任务DescribeFlowEvidenceReport获取出证报告任务执行结果 # @param request: Request instance for CreateFlowEvidenceReport. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowEvidenceReportRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowEvidenceReportResponse` def CreateFlowEvidenceReport(request) body = send_request('CreateFlowEvidenceReport', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowEvidenceReportResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。 # 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。 # 注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。 # 注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度` # @param request: Request instance for CreateFlowGroupByFiles. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesResponse` def CreateFlowGroupByFiles(request) body = send_request('CreateFlowGroupByFiles', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowGroupByFilesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。 # 适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。 # 注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度` # @param request: Request instance for CreateFlowGroupByTemplates. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByTemplatesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByTemplatesResponse` def CreateFlowGroupByTemplates(request) body = send_request('CreateFlowGroupByTemplates', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowGroupByTemplatesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 提交合同组签署流程审批结果的适用场景包括： # 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时，若指定了以下参数 为true，则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。 # - [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo) # - [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo) # 2. 同一合同组，同一签署人可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。 # @param request: Request instance for CreateFlowGroupSignReview. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupSignReviewRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupSignReviewResponse` def CreateFlowGroupSignReview(request) body = send_request('CreateFlowGroupSignReview', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowGroupSignReviewResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： # 1. 发起合同时，**签署人的NotifyType需设置为sms** # 2. 合同中当前状态为 **待签署** 的签署人是催办的对象 # 3. **每个合同只能催办一次** # **催办的效果**: 对方会收到如下的短信通知 # ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png) # 注：`合同催办是白名单功能，请联系客户经理申请开白后使用` # @param request: Request instance for CreateFlowReminds. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRemindsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowRemindsResponse` def CreateFlowReminds(request) body = send_request('CreateFlowReminds', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowRemindsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 提交企业流程审批结果 # **当前存在两种审核操作：** # # @param request: Request instance for CreateFlowSignReview. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignReviewRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowSignReviewResponse` def CreateFlowSignReview(request) body = send_request('CreateFlowSignReview', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowSignReviewResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 该接口用于发起合同后，生成用户的签署链接
# **注意** # 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。 # 2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。 # 3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。 # 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置。 # 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此App嵌入H5签署合同需要按照慧眼提供的慧眼人脸核身兼容性文档做兼容性适配。 # @param request: Request instance for CreateFlowSignUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlResponse` def CreateFlowSignUrl(request) body = send_request('CreateFlowSignUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateFlowSignUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。 # @param request: Request instance for CreateIntegrationDepartment. # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationDepartmentRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateIntegrationDepartmentResponse` def CreateIntegrationDepartment(request) body = send_request('CreateIntegrationDepartment', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateIntegrationDepartmentResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateIntegrationEmployees）用于创建企业员工。 # 支持以下场景 # # # # # # # # # # # # # # # # # # # # # # # #
生成端入参提醒方式
普通saas员工将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号发送短信通知员工（短信中带有认证加入企业的链接）
企微员工将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内企微内部实名消息
H5端 saas员工传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工
# 注意： # - 若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。 # - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。 # @param request: Request instance for CreateIntegrationEmployees. # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationEmployeesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateIntegrationEmployeesResponse` def CreateIntegrationEmployees(request) body = send_request('CreateIntegrationEmployees', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateIntegrationEmployeesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。 # 适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。 # 适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 # 适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。 # 适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。 # 注意事项：SaaS角色和集团角色对应的权限树是不一样的。 # @param request: Request instance for CreateIntegrationRole. # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationRoleRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateIntegrationRoleResponse` def CreateIntegrationRole(request) body = send_request('CreateIntegrationRole', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateIntegrationRoleResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。 # @param request: Request instance for CreateIntegrationUserRoles. # @type request: :class:`Tencentcloud::ess::V20201111::CreateIntegrationUserRolesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateIntegrationUserRolesResponse` def CreateIntegrationUserRoles(request) body = send_request('CreateIntegrationUserRoles', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateIntegrationUserRolesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。 # **适用场景**: # 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。 # **注意**: # 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件 # - 模板中配置的签署顺序是无序 # - B端企业的签署方式是静默签署 # - B端企业是非首位签署 # 2. 通过一码多签签署码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调 # ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign) # 3. 用户通过一码多签签署码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/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 CreateMultiFlowSignQRCode. # @type request: :class:`Tencentcloud::ess::V20201111::CreateMultiFlowSignQRCodeRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateMultiFlowSignQRCodeResponse` def CreateMultiFlowSignQRCode(request) body = send_request('CreateMultiFlowSignQRCode', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateMultiFlowSignQRCodeResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
# 附注： # - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。 # - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。 # - 仅支持待签署状态的合同生成签署链接。 # @param request: Request instance for CreateOrganizationBatchSignUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateOrganizationBatchSignUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateOrganizationBatchSignUrlResponse` def CreateOrganizationBatchSignUrl(request) body = send_request('CreateOrganizationBatchSignUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateOrganizationBatchSignUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。 #

1. 企业超管变更

#

换成企业的其他员工来当超管

#

2. 企业基础信息变更

#

可以变动

# #

不可变动

# #

如果企业名称变动会引起下面的变动

# # @param request: Request instance for CreateOrganizationInfoChangeUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateOrganizationInfoChangeUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateOrganizationInfoChangeUrlResponse` def CreateOrganizationInfoChangeUrl(request) body = send_request('CreateOrganizationInfoChangeUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateOrganizationInfoChangeUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 获取个人用户认证证书图片下载URL # 个人用户认证证书图片样式如下图 # ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png) # 注: # # @param request: Request instance for CreatePersonAuthCertificateImage. # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageResponse` def CreatePersonAuthCertificateImage(request) body = send_request('CreatePersonAuthCertificateImage', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreatePersonAuthCertificateImageResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 创建发起流程web页面 #
适用场景：通过该接口（CreatePrepareFlow）传入合同文件/模板编号及签署人信息，可获得发起流程的可嵌入页面，在页面完成签署控件等信息的编辑与确认后，快速发起流程。 #
注：该接口包含模板/文件发起流程的全部功能，调用接口后不会立即发起，需在可嵌入页面点击按钮进行发起流程。 # @param request: Request instance for CreatePrepareFlow. # @type request: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowResponse` def CreatePrepareFlow(request) body = send_request('CreatePrepareFlow', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreatePrepareFlowResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。 # @param request: Request instance for CreatePreparedPersonalEsign. # @type request: :class:`Tencentcloud::ess::V20201111::CreatePreparedPersonalEsignRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreatePreparedPersonalEsignResponse` def CreatePreparedPersonalEsign(request) body = send_request('CreatePreparedPersonalEsign', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreatePreparedPersonalEsignResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。 # 解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。 # 注意： # # @param request: Request instance for CreateReleaseFlow. # @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowResponse` def CreateReleaseFlow(request) body = send_request('CreateReleaseFlow', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateReleaseFlowResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 获取跳转至腾讯电子签小程序的签署链接 # 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。 # 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置 # 注： # # 其中小程序的原始Id如下，或者查看小程序信息自助获取。 # | 小程序 | AppID | 原始ID | # | ------------ | ------------ | ------------ | # | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | # | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | # @param request: Request instance for CreateSchemeUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlResponse` def CreateSchemeUrl(request) body = send_request('CreateSchemeUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateSchemeUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。 # 1. 可以**通过图片**创建印章，图片最大5MB # 2. 可以**系统创建**创建印章, 系统创建的印章样子下图(样式可以调整) # ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage.png) # @param request: Request instance for CreateSeal. # @type request: :class:`Tencentcloud::ess::V20201111::CreateSealRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateSealResponse` def CreateSeal(request) body = send_request('CreateSeal', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateSealResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 本接口（CreateSealPolicy）用于对企业员工进行印章授权 # @param request: Request instance for CreateSealPolicy. # @type request: :class:`Tencentcloud::ess::V20201111::CreateSealPolicyRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateSealPolicyResponse` def CreateSealPolicy(request) body = send_request('CreateSealPolicy', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateSealPolicyResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 获取个人用户自动签的开通链接。 # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。` # @param request: Request instance for CreateUserAutoSignEnableUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateUserAutoSignEnableUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateUserAutoSignEnableUrlResponse` def CreateUserAutoSignEnableUrl(request) body = send_request('CreateUserAutoSignEnableUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateUserAutoSignEnableUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 获取设置自动签印章小程序链接。 # 注意： # # @param request: Request instance for CreateUserAutoSignSealUrl. # @type request: :class:`Tencentcloud::ess::V20201111::CreateUserAutoSignSealUrlRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateUserAutoSignSealUrlResponse` def CreateUserAutoSignSealUrl(request) body = send_request('CreateUserAutoSignSealUrl', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateUserAutoSignSealUrlResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。 # 如果多次调用，会以最后一次的配置为准 # @param request: Request instance for CreateWebThemeConfig. # @type request: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigResponse` def CreateWebThemeConfig(request) body = send_request('CreateWebThemeConfig', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateWebThemeConfigResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 删除企业扩展服务授权，当前仅支持 “企业自动签” 和“批量签署” 的取消授权。 # 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口取消企业员工授权。 # 注：支持集团代子企业操作，请联系运营开通此功能。 # @param request: Request instance for DeleteExtendedServiceAuthInfos. # @type request: :class:`Tencentcloud::ess::V20201111::DeleteExtendedServiceAuthInfosRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteExtendedServiceAuthInfosResponse` def DeleteExtendedServiceAuthInfos(request) body = send_request('DeleteExtendedServiceAuthInfos', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DeleteExtendedServiceAuthInfosResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。 # @param request: Request instance for DeleteIntegrationDepartment. # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationDepartmentRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationDepartmentResponse` def DeleteIntegrationDepartment(request) body = send_request('DeleteIntegrationDepartment', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DeleteIntegrationDepartmentResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 该接口（DeleteIntegrationEmployees）用于移除企业员工，同时可选择是否进行离职交接。 # - 如果不设置交接人的ReceiveUserId或ReceiveOpenId，则该员工将被直接移除而不进行交接操作。 # - 如果设置了ReceiveUserId或ReceiveOpenId，该员工未处理的合同将会被系统交接给设置的交接人，然后再对该员工进行离职操作。 # 注：`1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。` # @param request: Request instance for DeleteIntegrationEmployees. # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationEmployeesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationEmployeesResponse` def DeleteIntegrationEmployees(request) body = send_request('DeleteIntegrationEmployees', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DeleteIntegrationEmployeesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。 # @param request: Request instance for DeleteIntegrationRoleUsers. # @type request: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationRoleUsersRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteIntegrationRoleUsersResponse` def DeleteIntegrationRoleUsers(request) body = send_request('DeleteIntegrationRoleUsers', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DeleteIntegrationRoleUsersResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限 # @param request: Request instance for DeleteSealPolicies. # @type request: :class:`Tencentcloud::ess::V20201111::DeleteSealPoliciesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteSealPoliciesResponse` def DeleteSealPolicies(request) body = send_request('DeleteSealPolicies', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DeleteSealPoliciesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。 # @param request: Request instance for DescribeBillUsageDetail. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeBillUsageDetailRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeBillUsageDetailResponse` def DescribeBillUsageDetail(request) body = send_request('DescribeBillUsageDetail', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeBillUsageDetailResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 查询企业扩展服务的授权详情（列表），当前支持查询以下内容： # 1. 企业自动签（本企业授权、集团企业授权、合作企业授权） # 2. 批量签署能力 # 注: 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId) # @param request: Request instance for DescribeExtendedServiceAuthDetail. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthDetailRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthDetailResponse` def DescribeExtendedServiceAuthDetail(request) body = send_request('DescribeExtendedServiceAuthDetail', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeExtendedServiceAuthDetailResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 查询企业扩展服务的开通和授权情况，当前支持查询以下内容： # 1. **企业自动签署** # 2. **批量签署授权** # 3. **企业与港澳台居民签署合同** # 4. **拓宽签署方年龄限制** # 5. **个人签署方仅校验手机号** # 6. **隐藏合同经办人姓名** # 7. **正楷临摹签名失败后更换其他签名类型** # 8. **短信通知签署方** # 9. **个人签署方手动签字** # 10. **骑缝章** # 11. **签署密码开通引导** # 对应能力开通页面在Web控制台-更多-企业设置-拓展服务，如下图所示: # ![image](https://qcloudimg.tencent-cloud.cn/raw/7d79746ecca1c5fe878a2ec36ed69c23.jpg) # 注: 所在企业的超管、法人才有权限调用此接口(Operator.UserId需要传递超管或者法人的UserId) # @param request: Request instance for DescribeExtendedServiceAuthInfos. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthInfosRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthInfosResponse` def DescribeExtendedServiceAuthInfos(request) body = send_request('DescribeExtendedServiceAuthInfos', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeExtendedServiceAuthInfosResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 本接口（DescribeFileUrls）用于查询文件的下载URL。 # 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。 # @param request: Request instance for DescribeFileUrls. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsResponse` def DescribeFileUrls(request) body = send_request('DescribeFileUrls', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeFileUrlsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 查询流程基础信息 # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。 # 注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误` # @param request: Request instance for DescribeFlowBriefs. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsResponse` def DescribeFlowBriefs(request) body = send_request('DescribeFlowBriefs', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeFlowBriefsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 查询流程填写控件内容，可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。 # @param request: Request instance for DescribeFlowComponents. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsResponse` def DescribeFlowComponents(request) body = send_request('DescribeFlowComponents', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeFlowComponentsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 获取出证报告任务执行结果，返回报告 URL。 # 注意： # # CreateFlowEvidenceReport提交申请出证报告任务DescribeFlowEvidenceReport获取出证报告任务执行结果 # @param request: Request instance for DescribeFlowEvidenceReport. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportResponse` def DescribeFlowEvidenceReport(request) body = send_request('DescribeFlowEvidenceReport', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeFlowEvidenceReportResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。 # 适用场景：可用于主动查询某个合同详情信息。 # @param request: Request instance for DescribeFlowInfo. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowInfoRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowInfoResponse` def DescribeFlowInfo(request) body = send_request('DescribeFlowInfo', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeFlowInfoResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。 # **适用场景** # 该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。 # 通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。 # **一个模板通常会包含以下结构信息** # - 模板模板ID, 模板名字等基本信息 # - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方 # - 发起方和签署方的填写控件 Components # - 签署方的签署控件 SignComponents # ![image](https://qcloudimg.tencent-cloud.cn/raw/ab81fa948a0a6fea14f48cac91d0e36a/channel_DescribeTemplates.png) # 模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联) # ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png) # @param request: Request instance for DescribeFlowTemplates. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesResponse` def DescribeFlowTemplates(request) body = send_request('DescribeFlowTemplates', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeFlowTemplatesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。 # @param request: Request instance for DescribeIntegrationDepartments. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationDepartmentsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationDepartmentsResponse` def DescribeIntegrationDepartments(request) body = send_request('DescribeIntegrationDepartments', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeIntegrationDepartmentsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。 # @param request: Request instance for DescribeIntegrationEmployees. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationEmployeesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationEmployeesResponse` def DescribeIntegrationEmployees(request) body = send_request('DescribeIntegrationEmployees', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeIntegrationEmployeesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。 # @param request: Request instance for DescribeIntegrationRoles. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesResponse` def DescribeIntegrationRoles(request) body = send_request('DescribeIntegrationRoles', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeIntegrationRolesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此API接口用来查询加入集团的成员企业信息 # 适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计 # @param request: Request instance for DescribeOrganizationGroupOrganizations. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeOrganizationGroupOrganizationsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeOrganizationGroupOrganizationsResponse` def DescribeOrganizationGroupOrganizations(request) body = send_request('DescribeOrganizationGroupOrganizations', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeOrganizationGroupOrganizationsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 查询企业印章的列表，需要操作者具有查询印章权限 # 客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。 # @param request: Request instance for DescribeOrganizationSeals. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeOrganizationSealsRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeOrganizationSealsResponse` def DescribeOrganizationSeals(request) body = send_request('DescribeOrganizationSeals', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeOrganizationSealsResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（DescribePersonCertificate）用于查询个人数字证书信息。
注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`
`2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。` # @param request: Request instance for DescribePersonCertificate. # @type request: :class:`Tencentcloud::ess::V20201111::DescribePersonCertificateRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribePersonCertificateResponse` def DescribePersonCertificate(request) body = send_request('DescribePersonCertificate', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribePersonCertificateResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 通过AuthCode查询个人用户是否实名 # 注意: # # @param request: Request instance for DescribeThirdPartyAuthCode. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeThirdPartyAuthCodeRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeThirdPartyAuthCodeResponse` def DescribeThirdPartyAuthCode(request) body = send_request('DescribeThirdPartyAuthCode', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeThirdPartyAuthCodeResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 通过此接口获取个人用户自动签的开通状态。 # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。` # @param request: Request instance for DescribeUserAutoSignStatus. # @type request: :class:`Tencentcloud::ess::V20201111::DescribeUserAutoSignStatusRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeUserAutoSignStatusResponse` def DescribeUserAutoSignStatus(request) body = send_request('DescribeUserAutoSignStatus', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeUserAutoSignStatusResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 通过此接口可以关闭个人用户自动签功能。 # 无需对应的用户刷脸等方式同意即可关闭。 # 注意: # # @param request: Request instance for DisableUserAutoSign. # @type request: :class:`Tencentcloud::ess::V20201111::DisableUserAutoSignRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::DisableUserAutoSignResponse` def DisableUserAutoSign(request) body = send_request('DisableUserAutoSign', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DisableUserAutoSignResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（GetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作
# 前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。
# 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。
# 注： # 1. `大文件转换所需的时间可能会比较长` # @param request: Request instance for GetTaskResultApi. # @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiResponse` def GetTaskResultApi(request) body = send_request('GetTaskResultApi', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = GetTaskResultApiResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 新增/删除企业应用集成中的回调配置。 # 新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。 # 请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。 # 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2) # @param request: Request instance for ModifyApplicationCallbackInfo. # @type request: :class:`Tencentcloud::ess::V20201111::ModifyApplicationCallbackInfoRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::ModifyApplicationCallbackInfoResponse` def ModifyApplicationCallbackInfo(request) body = send_request('ModifyApplicationCallbackInfo', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = ModifyApplicationCallbackInfoResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 管理企业扩展服务 ，企业经办人需要是企业超管或者法人。 # 跳转小程序的几种方式：主要是设置不同的EndPoint # 1. 通过链接Url直接跳转到小程序，不需要返回 # 设置EndPoint为WEIXINAPP，得到链接打开即可。 # 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App # 跳转到小程序的实现，参考官方文档打开 App # 设置EndPoint为APP，得到path。 # 3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 # 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置 # 设置EndPoint为APP，得到path。 # 4.其中小程序的原始Id如下，或者查看小程序信息自助获取。 # | 小程序 | AppID | 原始ID | # | ------------ | ------------ | ------------ | # | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | # | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | # @param request: Request instance for ModifyExtendedService. # @type request: :class:`Tencentcloud::ess::V20201111::ModifyExtendedServiceRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::ModifyExtendedServiceResponse` def ModifyExtendedService(request) body = send_request('ModifyExtendedService', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = ModifyExtendedServiceResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度： # 1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。 # 2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。 # 此接口有如下限制条件： # 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。 # 2. 在延长整个签署流程时，签署流程应至少还有一方未签署（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态）。 # 3. 在延长整个签署流程时，新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。 # 4. 在延长签署方的截止时间时，签署方不能处于流程完结或已终止状态（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。 # 5. 在延长签署方的截止时间时，签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同，还应早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。 # 6. 不支持操作合同组合同。 # @param request: Request instance for ModifyFlowDeadline. # @type request: :class:`Tencentcloud::ess::V20201111::ModifyFlowDeadlineRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::ModifyFlowDeadlineResponse` def ModifyFlowDeadline(request) body = send_request('ModifyFlowDeadline', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = ModifyFlowDeadlineResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。 # @param request: Request instance for ModifyIntegrationDepartment. # @type request: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationDepartmentRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationDepartmentResponse` def ModifyIntegrationDepartment(request) body = send_request('ModifyIntegrationDepartment', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = ModifyIntegrationDepartmentResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。 # 适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。 # 适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 # 适用场景3：更新集团角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。 # 适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。 # 注意事项：SaaS角色和集团角色对应的权限树是不一样的。 # @param request: Request instance for ModifyIntegrationRole. # @type request: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationRoleRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::ModifyIntegrationRoleResponse` def ModifyIntegrationRole(request) body = send_request('ModifyIntegrationRole', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = ModifyIntegrationRoleResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口用于启动流程。它是模板发起合同的最后一步。 # 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。 # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png) # 注： # 1.合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度） # 2.静默（自动）签署不支持合同签署方存在填写功能 # 3.在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。 # @param request: Request instance for StartFlow. # @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::StartFlowResponse` def StartFlow(request) body = send_request('StartFlow', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = StartFlowResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。 # 注：`在调用此接口时，需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。` # @param request: Request instance for UnbindEmployeeUserIdWithClientOpenId. # @type request: :class:`Tencentcloud::ess::V20201111::UnbindEmployeeUserIdWithClientOpenIdRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::UnbindEmployeeUserIdWithClientOpenIdResponse` def UnbindEmployeeUserIdWithClientOpenId(request) body = send_request('UnbindEmployeeUserIdWithClientOpenId', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = UnbindEmployeeUserIdWithClientOpenIdResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。 # 修改手机号的时候,支持以下场景进行提醒通知 # # # # # # # # # # # # # # # # # # # # # # # #
生成端入参提醒方式
普通saas员工不需要传递 InvitationNotifyType短信
企微员工不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内企微内部实名消息
H5端 saas员工传递 InvitationNotifyType = H5，不支持企微生成H5链接
# 注意： # - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。 # @param request: Request instance for UpdateIntegrationEmployees. # @type request: :class:`Tencentcloud::ess::V20201111::UpdateIntegrationEmployeesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::UpdateIntegrationEmployeesResponse` def UpdateIntegrationEmployees(request) body = send_request('UpdateIntegrationEmployees', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = UpdateIntegrationEmployeesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 此接口（UploadFiles）文件上传。
# 适用场景：用于合同，印章的文件上传。文件上传以后， # 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 # 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 # 注: # 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下 # 2. 调用此接口时需要设置单独的Domain请求域名，联调开发环境为: file.test.ess.tencent.cn，正式环境需要设置为:file.ess.tencent.cn，代码示例 # ``` # HttpProfile httpProfile = new HttpProfile(); # httpProfile.setEndpoint("file.test.ess.tencent.cn"); # ``` # @param request: Request instance for UploadFiles. # @type request: :class:`Tencentcloud::ess::V20201111::UploadFilesRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::UploadFilesResponse` def UploadFiles(request) body = send_request('UploadFiles', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = UploadFilesResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end # 对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。 # @param request: Request instance for VerifyPdf. # @type request: :class:`Tencentcloud::ess::V20201111::VerifyPdfRequest` # @rtype: :class:`Tencentcloud::ess::V20201111::VerifyPdfResponse` def VerifyPdf(request) body = send_request('VerifyPdf', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = VerifyPdfResponse.new model.deserialize(response['Response']) model else code = response['Response']['Error']['Code'] message = response['Response']['Error']['Message'] reqid = response['Response']['RequestId'] raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid) end rescue TencentCloud::Common::TencentCloudSDKException => e raise e rescue StandardError => e raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect) end end end end end