tencentcloud-sdk-essbasic 1.0.200
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-essbasic.rb +14 -0
- data/lib/v20201222/client.rb +1357 -0
- data/lib/v20201222/models.rb +4456 -0
- data/lib/v20210526/client.rb +253 -0
- data/lib/v20210526/models.rb +1261 -0
- metadata +68 -0
@@ -0,0 +1,1261 @@
|
|
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 Essbasic
|
19
|
+
module V20210526
|
20
|
+
# 应用相关信息
|
21
|
+
class Agent < TencentCloud::Common::AbstractModel
|
22
|
+
# @param AppId: 腾讯电子签颁发给渠道的应用ID,32位字符串
|
23
|
+
# @type AppId: String
|
24
|
+
# @param ProxyOrganizationId: 腾讯电子签颁发给渠道侧合作企业的企业ID
|
25
|
+
# @type ProxyOrganizationId: String
|
26
|
+
# @param ProxyAppId: 腾讯电子签颁发给渠道侧合作企业的应用ID
|
27
|
+
# @type ProxyAppId: String
|
28
|
+
# @param ProxyOperator: 渠道/平台合作企业经办人(操作员)
|
29
|
+
# @type ProxyOperator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
30
|
+
# @param ProxyOrganizationOpenId: 渠道/平台合作企业的企业ID
|
31
|
+
# @type ProxyOrganizationOpenId: String
|
32
|
+
|
33
|
+
attr_accessor :AppId, :ProxyOrganizationId, :ProxyAppId, :ProxyOperator, :ProxyOrganizationOpenId
|
34
|
+
|
35
|
+
def initialize(appid=nil, proxyorganizationid=nil, proxyappid=nil, proxyoperator=nil, proxyorganizationopenid=nil)
|
36
|
+
@AppId = appid
|
37
|
+
@ProxyOrganizationId = proxyorganizationid
|
38
|
+
@ProxyAppId = proxyappid
|
39
|
+
@ProxyOperator = proxyoperator
|
40
|
+
@ProxyOrganizationOpenId = proxyorganizationopenid
|
41
|
+
end
|
42
|
+
|
43
|
+
def deserialize(params)
|
44
|
+
@AppId = params['AppId']
|
45
|
+
@ProxyOrganizationId = params['ProxyOrganizationId']
|
46
|
+
@ProxyAppId = params['ProxyAppId']
|
47
|
+
unless params['ProxyOperator'].nil?
|
48
|
+
@ProxyOperator = UserInfo.new
|
49
|
+
@ProxyOperator.deserialize(params['ProxyOperator'])
|
50
|
+
end
|
51
|
+
@ProxyOrganizationOpenId = params['ProxyOrganizationOpenId']
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
# 此结构体 (Component) 用于描述控件属性。
|
56
|
+
class Component < TencentCloud::Common::AbstractModel
|
57
|
+
# @param ComponentId: 控件编号
|
58
|
+
|
59
|
+
# 注:
|
60
|
+
# 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
|
61
|
+
# 例:
|
62
|
+
# 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
|
63
|
+
# 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
|
64
|
+
|
65
|
+
# 创建控件时,此值为空
|
66
|
+
# 查询时返回完整结构
|
67
|
+
# @type ComponentId: String
|
68
|
+
# @param ComponentType: 如果是Component控件类型,则可选的字段为:
|
69
|
+
# TEXT - 普通文本控件;
|
70
|
+
# DATE - 普通日期控件;跟TEXT相比会有校验逻辑
|
71
|
+
# 如果是SignComponent控件类型,则可选的字段为
|
72
|
+
# SIGN_SEAL - 签署印章控件;
|
73
|
+
# SIGN_DATE - 签署日期控件;
|
74
|
+
# SIGN_SIGNATURE - 用户签名控件;
|
75
|
+
# SIGN_PERSONAL_SEAL - 个人签署印章控件;
|
76
|
+
|
77
|
+
# 表单域的控件不能作为印章和签名控件
|
78
|
+
# @type ComponentType: String
|
79
|
+
# @param ComponentName: 控件简称
|
80
|
+
# @type ComponentName: String
|
81
|
+
# @param ComponentRequired: 定义控件是否为必填项,默认为false
|
82
|
+
# @type ComponentRequired: Boolean
|
83
|
+
# @param FileIndex: 控件所属文件的序号 (文档中文件的排列序号)
|
84
|
+
# @type FileIndex: Integer
|
85
|
+
# @param GenerateMode: 控件生成的方式:
|
86
|
+
# NORMAL - 普通控件
|
87
|
+
# FIELD - 表单域
|
88
|
+
# KEYWORD - 关键字
|
89
|
+
# @type GenerateMode: String
|
90
|
+
# @param ComponentWidth: 参数控件宽度,默认100,单位px
|
91
|
+
# 表单域和关键字转换控件不用填
|
92
|
+
# @type ComponentWidth: Float
|
93
|
+
# @param ComponentHeight: 参数控件高度,默认100,单位px
|
94
|
+
# 表单域和关键字转换控件不用填
|
95
|
+
# @type ComponentHeight: Float
|
96
|
+
# @param ComponentPage: 参数控件所在页码
|
97
|
+
# @type ComponentPage: Integer
|
98
|
+
# @param ComponentPosX: 参数控件X位置,单位px
|
99
|
+
# @type ComponentPosX: Float
|
100
|
+
# @param ComponentPosY: 参数控件Y位置,单位px
|
101
|
+
# @type ComponentPosY: Float
|
102
|
+
# @param ComponentExtra: 参数控件样式,json格式表述
|
103
|
+
# 不同类型的控件会有部分非通用参数
|
104
|
+
# TEXT控件可以指定字体
|
105
|
+
# 例如:{"FontSize":12}
|
106
|
+
# @type ComponentExtra: String
|
107
|
+
# @param ComponentValue: 印章 ID,传参 DEFAULT_COMPANY_SEAL 表示使用默认印章。
|
108
|
+
# 控件填入内容,印章控件里面,如果是手写签名内容为PNG图片格式的base64编码
|
109
|
+
# @type ComponentValue: String
|
110
|
+
# @param ComponentDateFontSize: 日期签署控件的字号,默认为 12
|
111
|
+
|
112
|
+
# 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
|
113
|
+
# @type ComponentDateFontSize: Integer
|
114
|
+
# @param DocumentId: 控件所属文档的Id, 模块相关接口为空值
|
115
|
+
# @type DocumentId: String
|
116
|
+
# @param ComponentDescription: 控件描述
|
117
|
+
# @type ComponentDescription: String
|
118
|
+
|
119
|
+
attr_accessor :ComponentId, :ComponentType, :ComponentName, :ComponentRequired, :FileIndex, :GenerateMode, :ComponentWidth, :ComponentHeight, :ComponentPage, :ComponentPosX, :ComponentPosY, :ComponentExtra, :ComponentValue, :ComponentDateFontSize, :DocumentId, :ComponentDescription
|
120
|
+
|
121
|
+
def initialize(componentid=nil, componenttype=nil, componentname=nil, componentrequired=nil, fileindex=nil, generatemode=nil, componentwidth=nil, componentheight=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentextra=nil, componentvalue=nil, componentdatefontsize=nil, documentid=nil, componentdescription=nil)
|
122
|
+
@ComponentId = componentid
|
123
|
+
@ComponentType = componenttype
|
124
|
+
@ComponentName = componentname
|
125
|
+
@ComponentRequired = componentrequired
|
126
|
+
@FileIndex = fileindex
|
127
|
+
@GenerateMode = generatemode
|
128
|
+
@ComponentWidth = componentwidth
|
129
|
+
@ComponentHeight = componentheight
|
130
|
+
@ComponentPage = componentpage
|
131
|
+
@ComponentPosX = componentposx
|
132
|
+
@ComponentPosY = componentposy
|
133
|
+
@ComponentExtra = componentextra
|
134
|
+
@ComponentValue = componentvalue
|
135
|
+
@ComponentDateFontSize = componentdatefontsize
|
136
|
+
@DocumentId = documentid
|
137
|
+
@ComponentDescription = componentdescription
|
138
|
+
end
|
139
|
+
|
140
|
+
def deserialize(params)
|
141
|
+
@ComponentId = params['ComponentId']
|
142
|
+
@ComponentType = params['ComponentType']
|
143
|
+
@ComponentName = params['ComponentName']
|
144
|
+
@ComponentRequired = params['ComponentRequired']
|
145
|
+
@FileIndex = params['FileIndex']
|
146
|
+
@GenerateMode = params['GenerateMode']
|
147
|
+
@ComponentWidth = params['ComponentWidth']
|
148
|
+
@ComponentHeight = params['ComponentHeight']
|
149
|
+
@ComponentPage = params['ComponentPage']
|
150
|
+
@ComponentPosX = params['ComponentPosX']
|
151
|
+
@ComponentPosY = params['ComponentPosY']
|
152
|
+
@ComponentExtra = params['ComponentExtra']
|
153
|
+
@ComponentValue = params['ComponentValue']
|
154
|
+
@ComponentDateFontSize = params['ComponentDateFontSize']
|
155
|
+
@DocumentId = params['DocumentId']
|
156
|
+
@ComponentDescription = params['ComponentDescription']
|
157
|
+
end
|
158
|
+
end
|
159
|
+
|
160
|
+
# CreateConsoleLoginUrl请求参数结构体
|
161
|
+
class CreateConsoleLoginUrlRequest < TencentCloud::Common::AbstractModel
|
162
|
+
# @param Agent: 应用信息
|
163
|
+
# 此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
|
164
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
165
|
+
# @param ProxyOrganizationName: 渠道侧合作企业名称
|
166
|
+
# @type ProxyOrganizationName: String
|
167
|
+
# @param UniformSocialCreditCode: 渠道侧合作企业统一社会信用代码
|
168
|
+
# @type UniformSocialCreditCode: String
|
169
|
+
# @param ProxyOperatorName: 渠道侧合作企业经办人的姓名
|
170
|
+
# @type ProxyOperatorName: String
|
171
|
+
# @param Operator: 操作者的信息
|
172
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
173
|
+
# @param Module: 控制台指定模块,文件/合同管理:"DOCUMENT",模版管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
|
174
|
+
# @type Module: String
|
175
|
+
# @param ModuleId: 控制台指定模块Id
|
176
|
+
# @type ModuleId: String
|
177
|
+
|
178
|
+
attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Operator, :Module, :ModuleId
|
179
|
+
|
180
|
+
def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, operator=nil, _module=nil, moduleid=nil)
|
181
|
+
@Agent = agent
|
182
|
+
@ProxyOrganizationName = proxyorganizationname
|
183
|
+
@UniformSocialCreditCode = uniformsocialcreditcode
|
184
|
+
@ProxyOperatorName = proxyoperatorname
|
185
|
+
@Operator = operator
|
186
|
+
@Module = _module
|
187
|
+
@ModuleId = moduleid
|
188
|
+
end
|
189
|
+
|
190
|
+
def deserialize(params)
|
191
|
+
unless params['Agent'].nil?
|
192
|
+
@Agent = Agent.new
|
193
|
+
@Agent.deserialize(params['Agent'])
|
194
|
+
end
|
195
|
+
@ProxyOrganizationName = params['ProxyOrganizationName']
|
196
|
+
@UniformSocialCreditCode = params['UniformSocialCreditCode']
|
197
|
+
@ProxyOperatorName = params['ProxyOperatorName']
|
198
|
+
unless params['Operator'].nil?
|
199
|
+
@Operator = UserInfo.new
|
200
|
+
@Operator.deserialize(params['Operator'])
|
201
|
+
end
|
202
|
+
@Module = params['Module']
|
203
|
+
@ModuleId = params['ModuleId']
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
# CreateConsoleLoginUrl返回参数结构体
|
208
|
+
class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
|
209
|
+
# @param ConsoleUrl: 控制台url
|
210
|
+
# @type ConsoleUrl: String
|
211
|
+
# @param IsActivated: 渠道合作企业是否认证开通腾讯电子签。
|
212
|
+
# 当渠道合作企业未完成认证开通腾讯电子签,建议先调用同步企业信息(SyncProxyOrganization)和同步经办人信息(SyncProxyOrganizationOperators)接口成功后再跳转到登录页面。
|
213
|
+
# @type IsActivated: Boolean
|
214
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
215
|
+
# @type RequestId: String
|
216
|
+
|
217
|
+
attr_accessor :ConsoleUrl, :IsActivated, :RequestId
|
218
|
+
|
219
|
+
def initialize(consoleurl=nil, isactivated=nil, requestid=nil)
|
220
|
+
@ConsoleUrl = consoleurl
|
221
|
+
@IsActivated = isactivated
|
222
|
+
@RequestId = requestid
|
223
|
+
end
|
224
|
+
|
225
|
+
def deserialize(params)
|
226
|
+
@ConsoleUrl = params['ConsoleUrl']
|
227
|
+
@IsActivated = params['IsActivated']
|
228
|
+
@RequestId = params['RequestId']
|
229
|
+
end
|
230
|
+
end
|
231
|
+
|
232
|
+
# CreateFlowsByTemplates请求参数结构体
|
233
|
+
class CreateFlowsByTemplatesRequest < TencentCloud::Common::AbstractModel
|
234
|
+
# @param Agent: 渠道应用相关信息
|
235
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
236
|
+
# @param FlowInfos: 多个合同(流程)信息
|
237
|
+
# @type FlowInfos: Array
|
238
|
+
# @param Operator: 操作者的信息
|
239
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
240
|
+
|
241
|
+
attr_accessor :Agent, :FlowInfos, :Operator
|
242
|
+
|
243
|
+
def initialize(agent=nil, flowinfos=nil, operator=nil)
|
244
|
+
@Agent = agent
|
245
|
+
@FlowInfos = flowinfos
|
246
|
+
@Operator = operator
|
247
|
+
end
|
248
|
+
|
249
|
+
def deserialize(params)
|
250
|
+
unless params['Agent'].nil?
|
251
|
+
@Agent = Agent.new
|
252
|
+
@Agent.deserialize(params['Agent'])
|
253
|
+
end
|
254
|
+
unless params['FlowInfos'].nil?
|
255
|
+
@FlowInfos = []
|
256
|
+
params['FlowInfos'].each do |i|
|
257
|
+
flowinfo_tmp = FlowInfo.new
|
258
|
+
flowinfo_tmp.deserialize(i)
|
259
|
+
@FlowInfos << flowinfo_tmp
|
260
|
+
end
|
261
|
+
end
|
262
|
+
unless params['Operator'].nil?
|
263
|
+
@Operator = UserInfo.new
|
264
|
+
@Operator.deserialize(params['Operator'])
|
265
|
+
end
|
266
|
+
end
|
267
|
+
end
|
268
|
+
|
269
|
+
# CreateFlowsByTemplates返回参数结构体
|
270
|
+
class CreateFlowsByTemplatesResponse < TencentCloud::Common::AbstractModel
|
271
|
+
# @param FlowIds: 多个合同ID
|
272
|
+
# @type FlowIds: Array
|
273
|
+
# @param CustomerData: 渠道的业务信息,限制1024字符
|
274
|
+
# @type CustomerData: Array
|
275
|
+
# @param ErrorMessages: 创建消息,对应多个合同ID,
|
276
|
+
# 成功为“”,创建失败则对应失败消息
|
277
|
+
# @type ErrorMessages: Array
|
278
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
279
|
+
# @type RequestId: String
|
280
|
+
|
281
|
+
attr_accessor :FlowIds, :CustomerData, :ErrorMessages, :RequestId
|
282
|
+
|
283
|
+
def initialize(flowids=nil, customerdata=nil, errormessages=nil, requestid=nil)
|
284
|
+
@FlowIds = flowids
|
285
|
+
@CustomerData = customerdata
|
286
|
+
@ErrorMessages = errormessages
|
287
|
+
@RequestId = requestid
|
288
|
+
end
|
289
|
+
|
290
|
+
def deserialize(params)
|
291
|
+
@FlowIds = params['FlowIds']
|
292
|
+
@CustomerData = params['CustomerData']
|
293
|
+
@ErrorMessages = params['ErrorMessages']
|
294
|
+
@RequestId = params['RequestId']
|
295
|
+
end
|
296
|
+
end
|
297
|
+
|
298
|
+
# CreateSignUrls请求参数结构体
|
299
|
+
class CreateSignUrlsRequest < TencentCloud::Common::AbstractModel
|
300
|
+
# @param Agent: 渠道应用相关信息
|
301
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
302
|
+
# @param FlowIds: 所签署合同ID数组
|
303
|
+
# @type FlowIds: Array
|
304
|
+
# @param Operator: 操作者的信息
|
305
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
306
|
+
# @param Endpoint: 签署链接类型,默认:“WEIXINAPP”-直接跳小程序; “CHANNEL”-跳转H5页面; “APP”-第三方APP或小程序跳转电子签小程序;
|
307
|
+
# @type Endpoint: String
|
308
|
+
# @param JumpUrl: 签署完成后H5引导页跳转URL
|
309
|
+
# @type JumpUrl: String
|
310
|
+
|
311
|
+
attr_accessor :Agent, :FlowIds, :Operator, :Endpoint, :JumpUrl
|
312
|
+
|
313
|
+
def initialize(agent=nil, flowids=nil, operator=nil, endpoint=nil, jumpurl=nil)
|
314
|
+
@Agent = agent
|
315
|
+
@FlowIds = flowids
|
316
|
+
@Operator = operator
|
317
|
+
@Endpoint = endpoint
|
318
|
+
@JumpUrl = jumpurl
|
319
|
+
end
|
320
|
+
|
321
|
+
def deserialize(params)
|
322
|
+
unless params['Agent'].nil?
|
323
|
+
@Agent = Agent.new
|
324
|
+
@Agent.deserialize(params['Agent'])
|
325
|
+
end
|
326
|
+
@FlowIds = params['FlowIds']
|
327
|
+
unless params['Operator'].nil?
|
328
|
+
@Operator = UserInfo.new
|
329
|
+
@Operator.deserialize(params['Operator'])
|
330
|
+
end
|
331
|
+
@Endpoint = params['Endpoint']
|
332
|
+
@JumpUrl = params['JumpUrl']
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
336
|
+
# CreateSignUrls返回参数结构体
|
337
|
+
class CreateSignUrlsResponse < TencentCloud::Common::AbstractModel
|
338
|
+
# @param SignUrlInfos: 签署参与者签署H5链接信息数组
|
339
|
+
# @type SignUrlInfos: Array
|
340
|
+
# @param ErrorMessages: 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
|
341
|
+
# @type ErrorMessages: Array
|
342
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
343
|
+
# @type RequestId: String
|
344
|
+
|
345
|
+
attr_accessor :SignUrlInfos, :ErrorMessages, :RequestId
|
346
|
+
|
347
|
+
def initialize(signurlinfos=nil, errormessages=nil, requestid=nil)
|
348
|
+
@SignUrlInfos = signurlinfos
|
349
|
+
@ErrorMessages = errormessages
|
350
|
+
@RequestId = requestid
|
351
|
+
end
|
352
|
+
|
353
|
+
def deserialize(params)
|
354
|
+
unless params['SignUrlInfos'].nil?
|
355
|
+
@SignUrlInfos = []
|
356
|
+
params['SignUrlInfos'].each do |i|
|
357
|
+
signurlinfo_tmp = SignUrlInfo.new
|
358
|
+
signurlinfo_tmp.deserialize(i)
|
359
|
+
@SignUrlInfos << signurlinfo_tmp
|
360
|
+
end
|
361
|
+
end
|
362
|
+
@ErrorMessages = params['ErrorMessages']
|
363
|
+
@RequestId = params['RequestId']
|
364
|
+
end
|
365
|
+
end
|
366
|
+
|
367
|
+
# DescribeResourceUrlsByFlows请求参数结构体
|
368
|
+
class DescribeResourceUrlsByFlowsRequest < TencentCloud::Common::AbstractModel
|
369
|
+
# @param Agent: 渠道应用相关信息
|
370
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
371
|
+
# @param Operator: 操作者的信息
|
372
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
373
|
+
# @param FlowIds: 查询资源所对应的流程Id
|
374
|
+
# @type FlowIds: Array
|
375
|
+
|
376
|
+
attr_accessor :Agent, :Operator, :FlowIds
|
377
|
+
|
378
|
+
def initialize(agent=nil, operator=nil, flowids=nil)
|
379
|
+
@Agent = agent
|
380
|
+
@Operator = operator
|
381
|
+
@FlowIds = flowids
|
382
|
+
end
|
383
|
+
|
384
|
+
def deserialize(params)
|
385
|
+
unless params['Agent'].nil?
|
386
|
+
@Agent = Agent.new
|
387
|
+
@Agent.deserialize(params['Agent'])
|
388
|
+
end
|
389
|
+
unless params['Operator'].nil?
|
390
|
+
@Operator = UserInfo.new
|
391
|
+
@Operator.deserialize(params['Operator'])
|
392
|
+
end
|
393
|
+
@FlowIds = params['FlowIds']
|
394
|
+
end
|
395
|
+
end
|
396
|
+
|
397
|
+
# DescribeResourceUrlsByFlows返回参数结构体
|
398
|
+
class DescribeResourceUrlsByFlowsResponse < TencentCloud::Common::AbstractModel
|
399
|
+
# @param FlowResourceUrlInfos: 流程资源对应链接信息
|
400
|
+
# @type FlowResourceUrlInfos: Array
|
401
|
+
# @param ErrorMessages: 创建消息,对应多个合同ID,
|
402
|
+
# 成功为“”,创建失败则对应失败消息
|
403
|
+
# @type ErrorMessages: Array
|
404
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
405
|
+
# @type RequestId: String
|
406
|
+
|
407
|
+
attr_accessor :FlowResourceUrlInfos, :ErrorMessages, :RequestId
|
408
|
+
|
409
|
+
def initialize(flowresourceurlinfos=nil, errormessages=nil, requestid=nil)
|
410
|
+
@FlowResourceUrlInfos = flowresourceurlinfos
|
411
|
+
@ErrorMessages = errormessages
|
412
|
+
@RequestId = requestid
|
413
|
+
end
|
414
|
+
|
415
|
+
def deserialize(params)
|
416
|
+
unless params['FlowResourceUrlInfos'].nil?
|
417
|
+
@FlowResourceUrlInfos = []
|
418
|
+
params['FlowResourceUrlInfos'].each do |i|
|
419
|
+
flowresourceurlinfo_tmp = FlowResourceUrlInfo.new
|
420
|
+
flowresourceurlinfo_tmp.deserialize(i)
|
421
|
+
@FlowResourceUrlInfos << flowresourceurlinfo_tmp
|
422
|
+
end
|
423
|
+
end
|
424
|
+
@ErrorMessages = params['ErrorMessages']
|
425
|
+
@RequestId = params['RequestId']
|
426
|
+
end
|
427
|
+
end
|
428
|
+
|
429
|
+
# DescribeTemplates请求参数结构体
|
430
|
+
class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
|
431
|
+
# @param Agent: 渠道应用相关信息
|
432
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
433
|
+
# @param Operator: 操作者的信息
|
434
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
435
|
+
# @param TemplateId: 模版唯一标识
|
436
|
+
# @type TemplateId: String
|
437
|
+
|
438
|
+
attr_accessor :Agent, :Operator, :TemplateId
|
439
|
+
|
440
|
+
def initialize(agent=nil, operator=nil, templateid=nil)
|
441
|
+
@Agent = agent
|
442
|
+
@Operator = operator
|
443
|
+
@TemplateId = templateid
|
444
|
+
end
|
445
|
+
|
446
|
+
def deserialize(params)
|
447
|
+
unless params['Agent'].nil?
|
448
|
+
@Agent = Agent.new
|
449
|
+
@Agent.deserialize(params['Agent'])
|
450
|
+
end
|
451
|
+
unless params['Operator'].nil?
|
452
|
+
@Operator = UserInfo.new
|
453
|
+
@Operator.deserialize(params['Operator'])
|
454
|
+
end
|
455
|
+
@TemplateId = params['TemplateId']
|
456
|
+
end
|
457
|
+
end
|
458
|
+
|
459
|
+
# DescribeTemplates返回参数结构体
|
460
|
+
class DescribeTemplatesResponse < TencentCloud::Common::AbstractModel
|
461
|
+
# @param Templates: 模板详情
|
462
|
+
# @type Templates: Array
|
463
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
464
|
+
# @type RequestId: String
|
465
|
+
|
466
|
+
attr_accessor :Templates, :RequestId
|
467
|
+
|
468
|
+
def initialize(templates=nil, requestid=nil)
|
469
|
+
@Templates = templates
|
470
|
+
@RequestId = requestid
|
471
|
+
end
|
472
|
+
|
473
|
+
def deserialize(params)
|
474
|
+
unless params['Templates'].nil?
|
475
|
+
@Templates = []
|
476
|
+
params['Templates'].each do |i|
|
477
|
+
templateinfo_tmp = TemplateInfo.new
|
478
|
+
templateinfo_tmp.deserialize(i)
|
479
|
+
@Templates << templateinfo_tmp
|
480
|
+
end
|
481
|
+
end
|
482
|
+
@RequestId = params['RequestId']
|
483
|
+
end
|
484
|
+
end
|
485
|
+
|
486
|
+
# DescribeUsage请求参数结构体
|
487
|
+
class DescribeUsageRequest < TencentCloud::Common::AbstractModel
|
488
|
+
# @param Agent: 应用信息
|
489
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
490
|
+
# @param StartDate: 开始时间 eg:2021-03-21
|
491
|
+
# @type StartDate: String
|
492
|
+
# @param EndDate: 结束时间 eg:2021-06-21
|
493
|
+
# 开始时间到结束时间的区间长度小于等于90天
|
494
|
+
# @type EndDate: String
|
495
|
+
# @param Operator: 操作者的信息
|
496
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
497
|
+
# @param NeedAggregate: 是否汇总数据,默认不汇总
|
498
|
+
# 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数
|
499
|
+
# 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据
|
500
|
+
# @type NeedAggregate: Boolean
|
501
|
+
# @param Limit: 单次返回的最多条目数量,默认为1000,且不能超过1000
|
502
|
+
# @type Limit: Integer
|
503
|
+
# @param Offset: 偏移量,默认是0
|
504
|
+
# @type Offset: Integer
|
505
|
+
|
506
|
+
attr_accessor :Agent, :StartDate, :EndDate, :Operator, :NeedAggregate, :Limit, :Offset
|
507
|
+
|
508
|
+
def initialize(agent=nil, startdate=nil, enddate=nil, operator=nil, needaggregate=nil, limit=nil, offset=nil)
|
509
|
+
@Agent = agent
|
510
|
+
@StartDate = startdate
|
511
|
+
@EndDate = enddate
|
512
|
+
@Operator = operator
|
513
|
+
@NeedAggregate = needaggregate
|
514
|
+
@Limit = limit
|
515
|
+
@Offset = offset
|
516
|
+
end
|
517
|
+
|
518
|
+
def deserialize(params)
|
519
|
+
unless params['Agent'].nil?
|
520
|
+
@Agent = Agent.new
|
521
|
+
@Agent.deserialize(params['Agent'])
|
522
|
+
end
|
523
|
+
@StartDate = params['StartDate']
|
524
|
+
@EndDate = params['EndDate']
|
525
|
+
unless params['Operator'].nil?
|
526
|
+
@Operator = UserInfo.new
|
527
|
+
@Operator.deserialize(params['Operator'])
|
528
|
+
end
|
529
|
+
@NeedAggregate = params['NeedAggregate']
|
530
|
+
@Limit = params['Limit']
|
531
|
+
@Offset = params['Offset']
|
532
|
+
end
|
533
|
+
end
|
534
|
+
|
535
|
+
# DescribeUsage返回参数结构体
|
536
|
+
class DescribeUsageResponse < TencentCloud::Common::AbstractModel
|
537
|
+
# @param Total: 用量明细条数
|
538
|
+
# @type Total: Integer
|
539
|
+
# @param Details: 用量明细
|
540
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
541
|
+
# @type Details: Array
|
542
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
543
|
+
# @type RequestId: String
|
544
|
+
|
545
|
+
attr_accessor :Total, :Details, :RequestId
|
546
|
+
|
547
|
+
def initialize(total=nil, details=nil, requestid=nil)
|
548
|
+
@Total = total
|
549
|
+
@Details = details
|
550
|
+
@RequestId = requestid
|
551
|
+
end
|
552
|
+
|
553
|
+
def deserialize(params)
|
554
|
+
@Total = params['Total']
|
555
|
+
unless params['Details'].nil?
|
556
|
+
@Details = []
|
557
|
+
params['Details'].each do |i|
|
558
|
+
usagedetail_tmp = UsageDetail.new
|
559
|
+
usagedetail_tmp.deserialize(i)
|
560
|
+
@Details << usagedetail_tmp
|
561
|
+
end
|
562
|
+
end
|
563
|
+
@RequestId = params['RequestId']
|
564
|
+
end
|
565
|
+
end
|
566
|
+
|
567
|
+
# 创建流程签署人入参
|
568
|
+
class FlowApproverInfo < TencentCloud::Common::AbstractModel
|
569
|
+
# @param Name: 签署人姓名
|
570
|
+
# @type Name: String
|
571
|
+
# @param Mobile: 签署人手机号,脱敏显示
|
572
|
+
# @type Mobile: String
|
573
|
+
# @param IdCardNumber: 经办人身份证号
|
574
|
+
# @type IdCardNumber: String
|
575
|
+
# @param JumpUrl: 签署完前端跳转的url,暂未使用
|
576
|
+
# @type JumpUrl: String
|
577
|
+
# @param Deadline: 签署截止时间
|
578
|
+
# @type Deadline: Integer
|
579
|
+
# @param CallbackUrl: 签署完回调url
|
580
|
+
# @type CallbackUrl: String
|
581
|
+
# @param ApproverType: 签署人类型,PERSON和ORGANIZATION
|
582
|
+
# @type ApproverType: String
|
583
|
+
# @param OpenId: 用户侧第三方id
|
584
|
+
# @type OpenId: String
|
585
|
+
|
586
|
+
attr_accessor :Name, :Mobile, :IdCardNumber, :JumpUrl, :Deadline, :CallbackUrl, :ApproverType, :OpenId
|
587
|
+
|
588
|
+
def initialize(name=nil, mobile=nil, idcardnumber=nil, jumpurl=nil, deadline=nil, callbackurl=nil, approvertype=nil, openid=nil)
|
589
|
+
@Name = name
|
590
|
+
@Mobile = mobile
|
591
|
+
@IdCardNumber = idcardnumber
|
592
|
+
@JumpUrl = jumpurl
|
593
|
+
@Deadline = deadline
|
594
|
+
@CallbackUrl = callbackurl
|
595
|
+
@ApproverType = approvertype
|
596
|
+
@OpenId = openid
|
597
|
+
end
|
598
|
+
|
599
|
+
def deserialize(params)
|
600
|
+
@Name = params['Name']
|
601
|
+
@Mobile = params['Mobile']
|
602
|
+
@IdCardNumber = params['IdCardNumber']
|
603
|
+
@JumpUrl = params['JumpUrl']
|
604
|
+
@Deadline = params['Deadline']
|
605
|
+
@CallbackUrl = params['CallbackUrl']
|
606
|
+
@ApproverType = params['ApproverType']
|
607
|
+
@OpenId = params['OpenId']
|
608
|
+
end
|
609
|
+
end
|
610
|
+
|
611
|
+
# 此结构体 (FlowInfo) 用于描述流程信息。
|
612
|
+
class FlowInfo < TencentCloud::Common::AbstractModel
|
613
|
+
# @param FlowName: 合同名字
|
614
|
+
# @type FlowName: String
|
615
|
+
# @param Deadline: 签署截止时间戳,超过有效签署时间则该签署流程失败
|
616
|
+
# @type Deadline: Integer
|
617
|
+
# @param TemplateId: 模版ID
|
618
|
+
# @type TemplateId: String
|
619
|
+
# @param FlowType: 合同类型:
|
620
|
+
# 1. “劳务”
|
621
|
+
# 2. “销售”
|
622
|
+
# 3. “租赁”
|
623
|
+
# 4. “其他”
|
624
|
+
# @type FlowType: String
|
625
|
+
# @param CallbackUrl: 回调地址
|
626
|
+
# @type CallbackUrl: String
|
627
|
+
# @param FlowApprovers: 多个签署人信息
|
628
|
+
# @type FlowApprovers: Array
|
629
|
+
# @param FormFields: 表单K-V对列表
|
630
|
+
# @type FormFields: Array
|
631
|
+
# @param FlowDescription: 合同描述
|
632
|
+
# @type FlowDescription: String
|
633
|
+
# @param CustomerData: 渠道的业务信息,限制1024字符
|
634
|
+
# @type CustomerData: String
|
635
|
+
|
636
|
+
attr_accessor :FlowName, :Deadline, :TemplateId, :FlowType, :CallbackUrl, :FlowApprovers, :FormFields, :FlowDescription, :CustomerData
|
637
|
+
|
638
|
+
def initialize(flowname=nil, deadline=nil, templateid=nil, flowtype=nil, callbackurl=nil, flowapprovers=nil, formfields=nil, flowdescription=nil, customerdata=nil)
|
639
|
+
@FlowName = flowname
|
640
|
+
@Deadline = deadline
|
641
|
+
@TemplateId = templateid
|
642
|
+
@FlowType = flowtype
|
643
|
+
@CallbackUrl = callbackurl
|
644
|
+
@FlowApprovers = flowapprovers
|
645
|
+
@FormFields = formfields
|
646
|
+
@FlowDescription = flowdescription
|
647
|
+
@CustomerData = customerdata
|
648
|
+
end
|
649
|
+
|
650
|
+
def deserialize(params)
|
651
|
+
@FlowName = params['FlowName']
|
652
|
+
@Deadline = params['Deadline']
|
653
|
+
@TemplateId = params['TemplateId']
|
654
|
+
@FlowType = params['FlowType']
|
655
|
+
@CallbackUrl = params['CallbackUrl']
|
656
|
+
unless params['FlowApprovers'].nil?
|
657
|
+
@FlowApprovers = []
|
658
|
+
params['FlowApprovers'].each do |i|
|
659
|
+
flowapproverinfo_tmp = FlowApproverInfo.new
|
660
|
+
flowapproverinfo_tmp.deserialize(i)
|
661
|
+
@FlowApprovers << flowapproverinfo_tmp
|
662
|
+
end
|
663
|
+
end
|
664
|
+
unless params['FormFields'].nil?
|
665
|
+
@FormFields = []
|
666
|
+
params['FormFields'].each do |i|
|
667
|
+
formfield_tmp = FormField.new
|
668
|
+
formfield_tmp.deserialize(i)
|
669
|
+
@FormFields << formfield_tmp
|
670
|
+
end
|
671
|
+
end
|
672
|
+
@FlowDescription = params['FlowDescription']
|
673
|
+
@CustomerData = params['CustomerData']
|
674
|
+
end
|
675
|
+
end
|
676
|
+
|
677
|
+
# 流程对应资源链接信息
|
678
|
+
class FlowResourceUrlInfo < TencentCloud::Common::AbstractModel
|
679
|
+
# @param FlowId: 流程对应Id
|
680
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
681
|
+
# @type FlowId: String
|
682
|
+
# @param ResourceUrlInfos: 流程对应资源链接信息数组
|
683
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
684
|
+
# @type ResourceUrlInfos: Array
|
685
|
+
|
686
|
+
attr_accessor :FlowId, :ResourceUrlInfos
|
687
|
+
|
688
|
+
def initialize(flowid=nil, resourceurlinfos=nil)
|
689
|
+
@FlowId = flowid
|
690
|
+
@ResourceUrlInfos = resourceurlinfos
|
691
|
+
end
|
692
|
+
|
693
|
+
def deserialize(params)
|
694
|
+
@FlowId = params['FlowId']
|
695
|
+
unless params['ResourceUrlInfos'].nil?
|
696
|
+
@ResourceUrlInfos = []
|
697
|
+
params['ResourceUrlInfos'].each do |i|
|
698
|
+
resourceurlinfo_tmp = ResourceUrlInfo.new
|
699
|
+
resourceurlinfo_tmp.deserialize(i)
|
700
|
+
@ResourceUrlInfos << resourceurlinfo_tmp
|
701
|
+
end
|
702
|
+
end
|
703
|
+
end
|
704
|
+
end
|
705
|
+
|
706
|
+
# 此结构 (FormField) 用于描述内容控件填充结构。
|
707
|
+
class FormField < TencentCloud::Common::AbstractModel
|
708
|
+
# @param ComponentValue: 表单域或控件的Value
|
709
|
+
# @type ComponentValue: String
|
710
|
+
# @param ComponentId: 表单域或控件的ID,跟ComponentName二选一,不能全为空
|
711
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
712
|
+
# @type ComponentId: String
|
713
|
+
# @param ComponentName: 控件的名字,跟ComponentId二选一,不能全为空
|
714
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
715
|
+
# @type ComponentName: String
|
716
|
+
|
717
|
+
attr_accessor :ComponentValue, :ComponentId, :ComponentName
|
718
|
+
|
719
|
+
def initialize(componentvalue=nil, componentid=nil, componentname=nil)
|
720
|
+
@ComponentValue = componentvalue
|
721
|
+
@ComponentId = componentid
|
722
|
+
@ComponentName = componentname
|
723
|
+
end
|
724
|
+
|
725
|
+
def deserialize(params)
|
726
|
+
@ComponentValue = params['ComponentValue']
|
727
|
+
@ComponentId = params['ComponentId']
|
728
|
+
@ComponentName = params['ComponentName']
|
729
|
+
end
|
730
|
+
end
|
731
|
+
|
732
|
+
# PrepareFlows请求参数结构体
|
733
|
+
class PrepareFlowsRequest < TencentCloud::Common::AbstractModel
|
734
|
+
# @param Agent: 渠道应用相关信息
|
735
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
736
|
+
# @param FlowInfos: 多个合同(流程)信息
|
737
|
+
# @type FlowInfos: Array
|
738
|
+
# @param JumpUrl: 操作完成后的跳转地址
|
739
|
+
# @type JumpUrl: String
|
740
|
+
# @param Operator: 操作者的信息
|
741
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
742
|
+
|
743
|
+
attr_accessor :Agent, :FlowInfos, :JumpUrl, :Operator
|
744
|
+
|
745
|
+
def initialize(agent=nil, flowinfos=nil, jumpurl=nil, operator=nil)
|
746
|
+
@Agent = agent
|
747
|
+
@FlowInfos = flowinfos
|
748
|
+
@JumpUrl = jumpurl
|
749
|
+
@Operator = operator
|
750
|
+
end
|
751
|
+
|
752
|
+
def deserialize(params)
|
753
|
+
unless params['Agent'].nil?
|
754
|
+
@Agent = Agent.new
|
755
|
+
@Agent.deserialize(params['Agent'])
|
756
|
+
end
|
757
|
+
unless params['FlowInfos'].nil?
|
758
|
+
@FlowInfos = []
|
759
|
+
params['FlowInfos'].each do |i|
|
760
|
+
flowinfo_tmp = FlowInfo.new
|
761
|
+
flowinfo_tmp.deserialize(i)
|
762
|
+
@FlowInfos << flowinfo_tmp
|
763
|
+
end
|
764
|
+
end
|
765
|
+
@JumpUrl = params['JumpUrl']
|
766
|
+
unless params['Operator'].nil?
|
767
|
+
@Operator = UserInfo.new
|
768
|
+
@Operator.deserialize(params['Operator'])
|
769
|
+
end
|
770
|
+
end
|
771
|
+
end
|
772
|
+
|
773
|
+
# PrepareFlows返回参数结构体
|
774
|
+
class PrepareFlowsResponse < TencentCloud::Common::AbstractModel
|
775
|
+
# @param ConfirmUrl: 待发起文件确认页
|
776
|
+
# @type ConfirmUrl: String
|
777
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
778
|
+
# @type RequestId: String
|
779
|
+
|
780
|
+
attr_accessor :ConfirmUrl, :RequestId
|
781
|
+
|
782
|
+
def initialize(confirmurl=nil, requestid=nil)
|
783
|
+
@ConfirmUrl = confirmurl
|
784
|
+
@RequestId = requestid
|
785
|
+
end
|
786
|
+
|
787
|
+
def deserialize(params)
|
788
|
+
@ConfirmUrl = params['ConfirmUrl']
|
789
|
+
@RequestId = params['RequestId']
|
790
|
+
end
|
791
|
+
end
|
792
|
+
|
793
|
+
# 合作企业经办人列表信息
|
794
|
+
class ProxyOrganizationOperator < TencentCloud::Common::AbstractModel
|
795
|
+
# @param Id: 经办人ID(渠道颁发)
|
796
|
+
# @type Id: String
|
797
|
+
# @param Name: 经办人姓名
|
798
|
+
# @type Name: String
|
799
|
+
# @param IdCardType: 经办人身份证件类型
|
800
|
+
# 用户证件类型:默认ID_CARD
|
801
|
+
# 1. ID_CARD - 居民身份证
|
802
|
+
# 2. HOUSEHOLD_REGISTER - 户口本
|
803
|
+
# 3. TEMP_ID_CARD - 临时居民身份证
|
804
|
+
# @type IdCardType: String
|
805
|
+
# @param IdCardNumber: 经办人身份证号
|
806
|
+
# @type IdCardNumber: String
|
807
|
+
# @param Mobile: 经办人手机号
|
808
|
+
# @type Mobile: String
|
809
|
+
|
810
|
+
attr_accessor :Id, :Name, :IdCardType, :IdCardNumber, :Mobile
|
811
|
+
|
812
|
+
def initialize(id=nil, name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil)
|
813
|
+
@Id = id
|
814
|
+
@Name = name
|
815
|
+
@IdCardType = idcardtype
|
816
|
+
@IdCardNumber = idcardnumber
|
817
|
+
@Mobile = mobile
|
818
|
+
end
|
819
|
+
|
820
|
+
def deserialize(params)
|
821
|
+
@Id = params['Id']
|
822
|
+
@Name = params['Name']
|
823
|
+
@IdCardType = params['IdCardType']
|
824
|
+
@IdCardNumber = params['IdCardNumber']
|
825
|
+
@Mobile = params['Mobile']
|
826
|
+
end
|
827
|
+
end
|
828
|
+
|
829
|
+
# 签署参与者信息
|
830
|
+
class Recipient < TencentCloud::Common::AbstractModel
|
831
|
+
# @param RecipientId: 签署人唯一标识
|
832
|
+
# @type RecipientId: String
|
833
|
+
# @param RecipientType: 签署方类型:ENTERPRISE-企业INDIVIDUAL-自然人
|
834
|
+
# @type RecipientType: String
|
835
|
+
# @param Description: 描述
|
836
|
+
# @type Description: String
|
837
|
+
# @param RoleName: 签署方备注信息
|
838
|
+
# @type RoleName: String
|
839
|
+
# @param RequireValidation: 是否需要校验
|
840
|
+
# @type RequireValidation: Boolean
|
841
|
+
# @param RequireSign: 是否必须填写
|
842
|
+
# @type RequireSign: Boolean
|
843
|
+
# @param SignType: 签署类型
|
844
|
+
# @type SignType: Integer
|
845
|
+
# @param RoutingOrder: 签署顺序:数字越小优先级越高
|
846
|
+
# @type RoutingOrder: Integer
|
847
|
+
|
848
|
+
attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :SignType, :RoutingOrder
|
849
|
+
|
850
|
+
def initialize(recipientid=nil, recipienttype=nil, description=nil, rolename=nil, requirevalidation=nil, requiresign=nil, signtype=nil, routingorder=nil)
|
851
|
+
@RecipientId = recipientid
|
852
|
+
@RecipientType = recipienttype
|
853
|
+
@Description = description
|
854
|
+
@RoleName = rolename
|
855
|
+
@RequireValidation = requirevalidation
|
856
|
+
@RequireSign = requiresign
|
857
|
+
@SignType = signtype
|
858
|
+
@RoutingOrder = routingorder
|
859
|
+
end
|
860
|
+
|
861
|
+
def deserialize(params)
|
862
|
+
@RecipientId = params['RecipientId']
|
863
|
+
@RecipientType = params['RecipientType']
|
864
|
+
@Description = params['Description']
|
865
|
+
@RoleName = params['RoleName']
|
866
|
+
@RequireValidation = params['RequireValidation']
|
867
|
+
@RequireSign = params['RequireSign']
|
868
|
+
@SignType = params['SignType']
|
869
|
+
@RoutingOrder = params['RoutingOrder']
|
870
|
+
end
|
871
|
+
end
|
872
|
+
|
873
|
+
# 资源链接信息
|
874
|
+
class ResourceUrlInfo < TencentCloud::Common::AbstractModel
|
875
|
+
# @param Url: 资源链接地址,过期时间5分钟
|
876
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
877
|
+
# @type Url: String
|
878
|
+
# @param Name: 资源名称
|
879
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
880
|
+
# @type Name: String
|
881
|
+
# @param Type: 资源类型
|
882
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
883
|
+
# @type Type: String
|
884
|
+
|
885
|
+
attr_accessor :Url, :Name, :Type
|
886
|
+
|
887
|
+
def initialize(url=nil, name=nil, type=nil)
|
888
|
+
@Url = url
|
889
|
+
@Name = name
|
890
|
+
@Type = type
|
891
|
+
end
|
892
|
+
|
893
|
+
def deserialize(params)
|
894
|
+
@Url = params['Url']
|
895
|
+
@Name = params['Name']
|
896
|
+
@Type = params['Type']
|
897
|
+
end
|
898
|
+
end
|
899
|
+
|
900
|
+
# 签署链接内容
|
901
|
+
class SignUrlInfo < TencentCloud::Common::AbstractModel
|
902
|
+
# @param SignUrl: 签署链接
|
903
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
904
|
+
# @type SignUrl: String
|
905
|
+
# @param Deadline: 链接失效时间
|
906
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
907
|
+
# @type Deadline: Integer
|
908
|
+
# @param SignOrder: 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
909
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
910
|
+
# @type SignOrder: Integer
|
911
|
+
# @param SignId: 签署人编号
|
912
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
913
|
+
# @type SignId: String
|
914
|
+
# @param CustomUserId: 自定义用户编号
|
915
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
916
|
+
# @type CustomUserId: String
|
917
|
+
# @param Name: 用户姓名
|
918
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
919
|
+
# @type Name: String
|
920
|
+
# @param Mobile: 用户手机号码
|
921
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
922
|
+
# @type Mobile: String
|
923
|
+
# @param OrganizationName: 签署参与者机构名字
|
924
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
925
|
+
# @type OrganizationName: String
|
926
|
+
# @param ApproverType: 参与者类型:
|
927
|
+
# ORGANIZATION 企业经办人
|
928
|
+
# PERSON 自然人
|
929
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
930
|
+
# @type ApproverType: String
|
931
|
+
# @param IdCardNumber: 经办人身份证号
|
932
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
933
|
+
# @type IdCardNumber: String
|
934
|
+
# @param FlowId: 签署链接对应流程Id
|
935
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
936
|
+
# @type FlowId: String
|
937
|
+
# @param OpenId: 企业经办人 用户在渠道的编号
|
938
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
939
|
+
# @type OpenId: String
|
940
|
+
|
941
|
+
attr_accessor :SignUrl, :Deadline, :SignOrder, :SignId, :CustomUserId, :Name, :Mobile, :OrganizationName, :ApproverType, :IdCardNumber, :FlowId, :OpenId
|
942
|
+
|
943
|
+
def initialize(signurl=nil, deadline=nil, signorder=nil, signid=nil, customuserid=nil, name=nil, mobile=nil, organizationname=nil, approvertype=nil, idcardnumber=nil, flowid=nil, openid=nil)
|
944
|
+
@SignUrl = signurl
|
945
|
+
@Deadline = deadline
|
946
|
+
@SignOrder = signorder
|
947
|
+
@SignId = signid
|
948
|
+
@CustomUserId = customuserid
|
949
|
+
@Name = name
|
950
|
+
@Mobile = mobile
|
951
|
+
@OrganizationName = organizationname
|
952
|
+
@ApproverType = approvertype
|
953
|
+
@IdCardNumber = idcardnumber
|
954
|
+
@FlowId = flowid
|
955
|
+
@OpenId = openid
|
956
|
+
end
|
957
|
+
|
958
|
+
def deserialize(params)
|
959
|
+
@SignUrl = params['SignUrl']
|
960
|
+
@Deadline = params['Deadline']
|
961
|
+
@SignOrder = params['SignOrder']
|
962
|
+
@SignId = params['SignId']
|
963
|
+
@CustomUserId = params['CustomUserId']
|
964
|
+
@Name = params['Name']
|
965
|
+
@Mobile = params['Mobile']
|
966
|
+
@OrganizationName = params['OrganizationName']
|
967
|
+
@ApproverType = params['ApproverType']
|
968
|
+
@IdCardNumber = params['IdCardNumber']
|
969
|
+
@FlowId = params['FlowId']
|
970
|
+
@OpenId = params['OpenId']
|
971
|
+
end
|
972
|
+
end
|
973
|
+
|
974
|
+
# 同步经办人失败原因
|
975
|
+
class SyncFailReason < TencentCloud::Common::AbstractModel
|
976
|
+
# @param Id: 经办人Id
|
977
|
+
# @type Id: String
|
978
|
+
# @param Message: 失败原因
|
979
|
+
# 例如:Id不符合规范、证件号码不合法等
|
980
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
981
|
+
# @type Message: String
|
982
|
+
|
983
|
+
attr_accessor :Id, :Message
|
984
|
+
|
985
|
+
def initialize(id=nil, message=nil)
|
986
|
+
@Id = id
|
987
|
+
@Message = message
|
988
|
+
end
|
989
|
+
|
990
|
+
def deserialize(params)
|
991
|
+
@Id = params['Id']
|
992
|
+
@Message = params['Message']
|
993
|
+
end
|
994
|
+
end
|
995
|
+
|
996
|
+
# SyncProxyOrganizationOperators请求参数结构体
|
997
|
+
class SyncProxyOrganizationOperatorsRequest < TencentCloud::Common::AbstractModel
|
998
|
+
# @param OperatorType: 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
|
999
|
+
# @type OperatorType: String
|
1000
|
+
# @param Agent: 应用信息
|
1001
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
1002
|
+
# @param ProxyOrganizationOperators: 经办人信息列表
|
1003
|
+
# @type ProxyOrganizationOperators: Array
|
1004
|
+
# @param Operator: 操作者的信息
|
1005
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
1006
|
+
|
1007
|
+
attr_accessor :OperatorType, :Agent, :ProxyOrganizationOperators, :Operator
|
1008
|
+
|
1009
|
+
def initialize(operatortype=nil, agent=nil, proxyorganizationoperators=nil, operator=nil)
|
1010
|
+
@OperatorType = operatortype
|
1011
|
+
@Agent = agent
|
1012
|
+
@ProxyOrganizationOperators = proxyorganizationoperators
|
1013
|
+
@Operator = operator
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
def deserialize(params)
|
1017
|
+
@OperatorType = params['OperatorType']
|
1018
|
+
unless params['Agent'].nil?
|
1019
|
+
@Agent = Agent.new
|
1020
|
+
@Agent.deserialize(params['Agent'])
|
1021
|
+
end
|
1022
|
+
unless params['ProxyOrganizationOperators'].nil?
|
1023
|
+
@ProxyOrganizationOperators = []
|
1024
|
+
params['ProxyOrganizationOperators'].each do |i|
|
1025
|
+
proxyorganizationoperator_tmp = ProxyOrganizationOperator.new
|
1026
|
+
proxyorganizationoperator_tmp.deserialize(i)
|
1027
|
+
@ProxyOrganizationOperators << proxyorganizationoperator_tmp
|
1028
|
+
end
|
1029
|
+
end
|
1030
|
+
unless params['Operator'].nil?
|
1031
|
+
@Operator = UserInfo.new
|
1032
|
+
@Operator.deserialize(params['Operator'])
|
1033
|
+
end
|
1034
|
+
end
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# SyncProxyOrganizationOperators返回参数结构体
|
1038
|
+
class SyncProxyOrganizationOperatorsResponse < TencentCloud::Common::AbstractModel
|
1039
|
+
# @param Status: Status 同步状态,全部同步失败接口会直接报错
|
1040
|
+
# 1-成功
|
1041
|
+
# 2-部分成功
|
1042
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
1043
|
+
# @type Status: Integer
|
1044
|
+
# @param FailedList: 同步失败经办人及其失败原因
|
1045
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
1046
|
+
# @type FailedList: Array
|
1047
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1048
|
+
# @type RequestId: String
|
1049
|
+
|
1050
|
+
attr_accessor :Status, :FailedList, :RequestId
|
1051
|
+
|
1052
|
+
def initialize(status=nil, failedlist=nil, requestid=nil)
|
1053
|
+
@Status = status
|
1054
|
+
@FailedList = failedlist
|
1055
|
+
@RequestId = requestid
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
def deserialize(params)
|
1059
|
+
@Status = params['Status']
|
1060
|
+
unless params['FailedList'].nil?
|
1061
|
+
@FailedList = []
|
1062
|
+
params['FailedList'].each do |i|
|
1063
|
+
syncfailreason_tmp = SyncFailReason.new
|
1064
|
+
syncfailreason_tmp.deserialize(i)
|
1065
|
+
@FailedList << syncfailreason_tmp
|
1066
|
+
end
|
1067
|
+
end
|
1068
|
+
@RequestId = params['RequestId']
|
1069
|
+
end
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# SyncProxyOrganization请求参数结构体
|
1073
|
+
class SyncProxyOrganizationRequest < TencentCloud::Common::AbstractModel
|
1074
|
+
# @param Agent: 应用信息
|
1075
|
+
# 此接口Agent.ProxyOrganizationOpenId必填
|
1076
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
1077
|
+
# @param ProxyOrganizationName: 渠道侧合作企业名称
|
1078
|
+
# @type ProxyOrganizationName: String
|
1079
|
+
# @param UniformSocialCreditCode: 渠道侧合作企业统一社会信用代码
|
1080
|
+
# @type UniformSocialCreditCode: String
|
1081
|
+
# @param BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
|
1082
|
+
# @type BusinessLicense: String
|
1083
|
+
# @param Operator: 操作者的信息
|
1084
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
1085
|
+
|
1086
|
+
attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :BusinessLicense, :Operator
|
1087
|
+
|
1088
|
+
def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, businesslicense=nil, operator=nil)
|
1089
|
+
@Agent = agent
|
1090
|
+
@ProxyOrganizationName = proxyorganizationname
|
1091
|
+
@UniformSocialCreditCode = uniformsocialcreditcode
|
1092
|
+
@BusinessLicense = businesslicense
|
1093
|
+
@Operator = operator
|
1094
|
+
end
|
1095
|
+
|
1096
|
+
def deserialize(params)
|
1097
|
+
unless params['Agent'].nil?
|
1098
|
+
@Agent = Agent.new
|
1099
|
+
@Agent.deserialize(params['Agent'])
|
1100
|
+
end
|
1101
|
+
@ProxyOrganizationName = params['ProxyOrganizationName']
|
1102
|
+
@UniformSocialCreditCode = params['UniformSocialCreditCode']
|
1103
|
+
@BusinessLicense = params['BusinessLicense']
|
1104
|
+
unless params['Operator'].nil?
|
1105
|
+
@Operator = UserInfo.new
|
1106
|
+
@Operator.deserialize(params['Operator'])
|
1107
|
+
end
|
1108
|
+
end
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# SyncProxyOrganization返回参数结构体
|
1112
|
+
class SyncProxyOrganizationResponse < TencentCloud::Common::AbstractModel
|
1113
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1114
|
+
# @type RequestId: String
|
1115
|
+
|
1116
|
+
attr_accessor :RequestId
|
1117
|
+
|
1118
|
+
def initialize(requestid=nil)
|
1119
|
+
@RequestId = requestid
|
1120
|
+
end
|
1121
|
+
|
1122
|
+
def deserialize(params)
|
1123
|
+
@RequestId = params['RequestId']
|
1124
|
+
end
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# 此结构体 (TemplateInfo) 用于描述模板的信息。
|
1128
|
+
class TemplateInfo < TencentCloud::Common::AbstractModel
|
1129
|
+
# @param TemplateId: 模板ID
|
1130
|
+
# @type TemplateId: String
|
1131
|
+
# @param TemplateName: 模板名字
|
1132
|
+
# @type TemplateName: String
|
1133
|
+
# @param Description: 模板描述信息
|
1134
|
+
# @type Description: String
|
1135
|
+
# @param Components: 模板控件信息结构
|
1136
|
+
# @type Components: Array
|
1137
|
+
# @param SignComponents: 签署区模板信息结构
|
1138
|
+
# @type SignComponents: Array
|
1139
|
+
# @param Creator: 模板的创建者信息
|
1140
|
+
# @type Creator: String
|
1141
|
+
# @param CreatedOn: 模板创建的时间戳(精确到秒)
|
1142
|
+
# @type CreatedOn: Integer
|
1143
|
+
# @param TemplateType: 模板类型:1-静默签;2-静默签授权;3-普通模版
|
1144
|
+
# @type TemplateType: Integer
|
1145
|
+
# @param Recipients: 模板中的流程参与人信息
|
1146
|
+
# @type Recipients: Array
|
1147
|
+
|
1148
|
+
attr_accessor :TemplateId, :TemplateName, :Description, :Components, :SignComponents, :Creator, :CreatedOn, :TemplateType, :Recipients
|
1149
|
+
|
1150
|
+
def initialize(templateid=nil, templatename=nil, description=nil, components=nil, signcomponents=nil, creator=nil, createdon=nil, templatetype=nil, recipients=nil)
|
1151
|
+
@TemplateId = templateid
|
1152
|
+
@TemplateName = templatename
|
1153
|
+
@Description = description
|
1154
|
+
@Components = components
|
1155
|
+
@SignComponents = signcomponents
|
1156
|
+
@Creator = creator
|
1157
|
+
@CreatedOn = createdon
|
1158
|
+
@TemplateType = templatetype
|
1159
|
+
@Recipients = recipients
|
1160
|
+
end
|
1161
|
+
|
1162
|
+
def deserialize(params)
|
1163
|
+
@TemplateId = params['TemplateId']
|
1164
|
+
@TemplateName = params['TemplateName']
|
1165
|
+
@Description = params['Description']
|
1166
|
+
unless params['Components'].nil?
|
1167
|
+
@Components = []
|
1168
|
+
params['Components'].each do |i|
|
1169
|
+
component_tmp = Component.new
|
1170
|
+
component_tmp.deserialize(i)
|
1171
|
+
@Components << component_tmp
|
1172
|
+
end
|
1173
|
+
end
|
1174
|
+
unless params['SignComponents'].nil?
|
1175
|
+
@SignComponents = []
|
1176
|
+
params['SignComponents'].each do |i|
|
1177
|
+
component_tmp = Component.new
|
1178
|
+
component_tmp.deserialize(i)
|
1179
|
+
@SignComponents << component_tmp
|
1180
|
+
end
|
1181
|
+
end
|
1182
|
+
@Creator = params['Creator']
|
1183
|
+
@CreatedOn = params['CreatedOn']
|
1184
|
+
@TemplateType = params['TemplateType']
|
1185
|
+
unless params['Recipients'].nil?
|
1186
|
+
@Recipients = []
|
1187
|
+
params['Recipients'].each do |i|
|
1188
|
+
recipient_tmp = Recipient.new
|
1189
|
+
recipient_tmp.deserialize(i)
|
1190
|
+
@Recipients << recipient_tmp
|
1191
|
+
end
|
1192
|
+
end
|
1193
|
+
end
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
# 用量明细
|
1197
|
+
class UsageDetail < TencentCloud::Common::AbstractModel
|
1198
|
+
# @param ProxyOrganizationOpenId: 渠道侧合作企业唯一标识
|
1199
|
+
# @type ProxyOrganizationOpenId: String
|
1200
|
+
# @param Usage: 消耗量
|
1201
|
+
# @type Usage: Integer
|
1202
|
+
# @param Date: 日期,当需要汇总数据时日期为空
|
1203
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
1204
|
+
# @type Date: String
|
1205
|
+
# @param ProxyOrganizationName: 渠道侧合作企业名
|
1206
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
1207
|
+
# @type ProxyOrganizationName: String
|
1208
|
+
|
1209
|
+
attr_accessor :ProxyOrganizationOpenId, :Usage, :Date, :ProxyOrganizationName
|
1210
|
+
|
1211
|
+
def initialize(proxyorganizationopenid=nil, usage=nil, date=nil, proxyorganizationname=nil)
|
1212
|
+
@ProxyOrganizationOpenId = proxyorganizationopenid
|
1213
|
+
@Usage = usage
|
1214
|
+
@Date = date
|
1215
|
+
@ProxyOrganizationName = proxyorganizationname
|
1216
|
+
end
|
1217
|
+
|
1218
|
+
def deserialize(params)
|
1219
|
+
@ProxyOrganizationOpenId = params['ProxyOrganizationOpenId']
|
1220
|
+
@Usage = params['Usage']
|
1221
|
+
@Date = params['Date']
|
1222
|
+
@ProxyOrganizationName = params['ProxyOrganizationName']
|
1223
|
+
end
|
1224
|
+
end
|
1225
|
+
|
1226
|
+
# 接口调用者信息
|
1227
|
+
class UserInfo < TencentCloud::Common::AbstractModel
|
1228
|
+
# @param CustomUserId: 自定义用户编号
|
1229
|
+
# @type CustomUserId: String
|
1230
|
+
# @param Channel: 用户的来源渠道
|
1231
|
+
# @type Channel: String
|
1232
|
+
# @param OpenId: 用户在渠道的编号
|
1233
|
+
# @type OpenId: String
|
1234
|
+
# @param ClientIp: 用户真实IP
|
1235
|
+
# @type ClientIp: String
|
1236
|
+
# @param ProxyIp: 用户代理IP
|
1237
|
+
# @type ProxyIp: String
|
1238
|
+
|
1239
|
+
attr_accessor :CustomUserId, :Channel, :OpenId, :ClientIp, :ProxyIp
|
1240
|
+
|
1241
|
+
def initialize(customuserid=nil, channel=nil, openid=nil, clientip=nil, proxyip=nil)
|
1242
|
+
@CustomUserId = customuserid
|
1243
|
+
@Channel = channel
|
1244
|
+
@OpenId = openid
|
1245
|
+
@ClientIp = clientip
|
1246
|
+
@ProxyIp = proxyip
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
def deserialize(params)
|
1250
|
+
@CustomUserId = params['CustomUserId']
|
1251
|
+
@Channel = params['Channel']
|
1252
|
+
@OpenId = params['OpenId']
|
1253
|
+
@ClientIp = params['ClientIp']
|
1254
|
+
@ProxyIp = params['ProxyIp']
|
1255
|
+
end
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
end
|
1259
|
+
end
|
1260
|
+
end
|
1261
|
+
|