lib/v20201111/client.rb in tencentcloud-sdk-ess-3.0.659 vs lib/v20201111/client.rb in tencentcloud-sdk-ess-3.0.660
- old
+ new
@@ -216,12 +216,19 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # 本接口（CreateEmbedWebUrl）用于创建嵌入web的链接 本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
+ # 本接口（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)
@@ -269,17 +276,18 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # ### 适用场景
- # 在通过模板或者文件发起合同时，若未指定企业签署人信息，则流程发起后，可以调用此接口补充或签签署人。
- # 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
- # ### 限制条件
- # - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
- # - 他方企业仅支持通过姓名+手机号补充
+ # 适用场景：
+ # 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。
+ # 限制条件：
+ # 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)
@@ -385,13 +393,14 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # 此接口（CreateFlowGroupByTemplates）通过多模板创建合同组签署流程。<br/>
- # 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
+ # 此接口（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)
@@ -580,11 +589,11 @@
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)
@@ -674,11 +683,15 @@
# 个人用户认证证书图片样式如下图
# 
- # 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
+ # 注:
+ # <ul>
+ # <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
+ # <li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。 </li>
+ # </ul>
# @param request: Request instance for CreatePersonAuthCertificateImage.
# @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
# @rtype: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageResponse`
def CreatePersonAuthCertificateImage(request)
@@ -970,11 +983,11 @@
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)
@@ -1264,36 +1277,12 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # 集团企业统一使用主代子进行操作，无需根据子企业账号进行转化查询，该接口需要屏蔽下线
+ # 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
- # 通过子企业影子账号查询主企业员工账号
-
- # @param request: Request instance for DescribeIntegrationMainOrganizationUser.
- # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationMainOrganizationUserRequest`
- # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationMainOrganizationUserResponse`
- def DescribeIntegrationMainOrganizationUser(request)
- body = send_request('DescribeIntegrationMainOrganizationUser', request.serialize)
- response = JSON.parse(body)
- if response['Response'].key?('Error') == false
- model = DescribeIntegrationMainOrganizationUserResponse.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 DescribeIntegrationRoles.
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesRequest`
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesResponse`
def DescribeIntegrationRoles(request)
\ No newline at end of file