tencentcloud-sdk-ess 3.0.667 → 3.0.668

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f661a50b54fba09cd1e6f9b5947fd221ed18cd26
4
- data.tar.gz: 2b7a9e1b64650284979a975e0e7aeef0a04ab51b
3
+ metadata.gz: 212dfe8dafad5f373c9ba9049eece80306cc76e4
4
+ data.tar.gz: addecf57200c5288fd82d8a78a2dfb895ff6a00b
5
5
  SHA512:
6
- metadata.gz: 353a7c90f74848556158045b63ddf52550da0bba9ea20cdc1fea7c6780c1d59a87da31728757fb99a40cdbd501e81fc69be36486c0e8f27ccf70e712e13b8529
7
- data.tar.gz: 4bc35ca3bd9405926681f0c3baa6385962d2965167601e8fc2061e63e40aec7ce8ae5708cf9eb380b9822d27d73f63b5e828866f885ae3f4aecf1c6fa85402aa
6
+ metadata.gz: fe7b1452ec1ff73ba3216ed0ebc85f6692a36b38fbb9f67332eeed32601608a51ebb5064d87dad2b9cdadeebf9a391200d37ccd66d4f0faed82a21ec9be902f7
7
+ data.tar.gz: 06dee6f4cd5acc18b7e0b1dcd33191fc489d2abc5eac3ea34571fb2cbb3ab810ad1b1900db80df64d12ca309de66aac6de3906d13a86e3673042bfc10cf855f7
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.667
1
+ 3.0.668
@@ -53,9 +53,11 @@ module TencentCloud
53
53
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
54
54
  end
55
55
 
56
- # 用于撤销签署流程<br/>
56
+ # 用于撤销合同流程<br/>
57
57
  # 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
58
- # `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
58
+
59
+ # 注:
60
+ # `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
59
61
 
60
62
  # @param request: Request instance for CancelFlow.
61
63
  # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
@@ -1499,8 +1501,12 @@ module TencentCloud
1499
1501
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1500
1502
  end
1501
1503
 
1502
- # 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
1503
- # 注意:大文件转换所需的时间可能会比较长。
1504
+ # 此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
1505
+ # 前提条件:已调用 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
1506
+
1507
+ # 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
1508
+ # 注:
1509
+ # 1. `大文件转换所需的时间可能会比较长`
1504
1510
 
1505
1511
  # @param request: Request instance for GetTaskResultApi.
1506
1512
  # @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest`
@@ -1686,13 +1692,19 @@ module TencentCloud
1686
1692
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1687
1693
  end
1688
1694
 
1689
- # 此接口(UploadFiles)用于文件上传。<br/>
1690
- # 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
1695
+ # 此接口(UploadFiles)文件上传。<br/>
1696
+
1697
+ # 适用场景:用于合同,印章的文件上传。文件上传以后,
1698
+ # 如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
1699
+ # 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
1691
1700
 
1692
- # 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。<br/>
1693
- # 调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,代码示例:<br/>
1694
- # HttpProfile httpProfile = new HttpProfile();<br/>
1695
- # httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
1701
+ # 注:
1702
+ # 1. `图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下`
1703
+ # 2. `联调开发环境调用时需要设置Domain接口请求域名为 file.test.ess.tencent.cn,正式环境需要设置为file.ess.tencent.cn,代码示例`
1704
+ # ```
1705
+ # HttpProfile httpProfile = new HttpProfile();
1706
+ # httpProfile.setEndpoint("file.test.ess.tencent.cn");
1707
+ # ```
1696
1708
 
1697
1709
  # @param request: Request instance for UploadFiles.
1698
1710
  # @type request: :class:`Tencentcloud::ess::V20201111::UploadFilesRequest`
@@ -153,6 +153,8 @@ module TencentCloud
153
153
  # <li> **3** :见证人</li></ul>
154
154
  # 注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
155
155
  # @type ApproverRole: Integer
