tencentcloud-sdk-ess 1.0.364 → 3.0.371

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 397e27c4eff8b0973afe10e46b8d147958415ff4
4
- data.tar.gz: f040451b97e0e6d211523d52c8e2681f3fecdb72
3
+ metadata.gz: 44adbddc035df9dcec9139571b023a3270a2da15
4
+ data.tar.gz: 6f626748e67ba6fd3718cbdd4d1c935e2bce52c5
5
5
  SHA512:
6
- metadata.gz: 6d596d84f2f7ced018aff19b87ba4e16dc8b35d4098b7864c33df160df4418826413a54a540aafb293c8b8aa0a818756790d34bfe7bf15381bcaa523bb51628d
7
- data.tar.gz: 4ea68f5c49fd19a36253cb1ecba5ff3e36bc7a6bd848e1a24e889a1767c8700241eb452a2ad3bfc290662fb2b1933e2111ccb4675e6d304f36e957755a71b774
6
+ metadata.gz: c4db19179231c4ccecd57f682cbde1078057ac320bb2005c2dc1ed6fef601006315ec3b8ae0354631f9ac67eef2c1f4b2f70a065a8d0446ec3162dbfdb4c22ea
7
+ data.tar.gz: aee07888b5365d9a27a4cd3f34a339cee3b6ec8bd0847913686cc6b480fb6fc8a29bf99373ec7d3b455de33ac1610288a7448af7304e398b5bbf27a80a6af008
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.364
1
+ 3.0.371
@@ -79,6 +79,30 @@ module TencentCloud
79
79
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
80
80
  end
81
81
 
82
+ # 创建文件转换任务
83
+
84
+ # @param request: Request instance for CreateConvertTaskApi.
85
+ # @type request: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiRequest`
86
+ # @rtype: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiResponse`
87
+ def CreateConvertTaskApi(request)
88
+ body = send_request('CreateConvertTaskApi', request.serialize)
89
+ response = JSON.parse(body)
90
+ if response['Response'].key?('Error') == false
91
+ model = CreateConvertTaskApiResponse.new
92
+ model.deserialize(response['Response'])
93
+ model
94
+ else
95
+ code = response['Response']['Error']['Code']
96
+ message = response['Response']['Error']['Message']
97
+ reqid = response['Response']['RequestId']
98
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
99
+ end
100
+ rescue TencentCloud::Common::TencentCloudSDKException => e
101
+ raise e
102
+ rescue StandardError => e
103
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
104
+ end
105
+
82
106
  # 创建签署流程电子文档
83
107
  # 适用场景:见创建签署流程接口。
84
108
 
@@ -318,6 +342,30 @@ module TencentCloud
318
342
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
319
343
  end
320
344
 
345
+ # 查询转换任务状态
346
+
347
+ # @param request: Request instance for GetTaskResultApi.
348
+ # @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest`
349
+ # @rtype: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiResponse`
350
+ def GetTaskResultApi(request)
351
+ body = send_request('GetTaskResultApi', request.serialize)
352
+ response = JSON.parse(body)
353
+ if response['Response'].key?('Error') == false
354
+ model = GetTaskResultApiResponse.new
355
+ model.deserialize(response['Response'])
356
+ model
357
+ else
358
+ code = response['Response']['Error']['Code']
359
+ message = response['Response']['Error']['Message']
360
+ reqid = response['Response']['RequestId']
361
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
362
+ end
363
+ rescue TencentCloud::Common::TencentCloudSDKException => e
364
+ raise e
365
+ rescue StandardError => e
366
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
367
+ end
368
+
321
369
  # 此接口用于发起流程
322
370
  # 适用场景:见创建签署流程接口。
323
371
  # 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
@@ -40,7 +40,7 @@ module TencentCloud
40
40
  # @type ApproverName: String
41
41
  # @param ApproverMobile: 本环节需要操作人的手机号
42
42
  # @type ApproverMobile: String
43
- # @param SignComponents: 本环节操作人签署控件配置,为企业静默签署时,只允许类型为SIGN_SEAL(印章)和SIGN_DATE(日期)控件,并且传入印章编号。
43
+ # @param SignComponents: 本环节操作人签署控件配置
44
44
  # @type SignComponents: Array
45
45
  # @param OrganizationName: 如果是企业,则为企业的名字
46
46
  # @type OrganizationName: String
@@ -241,13 +241,15 @@ module TencentCloud
241
241
  # 模板控件信息
242
242
  class Component < TencentCloud::Common::AbstractModel
243
243
  # @param ComponentType: 如果是 Component 控件类型,则可选类型为:
244
- # TEXT - 内容文本控件
245
- # DATE - 内容日期控件
246
- # CHECK_BOX - 勾选框控件
244
+ # TEXT - 单行文本
245
+ # MULTI_LINE_TEXT - 多行文本
246
+ # CHECK_BOX - 勾选框
247
+ # ATTACHMENT - 附件
248
+ # SELECTOR - 选择器
247
249
  # 如果是 SignComponent 控件类型,则可选类型为:
