tencentcloud-sdk-ess 3.0.785 → 3.0.787
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +24 -0
- data/lib/v20201111/models.rb +111 -15
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 52b6b2d101c53120351bbd6ad3090760b361f9dc
|
4
|
+
data.tar.gz: 86eab18cb448642cb593ffd8fb22d8084c68d20c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6d8d8176ba5117ba89a3f0c224eb1d575fb4b14be1496c99b27af6b5eb9ec40ddefae864464df2de30a711957722496fd5692873f1ce304bbc5c081140b78512
|
7
|
+
data.tar.gz: d0d8f62174c8600da8aae8949cebae96a165f206fbe07be1b40804bec2b29d9e1ec2e748da042426f22ba5dcca3b0d606b2c0ef2aef7db865d3c8a9a63b4d3aa
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.787
|
data/lib/v20201111/client.rb
CHANGED
@@ -1522,6 +1522,30 @@ module TencentCloud
|
|
1522
1522
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1523
1523
|
end
|
1524
1524
|
|
1525
|
+
# 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
|
1526
|
+
|
1527
|
+
# @param request: Request instance for DescribeCancelFlowsTask.
|
1528
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeCancelFlowsTaskRequest`
|
1529
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeCancelFlowsTaskResponse`
|
1530
|
+
def DescribeCancelFlowsTask(request)
|
1531
|
+
body = send_request('DescribeCancelFlowsTask', request.serialize)
|
1532
|
+
response = JSON.parse(body)
|
1533
|
+
if response['Response'].key?('Error') == false
|
1534
|
+
model = DescribeCancelFlowsTaskResponse.new
|
1535
|
+
model.deserialize(response['Response'])
|
1536
|
+
model
|
1537
|
+
else
|
1538
|
+
code = response['Response']['Error']['Code']
|
1539
|
+
message = response['Response']['Error']['Message']
|
1540
|
+
reqid = response['Response']['RequestId']
|
1541
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
1542
|
+
end
|
1543
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
1544
|
+
raise e
|
1545
|
+
rescue StandardError => e
|
1546
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1547
|
+
end
|
1548
|
+
|
1525
1549
|
# 查询企业扩展服务的授权详情(列表),当前支持查询以下内容:
|
1526
1550
|
# 1. 企业自动签(本企业授权、集团企业授权、合作企业授权)
|
1527
1551
|
# 2. 批量签署能力
|
data/lib/v20201111/models.rb
CHANGED
@@ -764,6 +764,26 @@ module TencentCloud
|
|
764
764
|
end
|
765
765
|
end
|
766
766
|
|
767
|
+
# 撤销失败的流程信息
|
768
|
+
class CancelFailureFlow < TencentCloud::Common::AbstractModel
|
769
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
770
|
+
# @type FlowId: String
|
771
|
+
# @param Reason: 撤销失败原因
|
772
|
+
# @type Reason: String
|
773
|
+
|
774
|
+
attr_accessor :FlowId, :Reason
|
775
|
+
|
776
|
+
def initialize(flowid=nil, reason=nil)
|
777
|
+
@FlowId = flowid
|
778
|
+
@Reason = reason
|
779
|
+
end
|
780
|
+
|
781
|
+
def deserialize(params)
|
782
|
+
@FlowId = params['FlowId']
|
783
|
+
@Reason = params['Reason']
|
784
|
+
end
|
785
|
+
end
|
786
|
+
|
767
787
|
# CancelFlow请求参数结构体
|
768
788
|
class CancelFlowRequest < TencentCloud::Common::AbstractModel
|
769
789
|
# @param Operator: 执行本接口操作的员工信息。
|
@@ -3129,24 +3149,26 @@ module TencentCloud
|
|
3129
3149
|
# @param Agent: 代理企业和员工的信息。
|
3130
3150
|
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3131
3151
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3132
|
-
# @param InvitationNotifyType:
|
3133
|
-
|
3134
|
-
#
|
3135
|
-
# **SMS(默认)**:会通过短信或企业微信消息进行邀请。如果非企业微信场景,则是企业微信消息。其他场景则是短信通知,短信中包含链接,点击后进入微信小程序进行认证加入企业的逻辑。
|
3152
|
+
# @param InvitationNotifyType: 员工邀请方式
|
3153
|
+
# 可通过以下途径进行设置:
|
3154
|
+
# <ul><li>**SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。</li></ul>
|
3136
3155
|
# @type InvitationNotifyType: String
|
3137
3156
|
# @param JumpUrl: 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。
|
3138
3157
|
|
3139
3158
|
# 注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
|
3140
3159
|
# @type JumpUrl: String
|
3160
|
+
# @param Endpoint: 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月</li></ul>注意:InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型(InvitationNotifyType)</td><td>Endpoint</td></tr><tr><td>SMS(默认)</td><td>不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递,会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL</td></tr></tbody></table>
|
3161
|
+
# @type Endpoint: String
|
3141
3162
|
|
3142
|
-
attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl
|
3163
|
+
attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl, :Endpoint
|
3143
3164
|
|
3144
|
-
def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil)
|
3165
|
+
def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil, endpoint=nil)
|
3145
3166
|
@Operator = operator
|
3146
3167
|
@Employees = employees
|
3147
3168
|
@Agent = agent
|
3148
3169
|
@InvitationNotifyType = invitationnotifytype
|
3149
3170
|
@JumpUrl = jumpurl
|
3171
|
+
@Endpoint = endpoint
|
3150
3172
|
end
|
3151
3173
|
|
3152
3174
|
def deserialize(params)
|
@@ -3168,6 +3190,7 @@ module TencentCloud
|
|
3168
3190
|
end
|
3169
3191
|
@InvitationNotifyType = params['InvitationNotifyType']
|
3170
3192
|
@JumpUrl = params['JumpUrl']
|
3193
|
+
@Endpoint = params['Endpoint']
|
3171
3194
|
end
|
3172
3195
|
end
|
3173
3196
|
|
@@ -5169,6 +5192,80 @@ module TencentCloud
|
|
5169
5192
|
end
|
5170
5193
|
end
|
5171
5194
|
|
5195
|
+
# DescribeCancelFlowsTask请求参数结构体
|
5196
|
+
class DescribeCancelFlowsTaskRequest < TencentCloud::Common::AbstractModel
|
5197
|
+
# @param Operator: 执行本接口操作的员工信息。
|
5198
|
+
# <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
5199
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
5200
|
+
# @param TaskId: 批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
|
5201
|
+
# @type TaskId: String
|
5202
|
+
# @param Agent: 代理企业和员工的信息。
|
5203
|
+
# <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
5204
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
5205
|
+
|
5206
|
+
attr_accessor :Operator, :TaskId, :Agent
|
5207
|
+
|
5208
|
+
def initialize(operator=nil, taskid=nil, agent=nil)
|
5209
|
+
@Operator = operator
|
5210
|
+
@TaskId = taskid
|
5211
|
+
@Agent = agent
|
5212
|
+
end
|
5213
|
+
|
5214
|
+
def deserialize(params)
|
5215
|
+
unless params['Operator'].nil?
|
5216
|
+
@Operator = UserInfo.new
|
5217
|
+
@Operator.deserialize(params['Operator'])
|
5218
|
+
end
|
5219
|
+
@TaskId = params['TaskId']
|
5220
|
+
unless params['Agent'].nil?
|
5221
|
+
@Agent = Agent.new
|
5222
|
+
@Agent.deserialize(params['Agent'])
|
5223
|
+
end
|
5224
|
+
end
|
5225
|
+
end
|
5226
|
+
|
5227
|
+
# DescribeCancelFlowsTask返回参数结构体
|
5228
|
+
class DescribeCancelFlowsTaskResponse < TencentCloud::Common::AbstractModel
|
5229
|
+
# @param TaskId: 批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
|
5230
|
+
# @type TaskId: String
|
5231
|
+
# @param TaskStatus: 任务状态,需要关注的状态
|
5232
|
+
# <ul><li>**PROCESSING** - 任务执行中</li>
|
5233
|
+
# <li>**END** - 任务处理完成</li>
|
5234
|
+
# <li>**TIMEOUT** 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul>
|
5235
|
+
# @type TaskStatus: String
|
5236
|
+
# @param SuccessFlowIds: 批量撤销成功的签署流程编号
|
5237
|
+
# @type SuccessFlowIds: Array
|
5238
|
+
# @param FailureFlows: 批量撤销失败的签署流程信息
|
5239
|
+
# @type FailureFlows: Array
|
5240
|
+
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
5241
|
+
# @type RequestId: String
|
5242
|
+
|
5243
|
+
attr_accessor :TaskId, :TaskStatus, :SuccessFlowIds, :FailureFlows, :RequestId
|
5244
|
+
|
5245
|
+
def initialize(taskid=nil, taskstatus=nil, successflowids=nil, failureflows=nil, requestid=nil)
|
5246
|
+
@TaskId = taskid
|
5247
|
+
@TaskStatus = taskstatus
|
5248
|
+
@SuccessFlowIds = successflowids
|
5249
|
+
@FailureFlows = failureflows
|
5250
|
+
@RequestId = requestid
|
5251
|
+
end
|
5252
|
+
|
5253
|
+
def deserialize(params)
|
5254
|
+
@TaskId = params['TaskId']
|
5255
|
+
@TaskStatus = params['TaskStatus']
|
5256
|
+
@SuccessFlowIds = params['SuccessFlowIds']
|
5257
|
+
unless params['FailureFlows'].nil?
|
5258
|
+
@FailureFlows = []
|
5259
|
+
params['FailureFlows'].each do |i|
|
5260
|
+
cancelfailureflow_tmp = CancelFailureFlow.new
|
5261
|
+
cancelfailureflow_tmp.deserialize(i)
|
5262
|
+
@FailureFlows << cancelfailureflow_tmp
|
5263
|
+
end
|
5264
|
+
end
|
5265
|
+
@RequestId = params['RequestId']
|
5266
|
+
end
|
5267
|
+
end
|
5268
|
+
|
5172
5269
|
# DescribeExtendedServiceAuthDetail请求参数结构体
|
5173
5270
|
class DescribeExtendedServiceAuthDetailRequest < TencentCloud::Common::AbstractModel
|
5174
5271
|
# @param Operator: 执行本接口操作的员工信息。
|
@@ -10163,24 +10260,22 @@ module TencentCloud
|
|
10163
10260
|
# @param Agent: 代理企业和员工的信息。
|
10164
10261
|
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
10165
10262
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
10166
|
-
# @param InvitationNotifyType:
|
10167
|
-
|
10168
|
-
# **H5**:会生成H5的链接,点击链接进入H5的认证加入企业的逻辑。
|
10169
|
-
# **SMS(默认)**:会通过短信或企业微信消息进行邀请。如果非企业微信场景,则是企业微信消息。其他场景则是短信通知,短信中包含链接,点击后进入微信小程序进行认证加入企业的逻辑。
|
10263
|
+
# @param InvitationNotifyType: 员工邀请方式可通过以下途径进行设置:<ul><li>**SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。</li></ul>
|
10170
10264
|
# @type InvitationNotifyType: String
|
10171
|
-
# @param JumpUrl: 回跳地址,为认证成功后页面进行回跳的URL
|
10172
|
-
|
10173
|
-
# 注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
|
10265
|
+
# @param JumpUrl: 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
|
10174
10266
|
# @type JumpUrl: String
|
10267
|
+
# @param Endpoint: 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月</li></ul>注意:InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型(InvitationNotifyType)</td><td>Endpoint</td></tr><tr><td>SMS(默认)</td><td>不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递,会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL</td></tr></tbody></table>
|
10268
|
+
# @type Endpoint: String
|
10175
10269
|
|
10176
|
-
attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl
|
10270
|
+
attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl, :Endpoint
|
10177
10271
|
|
10178
|
-
def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil)
|
10272
|
+
def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil, endpoint=nil)
|
10179
10273
|
@Operator = operator
|
10180
10274
|
@Employees = employees
|
10181
10275
|
@Agent = agent
|
10182
10276
|
@InvitationNotifyType = invitationnotifytype
|
10183
10277
|
@JumpUrl = jumpurl
|
10278
|
+
@Endpoint = endpoint
|
10184
10279
|
end
|
10185
10280
|
|
10186
10281
|
def deserialize(params)
|
@@ -10202,6 +10297,7 @@ module TencentCloud
|
|
10202
10297
|
end
|
10203
10298
|
@InvitationNotifyType = params['InvitationNotifyType']
|
10204
10299
|
@JumpUrl = params['JumpUrl']
|
10300
|
+
@Endpoint = params['Endpoint']
|
10205
10301
|
end
|
10206
10302
|
end
|
10207
10303
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tencentcloud-sdk-ess
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.787
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-03-
|
11
|
+
date: 2024-03-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|