156
+ # @param ApproverRoleName: 自定义签署人角色名:收款人、开具人、见证人
157
+ # @type ApproverRoleName: String
156
158
  # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
157
159
 
158
160
  # 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
@@ -208,9 +210,9 @@ module TencentCloud
208
210
  # 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
209
211
  # @type AddSignComponentsLimits: Array
210
212
 
211
- attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview, :AddSignComponentsLimits
213
+ attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :OrganizationName, :SignComponents, :ApproverIdCardType, :ApproverIdCardNumber, :NotifyType, :ApproverRole, :ApproverRoleName, :VerifyChannel, :PreReadTime, :UserId, :ApproverSource, :CustomApproverTag, :ApproverOption, :ApproverVerifyTypes, :ApproverSignTypes, :ApproverNeedSignReview, :AddSignComponentsLimits
212
214
 
213
- def initialize(approvertype=nil, approvername=nil, approvermobile=nil, organizationname=nil, signcomponents=nil, approveridcardtype=nil, approveridcardnumber=nil, notifytype=nil, approverrole=nil, verifychannel=nil, prereadtime=nil, userid=nil, approversource=nil, customapprovertag=nil, approveroption=nil, approververifytypes=nil, approversigntypes=nil, approverneedsignreview=nil, addsigncomponentslimits=nil)
215
+ def initialize(approvertype=nil, approvername=nil, approvermobile=nil, organizationname=nil, signcomponents=nil, approveridcardtype=nil, approveridcardnumber=nil, notifytype=nil, approverrole=nil, approverrolename=nil, verifychannel=nil, prereadtime=nil, userid=nil, approversource=nil, customapprovertag=nil, approveroption=nil, approververifytypes=nil, approversigntypes=nil, approverneedsignreview=nil, addsigncomponentslimits=nil)
214
216
  @ApproverType = approvertype
215
217
  @ApproverName = approvername
216
218
  @ApproverMobile = approvermobile
@@ -220,6 +222,7 @@ module TencentCloud
220
222
  @ApproverIdCardNumber = approveridcardnumber
221
223
  @NotifyType = notifytype
222
224
  @ApproverRole = approverrole
225
+ @ApproverRoleName = approverrolename
223
226
  @VerifyChannel = verifychannel
224
227
  @PreReadTime = prereadtime
225
228
  @UserId = userid
@@ -249,6 +252,7 @@ module TencentCloud
249
252
  @ApproverIdCardNumber = params['ApproverIdCardNumber']
250
253
  @NotifyType = params['NotifyType']
251
254
  @ApproverRole = params['ApproverRole']
255
+ @ApproverRoleName = params['ApproverRoleName']
252
256
  @VerifyChannel = params['VerifyChannel']
253
257
  @PreReadTime = params['PreReadTime']
254
258
  @UserId = params['UserId']
@@ -272,6 +276,33 @@ module TencentCloud
272
276
  end
273
277
  end
274
278
 
279
+ # 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
280
+ class ApproverItem < TencentCloud::Common::AbstractModel
281
+ # @param SignId: 签署方唯一编号
282
+ # 注意:此字段可能返回 null,表示取不到有效值。
283
+ # @type SignId: String
284
+ # @param RecipientId: 签署方角色编号
285
+ # 注意:此字段可能返回 null,表示取不到有效值。
286
+ # @type RecipientId: String
287
+ # @param ApproverRoleName: 签署方角色名称
288
+ # 注意:此字段可能返回 null,表示取不到有效值。
289
+ # @type ApproverRoleName: String
290
+
291
+ attr_accessor :SignId, :RecipientId, :ApproverRoleName
292
+
293
+ def initialize(signid=nil, recipientid=nil, approverrolename=nil)
294
+ @SignId = signid
295
+ @RecipientId = recipientid
296
+ @ApproverRoleName = approverrolename
297
+ end
298
+
299
+ def deserialize(params)
300
+ @SignId = params['SignId']
301
+ @RecipientId = params['RecipientId']
302
+ @ApproverRoleName = params['ApproverRoleName']
303
+ end
304
+ end
305
+
275
306
  # 签署人个性化能力信息