248
- # SIGN_SEAL - 签署印章控件
250
+ # SIGN_SEAL - 签署印章控件,静默签署时需要传入印章id作为ComponentValue
249
251
  # SIGN_DATE - 签署日期控件
250
- # SIGN_SIGNATURE - 手写签名控件
252
+ # SIGN_SIGNATURE - 手写签名控件,静默签署时不能使用
251
253
  # @type ComponentType: String
252
254
  # @param ComponentWidth: 参数控件宽度,单位pt
253
255
  # @type ComponentWidth: Float
@@ -279,7 +281,12 @@ module TencentCloud
279
281
  # @type ComponentExtra: String
280
282
  # @param ComponentRecipientId: 控件关联的签署人ID
281
283
  # @type ComponentRecipientId: String
282
- # @param ComponentValue: 控件所填写的内容
284
+ # @param ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
285
+ # TEXT - 文本内容
286
+ # MULTI_LINE_TEXT - 文本内容
287
+ # CHECK_BOX - true/false
288
+ # ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
289
+ # SELECTOR - 选项值
283
290
  # @type ComponentValue: String
284
291
  # @param IsFormType: 是否是表单域类型,默认不存在
285
292
  # @type IsFormType: Boolean
@@ -339,6 +346,71 @@ module TencentCloud
339
346
  end
340
347
  end
341
348
 
349
+ # CreateConvertTaskApi请求参数结构体
350
+ class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
351
+ # @param ResourceId: 资源Id
352
+ # @type ResourceId: String
353
+ # @param ResourceType: 资源类型 取值范围doc,docx,html之一
354
+ # @type ResourceType: String
355
+ # @param ResourceName: 资源名称
356
+ # @type ResourceName: String
357
+ # @param Organization: 无
358
+ # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
359
+ # @param Operator: 无
360
+ # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
361
+ # @param Agent: 无
362
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
363
+
364
+ attr_accessor :ResourceId, :ResourceType, :ResourceName, :Organization, :Operator, :Agent
365
+
366
+ def initialize(resourceid=nil, resourcetype=nil, resourcename=nil, organization=nil, operator=nil, agent=nil)
367
+ @ResourceId = resourceid
368
+ @ResourceType = resourcetype
369
+ @ResourceName = resourcename
370
+ @Organization = organization
371
+ @Operator = operator
372
+ @Agent = agent
373
+ end
374
+
375
+ def deserialize(params)
376
+ @ResourceId = params['ResourceId']
377
+ @ResourceType = params['ResourceType']
378
+ @ResourceName = params['ResourceName']
379
+ unless params['Organization'].nil?
380
+ @Organization = OrganizationInfo.new
381
+ @Organization.deserialize(params['Organization'])
382
+ end
383
+ unless params['Operator'].nil?
384
+ @Operator = UserInfo.new
385
+ @Operator.deserialize(params['Operator'])
386
+ end
387
+ unless params['Agent'].nil?
388
+ @Agent = Agent.new
389
+ @Agent.deserialize(params['Agent'])
390
+ end
391
+ end
392
+ end
393
+
394
+ # CreateConvertTaskApi返回参数结构体
395
+ class CreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
396
+ # @param TaskId: 转换任务Id
397
+ # @type TaskId: String
398
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
399
+ # @type RequestId: String
400
+
401
+ attr_accessor :TaskId, :RequestId
402
+
403
+ def initialize(taskid=nil, requestid=nil)
404
+ @TaskId = taskid
405
+ @RequestId = requestid
406
+ end
407
+
408
+ def deserialize(params)
409
+ @TaskId = params['TaskId']
410
+ @RequestId = params['RequestId']
411
+ end
412
+ end
413
+
342
414
  # CreateDocument请求参数结构体
343
415
  class CreateDocumentRequest < TencentCloud::Common::AbstractModel
344
416
  # @param Operator: 调用方用户信息,userId 必填
@@ -434,12 +506,7 @@ module TencentCloud
434
506
  # @type FileIds: Array
435
507
  # @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
436
508
  # @type FlowType: String
437
- # @param Components: 经办人内容控件配置。可选类型为:
438
- # TEXT - 内容文本控件
439
- # MULTI_LINE_TEXT - 多行文本控件
440
- # CHECK_BOX - 勾选框控件
441
- # ATTACHMENT - 附件
442
- # 注:默认字体大小为 字号12
509
+ # @param Components: 经办人内容控件配置
443
510
  # @type Components: Array
444
511
  # @param CcInfos: 被抄送人的信息列表。
445
512
  # 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
@@ -1269,11 +1336,16 @@ module TencentCloud
1269
1336
 
1270
1337
  # 电子文档的控件填充信息
1271
1338
  class FormField < TencentCloud::Common::AbstractModel
1272
- # @param ComponentValue: 控件填充value
1339
+ # @param ComponentValue: 控件填充value,ComponentType和传入值类型对应关系:
1340
+ # TEXT - 文本内容
1341
+ # MULTI_LINE_TEXT - 文本内容
1342
+ # CHECK_BOX - true/false
1343
+ # ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
1344
+ # SELECTOR - 模板中配置的选项值
1273
1345
  # @type ComponentValue: String
