tencentcloud-sdk-ess 1.0.266
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/VERSION +1 -0
- data/lib/tencentcloud-sdk-ess.rb +11 -0
- data/lib/v20201111/client.rb +252 -0
- data/lib/v20201111/models.rb +1023 -0
- metadata +66 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 25905bb1fd85dd53b379bbc6dfd461743027ff3b
|
4
|
+
data.tar.gz: 6a072117d0344323b6c0c4f20215c538253c34e6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 90be40287990634e79c0c969be8595e5dc8302107bff046f3bec5fab44ea39cbe49538eb6b546987579f97c185e90f1b4e07d25c645a86fa0de1d3953834a226
|
7
|
+
data.tar.gz: 5c98e3d252b2fa9a0596b621c4c727ba22f2151dc660bf0ec643c5953a35a26a5a9f0d1607361fd85dd82be0e21d2c995ab8a77e38dfc4e1750ecca88e14cc7c
|
data/lib/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.0.266
|
@@ -0,0 +1,252 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
require 'json'
|
18
|
+
|
19
|
+
module TencentCloud
|
20
|
+
module Ess
|
21
|
+
module V20201111
|
22
|
+
class Client < TencentCloud::Common::AbstractClient
|
23
|
+
|
24
|
+
def initialize(credential, region, profile = nil)
|
25
|
+
api_version = '2020-11-11'
|
26
|
+
api_endpoint = 'ess.tencentcloudapi.com'
|
27
|
+
sdk_version = 'ESS_' + File.read(File.expand_path('../VERSION', __dir__)).strip
|
28
|
+
super(credential, region, api_version, api_endpoint, sdk_version, profile)
|
29
|
+
end
|
30
|
+
|
31
|
+
|
32
|
+
# 用于撤销流程
|
33
|
+
|
34
|
+
# @param request: Request instance for CancelFlow.
|
35
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
|
36
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CancelFlowResponse`
|
37
|
+
def CancelFlow(request)
|
38
|
+
body = send_request('CancelFlow', request.serialize)
|
39
|
+
response = JSON.parse(body)
|
40
|
+
if response['Response'].key?('Error') == false
|
41
|
+
model = CancelFlowResponse.new
|
42
|
+
model.deserialize(response['Response'])
|
43
|
+
model
|
44
|
+
else
|
45
|
+
code = response['Response']['Error']['Code']
|
46
|
+
message = response['Response']['Error']['Message']
|
47
|
+
reqid = response['Response']['RequestId']
|
48
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
49
|
+
end
|
50
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
51
|
+
raise e
|
52
|
+
rescue StandardError => e
|
53
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
54
|
+
end
|
55
|
+
|
56
|
+
# 创建电子文档
|
57
|
+
|
58
|
+
# @param request: Request instance for CreateDocument.
|
59
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreateDocumentRequest`
|
60
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateDocumentResponse`
|
61
|
+
def CreateDocument(request)
|
62
|
+
body = send_request('CreateDocument', request.serialize)
|
63
|
+
response = JSON.parse(body)
|
64
|
+
if response['Response'].key?('Error') == false
|
65
|
+
model = CreateDocumentResponse.new
|
66
|
+
model.deserialize(response['Response'])
|
67
|
+
model
|
68
|
+
else
|
69
|
+
code = response['Response']['Error']['Code']
|
70
|
+
message = response['Response']['Error']['Message']
|
71
|
+
reqid = response['Response']['RequestId']
|
72
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
73
|
+
end
|
74
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
75
|
+
raise e
|
76
|
+
rescue StandardError => e
|
77
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
78
|
+
end
|
79
|
+
|
80
|
+
# 创建签署流程
|
81
|
+
|
82
|
+
# @param request: Request instance for CreateFlow.
|
83
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest`
|
84
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowResponse`
|
85
|
+
def CreateFlow(request)
|
86
|
+
body = send_request('CreateFlow', request.serialize)
|
87
|
+
response = JSON.parse(body)
|
88
|
+
if response['Response'].key?('Error') == false
|
89
|
+
model = CreateFlowResponse.new
|
90
|
+
model.deserialize(response['Response'])
|
91
|
+
model
|
92
|
+
else
|
93
|
+
code = response['Response']['Error']['Code']
|
94
|
+
message = response['Response']['Error']['Message']
|
95
|
+
reqid = response['Response']['RequestId']
|
96
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
97
|
+
end
|
98
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
99
|
+
raise e
|
100
|
+
rescue StandardError => e
|
101
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
102
|
+
end
|
103
|
+
|
104
|
+
# 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建流程。
|
105
|
+
|
106
|
+
# @param request: Request instance for CreateFlowByFiles.
|
107
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesRequest`
|
108
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesResponse`
|
109
|
+
def CreateFlowByFiles(request)
|
110
|
+
body = send_request('CreateFlowByFiles', request.serialize)
|
111
|
+
response = JSON.parse(body)
|
112
|
+
if response['Response'].key?('Error') == false
|
113
|
+
model = CreateFlowByFilesResponse.new
|
114
|
+
model.deserialize(response['Response'])
|
115
|
+
model
|
116
|
+
else
|
117
|
+
code = response['Response']['Error']['Code']
|
118
|
+
message = response['Response']['Error']['Message']
|
119
|
+
reqid = response['Response']['RequestId']
|
120
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
121
|
+
end
|
122
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
123
|
+
raise e
|
124
|
+
rescue StandardError => e
|
125
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
126
|
+
end
|
127
|
+
|
128
|
+
# 获取小程序跳转链接
|
129
|
+
|
130
|
+
# @param request: Request instance for CreateSchemeUrl.
|
131
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlRequest`
|
132
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlResponse`
|
133
|
+
def CreateSchemeUrl(request)
|
134
|
+
body = send_request('CreateSchemeUrl', request.serialize)
|
135
|
+
response = JSON.parse(body)
|
136
|
+
if response['Response'].key?('Error') == false
|
137
|
+
model = CreateSchemeUrlResponse.new
|
138
|
+
model.deserialize(response['Response'])
|
139
|
+
model
|
140
|
+
else
|
141
|
+
code = response['Response']['Error']['Code']
|
142
|
+
message = response['Response']['Error']['Message']
|
143
|
+
reqid = response['Response']['RequestId']
|
144
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
145
|
+
end
|
146
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
147
|
+
raise e
|
148
|
+
rescue StandardError => e
|
149
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
150
|
+
end
|
151
|
+
|
152
|
+
# 查询文件下载URL
|
153
|
+
|
154
|
+
# @param request: Request instance for DescribeFileUrls.
|
155
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsRequest`
|
156
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsResponse`
|
157
|
+
def DescribeFileUrls(request)
|
158
|
+
body = send_request('DescribeFileUrls', request.serialize)
|
159
|
+
response = JSON.parse(body)
|
160
|
+
if response['Response'].key?('Error') == false
|
161
|
+
model = DescribeFileUrlsResponse.new
|
162
|
+
model.deserialize(response['Response'])
|
163
|
+
model
|
164
|
+
else
|
165
|
+
code = response['Response']['Error']['Code']
|
166
|
+
message = response['Response']['Error']['Message']
|
167
|
+
reqid = response['Response']['RequestId']
|
168
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
169
|
+
end
|
170
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
171
|
+
raise e
|
172
|
+
rescue StandardError => e
|
173
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
174
|
+
end
|
175
|
+
|
176
|
+
# 查询流程摘要
|
177
|
+
|
178
|
+
# @param request: Request instance for DescribeFlowBriefs.
|
179
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
|
180
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsResponse`
|
181
|
+
def DescribeFlowBriefs(request)
|
182
|
+
body = send_request('DescribeFlowBriefs', request.serialize)
|
183
|
+
response = JSON.parse(body)
|
184
|
+
if response['Response'].key?('Error') == false
|
185
|
+
model = DescribeFlowBriefsResponse.new
|
186
|
+
model.deserialize(response['Response'])
|
187
|
+
model
|
188
|
+
else
|
189
|
+
code = response['Response']['Error']['Code']
|
190
|
+
message = response['Response']['Error']['Message']
|
191
|
+
reqid = response['Response']['RequestId']
|
192
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
193
|
+
end
|
194
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
195
|
+
raise e
|
196
|
+
rescue StandardError => e
|
197
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
198
|
+
end
|
199
|
+
|
200
|
+
# 通过AuthCode查询用户是否实名
|
201
|
+
|
202
|
+
# @param request: Request instance for DescribeThirdPartyAuthCode.
|
203
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeThirdPartyAuthCodeRequest`
|
204
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeThirdPartyAuthCodeResponse`
|
205
|
+
def DescribeThirdPartyAuthCode(request)
|
206
|
+
body = send_request('DescribeThirdPartyAuthCode', request.serialize)
|
207
|
+
response = JSON.parse(body)
|
208
|
+
if response['Response'].key?('Error') == false
|
209
|
+
model = DescribeThirdPartyAuthCodeResponse.new
|
210
|
+
model.deserialize(response['Response'])
|
211
|
+
model
|
212
|
+
else
|
213
|
+
code = response['Response']['Error']['Code']
|
214
|
+
message = response['Response']['Error']['Message']
|
215
|
+
reqid = response['Response']['RequestId']
|
216
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
217
|
+
end
|
218
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
219
|
+
raise e
|
220
|
+
rescue StandardError => e
|
221
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
222
|
+
end
|
223
|
+
|
224
|
+
# 此接口用于发起流程
|
225
|
+
|
226
|
+
# @param request: Request instance for StartFlow.
|
227
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
|
228
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::StartFlowResponse`
|
229
|
+
def StartFlow(request)
|
230
|
+
body = send_request('StartFlow', request.serialize)
|
231
|
+
response = JSON.parse(body)
|
232
|
+
if response['Response'].key?('Error') == false
|
233
|
+
model = StartFlowResponse.new
|
234
|
+
model.deserialize(response['Response'])
|
235
|
+
model
|
236
|
+
else
|
237
|
+
code = response['Response']['Error']['Code']
|
238
|
+
message = response['Response']['Error']['Message']
|
239
|
+
reqid = response['Response']['RequestId']
|
240
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
241
|
+
end
|
242
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
243
|
+
raise e
|
244
|
+
rescue StandardError => e
|
245
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
246
|
+
end
|
247
|
+
|
248
|
+
|
249
|
+
end
|
250
|
+
end
|
251
|
+
end
|
252
|
+
end
|
@@ -0,0 +1,1023 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
module TencentCloud
|
18
|
+
module Ess
|
19
|
+
module V20201111
|
20
|
+
# 应用相关信息
|
21
|
+
class Agent < TencentCloud::Common::AbstractModel
|
22
|
+
|
23
|
+
|
24
|
+
def initialize()
|
25
|
+
end
|
26
|
+
|
27
|
+
def deserialize(params)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
# 参与者信息
|
32
|
+
class ApproverInfo < TencentCloud::Common::AbstractModel
|
33
|
+
# @param ApproverType: 参与者类型:
|
34
|
+
# 0:企业
|
35
|
+
# 1:个人
|
36
|
+
# 3:企业静默签署
|
37
|
+
# 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署,目前只支持第一方进行静默签署。
|
38
|
+
# @type ApproverType: Integer
|
39
|
+
# @param ApproverName: 本环节需要操作人的名字
|
40
|
+
# @type ApproverName: String
|
41
|
+
# @param ApproverMobile: 本环节需要操作人的手机号
|
42
|
+
# @type ApproverMobile: String
|
43
|
+
# @param SignComponents: 本环节操作人签署控件配置,为企业静默签署时,只允许类型为SIGN_SEAL(印章)和SIGN_DATE(日期)控件,并且传入印章编号。
|
44
|
+
# @type SignComponents: Array
|
45
|
+
# @param OrganizationName: 如果是企业,则为企业的名字
|
46
|
+
# @type OrganizationName: String
|
47
|
+
# @param ApproverIdCardNumber: 身份证号
|
48
|
+
# @type ApproverIdCardNumber: String
|
49
|
+
# @param ApproverIdCardType: 证件类型 ID_CARD 身份证
|
50
|
+
# @type ApproverIdCardType: String
|
51
|
+
# @param NotifyType: sms--短信,none--不通知
|
52
|
+
# @type NotifyType: String
|
53
|
+
# @param ApproverRole: 1--收款人、2--开具人、3--见证人
|
54
|
+
# @type ApproverRole: Integer
|
55
|
+
# @param VerifyChannel: 认证方式:
|
56
|
+
# WEIXINAPP - 微信小程序;
|
57
|
+
# VERIFYCODE - 验证码;
|
58
|
+
|
59
|
+
# 可以选择多个, 按照顺序进行优先级选择
|
60
|
+
# 注:使用验证码方式认证签署时,请传入["VERIFYCODE","WEIXINAPP"]
|
61
|
+
# @type VerifyChannel: Array
|
62
|
+
# @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
63
|
+
# @type PreReadTime: Integer
|
64
|
+
|
65
|
+
attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :SignComponents, :OrganizationName, :ApproverIdCardNumber, :ApproverIdCardType, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime
|
66
|
+
|
67
|
+
def initialize(approvertype=nil, approvername=nil, approvermobile=nil, signcomponents=nil, organizationname=nil, approveridcardnumber=nil, approveridcardtype=nil, notifytype=nil, approverrole=nil, verifychannel=nil, prereadtime=nil)
|
68
|
+
@ApproverType = approvertype
|
69
|
+
@ApproverName = approvername
|
70
|
+
@ApproverMobile = approvermobile
|
71
|
+
@SignComponents = signcomponents
|
72
|
+
@OrganizationName = organizationname
|
73
|
+
@ApproverIdCardNumber = approveridcardnumber
|
74
|
+
@ApproverIdCardType = approveridcardtype
|
75
|
+
@NotifyType = notifytype
|
76
|
+
@ApproverRole = approverrole
|
77
|
+
@VerifyChannel = verifychannel
|
78
|
+
@PreReadTime = prereadtime
|
79
|
+
end
|
80
|
+
|
81
|
+
def deserialize(params)
|
82
|
+
@ApproverType = params['ApproverType']
|
83
|
+
@ApproverName = params['ApproverName']
|
84
|
+
@ApproverMobile = params['ApproverMobile']
|
85
|
+
unless params['SignComponents'].nil?
|
86
|
+
@SignComponents = []
|
87
|
+
params['SignComponents'].each do |i|
|
88
|
+
component_tmp = Component.new
|
89
|
+
component_tmp.deserialize(i)
|
90
|
+
@SignComponents << component_tmp
|
91
|
+
end
|
92
|
+
end
|
93
|
+
@OrganizationName = params['OrganizationName']
|
94
|
+
@ApproverIdCardNumber = params['ApproverIdCardNumber']
|
95
|
+
@ApproverIdCardType = params['ApproverIdCardType']
|
96
|
+
@NotifyType = params['NotifyType']
|
97
|
+
@ApproverRole = params['ApproverRole']
|
98
|
+
@VerifyChannel = params['VerifyChannel']
|
99
|
+
@PreReadTime = params['PreReadTime']
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
# CancelFlow请求参数结构体
|
104
|
+
class CancelFlowRequest < TencentCloud::Common::AbstractModel
|
105
|
+
# @param Operator: 操作用户id
|
106
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
107
|
+
# @param Agent: 应用相关信息
|
108
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
109
|
+
# @param FlowId: 流程id
|
110
|
+
# @type FlowId: String
|
111
|
+
# @param CancelMessage: 撤销原因
|
112
|
+
# @type CancelMessage: String
|
113
|
+
|
114
|
+
attr_accessor :Operator, :Agent, :FlowId, :CancelMessage
|
115
|
+
|
116
|
+
def initialize(operator=nil, agent=nil, flowid=nil, cancelmessage=nil)
|
117
|
+
@Operator = operator
|
118
|
+
@Agent = agent
|
119
|
+
@FlowId = flowid
|
120
|
+
@CancelMessage = cancelmessage
|
121
|
+
end
|
122
|
+
|
123
|
+
def deserialize(params)
|
124
|
+
unless params['Operator'].nil?
|
125
|
+
@Operator = UserInfo.new
|
126
|
+
@Operator.deserialize(params['Operator'])
|
127
|
+
end
|
128
|
+
unless params['Agent'].nil?
|
129
|
+
@Agent = Agent.new
|
130
|
+
@Agent.deserialize(params['Agent'])
|
131
|
+
end
|
132
|
+
@FlowId = params['FlowId']
|
133
|
+
@CancelMessage = params['CancelMessage']
|
134
|
+
end
|
135
|
+
end
|
136
|
+
|
137
|
+
# CancelFlow返回参数结构体
|
138
|
+
class CancelFlowResponse < TencentCloud::Common::AbstractModel
|
139
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
140
|
+
# @type RequestId: String
|
141
|
+
|
142
|
+
attr_accessor :RequestId
|
143
|
+
|
144
|
+
def initialize(requestid=nil)
|
145
|
+
@RequestId = requestid
|
146
|
+
end
|
147
|
+
|
148
|
+
def deserialize(params)
|
149
|
+
@RequestId = params['RequestId']
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
# 抄送信息
|
154
|
+
class CcInfo < TencentCloud::Common::AbstractModel
|
155
|
+
# @param Mobile: 被抄送人手机号
|
156
|
+
# @type Mobile: String
|
157
|
+
|
158
|
+
attr_accessor :Mobile
|
159
|
+
|
160
|
+
def initialize(mobile=nil)
|
161
|
+
@Mobile = mobile
|
162
|
+
end
|
163
|
+
|
164
|
+
def deserialize(params)
|
165
|
+
@Mobile = params['Mobile']
|
166
|
+
end
|
167
|
+
end
|
168
|
+
|
169
|
+
# 模板控件信息
|
170
|
+
class Component < TencentCloud::Common::AbstractModel
|
171
|
+
# @param ComponentType: 如果是 Component 控件类型,则可选类型为:
|
172
|
+
# TEXT - 内容文本控件
|
173
|
+
# DATE - 内容日期控件
|
174
|
+
# SELECT - 勾选框控件
|
175
|
+
# 如果是 SignComponent 控件类型,则可选类型为:
|
176
|
+
# SIGN_SEAL - 签署印章控件
|
177
|
+
# SIGN_DATE - 签署日期控件
|
178
|
+
# SIGN_SIGNATURE - 手写签名控件
|
179
|
+
# @type ComponentType: String
|
180
|
+
# @param ComponentWidth: 参数控件宽度,单位px
|
181
|
+
# @type ComponentWidth: Float
|
182
|
+
# @param ComponentHeight: 参数控件高度,单位px
|
183
|
+
# @type ComponentHeight: Float
|
184
|
+
# @param ComponentPage: 参数控件所在页码,取值为:1-N
|
185
|
+
# @type ComponentPage: Integer
|
186
|
+
# @param ComponentPosX: 参数控件X位置,单位px
|
187
|
+
# @type ComponentPosX: Float
|
188
|
+
# @param ComponentPosY: 参数控件Y位置,单位px
|
189
|
+
# @type ComponentPosY: Float
|
190
|
+
# @param FileIndex: 控件所属文件的序号(模板中的resourceId排列序号,取值为:0-N)
|
191
|
+
# @type FileIndex: Integer
|
192
|
+
# @param ComponentId: 控件编号
|
193
|
+
# @type ComponentId: String
|
194
|
+
# @param ComponentName: 控件名称
|
195
|
+
# @type ComponentName: String
|
196
|
+
# @param ComponentRequired: 是否必选,默认为false
|
197
|
+
# @type ComponentRequired: Boolean
|
198
|
+
# @param ComponentExtra: 参数控件样式
|
199
|
+
# @type ComponentExtra: String
|
200
|
+
# @param ComponentRecipientId: 控件关联的签署人ID
|
201
|
+
# @type ComponentRecipientId: String
|
202
|
+
# @param ComponentValue: 控件所填写的内容
|
203
|
+
# @type ComponentValue: String
|
204
|
+
# @param IsFormType: 是否是表单域类型,默认不存在
|
205
|
+
# @type IsFormType: Boolean
|
206
|
+
# @param GenerateMode: NORMAL 正常模式,使用坐标制定签署控件位置
|
207
|
+
# FIELD 表单域,需使用ComponentName指定表单域名称
|
208
|
+
# KEYWORD 关键字,使用ComponentId指定关键字
|
209
|
+
# @type GenerateMode: String
|
210
|
+
# @param ComponentDateFontSize: 日期控件类型字号
|
211
|
+
# @type ComponentDateFontSize: Integer
|
212
|
+
|
213
|
+
attr_accessor :ComponentType, :ComponentWidth, :ComponentHeight, :ComponentPage, :ComponentPosX, :ComponentPosY, :FileIndex, :ComponentId, :ComponentName, :ComponentRequired, :ComponentExtra, :ComponentRecipientId, :ComponentValue, :IsFormType, :GenerateMode, :ComponentDateFontSize
|
214
|
+
|
215
|
+
def initialize(componenttype=nil, componentwidth=nil, componentheight=nil, componentpage=nil, componentposx=nil, componentposy=nil, fileindex=nil, componentid=nil, componentname=nil, componentrequired=nil, componentextra=nil, componentrecipientid=nil, componentvalue=nil, isformtype=nil, generatemode=nil, componentdatefontsize=nil)
|
216
|
+
@ComponentType = componenttype
|
217
|
+
@ComponentWidth = componentwidth
|
218
|
+
@ComponentHeight = componentheight
|
219
|
+
@ComponentPage = componentpage
|
220
|
+
@ComponentPosX = componentposx
|
221
|
+
@ComponentPosY = componentposy
|
222
|
+
@FileIndex = fileindex
|
223
|
+
@ComponentId = componentid
|
224
|
+
@ComponentName = componentname
|
225
|
+
@ComponentRequired = componentrequired
|
226
|
+
@ComponentExtra = componentextra
|
227
|
+
@ComponentRecipientId = componentrecipientid
|
228
|
+
@ComponentValue = componentvalue
|
229
|
+
@IsFormType = isformtype
|
230
|
+
@GenerateMode = generatemode
|
231
|
+
@ComponentDateFontSize = componentdatefontsize
|
232
|
+
end
|
233
|
+
|
234
|
+
def deserialize(params)
|
235
|
+
@ComponentType = params['ComponentType']
|
236
|
+
@ComponentWidth = params['ComponentWidth']
|
237
|
+
@ComponentHeight = params['ComponentHeight']
|
238
|
+
@ComponentPage = params['ComponentPage']
|
239
|
+
@ComponentPosX = params['ComponentPosX']
|
240
|
+
@ComponentPosY = params['ComponentPosY']
|
241
|
+
@FileIndex = params['FileIndex']
|
242
|
+
@ComponentId = params['ComponentId']
|
243
|
+
@ComponentName = params['ComponentName']
|
244
|
+
@ComponentRequired = params['ComponentRequired']
|
245
|
+
@ComponentExtra = params['ComponentExtra']
|
246
|
+
@ComponentRecipientId = params['ComponentRecipientId']
|
247
|
+
@ComponentValue = params['ComponentValue']
|
248
|
+
@IsFormType = params['IsFormType']
|
249
|
+
@GenerateMode = params['GenerateMode']
|
250
|
+
@ComponentDateFontSize = params['ComponentDateFontSize']
|
251
|
+
end
|
252
|
+
end
|
253
|
+
|
254
|
+
# CreateDocument请求参数结构体
|
255
|
+
class CreateDocumentRequest < TencentCloud::Common::AbstractModel
|
256
|
+
# @param Operator: 无
|
257
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
258
|
+
# @param TemplateId: 用户上传的模版ID
|
259
|
+
# @type TemplateId: String
|
260
|
+
# @param FlowId: 流程ID
|
261
|
+
# @type FlowId: String
|
262
|
+
# @param FileNames: 文件名列表
|
263
|
+
# @type FileNames: Array
|
264
|
+
# @param FormFields: 内容控件信息数组
|
265
|
+
# @type FormFields: Array
|
266
|
+
# @param Agent: 应用相关信息
|
267
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
268
|
+
# @param ClientToken: 客户端Token,保持接口幂等性
|
269
|
+
# @type ClientToken: String
|
270
|
+
|
271
|
+
attr_accessor :Operator, :TemplateId, :FlowId, :FileNames, :FormFields, :Agent, :ClientToken
|
272
|
+
|
273
|
+
def initialize(operator=nil, templateid=nil, flowid=nil, filenames=nil, formfields=nil, agent=nil, clienttoken=nil)
|
274
|
+
@Operator = operator
|
275
|
+
@TemplateId = templateid
|
276
|
+
@FlowId = flowid
|
277
|
+
@FileNames = filenames
|
278
|
+
@FormFields = formfields
|
279
|
+
@Agent = agent
|
280
|
+
@ClientToken = clienttoken
|
281
|
+
end
|
282
|
+
|
283
|
+
def deserialize(params)
|
284
|
+
unless params['Operator'].nil?
|
285
|
+
@Operator = UserInfo.new
|
286
|
+
@Operator.deserialize(params['Operator'])
|
287
|
+
end
|
288
|
+
@TemplateId = params['TemplateId']
|
289
|
+
@FlowId = params['FlowId']
|
290
|
+
@FileNames = params['FileNames']
|
291
|
+
unless params['FormFields'].nil?
|
292
|
+
@FormFields = []
|
293
|
+
params['FormFields'].each do |i|
|
294
|
+
formfield_tmp = FormField.new
|
295
|
+
formfield_tmp.deserialize(i)
|
296
|
+
@FormFields << formfield_tmp
|
297
|
+
end
|
298
|
+
end
|
299
|
+
unless params['Agent'].nil?
|
300
|
+
@Agent = Agent.new
|
301
|
+
@Agent.deserialize(params['Agent'])
|
302
|
+
end
|
303
|
+
@ClientToken = params['ClientToken']
|
304
|
+
end
|
305
|
+
end
|
306
|
+
|
307
|
+
# CreateDocument返回参数结构体
|
308
|
+
class CreateDocumentResponse < TencentCloud::Common::AbstractModel
|
309
|
+
# @param DocumentId: 返回的电子文档ID
|
310
|
+
# @type DocumentId: String
|
311
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
312
|
+
# @type RequestId: String
|
313
|
+
|
314
|
+
attr_accessor :DocumentId, :RequestId
|
315
|
+
|
316
|
+
def initialize(documentid=nil, requestid=nil)
|
317
|
+
@DocumentId = documentid
|
318
|
+
@RequestId = requestid
|
319
|
+
end
|
320
|
+
|
321
|
+
def deserialize(params)
|
322
|
+
@DocumentId = params['DocumentId']
|
323
|
+
@RequestId = params['RequestId']
|
324
|
+
end
|
325
|
+
end
|
326
|
+
|
327
|
+
# CreateFlowByFiles请求参数结构体
|
328
|
+
class CreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
|
329
|
+
# @param Operator: 调用方用户信息
|
330
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
331
|
+
# @param FlowName: 流程名称
|
332
|
+
# @type FlowName: String
|
333
|
+
# @param FileIds: 签署pdf文件的资源编号列表
|
334
|
+
# @type FileIds: Array
|
335
|
+
# @param Approvers: 签署参与者信息
|
336
|
+
# @type Approvers: Array
|
337
|
+
# @param FlowDescription: 流程描述
|
338
|
+
# @type FlowDescription: String
|
339
|
+
# @param Unordered: 发送类型:
|
340
|
+
# true:无序签
|
341
|
+
# false:有序签
|
342
|
+
# 注:默认为false(有序签)
|
343
|
+
# @type Unordered: Boolean
|
344
|
+
# @param FlowType: 流程的类型
|
345
|
+
# @type FlowType: String
|
346
|
+
# @param Deadline: 流程的签署截止时间
|
347
|
+
# @type Deadline: Integer
|
348
|
+
# @param Agent: 应用号信息
|
349
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
350
|
+
# @param Components: 经办人内容控件配置。可选类型为:
|
351
|
+
# TEXT - 内容文本控件
|
352
|
+
# MULTI_LINE_TEXT - 多行文本控件
|
353
|
+
# 注:默认字体大小为 字号12
|
354
|
+
# @type Components: Array
|
355
|
+
# @param CcInfos: 被抄送人的信息列表
|
356
|
+
# @type CcInfos: Array
|
357
|
+
|
358
|
+
attr_accessor :Operator, :FlowName, :FileIds, :Approvers, :FlowDescription, :Unordered, :FlowType, :Deadline, :Agent, :Components, :CcInfos
|
359
|
+
|
360
|
+
def initialize(operator=nil, flowname=nil, fileids=nil, approvers=nil, flowdescription=nil, unordered=nil, flowtype=nil, deadline=nil, agent=nil, components=nil, ccinfos=nil)
|
361
|
+
@Operator = operator
|
362
|
+
@FlowName = flowname
|
363
|
+
@FileIds = fileids
|
364
|
+
@Approvers = approvers
|
365
|
+
@FlowDescription = flowdescription
|
366
|
+
@Unordered = unordered
|
367
|
+
@FlowType = flowtype
|
368
|
+
@Deadline = deadline
|
369
|
+
@Agent = agent
|
370
|
+
@Components = components
|
371
|
+
@CcInfos = ccinfos
|
372
|
+
end
|
373
|
+
|
374
|
+
def deserialize(params)
|
375
|
+
unless params['Operator'].nil?
|
376
|
+
@Operator = UserInfo.new
|
377
|
+
@Operator.deserialize(params['Operator'])
|
378
|
+
end
|
379
|
+
@FlowName = params['FlowName']
|
380
|
+
@FileIds = params['FileIds']
|
381
|
+
unless params['Approvers'].nil?
|
382
|
+
@Approvers = []
|
383
|
+
params['Approvers'].each do |i|
|
384
|
+
approverinfo_tmp = ApproverInfo.new
|
385
|
+
approverinfo_tmp.deserialize(i)
|
386
|
+
@Approvers << approverinfo_tmp
|
387
|
+
end
|
388
|
+
end
|
389
|
+
@FlowDescription = params['FlowDescription']
|
390
|
+
@Unordered = params['Unordered']
|
391
|
+
@FlowType = params['FlowType']
|
392
|
+
@Deadline = params['Deadline']
|
393
|
+
unless params['Agent'].nil?
|
394
|
+
@Agent = Agent.new
|
395
|
+
@Agent.deserialize(params['Agent'])
|
396
|
+
end
|
397
|
+
unless params['Components'].nil?
|
398
|
+
@Components = []
|
399
|
+
params['Components'].each do |i|
|
400
|
+
component_tmp = Component.new
|
401
|
+
component_tmp.deserialize(i)
|
402
|
+
@Components << component_tmp
|
403
|
+
end
|
404
|
+
end
|
405
|
+
unless params['CcInfos'].nil?
|
406
|
+
@CcInfos = []
|
407
|
+
params['CcInfos'].each do |i|
|
408
|
+
ccinfo_tmp = CcInfo.new
|
409
|
+
ccinfo_tmp.deserialize(i)
|
410
|
+
@CcInfos << ccinfo_tmp
|
411
|
+
end
|
412
|
+
end
|
413
|
+
end
|
414
|
+
end
|
415
|
+
|
416
|
+
# CreateFlowByFiles返回参数结构体
|
417
|
+
class CreateFlowByFilesResponse < TencentCloud::Common::AbstractModel
|
418
|
+
# @param FlowId: 流程编号
|
419
|
+
# @type FlowId: String
|
420
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
421
|
+
# @type RequestId: String
|
422
|
+
|
423
|
+
attr_accessor :FlowId, :RequestId
|
424
|
+
|
425
|
+
def initialize(flowid=nil, requestid=nil)
|
426
|
+
@FlowId = flowid
|
427
|
+
@RequestId = requestid
|
428
|
+
end
|
429
|
+
|
430
|
+
def deserialize(params)
|
431
|
+
@FlowId = params['FlowId']
|
432
|
+
@RequestId = params['RequestId']
|
433
|
+
end
|
434
|
+
end
|
435
|
+
|
436
|
+
# CreateFlow请求参数结构体
|
437
|
+
class CreateFlowRequest < TencentCloud::Common::AbstractModel
|
438
|
+
# @param Operator: 操作人信息
|
439
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
440
|
+
# @param FlowName: 流程的名字, 长度不能超过200,中文字母数字下划线
|
441
|
+
# @type FlowName: String
|
442
|
+
# @param Approvers: 参与者信息
|
443
|
+
# @type Approvers: Array
|
444
|
+
# @param FlowDescription: 流程的描述, 长度不能超过1000
|
445
|
+
# @type FlowDescription: String
|
446
|
+
# @param Unordered: 发送类型(true为无序签,false为顺序签)
|
447
|
+
# @type Unordered: Boolean
|
448
|
+
# @param FlowType: 流程的种类(如销售合同/入职合同等)
|
449
|
+
# @type FlowType: String
|
450
|
+
# @param DeadLine: 过期时间戳,如果是0则为不过期
|
451
|
+
# @type DeadLine: Integer
|
452
|
+
# @param CallbackUrl: 执行结果的回调URL(需要以http://或者https://)开头
|
453
|
+
# @type CallbackUrl: String
|
454
|
+
# @param UserData: 用户自定义字段(需进行base64 encode),回调的时候会进行透传, 长度需要小于20480
|
455
|
+
# @type UserData: String
|
456
|
+
# @param Agent: 应用相关信息
|
457
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
458
|
+
# @param ClientToken: 客户端Token,保持接口幂等性
|
459
|
+
# @type ClientToken: String
|
460
|
+
|
461
|
+
attr_accessor :Operator, :FlowName, :Approvers, :FlowDescription, :Unordered, :FlowType, :DeadLine, :CallbackUrl, :UserData, :Agent, :ClientToken
|
462
|
+
|
463
|
+
def initialize(operator=nil, flowname=nil, approvers=nil, flowdescription=nil, unordered=nil, flowtype=nil, deadline=nil, callbackurl=nil, userdata=nil, agent=nil, clienttoken=nil)
|
464
|
+
@Operator = operator
|
465
|
+
@FlowName = flowname
|
466
|
+
@Approvers = approvers
|
467
|
+
@FlowDescription = flowdescription
|
468
|
+
@Unordered = unordered
|
469
|
+
@FlowType = flowtype
|
470
|
+
@DeadLine = deadline
|
471
|
+
@CallbackUrl = callbackurl
|
472
|
+
@UserData = userdata
|
473
|
+
@Agent = agent
|
474
|
+
@ClientToken = clienttoken
|
475
|
+
end
|
476
|
+
|
477
|
+
def deserialize(params)
|
478
|
+
unless params['Operator'].nil?
|
479
|
+
@Operator = UserInfo.new
|
480
|
+
@Operator.deserialize(params['Operator'])
|
481
|
+
end
|
482
|
+
@FlowName = params['FlowName']
|
483
|
+
unless params['Approvers'].nil?
|
484
|
+
@Approvers = []
|
485
|
+
params['Approvers'].each do |i|
|
486
|
+
flowcreateapprover_tmp = FlowCreateApprover.new
|
487
|
+
flowcreateapprover_tmp.deserialize(i)
|
488
|
+
@Approvers << flowcreateapprover_tmp
|
489
|
+
end
|
490
|
+
end
|
491
|
+
@FlowDescription = params['FlowDescription']
|
492
|
+
@Unordered = params['Unordered']
|
493
|
+
@FlowType = params['FlowType']
|
494
|
+
@DeadLine = params['DeadLine']
|
495
|
+
@CallbackUrl = params['CallbackUrl']
|
496
|
+
@UserData = params['UserData']
|
497
|
+
unless params['Agent'].nil?
|
498
|
+
@Agent = Agent.new
|
499
|
+
@Agent.deserialize(params['Agent'])
|
500
|
+
end
|
501
|
+
@ClientToken = params['ClientToken']
|
502
|
+
end
|
503
|
+
end
|
504
|
+
|
505
|
+
# CreateFlow返回参数结构体
|
506
|
+
class CreateFlowResponse < TencentCloud::Common::AbstractModel
|
507
|
+
# @param FlowId: 流程编号
|
508
|
+
# @type FlowId: String
|
509
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
510
|
+
# @type RequestId: String
|
511
|
+
|
512
|
+
attr_accessor :FlowId, :RequestId
|
513
|
+
|
514
|
+
def initialize(flowid=nil, requestid=nil)
|
515
|
+
@FlowId = flowid
|
516
|
+
@RequestId = requestid
|
517
|
+
end
|
518
|
+
|
519
|
+
def deserialize(params)
|
520
|
+
@FlowId = params['FlowId']
|
521
|
+
@RequestId = params['RequestId']
|
522
|
+
end
|
523
|
+
end
|
524
|
+
|
525
|
+
# CreateSchemeUrl请求参数结构体
|
526
|
+
class CreateSchemeUrlRequest < TencentCloud::Common::AbstractModel
|
527
|
+
# @param Operator: 调用方用户信息,参考通用结构
|
528
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
529
|
+
# @param Agent: 调用方渠道信息,参考通用结构
|
530
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
531
|
+
# @param Name: 姓名
|
532
|
+
# @type Name: String
|
533
|
+
# @param Mobile: 手机号
|
534
|
+
# @type Mobile: String
|
535
|
+
# @param PathType: 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
|
536
|
+
# @type PathType: Integer
|
537
|
+
# @param FlowId: 合同详情 id (PathType=1时必传)
|
538
|
+
# @type FlowId: String
|
539
|
+
|
540
|
+
attr_accessor :Operator, :Agent, :Name, :Mobile, :PathType, :FlowId
|
541
|
+
|
542
|
+
def initialize(operator=nil, agent=nil, name=nil, mobile=nil, pathtype=nil, flowid=nil)
|
543
|
+
@Operator = operator
|
544
|
+
@Agent = agent
|
545
|
+
@Name = name
|
546
|
+
@Mobile = mobile
|
547
|
+
@PathType = pathtype
|
548
|
+
@FlowId = flowid
|
549
|
+
end
|
550
|
+
|
551
|
+
def deserialize(params)
|
552
|
+
unless params['Operator'].nil?
|
553
|
+
@Operator = UserInfo.new
|
554
|
+
@Operator.deserialize(params['Operator'])
|
555
|
+
end
|
556
|
+
unless params['Agent'].nil?
|
557
|
+
@Agent = Agent.new
|
558
|
+
@Agent.deserialize(params['Agent'])
|
559
|
+
end
|
560
|
+
@Name = params['Name']
|
561
|
+
@Mobile = params['Mobile']
|
562
|
+
@PathType = params['PathType']
|
563
|
+
@FlowId = params['FlowId']
|
564
|
+
end
|
565
|
+
end
|
566
|
+
|
567
|
+
# CreateSchemeUrl返回参数结构体
|
568
|
+
class CreateSchemeUrlResponse < TencentCloud::Common::AbstractModel
|
569
|
+
# @param SchemeUrl: 小程序链接地址
|
570
|
+
# @type SchemeUrl: String
|
571
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
572
|
+
# @type RequestId: String
|
573
|
+
|
574
|
+
attr_accessor :SchemeUrl, :RequestId
|
575
|
+
|
576
|
+
def initialize(schemeurl=nil, requestid=nil)
|
577
|
+
@SchemeUrl = schemeurl
|
578
|
+
@RequestId = requestid
|
579
|
+
end
|
580
|
+
|
581
|
+
def deserialize(params)
|
582
|
+
@SchemeUrl = params['SchemeUrl']
|
583
|
+
@RequestId = params['RequestId']
|
584
|
+
end
|
585
|
+
end
|
586
|
+
|
587
|
+
# DescribeFileUrls请求参数结构体
|
588
|
+
class DescribeFileUrlsRequest < TencentCloud::Common::AbstractModel
|
589
|
+
# @param BusinessType: 文件对应的业务类型,目前支持:
|
590
|
+
# - 模板 "TEMPLATE"
|
591
|
+
# - 文档 "DOCUMENT"
|
592
|
+
# - 印章 “SEAL”
|
593
|
+
# - 流程 "FLOW"
|
594
|
+
# @type BusinessType: String
|
595
|
+
# @param Operator: 操作者信息
|
596
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
597
|
+
# @param BusinessIds: 业务编号的数组,如模板编号、文档编号、印章编号
|
598
|
+
# @type BusinessIds: Array
|
599
|
+
# @param FileType: 文件类型,"JPG", "PDF","ZIP"等
|
600
|
+
# @type FileType: String
|
601
|
+
# @param FileName: 下载后的文件命名,只有fileType为zip的时候生效
|
602
|
+
# @type FileName: String
|
603
|
+
# @param Offset: 指定资源起始偏移量
|
604
|
+
# @type Offset: Integer
|
605
|
+
# @param Limit: 指定资源数量,查询全部资源则传入-1
|
606
|
+
# @type Limit: Integer
|
607
|
+
# @param Agent: 应用相关信息
|
608
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
609
|
+
# @param UrlTtl: 下载url过期时间,0: 按默认值5分钟,允许范围:1s~24*60*60s(1天)
|
610
|
+
# @type UrlTtl: Integer
|
611
|
+
# @param CcToken: 流程校验发送邮件权限
|
612
|
+
# @type CcToken: String
|
613
|
+
# @param Scene: 场景
|
614
|
+
# @type Scene: String
|
615
|
+
|
616
|
+
attr_accessor :BusinessType, :Operator, :BusinessIds, :FileType, :FileName, :Offset, :Limit, :Agent, :UrlTtl, :CcToken, :Scene
|
617
|
+
|
618
|
+
def initialize(businesstype=nil, operator=nil, businessids=nil, filetype=nil, filename=nil, offset=nil, limit=nil, agent=nil, urlttl=nil, cctoken=nil, scene=nil)
|
619
|
+
@BusinessType = businesstype
|
620
|
+
@Operator = operator
|
621
|
+
@BusinessIds = businessids
|
622
|
+
@FileType = filetype
|
623
|
+
@FileName = filename
|
624
|
+
@Offset = offset
|
625
|
+
@Limit = limit
|
626
|
+
@Agent = agent
|
627
|
+
@UrlTtl = urlttl
|
628
|
+
@CcToken = cctoken
|
629
|
+
@Scene = scene
|
630
|
+
end
|
631
|
+
|
632
|
+
def deserialize(params)
|
633
|
+
@BusinessType = params['BusinessType']
|
634
|
+
unless params['Operator'].nil?
|
635
|
+
@Operator = UserInfo.new
|
636
|
+
@Operator.deserialize(params['Operator'])
|
637
|
+
end
|
638
|
+
@BusinessIds = params['BusinessIds']
|
639
|
+
@FileType = params['FileType']
|
640
|
+
@FileName = params['FileName']
|
641
|
+
@Offset = params['Offset']
|
642
|
+
@Limit = params['Limit']
|
643
|
+
unless params['Agent'].nil?
|
644
|
+
@Agent = Agent.new
|
645
|
+
@Agent.deserialize(params['Agent'])
|
646
|
+
end
|
647
|
+
@UrlTtl = params['UrlTtl']
|
648
|
+
@CcToken = params['CcToken']
|
649
|
+
@Scene = params['Scene']
|
650
|
+
end
|
651
|
+
end
|
652
|
+
|
653
|
+
# DescribeFileUrls返回参数结构体
|
654
|
+
class DescribeFileUrlsResponse < TencentCloud::Common::AbstractModel
|
655
|
+
# @param FileUrls: URL信息
|
656
|
+
# @type FileUrls: Array
|
657
|
+
# @param TotalCount: URL数量
|
658
|
+
# @type TotalCount: Integer
|
659
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
660
|
+
# @type RequestId: String
|
661
|
+
|
662
|
+
attr_accessor :FileUrls, :TotalCount, :RequestId
|
663
|
+
|
664
|
+
def initialize(fileurls=nil, totalcount=nil, requestid=nil)
|
665
|
+
@FileUrls = fileurls
|
666
|
+
@TotalCount = totalcount
|
667
|
+
@RequestId = requestid
|
668
|
+
end
|
669
|
+
|
670
|
+
def deserialize(params)
|
671
|
+
unless params['FileUrls'].nil?
|
672
|
+
@FileUrls = []
|
673
|
+
params['FileUrls'].each do |i|
|
674
|
+
fileurl_tmp = FileUrl.new
|
675
|
+
fileurl_tmp.deserialize(i)
|
676
|
+
@FileUrls << fileurl_tmp
|
677
|
+
end
|
678
|
+
end
|
679
|
+
@TotalCount = params['TotalCount']
|
680
|
+
@RequestId = params['RequestId']
|
681
|
+
end
|
682
|
+
end
|
683
|
+
|
684
|
+
# DescribeFlowBriefs请求参数结构体
|
685
|
+
class DescribeFlowBriefsRequest < TencentCloud::Common::AbstractModel
|
686
|
+
# @param Operator: 操作人信息
|
687
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
688
|
+
# @param FlowIds: 需要查询的流程ID列表
|
689
|
+
# @type FlowIds: Array
|
690
|
+
# @param Agent: 代理商信息
|
691
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
692
|
+
|
693
|
+
attr_accessor :Operator, :FlowIds, :Agent
|
694
|
+
|
695
|
+
def initialize(operator=nil, flowids=nil, agent=nil)
|
696
|
+
@Operator = operator
|
697
|
+
@FlowIds = flowids
|
698
|
+
@Agent = agent
|
699
|
+
end
|
700
|
+
|
701
|
+
def deserialize(params)
|
702
|
+
unless params['Operator'].nil?
|
703
|
+
@Operator = UserInfo.new
|
704
|
+
@Operator.deserialize(params['Operator'])
|
705
|
+
end
|
706
|
+
@FlowIds = params['FlowIds']
|
707
|
+
unless params['Agent'].nil?
|
708
|
+
@Agent = Agent.new
|
709
|
+
@Agent.deserialize(params['Agent'])
|
710
|
+
end
|
711
|
+
end
|
712
|
+
end
|
713
|
+
|
714
|
+
# DescribeFlowBriefs返回参数结构体
|
715
|
+
class DescribeFlowBriefsResponse < TencentCloud::Common::AbstractModel
|
716
|
+
# @param FlowBriefs: 流程列表
|
717
|
+
# @type FlowBriefs: Array
|
718
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
719
|
+
# @type RequestId: String
|
720
|
+
|
721
|
+
attr_accessor :FlowBriefs, :RequestId
|
722
|
+
|
723
|
+
def initialize(flowbriefs=nil, requestid=nil)
|
724
|
+
@FlowBriefs = flowbriefs
|
725
|
+
@RequestId = requestid
|
726
|
+
end
|
727
|
+
|
728
|
+
def deserialize(params)
|
729
|
+
unless params['FlowBriefs'].nil?
|
730
|
+
@FlowBriefs = []
|
731
|
+
params['FlowBriefs'].each do |i|
|
732
|
+
flowbrief_tmp = FlowBrief.new
|
733
|
+
flowbrief_tmp.deserialize(i)
|
734
|
+
@FlowBriefs << flowbrief_tmp
|
735
|
+
end
|
736
|
+
end
|
737
|
+
@RequestId = params['RequestId']
|
738
|
+
end
|
739
|
+
end
|
740
|
+
|
741
|
+
# DescribeThirdPartyAuthCode请求参数结构体
|
742
|
+
class DescribeThirdPartyAuthCodeRequest < TencentCloud::Common::AbstractModel
|
743
|
+
# @param AuthCode: AuthCode 值
|
744
|
+
# @type AuthCode: String
|
745
|
+
|
746
|
+
attr_accessor :AuthCode
|
747
|
+
|
748
|
+
def initialize(authcode=nil)
|
749
|
+
@AuthCode = authcode
|
750
|
+
end
|
751
|
+
|
752
|
+
def deserialize(params)
|
753
|
+
@AuthCode = params['AuthCode']
|
754
|
+
end
|
755
|
+
end
|
756
|
+
|
757
|
+
# DescribeThirdPartyAuthCode返回参数结构体
|
758
|
+
class DescribeThirdPartyAuthCodeResponse < TencentCloud::Common::AbstractModel
|
759
|
+
# @param VerifyStatus: 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
|
760
|
+
# @type VerifyStatus: String
|
761
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
762
|
+
# @type RequestId: String
|
763
|
+
|
764
|
+
attr_accessor :VerifyStatus, :RequestId
|
765
|
+
|
766
|
+
def initialize(verifystatus=nil, requestid=nil)
|
767
|
+
@VerifyStatus = verifystatus
|
768
|
+
@RequestId = requestid
|
769
|
+
end
|
770
|
+
|
771
|
+
def deserialize(params)
|
772
|
+
@VerifyStatus = params['VerifyStatus']
|
773
|
+
@RequestId = params['RequestId']
|
774
|
+
end
|
775
|
+
end
|
776
|
+
|
777
|
+
# 下载文件的URL信息
|
778
|
+
class FileUrl < TencentCloud::Common::AbstractModel
|
779
|
+
# @param Url: 下载文件的URL
|
780
|
+
# @type Url: String
|
781
|
+
# @param Option: 下载文件的附加信息
|
782
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
783
|
+
# @type Option: String
|
784
|
+
|
785
|
+
attr_accessor :Url, :Option
|
786
|
+
|
787
|
+
def initialize(url=nil, option=nil)
|
788
|
+
@Url = url
|
789
|
+
@Option = option
|
790
|
+
end
|
791
|
+
|
792
|
+
def deserialize(params)
|
793
|
+
@Url = params['Url']
|
794
|
+
@Option = params['Option']
|
795
|
+
end
|
796
|
+
end
|
797
|
+
|
798
|
+
# 流程信息摘要
|
799
|
+
class FlowBrief < TencentCloud::Common::AbstractModel
|
800
|
+
# @param FlowId: 流程的编号
|
801
|
+
# @type FlowId: String
|
802
|
+
# @param FlowName: 流程的名称
|
803
|
+
# @type FlowName: String
|
804
|
+
# @param FlowDescription: 流程的描述
|
805
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
806
|
+
# @type FlowDescription: String
|
807
|
+
# @param FlowType: 流程的类型
|
808
|
+
# @type FlowType: String
|
809
|
+
# @param FlowStatus: 流程状态
|
810
|
+
# - `1` 未签署
|
811
|
+
# - `2` 部分签署
|
812
|
+
# - `3` 已退回
|
813
|
+
# - `4` 完成签署
|
814
|
+
# - `5` 已过期
|
815
|
+
# - `6` 已取消
|
816
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
817
|
+
# @type FlowStatus: Integer
|
818
|
+
# @param CreatedOn: 流程创建的时间戳
|
819
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
820
|
+
# @type CreatedOn: Integer
|
821
|
+
# @param FlowMessage: 拒签或者取消的原因描述
|
822
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
823
|
+
# @type FlowMessage: String
|
824
|
+
|
825
|
+
attr_accessor :FlowId, :FlowName, :FlowDescription, :FlowType, :FlowStatus, :CreatedOn, :FlowMessage
|
826
|
+
|
827
|
+
def initialize(flowid=nil, flowname=nil, flowdescription=nil, flowtype=nil, flowstatus=nil, createdon=nil, flowmessage=nil)
|
828
|
+
@FlowId = flowid
|
829
|
+
@FlowName = flowname
|
830
|
+
@FlowDescription = flowdescription
|
831
|
+
@FlowType = flowtype
|
832
|
+
@FlowStatus = flowstatus
|
833
|
+
@CreatedOn = createdon
|
834
|
+
@FlowMessage = flowmessage
|
835
|
+
end
|
836
|
+
|
837
|
+
def deserialize(params)
|
838
|
+
@FlowId = params['FlowId']
|
839
|
+
@FlowName = params['FlowName']
|
840
|
+
@FlowDescription = params['FlowDescription']
|
841
|
+
@FlowType = params['FlowType']
|
842
|
+
@FlowStatus = params['FlowStatus']
|
843
|
+
@CreatedOn = params['CreatedOn']
|
844
|
+
@FlowMessage = params['FlowMessage']
|
845
|
+
end
|
846
|
+
end
|
847
|
+
|
848
|
+
# 创建流程的签署方信息
|
849
|
+
class FlowCreateApprover < TencentCloud::Common::AbstractModel
|
850
|
+
# @param ApproverType: 签署方类型 (0为企业/1为个人)
|
851
|
+
# @type ApproverType: Integer
|
852
|
+
# @param OrganizationName: 如果签署方为企业,需要填入企业全称
|
853
|
+
# @type OrganizationName: String
|
854
|
+
# @param Required: 是否需要签署
|
855
|
+
# - `false`: 不需要签署
|
856
|
+
# - `true`: 需要签署
|
857
|
+
# @type Required: Boolean
|
858
|
+
# @param ApproverName: 签署方经办人姓名
|
859
|
+
# @type ApproverName: String
|
860
|
+
# @param ApproverMobile: 签署方经办人手机号码
|
861
|
+
# @type ApproverMobile: String
|
862
|
+
# @param ApproverIdCardType: 签署方经办人证件类型,ID_CARD表示身份证
|
863
|
+
# @type ApproverIdCardType: String
|
864
|
+
# @param ApproverIdCardNumber: 签署方经办人证件号码
|
865
|
+
# @type ApproverIdCardNumber: String
|
866
|
+
# @param RecipientId: 签署方经办人在模板中的角色ID
|
867
|
+
# @type RecipientId: String
|
868
|
+
# @param UserId: 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
|
869
|
+
# @type UserId: String
|
870
|
+
# @param IsFullText: 签署前置条件:是否需要阅读全文,默认为不需要
|
871
|
+
# @type IsFullText: Boolean
|
872
|
+
# @param PreReadTime: 签署前置条件:阅读时长限制,默认为不需要
|
873
|
+
# @type PreReadTime: Integer
|
874
|
+
# @param NotifyType: 是否发送短信,sms--短信通知,none--不通知,默认为sms
|
875
|
+
# @type NotifyType: String
|
876
|
+
|
877
|
+
attr_accessor :ApproverType, :OrganizationName, :Required, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :UserId, :IsFullText, :PreReadTime, :NotifyType
|
878
|
+
|
879
|
+
def initialize(approvertype=nil, organizationname=nil, required=nil, approvername=nil, approvermobile=nil, approveridcardtype=nil, approveridcardnumber=nil, recipientid=nil, userid=nil, isfulltext=nil, prereadtime=nil, notifytype=nil)
|
880
|
+
@ApproverType = approvertype
|
881
|
+
@OrganizationName = organizationname
|
882
|
+
@Required = required
|
883
|
+
@ApproverName = approvername
|
884
|
+
@ApproverMobile = approvermobile
|
885
|
+
@ApproverIdCardType = approveridcardtype
|
886
|
+
@ApproverIdCardNumber = approveridcardnumber
|
887
|
+
@RecipientId = recipientid
|
888
|
+
@UserId = userid
|
889
|
+
@IsFullText = isfulltext
|
890
|
+
@PreReadTime = prereadtime
|
891
|
+
@NotifyType = notifytype
|
892
|
+
end
|
893
|
+
|
894
|
+
def deserialize(params)
|
895
|
+
@ApproverType = params['ApproverType']
|
896
|
+
@OrganizationName = params['OrganizationName']
|
897
|
+
@Required = params['Required']
|
898
|
+
@ApproverName = params['ApproverName']
|
899
|
+
@ApproverMobile = params['ApproverMobile']
|
900
|
+
@ApproverIdCardType = params['ApproverIdCardType']
|
901
|
+
@ApproverIdCardNumber = params['ApproverIdCardNumber']
|
902
|
+
@RecipientId = params['RecipientId']
|
903
|
+
@UserId = params['UserId']
|
904
|
+
@IsFullText = params['IsFullText']
|
905
|
+
@PreReadTime = params['PreReadTime']
|
906
|
+
@NotifyType = params['NotifyType']
|
907
|
+
end
|
908
|
+
end
|
909
|
+
|
910
|
+
# 电子文档的控件填充信息
|
911
|
+
class FormField < TencentCloud::Common::AbstractModel
|
912
|
+
# @param ComponentValue: 控件填充value
|
913
|
+
# @type ComponentValue: String
|
914
|
+
# @param ComponentId: 控件id
|
915
|
+
# @type ComponentId: String
|
916
|
+
# @param ComponentName: 控件名字
|
917
|
+
# @type ComponentName: String
|
918
|
+
|
919
|
+
attr_accessor :ComponentValue, :ComponentId, :ComponentName
|
920
|
+
|
921
|
+
def initialize(componentvalue=nil, componentid=nil, componentname=nil)
|
922
|
+
@ComponentValue = componentvalue
|
923
|
+
@ComponentId = componentid
|
924
|
+
@ComponentName = componentname
|
925
|
+
end
|
926
|
+
|
927
|
+
def deserialize(params)
|
928
|
+
@ComponentValue = params['ComponentValue']
|
929
|
+
@ComponentId = params['ComponentId']
|
930
|
+
@ComponentName = params['ComponentName']
|
931
|
+
end
|
932
|
+
end
|
933
|
+
|
934
|
+
# StartFlow请求参数结构体
|
935
|
+
class StartFlowRequest < TencentCloud::Common::AbstractModel
|
936
|
+
# @param Operator: 用户信息
|
937
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
938
|
+
# @param FlowId: 流程编号
|
939
|
+
# @type FlowId: String
|
940
|
+
# @param Agent: 应用相关信息
|
941
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
942
|
+
# @param ClientToken: 客户端Token,保持接口幂等性
|
943
|
+
# @type ClientToken: String
|
944
|
+
|
945
|
+
attr_accessor :Operator, :FlowId, :Agent, :ClientToken
|
946
|
+
|
947
|
+
def initialize(operator=nil, flowid=nil, agent=nil, clienttoken=nil)
|
948
|
+
@Operator = operator
|
949
|
+
@FlowId = flowid
|
950
|
+
@Agent = agent
|
951
|
+
@ClientToken = clienttoken
|
952
|
+
end
|
953
|
+
|
954
|
+
def deserialize(params)
|
955
|
+
unless params['Operator'].nil?
|
956
|
+
@Operator = UserInfo.new
|
957
|
+
@Operator.deserialize(params['Operator'])
|
958
|
+
end
|
959
|
+
@FlowId = params['FlowId']
|
960
|
+
unless params['Agent'].nil?
|
961
|
+
@Agent = Agent.new
|
962
|
+
@Agent.deserialize(params['Agent'])
|
963
|
+
end
|
964
|
+
@ClientToken = params['ClientToken']
|
965
|
+
end
|
966
|
+
end
|
967
|
+
|
968
|
+
# StartFlow返回参数结构体
|
969
|
+
class StartFlowResponse < TencentCloud::Common::AbstractModel
|
970
|
+
# @param Status: 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
|
971
|
+
# @type Status: String
|
972
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
973
|
+
# @type RequestId: String
|
974
|
+
|
975
|
+
attr_accessor :Status, :RequestId
|
976
|
+
|
977
|
+
def initialize(status=nil, requestid=nil)
|
978
|
+
@Status = status
|
979
|
+
@RequestId = requestid
|
980
|
+
end
|
981
|
+
|
982
|
+
def deserialize(params)
|
983
|
+
@Status = params['Status']
|
984
|
+
@RequestId = params['RequestId']
|
985
|
+
end
|
986
|
+
end
|
987
|
+
|
988
|
+
# 用户信息
|
989
|
+
class UserInfo < TencentCloud::Common::AbstractModel
|
990
|
+
# @param UserId: 用户在平台的编号
|
991
|
+
# @type UserId: String
|
992
|
+
# @param Channel: 用户的来源渠道
|
993
|
+
# @type Channel: String
|
994
|
+
# @param OpenId: 用户在渠道的编号
|
995
|
+
# @type OpenId: String
|
996
|
+
# @param ClientIp: 用户真实IP
|
997
|
+
# @type ClientIp: String
|
998
|
+
# @param ProxyIp: 用户代理IP
|
999
|
+
# @type ProxyIp: String
|
1000
|
+
|
1001
|
+
attr_accessor :UserId, :Channel, :OpenId, :ClientIp, :ProxyIp
|
1002
|
+
|
1003
|
+
def initialize(userid=nil, channel=nil, openid=nil, clientip=nil, proxyip=nil)
|
1004
|
+
@UserId = userid
|
1005
|
+
@Channel = channel
|
1006
|
+
@OpenId = openid
|
1007
|
+
@ClientIp = clientip
|
1008
|
+
@ProxyIp = proxyip
|
1009
|
+
end
|
1010
|
+
|
1011
|
+
def deserialize(params)
|
1012
|
+
@UserId = params['UserId']
|
1013
|
+
@Channel = params['Channel']
|
1014
|
+
@OpenId = params['OpenId']
|
1015
|
+
@ClientIp = params['ClientIp']
|
1016
|
+
@ProxyIp = params['ProxyIp']
|
1017
|
+
end
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
end
|
1021
|
+
end
|
1022
|
+
end
|
1023
|
+
|
metadata
ADDED
@@ -0,0 +1,66 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: tencentcloud-sdk-ess
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.266
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Tencent Cloud
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-02-28 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: tencentcloud-sdk-common
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.0'
|
27
|
+
description: Tencent Cloud Ruby SDK is the official software development kit, which
|
28
|
+
allows Ruby developers to write software that makes use of Tencent Cloud service
|
29
|
+
ESS.
|
30
|
+
email:
|
31
|
+
- tencentcloudapi@tencent.com
|
32
|
+
executables: []
|
33
|
+
extensions: []
|
34
|
+
extra_rdoc_files: []
|
35
|
+
files:
|
36
|
+
- lib/VERSION
|
37
|
+
- lib/tencentcloud-sdk-ess.rb
|
38
|
+
- lib/v20201111/client.rb
|
39
|
+
- lib/v20201111/models.rb
|
40
|
+
homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
|
41
|
+
licenses:
|
42
|
+
- Apache-2.0
|
43
|
+
metadata:
|
44
|
+
source_code_uri: https://github.com/TencentCloud/tencentcloud-sdk-ruby/tencentcloud-sdk-ess
|
45
|
+
changelog_uri: https://github.com/TencentCloud/tencentcloud-sdk-ruby/blob/master/CHANGELOG.md
|
46
|
+
post_install_message:
|
47
|
+
rdoc_options: []
|
48
|
+
require_paths:
|
49
|
+
- lib
|
50
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
56
|
+
requirements:
|
57
|
+
- - ">="
|
58
|
+
- !ruby/object:Gem::Version
|
59
|
+
version: '0'
|
60
|
+
requirements: []
|
61
|
+
rubyforge_project:
|
62
|
+
rubygems_version: 2.6.14
|
63
|
+
signing_key:
|
64
|
+
specification_version: 4
|
65
|
+
summary: Tencent Cloud SDK for Ruby - ESS
|
66
|
+
test_files: []
|