276
307
  class ApproverOption < TencentCloud::Common::AbstractModel
277
308
  # @param NoRefuse: 签署方是否可以拒签
@@ -284,17 +315,24 @@ module TencentCloud
284
315
  # <ul><li> **false** : ( 默认)可以转他人处理</li>
285
316
  # <li> **true** :不可以转他人处理</li></ul>
286
317
  # @type NoTransfer: Boolean
318
+ # @param FillType: 签署人信息补充类型,默认无需补充。
287
319
 
288
- attr_accessor :NoRefuse, :NoTransfer
320
+ # <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)</li>
321
+ # </ul>
322
+ # @type FillType: Integer
323
+
324
+ attr_accessor :NoRefuse, :NoTransfer, :FillType
289
325
 
290
- def initialize(norefuse=nil, notransfer=nil)
326
+ def initialize(norefuse=nil, notransfer=nil, filltype=nil)
291
327
  @NoRefuse = norefuse
292
328
  @NoTransfer = notransfer
329
+ @FillType = filltype
293
330
  end
294
331
 
295
332
  def deserialize(params)
296
333
  @NoRefuse = params['NoRefuse']
297
334
  @NoTransfer = params['NoTransfer']
335
+ @FillType = params['FillType']
298
336
  end
299
337
  end
300
338
 
@@ -535,9 +573,10 @@ module TencentCloud
535
573
  # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
536
574
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
537
575
  # @param FlowId: 合同流程ID, 为32位字符串。
538
- # 建议开发者保存此流程ID方便后续其他操作。
576
+
577
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
539
578
  # @type FlowId: String
540
- # @param CancelMessage: 撤销此合同(流程)的原因,最长200个字。
579
+ # @param CancelMessage: 撤销此合同流程的原因,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
541
580
  # @type CancelMessage: String
542
581
  # @param Agent: 代理企业和员工的信息。
543
582
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -1382,20 +1421,32 @@ module TencentCloud
1382
1421
  # `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
1383
1422
  # 注意:此字段可能返回 null,表示取不到有效值。
1384
1423
  # @type PreviewFileUrl: String
1424
+ # @param Approvers: 签署方信息,如角色ID、角色名称等
1425
+ # 注意:此字段可能返回 null,表示取不到有效值。
1426
+ # @type Approvers: Array
1385
1427
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1386
1428
  # @type RequestId: String
1387
1429
 
1388
- attr_accessor :DocumentId, :PreviewFileUrl, :RequestId
1430
+ attr_accessor :DocumentId, :PreviewFileUrl, :Approvers, :RequestId
1389
1431
 
1390
- def initialize(documentid=nil, previewfileurl=nil, requestid=nil)
1432
+ def initialize(documentid=nil, previewfileurl=nil, approvers=nil, requestid=nil)
1391
1433
  @DocumentId = documentid
1392
1434
  @PreviewFileUrl = previewfileurl
1435
+ @Approvers = approvers
1393
1436
  @RequestId = requestid
1394
1437
  end
1395
1438
 
1396
1439
  def deserialize(params)
1397
1440
  @DocumentId = params['DocumentId']
1398
1441
  @PreviewFileUrl = params['PreviewFileUrl']
1442
+ unless params['Approvers'].nil?
1443
+ @Approvers = []
1444
+ params['Approvers'].each do |i|
1445
+ approveritem_tmp = ApproverItem.new
1446
+ approveritem_tmp.deserialize(i)
1447
+ @Approvers << approveritem_tmp
1448
+ end
1449
+ end
1399
1450
  @RequestId = params['RequestId']
1400
1451
  end
1401
1452
  end
@@ -1503,15 +1554,21 @@ module TencentCloud
1503
1554
  # @param Agent: 代理企业和员工的信息。