1274
- # @param ComponentId: 控件id
1346
+ # @param ComponentId: 控件id,和ComponentName选择一项传入即可
1275
1347
  # @type ComponentId: String
1276
- # @param ComponentName: 控件名字,最大长度不超过30字符
1348
+ # @param ComponentName: 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
1277
1349
  # @type ComponentName: String
1278
1350
 
1279
1351
  attr_accessor :ComponentValue, :ComponentId, :ComponentName
@@ -1291,6 +1363,107 @@ module TencentCloud
1291
1363
  end
1292
1364
  end
1293
1365
 
1366
+ # GetTaskResultApi请求参数结构体
1367
+ class GetTaskResultApiRequest < TencentCloud::Common::AbstractModel
1368
+ # @param TaskId: 任务Id
1369
+ # @type TaskId: String
1370
+ # @param Organization: 企业信息
1371
+ # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
1372
+ # @param Operator: 操作人信息
1373
+ # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1374
+ # @param Agent: 渠道信息
1375
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1376
+
1377
+ attr_accessor :TaskId, :Organization, :Operator, :Agent
1378
+
1379
+ def initialize(taskid=nil, organization=nil, operator=nil, agent=nil)
1380
+ @TaskId = taskid
1381
+ @Organization = organization
1382
+ @Operator = operator
1383
+ @Agent = agent
1384
+ end
1385
+
1386
+ def deserialize(params)
1387
+ @TaskId = params['TaskId']
1388
+ unless params['Organization'].nil?
1389
+ @Organization = OrganizationInfo.new
1390
+ @Organization.deserialize(params['Organization'])
1391
+ end
1392
+ unless params['Operator'].nil?
1393
+ @Operator = UserInfo.new
1394
+ @Operator.deserialize(params['Operator'])
1395
+ end
1396
+ unless params['Agent'].nil?
1397
+ @Agent = Agent.new
1398
+ @Agent.deserialize(params['Agent'])
1399
+ end
1400
+ end
1401
+ end
1402
+
1403
+ # GetTaskResultApi返回参数结构体
1404
+ class GetTaskResultApiResponse < TencentCloud::Common::AbstractModel
1405
+ # @param TaskId: 任务Id
1406
+ # @type TaskId: String
1407
+ # @param TaskStatus: 任务状态
1408
+ # @type TaskStatus: Integer
1409
+ # @param TaskMessage: 状态描述
1410
+ # @type TaskMessage: String
1411
+ # @param ResourceId: 资源Id
1412
+ # @type ResourceId: String
1413
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1414
+ # @type RequestId: String
1415
+
1416
+ attr_accessor :TaskId, :TaskStatus, :TaskMessage, :ResourceId, :RequestId
1417
+
1418
+ def initialize(taskid=nil, taskstatus=nil, taskmessage=nil, resourceid=nil, requestid=nil)
1419
+ @TaskId = taskid
1420
+ @TaskStatus = taskstatus
1421
+ @TaskMessage = taskmessage
1422
+ @ResourceId = resourceid
1423
+ @RequestId = requestid
1424
+ end
1425
+
1426
+ def deserialize(params)
1427
+ @TaskId = params['TaskId']
1428
+ @TaskStatus = params['TaskStatus']
1429
+ @TaskMessage = params['TaskMessage']
1430
+ @ResourceId = params['ResourceId']
1431
+ @RequestId = params['RequestId']
1432
+ end
1433
+ end
1434
+
1435
+ # 机构信息
1436
+ class OrganizationInfo < TencentCloud::Common::AbstractModel
1437
+ # @param OrganizationId: 机构在平台的编号
1438
+ # @type OrganizationId: String
1439
+ # @param Channel: 用户渠道
1440
+ # @type Channel: String
1441
+ # @param OrganizationOpenId: 用户在渠道的机构编号
1442
+ # @type OrganizationOpenId: String
1443
+ # @param ClientIp: 用户真实的IP
1444
+ # @type ClientIp: String
1445
+ # @param ProxyIp: 机构的代理IP
1446
+ # @type ProxyIp: String
1447
+
1448
+ attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
1449
+
1450
+ def initialize(organizationid=nil, channel=nil, organizationopenid=nil, clientip=nil, proxyip=nil)
1451
+ @OrganizationId = organizationid
1452
+ @Channel = channel
1453
+ @OrganizationOpenId = organizationopenid
1454
+ @ClientIp = clientip
1455
+ @ProxyIp = proxyip
1456
+ end
1457
+
1458
+ def deserialize(params)
1459
+ @OrganizationId = params['OrganizationId']
1460
+ @Channel = params['Channel']
1461
+ @OrganizationOpenId = params['OrganizationOpenId']
1462
+ @ClientIp = params['ClientIp']
1463
+ @ProxyIp = params['ProxyIp']
1464
+ end
1465
+ end
1466
+
1294
1467
  # 签署参与者信息
1295
1468
  class Recipient < TencentCloud::Common::AbstractModel
1296
1469
  # @param RecipientId: 签署参与者ID
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.364
4
+ version: 3.0.371
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-07-26 00:00:00.000000000 Z
11
+ date: 2022-08-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common