tencentcloud-sdk-ess 1.0.363 → 3.0.379
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 +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +73 -0
- data/lib/v20201111/models.rb +457 -167
- metadata +10 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f499ded35839e4ede68e7aa47f66ffc9dffcf49d
|
4
|
+
data.tar.gz: e98662c67be6654e93c9d5e4665614cd27140e58
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4e7cadab1c62fbf04fc4076d3ec42d98f085faa79aec7a5cc57ef244f7e3d0e195fcd46e09cc9dfc60e355de1b4d52c9af2dcfc970129f141d1504634ad16ab9
|
7
|
+
data.tar.gz: 4366df594898f507a032c81611cd074ff893308181d07ba5792ad86a36565ef54cc8d1d311a2363f572601705006d575f585a9008e9d2e5e6f6ccd53dae02a7f
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
3.0.379
|
data/lib/v20201111/client.rb
CHANGED
@@ -79,6 +79,55 @@ module TencentCloud
|
|
79
79
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
80
80
|
end
|
81
81
|
|
82
|
+
# 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
83
|
+
# 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
84
|
+
|
85
|
+
# @param request: Request instance for CreateBatchCancelFlowUrl.
|
86
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`
|
87
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlResponse`
|
88
|
+
def CreateBatchCancelFlowUrl(request)
|
89
|
+
body = send_request('CreateBatchCancelFlowUrl', request.serialize)
|
90
|
+
response = JSON.parse(body)
|
91
|
+
if response['Response'].key?('Error') == false
|
92
|
+
model = CreateBatchCancelFlowUrlResponse.new
|
93
|
+
model.deserialize(response['Response'])
|
94
|
+
model
|
95
|
+
else
|
96
|
+
code = response['Response']['Error']['Code']
|
97
|
+
message = response['Response']['Error']['Message']
|
98
|
+
reqid = response['Response']['RequestId']
|
99
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
100
|
+
end
|
101
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
102
|
+
raise e
|
103
|
+
rescue StandardError => e
|
104
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
105
|
+
end
|
106
|
+
|
107
|
+
# 创建文件转换任务
|
108
|
+
|
109
|
+
# @param request: Request instance for CreateConvertTaskApi.
|
110
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiRequest`
|
111
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiResponse`
|
112
|
+
def CreateConvertTaskApi(request)
|
113
|
+
body = send_request('CreateConvertTaskApi', request.serialize)
|
114
|
+
response = JSON.parse(body)
|
115
|
+
if response['Response'].key?('Error') == false
|
116
|
+
model = CreateConvertTaskApiResponse.new
|
117
|
+
model.deserialize(response['Response'])
|
118
|
+
model
|
119
|
+
else
|
120
|
+
code = response['Response']['Error']['Code']
|
121
|
+
message = response['Response']['Error']['Message']
|
122
|
+
reqid = response['Response']['RequestId']
|
123
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
124
|
+
end
|
125
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
126
|
+
raise e
|
127
|
+
rescue StandardError => e
|
128
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
129
|
+
end
|
130
|
+
|
82
131
|
# 创建签署流程电子文档
|
83
132
|
# 适用场景:见创建签署流程接口。
|
84
133
|
|
@@ -318,6 +367,30 @@ module TencentCloud
|
|
318
367
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
319
368
|
end
|
320
369
|
|
370
|
+
# 查询转换任务状态
|
371
|
+
|
372
|
+
# @param request: Request instance for GetTaskResultApi.
|
373
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest`
|
374
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiResponse`
|
375
|
+
def GetTaskResultApi(request)
|
376
|
+
body = send_request('GetTaskResultApi', request.serialize)
|
377
|
+
response = JSON.parse(body)
|
378
|
+
if response['Response'].key?('Error') == false
|
379
|
+
model = GetTaskResultApiResponse.new
|
380
|
+
model.deserialize(response['Response'])
|
381
|
+
model
|
382
|
+
else
|
383
|
+
code = response['Response']['Error']['Code']
|
384
|
+
message = response['Response']['Error']['Message']
|
385
|
+
reqid = response['Response']['RequestId']
|
386
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
387
|
+
end
|
388
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
389
|
+
raise e
|
390
|
+
rescue StandardError => e
|
391
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
392
|
+
end
|
393
|
+
|
321
394
|
# 此接口用于发起流程
|
322
395
|
# 适用场景:见创建签署流程接口。
|
323
396
|
# 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
data/lib/v20201111/models.rb
CHANGED
@@ -40,7 +40,7 @@ module TencentCloud
|
|
40
40
|
# @type ApproverName: String
|
41
41
|
# @param ApproverMobile: 本环节需要操作人的手机号
|
42
42
|
# @type ApproverMobile: String
|
43
|
-
# @param SignComponents:
|
43
|
+
# @param SignComponents: 本环节操作人签署控件配置
|
44
44
|
# @type SignComponents: Array
|
45
45
|
# @param OrganizationName: 如果是企业,则为企业的名字
|
46
46
|
# @type OrganizationName: String
|
@@ -98,6 +98,34 @@ module TencentCloud
|
|
98
98
|
end
|
99
99
|
end
|
100
100
|
|
101
|
+
# 指定签署人限制项
|
102
|
+
class ApproverRestriction < TencentCloud::Common::AbstractModel
|
103
|
+
# @param Name: 指定签署人名字
|
104
|
+
# @type Name: String
|
105
|
+
# @param Mobile: 指定签署人手机号
|
106
|
+
# @type Mobile: String
|
107
|
+
# @param IdCardType: 指定签署人证件类型
|
108
|
+
# @type IdCardType: String
|
109
|
+
# @param IdCardNumber: 指定签署人证件号码
|
110
|
+
# @type IdCardNumber: String
|
111
|
+
|
112
|
+
attr_accessor :Name, :Mobile, :IdCardType, :IdCardNumber
|
113
|
+
|
114
|
+
def initialize(name=nil, mobile=nil, idcardtype=nil, idcardnumber=nil)
|
115
|
+
@Name = name
|
116
|
+
@Mobile = mobile
|
117
|
+
@IdCardType = idcardtype
|
118
|
+
@IdCardNumber = idcardnumber
|
119
|
+
end
|
120
|
+
|
121
|
+
def deserialize(params)
|
122
|
+
@Name = params['Name']
|
123
|
+
@Mobile = params['Mobile']
|
124
|
+
@IdCardType = params['IdCardType']
|
125
|
+
@IdCardNumber = params['IdCardNumber']
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
101
129
|
# 此结构体 (Caller) 用于描述调用方属性。
|
102
130
|
class Caller < TencentCloud::Common::AbstractModel
|
103
131
|
# @param ApplicationId: 应用号
|
@@ -128,31 +156,31 @@ module TencentCloud
|
|
128
156
|
|
129
157
|
# CancelFlow请求参数结构体
|
130
158
|
class CancelFlowRequest < TencentCloud::Common::AbstractModel
|
159
|
+
# @param Operator: 调用方用户信息,userId 必填
|
160
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
131
161
|
# @param FlowId: 签署流程id
|
132
162
|
# @type FlowId: String
|
133
163
|
# @param CancelMessage: 撤销原因,最长200个字符;
|
134
164
|
# @type CancelMessage: String
|
135
|
-
# @param Operator: 操作用户id
|
136
|
-
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
137
165
|
# @param Agent: 应用相关信息
|
138
166
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
139
167
|
|
140
|
-
attr_accessor :
|
168
|
+
attr_accessor :Operator, :FlowId, :CancelMessage, :Agent
|
141
169
|
|
142
|
-
def initialize(
|
170
|
+
def initialize(operator=nil, flowid=nil, cancelmessage=nil, agent=nil)
|
171
|
+
@Operator = operator
|
143
172
|
@FlowId = flowid
|
144
173
|
@CancelMessage = cancelmessage
|
145
|
-
@Operator = operator
|
146
174
|
@Agent = agent
|
147
175
|
end
|
148
176
|
|
149
177
|
def deserialize(params)
|
150
|
-
@FlowId = params['FlowId']
|
151
|
-
@CancelMessage = params['CancelMessage']
|
152
178
|
unless params['Operator'].nil?
|
153
179
|
@Operator = UserInfo.new
|
154
180
|
@Operator.deserialize(params['Operator'])
|
155
181
|
end
|
182
|
+
@FlowId = params['FlowId']
|
183
|
+
@CancelMessage = params['CancelMessage']
|
156
184
|
unless params['Agent'].nil?
|
157
185
|
@Agent = Agent.new
|
158
186
|
@Agent.deserialize(params['Agent'])
|
@@ -241,13 +269,15 @@ module TencentCloud
|
|
241
269
|
# 模板控件信息
|
242
270
|
class Component < TencentCloud::Common::AbstractModel
|
243
271
|
# @param ComponentType: 如果是 Component 控件类型,则可选类型为:
|
244
|
-
# TEXT -
|
245
|
-
#
|
246
|
-
# CHECK_BOX -
|
272
|
+
# TEXT - 单行文本
|
273
|
+
# MULTI_LINE_TEXT - 多行文本
|
274
|
+
# CHECK_BOX - 勾选框
|
275
|
+
# ATTACHMENT - 附件
|
276
|
+
# SELECTOR - 选择器
|
247
277
|
# 如果是 SignComponent 控件类型,则可选类型为:
|
248
|
-
# SIGN_SEAL -
|
278
|
+
# SIGN_SEAL - 签署印章控件,静默签署时需要传入印章id作为ComponentValue
|
249
279
|
# SIGN_DATE - 签署日期控件
|
250
|
-
# SIGN_SIGNATURE -
|
280
|
+
# SIGN_SIGNATURE - 手写签名控件,静默签署时不能使用
|
251
281
|
# @type ComponentType: String
|
252
282
|
# @param ComponentWidth: 参数控件宽度,单位pt
|
253
283
|
# @type ComponentWidth: Float
|
@@ -279,7 +309,12 @@ module TencentCloud
|
|
279
309
|
# @type ComponentExtra: String
|
280
310
|
# @param ComponentRecipientId: 控件关联的签署人ID
|
281
311
|
# @type ComponentRecipientId: String
|
282
|
-
# @param ComponentValue:
|
312
|
+
# @param ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
|
313
|
+
# TEXT - 文本内容
|
314
|
+
# MULTI_LINE_TEXT - 文本内容
|
315
|
+
# CHECK_BOX - true/false
|
316
|
+
# ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
317
|
+
# SELECTOR - 选项值
|
283
318
|
# @type ComponentValue: String
|
284
319
|
# @param IsFormType: 是否是表单域类型,默认不存在
|
285
320
|
# @type IsFormType: Boolean
|
@@ -339,18 +374,132 @@ module TencentCloud
|
|
339
374
|
end
|
340
375
|
end
|
341
376
|
|
377
|
+
# CreateBatchCancelFlowUrl请求参数结构体
|
378
|
+
class CreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
|
379
|
+
# @param Operator: 调用方用户信息,userId 必填
|
380
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
381
|
+
# @param FlowIds: 需要执行撤回的签署流程id数组,最多100个
|
382
|
+
# @type FlowIds: Array
|
383
|
+
|
384
|
+
attr_accessor :Operator, :FlowIds
|
385
|
+
|
386
|
+
def initialize(operator=nil, flowids=nil)
|
387
|
+
@Operator = operator
|
388
|
+
@FlowIds = flowids
|
389
|
+
end
|
390
|
+
|
391
|
+
def deserialize(params)
|
392
|
+
unless params['Operator'].nil?
|
393
|
+
@Operator = UserInfo.new
|
394
|
+
@Operator.deserialize(params['Operator'])
|
395
|
+
end
|
396
|
+
@FlowIds = params['FlowIds']
|
397
|
+
end
|
398
|
+
end
|
399
|
+
|
400
|
+
# CreateBatchCancelFlowUrl返回参数结构体
|
401
|
+
class CreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
|
402
|
+
# @param BatchCancelFlowUrl: 批量撤回签署流程链接
|
403
|
+
# @type BatchCancelFlowUrl: String
|
404
|
+
# @param FailMessages: 签署流程撤回失败信息
|
405
|
+
# @type FailMessages: Array
|
406
|
+
# @param UrlExpireOn: 签署连接过期时间字符串:年月日-时分秒
|
407
|
+
# @type UrlExpireOn: String
|
408
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
409
|
+
# @type RequestId: String
|
410
|
+
|
411
|
+
attr_accessor :BatchCancelFlowUrl, :FailMessages, :UrlExpireOn, :RequestId
|
412
|
+
|
413
|
+
def initialize(batchcancelflowurl=nil, failmessages=nil, urlexpireon=nil, requestid=nil)
|
414
|
+
@BatchCancelFlowUrl = batchcancelflowurl
|
415
|
+
@FailMessages = failmessages
|
416
|
+
@UrlExpireOn = urlexpireon
|
417
|
+
@RequestId = requestid
|
418
|
+
end
|
419
|
+
|
420
|
+
def deserialize(params)
|
421
|
+
@BatchCancelFlowUrl = params['BatchCancelFlowUrl']
|
422
|
+
@FailMessages = params['FailMessages']
|
423
|
+
@UrlExpireOn = params['UrlExpireOn']
|
424
|
+
@RequestId = params['RequestId']
|
425
|
+
end
|
426
|
+
end
|
427
|
+
|
428
|
+
# CreateConvertTaskApi请求参数结构体
|
429
|
+
class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
|
430
|
+
# @param ResourceId: 资源Id
|
431
|
+
# @type ResourceId: String
|
432
|
+
# @param ResourceType: 资源类型 取值范围doc,docx,html之一
|
433
|
+
# @type ResourceType: String
|
434
|
+
# @param ResourceName: 资源名称
|
435
|
+
# @type ResourceName: String
|
436
|
+
# @param Organization: 无
|
437
|
+
# @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
|
438
|
+
# @param Operator: 无
|
439
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
440
|
+
# @param Agent: 无
|
441
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
442
|
+
|
443
|
+
attr_accessor :ResourceId, :ResourceType, :ResourceName, :Organization, :Operator, :Agent
|
444
|
+
|
445
|
+
def initialize(resourceid=nil, resourcetype=nil, resourcename=nil, organization=nil, operator=nil, agent=nil)
|
446
|
+
@ResourceId = resourceid
|
447
|
+
@ResourceType = resourcetype
|
448
|
+
@ResourceName = resourcename
|
449
|
+
@Organization = organization
|
450
|
+
@Operator = operator
|
451
|
+
@Agent = agent
|
452
|
+
end
|
453
|
+
|
454
|
+
def deserialize(params)
|
455
|
+
@ResourceId = params['ResourceId']
|
456
|
+
@ResourceType = params['ResourceType']
|
457
|
+
@ResourceName = params['ResourceName']
|
458
|
+
unless params['Organization'].nil?
|
459
|
+
@Organization = OrganizationInfo.new
|
460
|
+
@Organization.deserialize(params['Organization'])
|
461
|
+
end
|
462
|
+
unless params['Operator'].nil?
|
463
|
+
@Operator = UserInfo.new
|
464
|
+
@Operator.deserialize(params['Operator'])
|
465
|
+
end
|
466
|
+
unless params['Agent'].nil?
|
467
|
+
@Agent = Agent.new
|
468
|
+
@Agent.deserialize(params['Agent'])
|
469
|
+
end
|
470
|
+
end
|
471
|
+
end
|
472
|
+
|
473
|
+
# CreateConvertTaskApi返回参数结构体
|
474
|
+
class CreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
|
475
|
+
# @param TaskId: 转换任务Id
|
476
|
+
# @type TaskId: String
|
477
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
478
|
+
# @type RequestId: String
|
479
|
+
|
480
|
+
attr_accessor :TaskId, :RequestId
|
481
|
+
|
482
|
+
def initialize(taskid=nil, requestid=nil)
|
483
|
+
@TaskId = taskid
|
484
|
+
@RequestId = requestid
|
485
|
+
end
|
486
|
+
|
487
|
+
def deserialize(params)
|
488
|
+
@TaskId = params['TaskId']
|
489
|
+
@RequestId = params['RequestId']
|
490
|
+
end
|
491
|
+
end
|
492
|
+
|
342
493
|
# CreateDocument请求参数结构体
|
343
494
|
class CreateDocumentRequest < TencentCloud::Common::AbstractModel
|
495
|
+
# @param Operator: 调用方用户信息,userId 必填
|
496
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
344
497
|
# @param FlowId: 签署流程编号,由CreateFlow接口返回
|
345
498
|
# @type FlowId: String
|
346
499
|
# @param TemplateId: 用户上传的模板ID
|
347
500
|
# @type TemplateId: String
|
348
501
|
# @param FileNames: 文件名列表,单个文件名最大长度200个字符
|
349
502
|
# @type FileNames: Array
|
350
|
-
# @param Operator: 无
|
351
|
-
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
352
|
-
# @param Agent: 应用相关信息
|
353
|
-
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
354
503
|
# @param FormFields: 内容控件信息数组
|
355
504
|
# @type FormFields: Array
|
356
505
|
# @param NeedPreview: 是否需要生成预览文件 默认不生成;
|
@@ -358,32 +507,30 @@ module TencentCloud
|
|
358
507
|
# @type NeedPreview: Boolean
|
359
508
|
# @param ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
|
360
509
|
# @type ClientToken: String
|
510
|
+
# @param Agent: 应用相关信息
|
511
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
361
512
|
|
362
|
-
attr_accessor :FlowId, :TemplateId, :FileNames, :
|
513
|
+
attr_accessor :Operator, :FlowId, :TemplateId, :FileNames, :FormFields, :NeedPreview, :ClientToken, :Agent
|
363
514
|
|
364
|
-
def initialize(
|
515
|
+
def initialize(operator=nil, flowid=nil, templateid=nil, filenames=nil, formfields=nil, needpreview=nil, clienttoken=nil, agent=nil)
|
516
|
+
@Operator = operator
|
365
517
|
@FlowId = flowid
|
366
518
|
@TemplateId = templateid
|
367
519
|
@FileNames = filenames
|
368
|
-
@Operator = operator
|
369
|
-
@Agent = agent
|
370
520
|
@FormFields = formfields
|
371
521
|
@NeedPreview = needpreview
|
372
522
|
@ClientToken = clienttoken
|
523
|
+
@Agent = agent
|
373
524
|
end
|
374
525
|
|
375
526
|
def deserialize(params)
|
376
|
-
@FlowId = params['FlowId']
|
377
|
-
@TemplateId = params['TemplateId']
|
378
|
-
@FileNames = params['FileNames']
|
379
527
|
unless params['Operator'].nil?
|
380
528
|
@Operator = UserInfo.new
|
381
529
|
@Operator.deserialize(params['Operator'])
|
382
530
|
end
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
end
|
531
|
+
@FlowId = params['FlowId']
|
532
|
+
@TemplateId = params['TemplateId']
|
533
|
+
@FileNames = params['FileNames']
|
387
534
|
unless params['FormFields'].nil?
|
388
535
|
@FormFields = []
|
389
536
|
params['FormFields'].each do |i|
|
@@ -394,6 +541,10 @@ module TencentCloud
|
|
394
541
|
end
|
395
542
|
@NeedPreview = params['NeedPreview']
|
396
543
|
@ClientToken = params['ClientToken']
|
544
|
+
unless params['Agent'].nil?
|
545
|
+
@Agent = Agent.new
|
546
|
+
@Agent.deserialize(params['Agent'])
|
547
|
+
end
|
397
548
|
end
|
398
549
|
end
|
399
550
|
|
@@ -424,23 +575,26 @@ module TencentCloud
|
|
424
575
|
|
425
576
|
# CreateFlowByFiles请求参数结构体
|
426
577
|
class CreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
|
578
|
+
# @param Operator: 调用方用户信息,userId 必填
|
579
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
427
580
|
# @param FlowName: 签署流程名称,最大长度200个字符
|
428
581
|
# @type FlowName: String
|
429
582
|
# @param Approvers: 签署参与者信息
|
430
583
|
# @type Approvers: Array
|
431
584
|
# @param FileIds: 签署pdf文件的资源编号列表,通过UploadFiles接口获取
|
432
585
|
# @type FileIds: Array
|
433
|
-
# @param
|
434
|
-
# @type
|
435
|
-
# @param
|
436
|
-
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
437
|
-
# @param Components: 经办人内容控件配置。可选类型为:
|
438
|
-
# TEXT - 内容文本控件
|
439
|
-
# MULTI_LINE_TEXT - 多行文本控件
|
440
|
-
# CHECK_BOX - 勾选框控件
|
441
|
-
# ATTACHMENT - 附件
|
442
|
-
# 注:默认字体大小为 字号12
|
586
|
+
# @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
587
|
+
# @type FlowType: String
|
588
|
+
# @param Components: 经办人内容控件配置
|
443
589
|
# @type Components: Array
|
590
|
+
# @param CcInfos: 被抄送人的信息列表。
|
591
|
+
# 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
592
|
+
# @type CcInfos: Array
|
593
|
+
# @param NeedPreview: 是否需要预览,true:预览模式,false:非预览(默认);
|
594
|
+
# 预览链接有效期300秒;
|
595
|
+
# @type NeedPreview: Boolean
|
596
|
+
# @param FlowDescription: 签署流程描述,最大长度1000个字符
|
597
|
+
# @type FlowDescription: String
|
444
598
|
# @param Deadline: 签署流程的签署截止时间。
|
445
599
|
# 值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
446
600
|
# @type Deadline: Integer
|
@@ -449,38 +603,34 @@ module TencentCloud
|
|
449
603
|
# false:有序签
|
450
604
|
# 注:默认为false(有序签)
|
451
605
|
# @type Unordered: Boolean
|
452
|
-
# @param NeedPreview: 是否需要预览,true:预览模式,false:非预览(默认);
|
453
|
-
# 预览链接有效期300秒;
|
454
|
-
# @type NeedPreview: Boolean
|
455
|
-
# @param FlowDescription: 签署流程描述,最大长度1000个字符
|
456
|
-
# @type FlowDescription: String
|
457
|
-
# @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
458
|
-
# @type FlowType: String
|
459
|
-
# @param CcInfos: 被抄送人的信息列表。
|
460
|
-
# 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
|
461
|
-
# @type CcInfos: Array
|
462
606
|
# @param CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
463
607
|
# @type CustomShowMap: String
|
608
|
+
# @param Agent: 应用号信息
|
609
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
464
610
|
|
465
|
-
attr_accessor :FlowName, :Approvers, :FileIds, :
|
611
|
+
attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowType, :Components, :CcInfos, :NeedPreview, :FlowDescription, :Deadline, :Unordered, :CustomShowMap, :Agent
|
466
612
|
|
467
|
-
def initialize(
|
613
|
+
def initialize(operator=nil, flowname=nil, approvers=nil, fileids=nil, flowtype=nil, components=nil, ccinfos=nil, needpreview=nil, flowdescription=nil, deadline=nil, unordered=nil, customshowmap=nil, agent=nil)
|
614
|
+
@Operator = operator
|
468
615
|
@FlowName = flowname
|
469
616
|
@Approvers = approvers
|
470
617
|
@FileIds = fileids
|
471
|
-
@
|
472
|
-
@Agent = agent
|
618
|
+
@FlowType = flowtype
|
473
619
|
@Components = components
|
474
|
-
@
|
475
|
-
@Unordered = unordered
|
620
|
+
@CcInfos = ccinfos
|
476
621
|
@NeedPreview = needpreview
|
477
622
|
@FlowDescription = flowdescription
|
478
|
-
@
|
479
|
-
@
|
623
|
+
@Deadline = deadline
|
624
|
+
@Unordered = unordered
|
480
625
|
@CustomShowMap = customshowmap
|
626
|
+
@Agent = agent
|
481
627
|
end
|
482
628
|
|
483
629
|
def deserialize(params)
|
630
|
+
unless params['Operator'].nil?
|
631
|
+
@Operator = UserInfo.new
|
632
|
+
@Operator.deserialize(params['Operator'])
|
633
|
+
end
|
484
634
|
@FlowName = params['FlowName']
|
485
635
|
unless params['Approvers'].nil?
|
486
636
|
@Approvers = []
|
@@ -491,14 +641,7 @@ module TencentCloud
|
|
491
641
|
end
|
492
642
|
end
|
493
643
|
@FileIds = params['FileIds']
|
494
|
-
|
495
|
-
@Operator = UserInfo.new
|
496
|
-
@Operator.deserialize(params['Operator'])
|
497
|
-
end
|
498
|
-
unless params['Agent'].nil?
|
499
|
-
@Agent = Agent.new
|
500
|
-
@Agent.deserialize(params['Agent'])
|
501
|
-
end
|
644
|
+
@FlowType = params['FlowType']
|
502
645
|
unless params['Components'].nil?
|
503
646
|
@Components = []
|
504
647
|
params['Components'].each do |i|
|
@@ -507,11 +650,6 @@ module TencentCloud
|
|
507
650
|
@Components << component_tmp
|
508
651
|
end
|
509
652
|
end
|
510
|
-
@Deadline = params['Deadline']
|
511
|
-
@Unordered = params['Unordered']
|
512
|
-
@NeedPreview = params['NeedPreview']
|
513
|
-
@FlowDescription = params['FlowDescription']
|
514
|
-
@FlowType = params['FlowType']
|
515
653
|
unless params['CcInfos'].nil?
|
516
654
|
@CcInfos = []
|
517
655
|
params['CcInfos'].each do |i|
|
@@ -520,7 +658,15 @@ module TencentCloud
|
|
520
658
|
@CcInfos << ccinfo_tmp
|
521
659
|
end
|
522
660
|
end
|
661
|
+
@NeedPreview = params['NeedPreview']
|
662
|
+
@FlowDescription = params['FlowDescription']
|
663
|
+
@Deadline = params['Deadline']
|
664
|
+
@Unordered = params['Unordered']
|
523
665
|
@CustomShowMap = params['CustomShowMap']
|
666
|
+
unless params['Agent'].nil?
|
667
|
+
@Agent = Agent.new
|
668
|
+
@Agent.deserialize(params['Agent'])
|
669
|
+
end
|
524
670
|
end
|
525
671
|
end
|
526
672
|
|
@@ -551,56 +697,60 @@ module TencentCloud
|
|
551
697
|
|
552
698
|
# CreateFlow请求参数结构体
|
553
699
|
class CreateFlowRequest < TencentCloud::Common::AbstractModel
|
700
|
+
# @param Operator: 调用方用户信息,userId 必填
|
701
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
554
702
|
# @param FlowName: 签署流程名称,最大长度200个字符
|
555
703
|
# @type FlowName: String
|
556
704
|
# @param Approvers: 签署流程参与者信息
|
557
705
|
# @type Approvers: Array
|
558
|
-
# @param
|
559
|
-
# @type
|
560
|
-
# @param
|
561
|
-
# @type
|
562
|
-
# @param
|
563
|
-
#
|
564
|
-
# false:有序签
|
565
|
-
# 注:默认为false(有序签),请和模板中的配置保持一致
|
566
|
-
# @type Unordered: Boolean
|
706
|
+
# @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
707
|
+
# @type FlowType: String
|
708
|
+
# @param ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
|
709
|
+
# @type ClientToken: String
|
710
|
+
# @param CallbackUrl: 暂未开放
|
711
|
+
# @type CallbackUrl: String
|
567
712
|
# @param DeadLine: 签署流程的签署截止时间。
|
568
713
|
# 值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
569
714
|
# @type DeadLine: Integer
|
570
|
-
# @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
571
|
-
# @type FlowType: String
|
572
715
|
# @param UserData: 用户自定义字段(需进行base64 encode),回调的时候会进行透传, 长度需要小于20480
|
573
716
|
# @type UserData: String
|
574
717
|
# @param FlowDescription: 签署流程描述,最大长度1000个字符
|
575
718
|
# @type FlowDescription: String
|
576
|
-
# @param
|
577
|
-
#
|
719
|
+
# @param Unordered: 发送类型:
|
720
|
+
# true:无序签
|
721
|
+
# false:有序签
|
722
|
+
# 注:默认为false(有序签),请和模板中的配置保持一致
|
723
|
+
# @type Unordered: Boolean
|
578
724
|
# @param CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
|
579
725
|
# @type CustomShowMap: String
|
580
726
|
# @param RelatedFlowId: 暂未开放
|
581
727
|
# @type RelatedFlowId: String
|
582
|
-
# @param
|
583
|
-
# @type
|
728
|
+
# @param Agent: 应用相关信息
|
729
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
584
730
|
|
585
|
-
attr_accessor :FlowName, :Approvers, :
|
731
|
+
attr_accessor :Operator, :FlowName, :Approvers, :FlowType, :ClientToken, :CallbackUrl, :DeadLine, :UserData, :FlowDescription, :Unordered, :CustomShowMap, :RelatedFlowId, :Agent
|
586
732
|
|
587
|
-
def initialize(
|
733
|
+
def initialize(operator=nil, flowname=nil, approvers=nil, flowtype=nil, clienttoken=nil, callbackurl=nil, deadline=nil, userdata=nil, flowdescription=nil, unordered=nil, customshowmap=nil, relatedflowid=nil, agent=nil)
|
734
|
+
@Operator = operator
|
588
735
|
@FlowName = flowname
|
589
736
|
@Approvers = approvers
|
590
|
-
@Operator = operator
|
591
|
-
@Agent = agent
|
592
|
-
@Unordered = unordered
|
593
|
-
@DeadLine = deadline
|
594
737
|
@FlowType = flowtype
|
738
|
+
@ClientToken = clienttoken
|
739
|
+
@CallbackUrl = callbackurl
|
740
|
+
@DeadLine = deadline
|
595
741
|
@UserData = userdata
|
596
742
|
@FlowDescription = flowdescription
|
597
|
-
@
|
743
|
+
@Unordered = unordered
|
598
744
|
@CustomShowMap = customshowmap
|
599
745
|
@RelatedFlowId = relatedflowid
|
600
|
-
@
|
746
|
+
@Agent = agent
|
601
747
|
end
|
602
748
|
|
603
749
|
def deserialize(params)
|
750
|
+
unless params['Operator'].nil?
|
751
|
+
@Operator = UserInfo.new
|
752
|
+
@Operator.deserialize(params['Operator'])
|
753
|
+
end
|
604
754
|
@FlowName = params['FlowName']
|
605
755
|
unless params['Approvers'].nil?
|
606
756
|
@Approvers = []
|
@@ -610,23 +760,19 @@ module TencentCloud
|
|
610
760
|
@Approvers << flowcreateapprover_tmp
|
611
761
|
end
|
612
762
|
end
|
613
|
-
unless params['Operator'].nil?
|
614
|
-
@Operator = UserInfo.new
|
615
|
-
@Operator.deserialize(params['Operator'])
|
616
|
-
end
|
617
|
-
unless params['Agent'].nil?
|
618
|
-
@Agent = Agent.new
|
619
|
-
@Agent.deserialize(params['Agent'])
|
620
|
-
end
|
621
|
-
@Unordered = params['Unordered']
|
622
|
-
@DeadLine = params['DeadLine']
|
623
763
|
@FlowType = params['FlowType']
|
764
|
+
@ClientToken = params['ClientToken']
|
765
|
+
@CallbackUrl = params['CallbackUrl']
|
766
|
+
@DeadLine = params['DeadLine']
|
624
767
|
@UserData = params['UserData']
|
625
768
|
@FlowDescription = params['FlowDescription']
|
626
|
-
@
|
769
|
+
@Unordered = params['Unordered']
|
627
770
|
@CustomShowMap = params['CustomShowMap']
|
628
771
|
@RelatedFlowId = params['RelatedFlowId']
|
629
|
-
|
772
|
+
unless params['Agent'].nil?
|
773
|
+
@Agent = Agent.new
|
774
|
+
@Agent.deserialize(params['Agent'])
|
775
|
+
end
|
630
776
|
end
|
631
777
|
end
|
632
778
|
|
@@ -671,10 +817,12 @@ module TencentCloud
|
|
671
817
|
# @type FlowEffectiveDay: Integer
|
672
818
|
# @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
|
673
819
|
# @type QrEffectiveDay: Integer
|
820
|
+
# @param ApproverRestrictions: 限制二维码用户条件
|
821
|
+
# @type ApproverRestrictions: :class:`Tencentcloud::Ess.v20201111.models.ApproverRestriction`
|
674
822
|
|
675
|
-
attr_accessor :TemplateId, :FlowName, :Operator, :Agent, :CallbackUrl, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay
|
823
|
+
attr_accessor :TemplateId, :FlowName, :Operator, :Agent, :CallbackUrl, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :ApproverRestrictions
|
676
824
|
|
677
|
-
def initialize(templateid=nil, flowname=nil, operator=nil, agent=nil, callbackurl=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil)
|
825
|
+
def initialize(templateid=nil, flowname=nil, operator=nil, agent=nil, callbackurl=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, approverrestrictions=nil)
|
678
826
|
@TemplateId = templateid
|
679
827
|
@FlowName = flowname
|
680
828
|
@Operator = operator
|
@@ -683,6 +831,7 @@ module TencentCloud
|
|
683
831
|
@MaxFlowNum = maxflownum
|
684
832
|
@FlowEffectiveDay = floweffectiveday
|
685
833
|
@QrEffectiveDay = qreffectiveday
|
834
|
+
@ApproverRestrictions = approverrestrictions
|
686
835
|
end
|
687
836
|
|
688
837
|
def deserialize(params)
|
@@ -700,6 +849,10 @@ module TencentCloud
|
|
700
849
|
@MaxFlowNum = params['MaxFlowNum']
|
701
850
|
@FlowEffectiveDay = params['FlowEffectiveDay']
|
702
851
|
@QrEffectiveDay = params['QrEffectiveDay']
|
852
|
+
unless params['ApproverRestrictions'].nil?
|
853
|
+
@ApproverRestrictions = ApproverRestriction.new
|
854
|
+
@ApproverRestrictions.deserialize(params['ApproverRestrictions'])
|
855
|
+
end
|
703
856
|
end
|
704
857
|
end
|
705
858
|
|
@@ -707,13 +860,16 @@ module TencentCloud
|
|
707
860
|
class CreateMultiFlowSignQRCodeResponse < TencentCloud::Common::AbstractModel
|
708
861
|
# @param QrCode: 签署二维码对象
|
709
862
|
# @type QrCode: :class:`Tencentcloud::Ess.v20201111.models.SignQrCode`
|
863
|
+
# @param SignUrls: 签署链接对象
|
864
|
+
# @type SignUrls: :class:`Tencentcloud::Ess.v20201111.models.SignUrl`
|
710
865
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
711
866
|
# @type RequestId: String
|
712
867
|
|
713
|
-
attr_accessor :QrCode, :RequestId
|
868
|
+
attr_accessor :QrCode, :SignUrls, :RequestId
|
714
869
|
|
715
|
-
def initialize(qrcode=nil, requestid=nil)
|
870
|
+
def initialize(qrcode=nil, signurls=nil, requestid=nil)
|
716
871
|
@QrCode = qrcode
|
872
|
+
@SignUrls = signurls
|
717
873
|
@RequestId = requestid
|
718
874
|
end
|
719
875
|
|
@@ -722,46 +878,50 @@ module TencentCloud
|
|
722
878
|
@QrCode = SignQrCode.new
|
723
879
|
@QrCode.deserialize(params['QrCode'])
|
724
880
|
end
|
881
|
+
unless params['SignUrls'].nil?
|
882
|
+
@SignUrls = SignUrl.new
|
883
|
+
@SignUrls.deserialize(params['SignUrls'])
|
884
|
+
end
|
725
885
|
@RequestId = params['RequestId']
|
726
886
|
end
|
727
887
|
end
|
728
888
|
|
729
889
|
# CreateSchemeUrl请求参数结构体
|
730
890
|
class CreateSchemeUrlRequest < TencentCloud::Common::AbstractModel
|
731
|
-
# @param Operator:
|
891
|
+
# @param Operator: 调用方用户信息,userId 必填
|
732
892
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
733
|
-
# @param
|
734
|
-
# @type
|
893
|
+
# @param OrganizationName: 企业名称
|
894
|
+
# @type OrganizationName: String
|
895
|
+
# @param Name: 姓名,最大长度50个字符
|
896
|
+
# @type Name: String
|
897
|
+
# @param Mobile: 手机号,大陆手机号11位
|
898
|
+
# @type Mobile: String
|
735
899
|
# @param EndPoint: 链接类型
|
736
900
|
# HTTP:跳转电子签小程序的http_url,
|
737
901
|
# APP:第三方APP或小程序跳转电子签小程序的path。
|
738
902
|
# 默认为HTTP类型
|
739
903
|
# @type EndPoint: String
|
740
|
-
# @param Name: 姓名,最大长度50个字符
|
741
|
-
# @type Name: String
|
742
|
-
# @param Mobile: 手机号,大陆手机号11位
|
743
|
-
# @type Mobile: String
|
744
|
-
# @param OrganizationName: 企业名称
|
745
|
-
# @type OrganizationName: String
|
746
904
|
# @param FlowId: 签署流程编号 (PathType=1时必传)
|
747
905
|
# @type FlowId: String
|
748
906
|
# @param PathType: 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
|
749
907
|
# @type PathType: Integer
|
750
908
|
# @param AutoJumpBack: 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
|
751
909
|
# @type AutoJumpBack: Boolean
|
910
|
+
# @param Agent: 应用相关信息
|
911
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
752
912
|
|
753
|
-
attr_accessor :Operator, :
|
913
|
+
attr_accessor :Operator, :OrganizationName, :Name, :Mobile, :EndPoint, :FlowId, :PathType, :AutoJumpBack, :Agent
|
754
914
|
|
755
|
-
def initialize(operator=nil,
|
915
|
+
def initialize(operator=nil, organizationname=nil, name=nil, mobile=nil, endpoint=nil, flowid=nil, pathtype=nil, autojumpback=nil, agent=nil)
|
756
916
|
@Operator = operator
|
757
|
-
@
|
758
|
-
@EndPoint = endpoint
|
917
|
+
@OrganizationName = organizationname
|
759
918
|
@Name = name
|
760
919
|
@Mobile = mobile
|
761
|
-
@
|
920
|
+
@EndPoint = endpoint
|
762
921
|
@FlowId = flowid
|
763
922
|
@PathType = pathtype
|
764
923
|
@AutoJumpBack = autojumpback
|
924
|
+
@Agent = agent
|
765
925
|
end
|
766
926
|
|
767
927
|
def deserialize(params)
|
@@ -769,17 +929,17 @@ module TencentCloud
|
|
769
929
|
@Operator = UserInfo.new
|
770
930
|
@Operator.deserialize(params['Operator'])
|
771
931
|
end
|
772
|
-
|
773
|
-
@Agent = Agent.new
|
774
|
-
@Agent.deserialize(params['Agent'])
|
775
|
-
end
|
776
|
-
@EndPoint = params['EndPoint']
|
932
|
+
@OrganizationName = params['OrganizationName']
|
777
933
|
@Name = params['Name']
|
778
934
|
@Mobile = params['Mobile']
|
779
|
-
@
|
935
|
+
@EndPoint = params['EndPoint']
|
780
936
|
@FlowId = params['FlowId']
|
781
937
|
@PathType = params['PathType']
|
782
938
|
@AutoJumpBack = params['AutoJumpBack']
|
939
|
+
unless params['Agent'].nil?
|
940
|
+
@Agent = Agent.new
|
941
|
+
@Agent.deserialize(params['Agent'])
|
942
|
+
end
|
783
943
|
end
|
784
944
|
end
|
785
945
|
|
@@ -903,27 +1063,27 @@ module TencentCloud
|
|
903
1063
|
|
904
1064
|
# DescribeFlowBriefs请求参数结构体
|
905
1065
|
class DescribeFlowBriefsRequest < TencentCloud::Common::AbstractModel
|
1066
|
+
# @param Operator: 调用方用户信息,userId 必填
|
1067
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
906
1068
|
# @param FlowIds: 需要查询的流程ID列表
|
907
1069
|
# @type FlowIds: Array
|
908
|
-
# @param Operator: 操作人信息
|
909
|
-
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
910
1070
|
# @param Agent: 应用相关信息
|
911
1071
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
912
1072
|
|
913
|
-
attr_accessor :
|
1073
|
+
attr_accessor :Operator, :FlowIds, :Agent
|
914
1074
|
|
915
|
-
def initialize(
|
916
|
-
@FlowIds = flowids
|
1075
|
+
def initialize(operator=nil, flowids=nil, agent=nil)
|
917
1076
|
@Operator = operator
|
1077
|
+
@FlowIds = flowids
|
918
1078
|
@Agent = agent
|
919
1079
|
end
|
920
1080
|
|
921
1081
|
def deserialize(params)
|
922
|
-
@FlowIds = params['FlowIds']
|
923
1082
|
unless params['Operator'].nil?
|
924
1083
|
@Operator = UserInfo.new
|
925
1084
|
@Operator.deserialize(params['Operator'])
|
926
1085
|
end
|
1086
|
+
@FlowIds = params['FlowIds']
|
927
1087
|
unless params['Agent'].nil?
|
928
1088
|
@Agent = Agent.new
|
929
1089
|
@Agent.deserialize(params['Agent'])
|
@@ -960,31 +1120,31 @@ module TencentCloud
|
|
960
1120
|
|
961
1121
|
# DescribeFlowTemplates请求参数结构体
|
962
1122
|
class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
|
963
|
-
# @param Operator:
|
1123
|
+
# @param Operator: 调用方用户信息,userId 必填
|
964
1124
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
965
|
-
# @param Offset: 查询偏移位置,默认0
|
966
|
-
# @type Offset: Integer
|
967
|
-
# @param Limit: 查询个数,默认20,最大100
|
968
|
-
# @type Limit: Integer
|
969
1125
|
# @param Filters: 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
|
970
1126
|
# @type Filters: Array
|
971
|
-
# @param
|
972
|
-
# @type
|
973
|
-
# @param
|
974
|
-
# @type
|
1127
|
+
# @param Limit: 查询个数,默认20,最大100
|
1128
|
+
# @type Limit: Integer
|
1129
|
+
# @param Offset: 查询偏移位置,默认0
|
1130
|
+
# @type Offset: Integer
|
975
1131
|
# @param ContentType: 查询内容:0-模板列表及详情(默认),1-仅模板列表
|
976
1132
|
# @type ContentType: Integer
|
1133
|
+
# @param GenerateSource: 暂未开放
|
1134
|
+
# @type GenerateSource: Integer
|
1135
|
+
# @param Agent: 应用相关信息
|
1136
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
977
1137
|
|
978
|
-
attr_accessor :Operator, :
|
1138
|
+
attr_accessor :Operator, :Filters, :Limit, :Offset, :ContentType, :GenerateSource, :Agent
|
979
1139
|
|
980
|
-
def initialize(operator=nil,
|
1140
|
+
def initialize(operator=nil, filters=nil, limit=nil, offset=nil, contenttype=nil, generatesource=nil, agent=nil)
|
981
1141
|
@Operator = operator
|
982
|
-
@Offset = offset
|
983
|
-
@Limit = limit
|
984
1142
|
@Filters = filters
|
985
|
-
@
|
986
|
-
@
|
1143
|
+
@Limit = limit
|
1144
|
+
@Offset = offset
|
987
1145
|
@ContentType = contenttype
|
1146
|
+
@GenerateSource = generatesource
|
1147
|
+
@Agent = agent
|
988
1148
|
end
|
989
1149
|
|
990
1150
|
def deserialize(params)
|
@@ -992,8 +1152,6 @@ module TencentCloud
|
|
992
1152
|
@Operator = UserInfo.new
|
993
1153
|
@Operator.deserialize(params['Operator'])
|
994
1154
|
end
|
995
|
-
@Offset = params['Offset']
|
996
|
-
@Limit = params['Limit']
|
997
1155
|
unless params['Filters'].nil?
|
998
1156
|
@Filters = []
|
999
1157
|
params['Filters'].each do |i|
|
@@ -1002,12 +1160,14 @@ module TencentCloud
|
|
1002
1160
|
@Filters << filter_tmp
|
1003
1161
|
end
|
1004
1162
|
end
|
1163
|
+
@Limit = params['Limit']
|
1164
|
+
@Offset = params['Offset']
|
1165
|
+
@ContentType = params['ContentType']
|
1166
|
+
@GenerateSource = params['GenerateSource']
|
1005
1167
|
unless params['Agent'].nil?
|
1006
1168
|
@Agent = Agent.new
|
1007
1169
|
@Agent.deserialize(params['Agent'])
|
1008
1170
|
end
|
1009
|
-
@GenerateSource = params['GenerateSource']
|
1010
|
-
@ContentType = params['ContentType']
|
1011
1171
|
end
|
1012
1172
|
end
|
1013
1173
|
|
@@ -1269,11 +1429,16 @@ module TencentCloud
|
|
1269
1429
|
|
1270
1430
|
# 电子文档的控件填充信息
|
1271
1431
|
class FormField < TencentCloud::Common::AbstractModel
|
1272
|
-
# @param ComponentValue: 控件填充value
|
1432
|
+
# @param ComponentValue: 控件填充value,ComponentType和传入值类型对应关系:
|
1433
|
+
# TEXT - 文本内容
|
1434
|
+
# MULTI_LINE_TEXT - 文本内容
|
1435
|
+
# CHECK_BOX - true/false
|
1436
|
+
# ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
1437
|
+
# SELECTOR - 模板中配置的选项值
|
1273
1438
|
# @type ComponentValue: String
|
1274
|
-
# @param ComponentId: 控件id
|
1439
|
+
# @param ComponentId: 控件id,和ComponentName选择一项传入即可
|
1275
1440
|
# @type ComponentId: String
|
1276
|
-
# @param ComponentName: 控件名字,最大长度不超过30
|
1441
|
+
# @param ComponentName: 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
|
1277
1442
|
# @type ComponentName: String
|
1278
1443
|
|
1279
1444
|
attr_accessor :ComponentValue, :ComponentId, :ComponentName
|
@@ -1291,6 +1456,107 @@ module TencentCloud
|
|
1291
1456
|
end
|
1292
1457
|
end
|
1293
1458
|
|
1459
|
+
# GetTaskResultApi请求参数结构体
|
1460
|
+
class GetTaskResultApiRequest < TencentCloud::Common::AbstractModel
|
1461
|
+
# @param TaskId: 任务Id
|
1462
|
+
# @type TaskId: String
|
1463
|
+
# @param Organization: 企业信息
|
1464
|
+
# @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
|
1465
|
+
# @param Operator: 操作人信息
|
1466
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
1467
|
+
# @param Agent: 渠道信息
|
1468
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1469
|
+
|
1470
|
+
attr_accessor :TaskId, :Organization, :Operator, :Agent
|
1471
|
+
|
1472
|
+
def initialize(taskid=nil, organization=nil, operator=nil, agent=nil)
|
1473
|
+
@TaskId = taskid
|
1474
|
+
@Organization = organization
|
1475
|
+
@Operator = operator
|
1476
|
+
@Agent = agent
|
1477
|
+
end
|
1478
|
+
|
1479
|
+
def deserialize(params)
|
1480
|
+
@TaskId = params['TaskId']
|
1481
|
+
unless params['Organization'].nil?
|
1482
|
+
@Organization = OrganizationInfo.new
|
1483
|
+
@Organization.deserialize(params['Organization'])
|
1484
|
+
end
|
1485
|
+
unless params['Operator'].nil?
|
1486
|
+
@Operator = UserInfo.new
|
1487
|
+
@Operator.deserialize(params['Operator'])
|
1488
|
+
end
|
1489
|
+
unless params['Agent'].nil?
|
1490
|
+
@Agent = Agent.new
|
1491
|
+
@Agent.deserialize(params['Agent'])
|
1492
|
+
end
|
1493
|
+
end
|
1494
|
+
end
|
1495
|
+
|
1496
|
+
# GetTaskResultApi返回参数结构体
|
1497
|
+
class GetTaskResultApiResponse < TencentCloud::Common::AbstractModel
|
1498
|
+
# @param TaskId: 任务Id
|
1499
|
+
# @type TaskId: String
|
1500
|
+
# @param TaskStatus: 任务状态
|
1501
|
+
# @type TaskStatus: Integer
|
1502
|
+
# @param TaskMessage: 状态描述
|
1503
|
+
# @type TaskMessage: String
|
1504
|
+
# @param ResourceId: 资源Id
|
1505
|
+
# @type ResourceId: String
|
1506
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1507
|
+
# @type RequestId: String
|
1508
|
+
|
1509
|
+
attr_accessor :TaskId, :TaskStatus, :TaskMessage, :ResourceId, :RequestId
|
1510
|
+
|
1511
|
+
def initialize(taskid=nil, taskstatus=nil, taskmessage=nil, resourceid=nil, requestid=nil)
|
1512
|
+
@TaskId = taskid
|
1513
|
+
@TaskStatus = taskstatus
|
1514
|
+
@TaskMessage = taskmessage
|
1515
|
+
@ResourceId = resourceid
|
1516
|
+
@RequestId = requestid
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
def deserialize(params)
|
1520
|
+
@TaskId = params['TaskId']
|
1521
|
+
@TaskStatus = params['TaskStatus']
|
1522
|
+
@TaskMessage = params['TaskMessage']
|
1523
|
+
@ResourceId = params['ResourceId']
|
1524
|
+
@RequestId = params['RequestId']
|
1525
|
+
end
|
1526
|
+
end
|
1527
|
+
|
1528
|
+
# 机构信息
|
1529
|
+
class OrganizationInfo < TencentCloud::Common::AbstractModel
|
1530
|
+
# @param OrganizationId: 机构在平台的编号
|
1531
|
+
# @type OrganizationId: String
|
1532
|
+
# @param Channel: 用户渠道
|
1533
|
+
# @type Channel: String
|
1534
|
+
# @param OrganizationOpenId: 用户在渠道的机构编号
|
1535
|
+
# @type OrganizationOpenId: String
|
1536
|
+
# @param ClientIp: 用户真实的IP
|
1537
|
+
# @type ClientIp: String
|
1538
|
+
# @param ProxyIp: 机构的代理IP
|
1539
|
+
# @type ProxyIp: String
|
1540
|
+
|
1541
|
+
attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
|
1542
|
+
|
1543
|
+
def initialize(organizationid=nil, channel=nil, organizationopenid=nil, clientip=nil, proxyip=nil)
|
1544
|
+
@OrganizationId = organizationid
|
1545
|
+
@Channel = channel
|
1546
|
+
@OrganizationOpenId = organizationopenid
|
1547
|
+
@ClientIp = clientip
|
1548
|
+
@ProxyIp = proxyip
|
1549
|
+
end
|
1550
|
+
|
1551
|
+
def deserialize(params)
|
1552
|
+
@OrganizationId = params['OrganizationId']
|
1553
|
+
@Channel = params['Channel']
|
1554
|
+
@OrganizationOpenId = params['OrganizationOpenId']
|
1555
|
+
@ClientIp = params['ClientIp']
|
1556
|
+
@ProxyIp = params['ProxyIp']
|
1557
|
+
end
|
1558
|
+
end
|
1559
|
+
|
1294
1560
|
# 签署参与者信息
|
1295
1561
|
class Recipient < TencentCloud::Common::AbstractModel
|
1296
1562
|
# @param RecipientId: 签署参与者ID
|
@@ -1379,37 +1645,61 @@ module TencentCloud
|
|
1379
1645
|
end
|
1380
1646
|
end
|
1381
1647
|
|
1648
|
+
# 一码多扫签署二维码签署信息
|
1649
|
+
class SignUrl < TencentCloud::Common::AbstractModel
|
1650
|
+
# @param AppSignUrl: 小程序签署链接
|
1651
|
+
# @type AppSignUrl: String
|
1652
|
+
# @param EffectiveTime: 签署链接有效时间
|
1653
|
+
# @type EffectiveTime: String
|
1654
|
+
# @param HttpSignUrl: 移动端签署链接
|
1655
|
+
# @type HttpSignUrl: String
|
1656
|
+
|
1657
|
+
attr_accessor :AppSignUrl, :EffectiveTime, :HttpSignUrl
|
1658
|
+
|
1659
|
+
def initialize(appsignurl=nil, effectivetime=nil, httpsignurl=nil)
|
1660
|
+
@AppSignUrl = appsignurl
|
1661
|
+
@EffectiveTime = effectivetime
|
1662
|
+
@HttpSignUrl = httpsignurl
|
1663
|
+
end
|
1664
|
+
|
1665
|
+
def deserialize(params)
|
1666
|
+
@AppSignUrl = params['AppSignUrl']
|
1667
|
+
@EffectiveTime = params['EffectiveTime']
|
1668
|
+
@HttpSignUrl = params['HttpSignUrl']
|
1669
|
+
end
|
1670
|
+
end
|
1671
|
+
|
1382
1672
|
# StartFlow请求参数结构体
|
1383
1673
|
class StartFlowRequest < TencentCloud::Common::AbstractModel
|
1674
|
+
# @param Operator: 调用方用户信息,userId 必填
|
1675
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
1384
1676
|
# @param FlowId: 签署流程编号,由CreateFlow接口返回
|
1385
1677
|
# @type FlowId: String
|
1386
|
-
# @param Operator: 用户信息
|
1387
|
-
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
1388
|
-
# @param Agent: 应用相关信息
|
1389
|
-
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1390
1678
|
# @param ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
|
1391
1679
|
# @type ClientToken: String
|
1680
|
+
# @param Agent: 应用相关信息
|
1681
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1392
1682
|
|
1393
|
-
attr_accessor :
|
1683
|
+
attr_accessor :Operator, :FlowId, :ClientToken, :Agent
|
1394
1684
|
|
1395
|
-
def initialize(
|
1396
|
-
@FlowId = flowid
|
1685
|
+
def initialize(operator=nil, flowid=nil, clienttoken=nil, agent=nil)
|
1397
1686
|
@Operator = operator
|
1398
|
-
@
|
1687
|
+
@FlowId = flowid
|
1399
1688
|
@ClientToken = clienttoken
|
1689
|
+
@Agent = agent
|
1400
1690
|
end
|
1401
1691
|
|
1402
1692
|
def deserialize(params)
|
1403
|
-
@FlowId = params['FlowId']
|
1404
1693
|
unless params['Operator'].nil?
|
1405
1694
|
@Operator = UserInfo.new
|
1406
1695
|
@Operator.deserialize(params['Operator'])
|
1407
1696
|
end
|
1697
|
+
@FlowId = params['FlowId']
|
1698
|
+
@ClientToken = params['ClientToken']
|
1408
1699
|
unless params['Agent'].nil?
|
1409
1700
|
@Agent = Agent.new
|
1410
1701
|
@Agent.deserialize(params['Agent'])
|
1411
1702
|
end
|
1412
|
-
@ClientToken = params['ClientToken']
|
1413
1703
|
end
|
1414
1704
|
end
|
1415
1705
|
|
metadata
CHANGED
@@ -1,27 +1,27 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tencentcloud-sdk-ess
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 3.0.379
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- -
|
17
|
+
- - ~>
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: '1.0'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
|
-
- -
|
24
|
+
- - ~>
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '1.0'
|
27
27
|
description: Tencent Cloud Ruby SDK is the official software development kit, which
|
@@ -33,10 +33,10 @@ executables: []
|
|
33
33
|
extensions: []
|
34
34
|
extra_rdoc_files: []
|
35
35
|
files:
|
36
|
-
- lib/VERSION
|
37
|
-
- lib/tencentcloud-sdk-ess.rb
|
38
|
-
- lib/v20201111/client.rb
|
39
36
|
- lib/v20201111/models.rb
|
37
|
+
- lib/v20201111/client.rb
|
38
|
+
- lib/tencentcloud-sdk-ess.rb
|
39
|
+
- lib/VERSION
|
40
40
|
homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
|
41
41
|
licenses:
|
42
42
|
- Apache-2.0
|
@@ -49,17 +49,17 @@ require_paths:
|
|
49
49
|
- lib
|
50
50
|
required_ruby_version: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- -
|
52
|
+
- - '>='
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '0'
|
55
55
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
56
56
|
requirements:
|
57
|
-
- -
|
57
|
+
- - '>='
|
58
58
|
- !ruby/object:Gem::Version
|
59
59
|
version: '0'
|
60
60
|
requirements: []
|
61
61
|
rubyforge_project:
|
62
|
-
rubygems_version: 2.
|
62
|
+
rubygems_version: 2.0.14
|
63
63
|
signing_key:
|
64
64
|
specification_version: 4
|
65
65
|
summary: Tencent Cloud SDK for Ruby - ESS
|