1504
1555
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1505
1556
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1557
+ # @param FillApproverType: 签署人信息补充方式
1558
+
1559
+ # <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
1560
+ # <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
1561
+ # @type FillApproverType: Integer
1506
1562
 
1507
- attr_accessor :Operator, :FlowId, :Approvers, :Initiator, :Agent
1563
+ attr_accessor :Operator, :FlowId, :Approvers, :Initiator, :Agent, :FillApproverType
1508
1564
 
1509
- def initialize(operator=nil, flowid=nil, approvers=nil, initiator=nil, agent=nil)
1565
+ def initialize(operator=nil, flowid=nil, approvers=nil, initiator=nil, agent=nil, fillapprovertype=nil)
1510
1566
  @Operator = operator
1511
1567
  @FlowId = flowid
1512
1568
  @Approvers = approvers
1513
1569
  @Initiator = initiator
1514
1570
  @Agent = agent
1571
+ @FillApproverType = fillapprovertype
1515
1572
  end
1516
1573
 
1517
1574
  def deserialize(params)
@@ -1533,6 +1590,7 @@ module TencentCloud
1533
1590
  @Agent = Agent.new
1534
1591
  @Agent.deserialize(params['Agent'])
1535
1592
  end
1593
+ @FillApproverType = params['FillApproverType']
1536
1594
  end
1537
1595
  end
1538
1596
 
@@ -1745,20 +1803,32 @@ module TencentCloud
1745
1803
  # 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
1746
1804
  # 注意:此字段可能返回 null,表示取不到有效值。
1747
1805
  # @type PreviewUrl: String
1806
+ # @param Approvers: 签署方信息,如角色ID、角色名称等
1807
+ # 注意:此字段可能返回 null,表示取不到有效值。
1808
+ # @type Approvers: Array
1748
1809
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1749
1810
  # @type RequestId: String
1750
1811
 
1751
- attr_accessor :FlowId, :PreviewUrl, :RequestId
1812
+ attr_accessor :FlowId, :PreviewUrl, :Approvers, :RequestId
1752
1813
 
1753
- def initialize(flowid=nil, previewurl=nil, requestid=nil)
1814
+ def initialize(flowid=nil, previewurl=nil, approvers=nil, requestid=nil)
1754
1815
  @FlowId = flowid
1755
1816
  @PreviewUrl = previewurl
1817
+ @Approvers = approvers
1756
1818
  @RequestId = requestid
1757
1819
  end
1758
1820
 
1759
1821
  def deserialize(params)
1760
1822
  @FlowId = params['FlowId']
1761
1823
  @PreviewUrl = params['PreviewUrl']
1824
+ unless params['Approvers'].nil?
1825
+ @Approvers = []
1826
+ params['Approvers'].each do |i|
1827
+ approveritem_tmp = ApproverItem.new
1828
+ approveritem_tmp.deserialize(i)
1829
+ @Approvers << approveritem_tmp
1830
+ end
1831
+ end
1762
1832
  @RequestId = params['RequestId']
1763
1833
  end
1764
1834
  end
@@ -3452,10 +3522,12 @@ module TencentCloud
3452
3522
 
3453
3523
  # 注: `字段为数组, 可以传值隐藏多个按钮`
3454
3524
  # @type Hides: Array
3525
+ # @param RecipientId: 签署节点ID,用于生成动态签署人链接完成领取
3526
+ # @type RecipientId: String
3455
3527
 
3456
- attr_accessor :Operator, :OrganizationName, :Name, :Mobile, :EndPoint, :FlowId, :FlowGroupId, :PathType, :AutoJumpBack, :Agent, :Hides
3528
+ attr_accessor :Operator, :OrganizationName, :Name, :Mobile, :EndPoint, :FlowId, :FlowGroupId, :PathType, :AutoJumpBack, :Agent, :Hides, :RecipientId
3457
3529
 
