lib/v20210526/client.rb in tencentcloud-sdk-essbasic-3.0.696 vs lib/v20210526/client.rb in tencentcloud-sdk-essbasic-3.0.697
- old
+ new
@@ -236,12 +236,30 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # 此接口（ChannelCreateBoundFlows）用于子客领取合同，经办人需要有相应的角色，合同不能重复领取。
+ # 此接口（ChannelCreateBoundFlows）用于子客企业领取未归属给员工的合同，将合同领取给当前员工，合同不能重复领取。
+
+ # **未归属合同发起方式**
+ # 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
+ # ```
+ # FlowApprovers: []*essbasic.FlowApproverInfo{
+ # {
+ # ApproverType: common.StringPtr("ORGANIZATION"),
+ # OrganizationOpenId: common.StringPtr("org_dianziqian"),
+ # OrganizationName: common.StringPtr("典子谦示例企业"),
+ # }
+ # },
+ # ```
+
+ # 可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
+ # 
+
+ # 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
+
# @param request: Request instance for ChannelCreateBoundFlows.
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBoundFlowsRequest`
# @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBoundFlowsResponse`
def ChannelCreateBoundFlows(request)
body = send_request('ChannelCreateBoundFlows', request.serialize)
@@ -598,11 +616,12 @@
# 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办
# 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
# 2. **每个合同只能催办一次**
- # **催办的效果**: 对方会受到如下的短信通知
+ # **催办的效果**: 对方会收到如下的短信通知
+
# 
# **注**：`合同催办是白名单功能，请联系客户经理申请开白后使用`
@@ -686,25 +705,25 @@
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
- # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
- # 常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
- # **本接口适用于发起方没有填写控件的 B2C或者单C模板**
+ # **适用场景**:
+ # 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
- # **若是B2C模板,还要满足以下任意一个条件**
-
- # - 模板中配置的签署顺序是无序
- # - B端企业的签署方式是静默签署
- # - B端企业是非首位签署
-
- # 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+ # **注意**:
+ # 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
+ # - 模板中配置的签署顺序是无序
+ # - B端企业的签署方式是静默签署
+ # - B端企业是非首位签署
+ # 2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
# ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
+ # 3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
- # 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
+ # 二维码的样式如下图:
+ # 
# @param request: Request instance for ChannelCreateMultiFlowSignQRCode.
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateMultiFlowSignQRCodeRequest`
# @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateMultiFlowSignQRCodeResponse`
def ChannelCreateMultiFlowSignQRCode(request)
@@ -1094,10 +1113,34 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
+ # 通过此接口（ChannelDescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
+
+ # @param request: Request instance for ChannelDescribeBillUsageDetail.
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeBillUsageDetailRequest`
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeBillUsageDetailResponse`
+ def ChannelDescribeBillUsageDetail(request)
+ body = send_request('ChannelDescribeBillUsageDetail', request.serialize)
+ response = JSON.parse(body)
+ if response['Response'].key?('Error') == false
+ model = ChannelDescribeBillUsageDetailResponse.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
+
# 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息，支持设置过滤条件以筛选员工查询结果。
# **注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
# @param request: Request instance for ChannelDescribeEmployees.
@@ -1120,12 +1163,26 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
+ # 用于获取合同中填写控件填写状态和填写的内容。
+ # **注意**: `附件控件不会出现在结果列表中`
+
+
+ # **授权**:
+ # 此接口需要授权, 有两种开通权限的途径
+
+ # **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
+ # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
+
+ # 
+
+ # **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
+ # 
+
# @param request: Request instance for ChannelDescribeFlowComponents.
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeFlowComponentsRequest`
# @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeFlowComponentsResponse`
def ChannelDescribeFlowComponents(request)
body = send_request('ChannelDescribeFlowComponents', request.serialize)
@@ -1821,10 +1878,11 @@
# - 签署方的签署控件 SignComponents
# 
# 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+
# 
# **注意**
@@ -1851,13 +1909,14 @@
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
- # 此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。
- # 注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
+ # 此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。
+ # 注: 此接口**每日限频50次**，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
+
# @param request: Request instance for DescribeUsage.
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeUsageRequest`
# @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeUsageResponse`
def DescribeUsage(request)
body = send_request('DescribeUsage', request.serialize)
@@ -1881,11 +1940,11 @@
# 此接口（GetDownloadFlowUrl）用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
# 
# 注:
# <ul>
- # <li>仅支持下载 **本企业** 下合同，链接会 **登录企业控制台** </li>
- # <li> **链接仅可使用一次**，不可重复使用</li>
+ # <li>仅支持下载 <b>本企业</b> 下合同，链接会 <b>登录企业控制台</b> </li>
+ # <li> <b>链接仅可使用一次</b>，不可重复使用</li>
# </ul>
# @param request: Request instance for GetDownloadFlowUrl.
# @type request: :class:`Tencentcloud::essbasic::V20210526::GetDownloadFlowUrlRequest`
# @rtype: :class:`Tencentcloud::essbasic::V20210526::GetDownloadFlowUrlResponse`
\ No newline at end of file