3458
- def initialize(operator=nil, organizationname=nil, name=nil, mobile=nil, endpoint=nil, flowid=nil, flowgroupid=nil, pathtype=nil, autojumpback=nil, agent=nil, hides=nil)
3530
+ def initialize(operator=nil, organizationname=nil, name=nil, mobile=nil, endpoint=nil, flowid=nil, flowgroupid=nil, pathtype=nil, autojumpback=nil, agent=nil, hides=nil, recipientid=nil)
3459
3531
  @Operator = operator
3460
3532
  @OrganizationName = organizationname
3461
3533
  @Name = name
@@ -3467,6 +3539,7 @@ module TencentCloud
3467
3539
  @AutoJumpBack = autojumpback
3468
3540
  @Agent = agent
3469
3541
  @Hides = hides
3542
+ @RecipientId = recipientid
3470
3543
  end
3471
3544
 
3472
3545
  def deserialize(params)
@@ -3487,6 +3560,7 @@ module TencentCloud
3487
3560
  @Agent.deserialize(params['Agent'])
3488
3561
  end
3489
3562
  @Hides = params['Hides']
3563
+ @RecipientId = params['RecipientId']
3490
3564
  end
3491
3565
  end
3492
3566
 
@@ -3498,18 +3572,22 @@ module TencentCloud
3498
3572
  # <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
3499
3573
  # <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
3500
3574
  # @type SchemeUrl: String
3575
+ # @param SchemeQrcodeUrl: 二维码,在生成动态签署人跳转封面页链接时返回
3576
+ # @type SchemeQrcodeUrl: String
3501
3577
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3502
3578
  # @type RequestId: String
3503
3579
 
3504
- attr_accessor :SchemeUrl, :RequestId
3580
+ attr_accessor :SchemeUrl, :SchemeQrcodeUrl, :RequestId
3505
3581
 
3506
- def initialize(schemeurl=nil, requestid=nil)
3582
+ def initialize(schemeurl=nil, schemeqrcodeurl=nil, requestid=nil)
3507
3583
  @SchemeUrl = schemeurl
3584
+ @SchemeQrcodeUrl = schemeqrcodeurl
3508
3585
  @RequestId = requestid
3509
3586
  end
3510
3587
 
3511
3588
  def deserialize(params)
3512
3589
  @SchemeUrl = params['SchemeUrl']
3590
+ @SchemeQrcodeUrl = params['SchemeQrcodeUrl']
3513
3591
  @RequestId = params['RequestId']
3514
3592
  end
3515
3593
  end
@@ -4295,10 +4373,10 @@ module TencentCloud
4295
4373
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4296
4374
  # @param BusinessType: 文件对应的业务类型,目前支持:
4297
4375
  # <ul>
4298
- # <li>FLOW 如需下载合同文件请选择此项</li>
4299
- # <li>TEMPLATE 如需下载模板文件请选择此项</li>
4300
- # <li>DOCUMENT 如需下载文档文件请选择此项</li>
4301
- # <li>SEAL 如需下载印章图片请选择此项</li>
4376
+ # <li>**FLOW ** : 如需下载合同文件请选择此项</li>
4377
+ # <li>**TEMPLATE ** : 如需下载模板文件请选择此项</li>
4378
+ # <li>**DOCUMENT **: 如需下载文档文件请选择此项</li>
4379
+ # <li>**SEAL **: 如需下载印章图片请选择此项</li>
4302
4380
  # </ul>
4303
4381
  # @type BusinessType: String
4304
4382
  # @param BusinessIds: 业务编号的数组,取值如下:
@@ -4378,7 +4456,7 @@ module TencentCloud
4378
4456
  # DescribeFileUrls返回参数结构体
4379
4457
  class DescribeFileUrlsResponse < TencentCloud::Common::AbstractModel
4380
4458
  # @param FileUrls: 文件URL信息;
4381
- # 链接不是永久链接,有效期5分钟后链接失效。
4459
+ # 链接不是永久链接, 过期时间收UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
4382
4460
  # @type FileUrls: Array
4383
4461
  # @param TotalCount: URL数量
4384
4462
  # @type TotalCount: Integer
@@ -5775,15 +5853,18 @@ module TencentCloud
5775
5853
  # @type ApproverName: String
5776
5854
  # @param ApproverMobile: 补充企业签署人员工手机号
5777
5855
  # @type ApproverMobile: String
5856
+ # @param OrganizationName: 补充企业动态签署人时,需要指定对应企业名称
5857
+ # @type OrganizationName: String
5778
5858
 
5779
- attr_accessor :RecipientId, :ApproverSource, :CustomUserId, :ApproverName, :ApproverMobile
5859
+ attr_accessor :RecipientId, :ApproverSource, :CustomUserId, :ApproverName, :ApproverMobile, :OrganizationName
5780
5860
 
5781
- def initialize(recipientid=nil, approversource=nil, customuserid=nil, approvername=nil, approvermobile=nil)
5861
+ def initialize(recipientid=nil, approversource=nil, customuserid=nil, approvername=nil, approvermobile=nil, organizationname=nil)
5782
5862
  @RecipientId = recipientid
5783
5863
  @ApproverSource = approversource
5784
5864
  @CustomUserId = customuserid
5785
5865
  @ApproverName = approvername
5786
5866
  @ApproverMobile = approvermobile
5867
+ @OrganizationName = organizationname
5787
5868
  end
5788
5869
 
5789
5870
  def deserialize(params)
@@ -5792,6 +5873,7 @@ module TencentCloud
5792
5873
  @CustomUserId = params['CustomUserId']
5793
5874
  @ApproverName = params['ApproverName']
5794
5875
  @ApproverMobile = params['ApproverMobile']
5876
+ @OrganizationName = params['OrganizationName']
5795
5877
  end
5796
5878
  end
5797
5879
 
@@ -5908,10 +5990,13 @@ module TencentCloud
5908
5990
  # @param SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
5909
5991
  # 注意:此字段可能返回 null,表示取不到有效值。
5910
5992
  # @type SignId: String
5993
+ # @param ApproverRoleName: 自定义签署人角色
5994
+ # 注意:此字段可能返回 null,表示取不到有效值。
5995
+ # @type ApproverRoleName: String
5911
5996
 
5912
- attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName, :SignId
5997
+ attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName, :SignId, :ApproverRoleName
5913
5998
 
5914
- def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil, signid=nil)
5999
+ def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil, signid=nil, approverrolename=nil)
5915
6000
  @ApproveMessage = approvemessage
5916
6001
  @ApproveName = approvename
5917
6002
  @ApproveStatus = approvestatus
@@ -5926,6 +6011,7 @@ module TencentCloud
5926
6011
  @OrganizationId = organizationid
5927
6012
  @OrganizationName = organizationname
5928
6013
  @SignId = signid
6014
+ @ApproverRoleName = approverrolename
5929
6015
  end
5930
6016
 
5931
6017
  def deserialize(params)
@@ -5943,6 +6029,7 @@ module TencentCloud
5943
6029
  @OrganizationId = params['OrganizationId']
5944
6030
  @OrganizationName = params['OrganizationName']
5945
6031
  @SignId = params['SignId']
6032
+ @ApproverRoleName = params['ApproverRoleName']
5946
6033
  end
5947
6034
  end
5948
6035
 
@@ -6689,11 +6776,14 @@ module TencentCloud
6689
6776
 
6690
6777
  # GetTaskResultApi请求参数结构体
6691
6778
  class GetTaskResultApiRequest < TencentCloud::Common::AbstractModel
6692
- # @param TaskId: 任务Id,通过接口CreateConvertTaskApiCreateMergeFileTask得到的返回任务id
6779
+ # @param TaskId: 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>或<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateMergeFileTask" target="_blank">创建多文件转换任务接口</a>
6780
+ # 得到的转换任务id
6693
6781
  # @type TaskId: String
6694
- # @param Operator: 操作人信息,UserId必填
6782
+ # @param Operator: 执行本接口操作的员工信息。
6783
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
6695
6784
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
6696
- # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6785
+ # @param Agent: 代理企业和员工的信息。
6786
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6697
6787
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
6698
6788
  # @param Organization: 暂未开放
6699
6789
  # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
@@ -6732,20 +6822,20 @@ module TencentCloud
6732
6822
  # @param TaskId: 任务Id
6733
6823
  # @type TaskId: String
6734
6824
  # @param TaskStatus: 任务状态,需要关注的状态
6735
- # 0 :NeedTranform - 任务已提交
6736
- # 4 :Processing - 文档转换中
6737
- # 8 :TaskEnd - 任务处理完成
6738
- # -2 :DownloadFailed - 下载失败
6739
- # -6 :ProcessFailed - 转换失败
6740
- # -13:ProcessTimeout - 转换文件超时
6825
+ # <ul><li>**0** :NeedTranform - 任务已提交</li>
6826
+ # <li>**4** :Processing - 文档转换中</li>
6827
+ # <li>**8** :TaskEnd - 任务处理完成</li>
6828
+ # <li>**-2** :DownloadFailed - 下载失败</li>
6829
+ # <li>**-6** :ProcessFailed - 转换失败</li>
6830
+ # <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
6741
6831
  # @type TaskStatus: Integer
6742
6832
  # @param TaskMessage: 状态描述,需要关注的状态
6743
- # NeedTranform - 任务已提交
6744
- # Processing - 文档转换中
6745
- # TaskEnd - 任务处理完成
6746
- # DownloadFailed - 下载失败
6747
- # ProcessFailed - 转换失败
6748
- # ProcessTimeout - 转换文件超时
6833
+ # <ul><li> **NeedTranform** : 任务已提交</li>
6834
+ # <li> **Processing** : 文档转换中</li>
6835
+ # <li> **TaskEnd** : 任务处理完成</li>
6836
+ # <li> **DownloadFailed** : 下载失败</li>
6837
+ # <li> **ProcessFailed** : 转换失败</li>
6838
+ # <li> **ProcessTimeout** : 转换文件超时</li></ul>
6749
6839
  # @type TaskMessage: String
6750
6840
  # @param ResourceId: 资源Id,也是FileId,用于文件发起时使用
6751
6841
  # @type ResourceId: String
@@ -8400,33 +8490,52 @@ module TencentCloud
8400
8490
 
8401
8491
  # UploadFiles请求参数结构体
8402
8492
  class UploadFilesRequest < TencentCloud::Common::AbstractModel
8403
- # @param BusinessType: 文件对应业务类型
8404
- # 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
8405
- # 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
8406
- # 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
8493
+ # @param BusinessType: 文件对应业务类型,可以选择的类型如下
8494
+ # <ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
8495
+ # <li> **DOCUMENT** : 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
8496
+ # <li> **DOCUMENT** : 此文件用于合同图片控件的填充,文件类型支持.jpg/.png</li>
8497
+ # <li> **SEAL** : 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li></ul>
8407
8498
  # @type BusinessType: String
8408
- # @param Caller: 调用方信息,其中OperatorId为必填字段,即用户的UserId
8499
+ # @param Caller: 执行本接口操作的员工信息。其中OperatorId为必填字段,即用户的UserId
8500
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
8409
8501
  # @type Caller: :class:`Tencentcloud::Ess.v20201111.models.Caller`
8410
- # @param FileInfos: 上传文件内容数组,最多支持20个文件
8502
+ # @param FileInfos: 上传文件内容数组,最多支持上传20个文件。
8411
8503
  # @type FileInfos: Array
8412
- # @param FileType: 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
8413
- # 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
8504
+ # @param FileType: 文件类型, 默认通过文件内容和文件后缀一起解析得到文件类型,调用接口时可以显示的指定上传文件的类型。
8505
+ # 可支持的指定类型如下:
8506
+ # <ul><li>pdf</li>
8507
+ # <li>doc</li>
8508
+ # <li>docx</li>
8509
+ # <li>xls</li>
8510
+ # <li>xlsx</li>
8511
+ # <li>html</li>
8512
+ # <li>jpg</li>
8513
+ # <li>jpeg</li>
8514
+ # <li>png</li></ul>
8515
+ # 如:pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
8414
8516
  # @type FileType: String
8415
- # @param CoverRect: 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
8416
- # true--是,处理置白
8417
- # 默认为false--否,不处理
8517
+ # @param CoverRect: 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。
8518
+ # <ul><li>**true**:将灰色矩阵置为白色。</li>
8519
+ # <li>**false**:无需处理,不会将灰色矩阵置为白色(默认)。</li></ul>
8520
+
8521
+ # 注: `该参数仅在关键字定位时,需要去除关键字所在的灰框场景下使用。`
8418
8522
  # @type CoverRect: Boolean
8419
8523
  # @param CustomIds: 用户自定义ID数组,与上传文件一一对应
8524
+
8525
+ # 注: `历史遗留问题,已经废弃,调用接口时不用赋值`
8420
8526
  # @type CustomIds: Array
8421
8527
  # @param FileUrls: 不再使用,上传文件链接数组,最多支持20个URL
8422
8528
  # @type FileUrls: String
8529
+ # @param Agent: 代理企业和员工的信息。
8530
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8531
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
8423
8532
 
8424
- attr_accessor :BusinessType, :Caller, :FileInfos, :FileType, :CoverRect, :CustomIds, :FileUrls
8533
+ attr_accessor :BusinessType, :Caller, :FileInfos, :FileType, :CoverRect, :CustomIds, :FileUrls, :Agent
8425
8534
  extend Gem::Deprecate
8426
8535
  deprecate :FileUrls, :none, 2023, 9
8427
8536
  deprecate :FileUrls=, :none, 2023, 9
8428
8537
 
8429
- def initialize(businesstype=nil, caller=nil, fileinfos=nil, filetype=nil, coverrect=nil, customids=nil, fileurls=nil)
8538
+ def initialize(businesstype=nil, caller=nil, fileinfos=nil, filetype=nil, coverrect=nil, customids=nil, fileurls=nil, agent=nil)
8430
8539
  @BusinessType = businesstype
8431
8540
  @Caller = caller
8432
8541
  @FileInfos = fileinfos
@@ -8434,6 +8543,7 @@ module TencentCloud
8434
8543
  @CoverRect = coverrect
8435
8544
  @CustomIds = customids
8436
8545
  @FileUrls = fileurls
8546
+ @Agent = agent
8437
8547
  end
8438
8548
 
8439
8549
  def deserialize(params)
@@ -8454,12 +8564,17 @@ module TencentCloud
8454
8564
  @CoverRect = params['CoverRect']
8455
8565
  @CustomIds = params['CustomIds']
8456
8566
  @FileUrls = params['FileUrls']
8567
+ unless params['Agent'].nil?
8568
+ @Agent = Agent.new
8569
+ @Agent.deserialize(params['Agent'])
8570
+ end
8457
8571
  end
8458
8572
  end
8459
8573
 
8460
8574
  # UploadFiles返回参数结构体
8461
8575
  class UploadFilesResponse < TencentCloud::Common::AbstractModel
8462
- # @param FileIds: 文件id数组
8576
+ # @param FileIds: 文件资源ID数组,每个文件资源ID为32位字符串。
8577
+ # 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
8463
8578
  # @type FileIds: Array
8464
8579
  # @param TotalCount: 上传成功文件数量
8465
8580
  # @type TotalCount: Integer
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.667
4
+ version: 3.0.668
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-26 00:00:00.000000000 Z
11
+ date: 2023-09-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,9 +33,9 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
+ - lib/tencentcloud-sdk-ess.rb
36
37
  - lib/v20201111/models.rb
37
38
  - lib/v20201111/client.rb
38
- - lib/tencentcloud-sdk-ess.rb
39
39
  - lib/VERSION
40
40
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
41
41
  licenses: