tencentcloud-sdk-essbasic 3.0.624 → 3.0.626

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: 60ae778805b9af9a72199376a67a877c9e140f09
4
- data.tar.gz: 60a0fa05a54935669e66caf4af2ac67a06ba3c15
3
+ metadata.gz: 1c4fdf91e036df69fa6f5da8615bd9a5e246c760
4
+ data.tar.gz: 8b42abf5c4166e5147f0172d4f298b7b319d0998
5
5
  SHA512:
6
- metadata.gz: 35656a85d1f89ede6e13c7bdceca30920d0c481f940f5b9aede3d86e03372558133488a673d40dabdeb280ac749bc5e728852abcdbb27da687cdc4d483ab873e
7
- data.tar.gz: 65435d5f84f49cf51c305fbfda94e371012f88f5b759fc113d4972304ed8144ccb7421d2fb667ef626ad0ec499a7aeb77a8c0f91150386632dd1a6bf15b3cccf
6
+ metadata.gz: c1813044566c15b0b592ca23fb0316ea18021d70eaa51f6f7bf20c0b14466e4adb9b1741391e81149b3ab2ba17b3f5359a49755561ed531be761f2e611966644
7
+ data.tar.gz: 73b349846a5c96f660d2fae9cc27f262acdfae12f003ea54a4ede29a15753260c01f336c0b1f87e171078fe8ee0c8a5d02e260d411af4124fbe4ea1caaa78d83
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.624
1
+ 3.0.626
@@ -701,7 +701,8 @@ module TencentCloud
701
701
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
702
702
  end
703
703
 
704
- # 通过发起转换任务接口(ChannelCreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
704
+ # 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
705
+ # 注意:大文件转换所需的时间可能会比较长。
705
706
 
706
707
  # @param request: Request instance for ChannelGetTaskResultApi.
707
708
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelGetTaskResultApiRequest`
@@ -1018,7 +1019,17 @@ module TencentCloud
1018
1019
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1019
1020
  end
1020
1021
 
1021
- # 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
1022
+ # 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
1023
+
1024
+ # > **适用场景**
1025
+ # >
1026
+ # > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
1027
+ # > 一个模板通常会包含以下结构信息
1028
+ # >- 模板基本信息
1029
+ # >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
1030
+ # >- 填写控件 Components
1031
+ # >- 签署控件 SignComponents
1032
+ # >- 生成模板的文件基础信息 FileInfos
1022
1033
 
1023
1034
  # @param request: Request instance for DescribeTemplates.
1024
1035
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesRequest`
@@ -32,8 +32,8 @@ module TencentCloud
32
32
 
33
33
  attr_accessor :AppId, :ProxyOrganizationOpenId, :ProxyOperator, :ProxyAppId, :ProxyOrganizationId
34
34
  extend Gem::Deprecate
35
- deprecate :ProxyOrganizationId, :none, 2023, 7
36
- deprecate :ProxyOrganizationId=, :none, 2023, 7
35
+ deprecate :ProxyOrganizationId, :none, 2023, 8
36
+ deprecate :ProxyOrganizationId=, :none, 2023, 8
37
37
 
38
38
  def initialize(appid=nil, proxyorganizationopenid=nil, proxyoperator=nil, proxyappid=nil, proxyorganizationid=nil)
39
39
  @AppId = appid
@@ -264,8 +264,8 @@ module TencentCloud
264
264
 
265
265
  attr_accessor :Agent, :FlowIds, :CancelMessage, :CancelMessageFormat, :Operator
266
266
  extend Gem::Deprecate
267
- deprecate :Operator, :none, 2023, 7
268
- deprecate :Operator=, :none, 2023, 7
267
+ deprecate :Operator, :none, 2023, 8
268
+ deprecate :Operator=, :none, 2023, 8
269
269
 
270
270
  def initialize(agent=nil, flowids=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil)
271
271
  @Agent = agent
@@ -329,8 +329,8 @@ module TencentCloud
329
329
 
330
330
  attr_accessor :FlowId, :Agent, :CancelMessage, :CancelMessageFormat, :Operator
331
331
  extend Gem::Deprecate
332
- deprecate :Operator, :none, 2023, 7
333
- deprecate :Operator=, :none, 2023, 7
332
+ deprecate :Operator, :none, 2023, 8
333
+ deprecate :Operator=, :none, 2023, 8
334
334
 
335
335
  def initialize(flowid=nil, agent=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil)
336
336
  @FlowId = flowid
@@ -382,8 +382,8 @@ module TencentCloud
382
382
 
383
383
  attr_accessor :Agent, :QrCodeId, :Operator
384
384
  extend Gem::Deprecate
385
- deprecate :Operator, :none, 2023, 7
386
- deprecate :Operator=, :none, 2023, 7
385
+ deprecate :Operator, :none, 2023, 8
386
+ deprecate :Operator=, :none, 2023, 8
387
387
 
388
388
  def initialize(agent=nil, qrcodeid=nil, operator=nil)
389
389
  @Agent = agent
@@ -431,8 +431,8 @@ module TencentCloud
431
431
 
432
432
  attr_accessor :Agent, :FlowIds, :Operator
433
433
  extend Gem::Deprecate
434
- deprecate :Operator, :none, 2023, 7
435
- deprecate :Operator=, :none, 2023, 7
434
+ deprecate :Operator, :none, 2023, 8
435
+ deprecate :Operator=, :none, 2023, 8
436
436
 
437
437
  def initialize(agent=nil, flowids=nil, operator=nil)
438
438
  @Agent = agent
@@ -493,8 +493,8 @@ module TencentCloud
493
493
 
494
494
  attr_accessor :Agent, :FlowIds, :Operator
495
495
  extend Gem::Deprecate
496
- deprecate :Operator, :none, 2023, 7
497
- deprecate :Operator=, :none, 2023, 7
496
+ deprecate :Operator, :none, 2023, 8
497
+ deprecate :Operator=, :none, 2023, 8
498
498
 
499
499
  def initialize(agent=nil, flowids=nil, operator=nil)
500
500
  @Agent = agent
@@ -548,10 +548,10 @@ module TencentCloud
548
548
 
549
549
  attr_accessor :Agent, :ResourceType, :ResourceName, :ResourceId, :Operator, :Organization
550
550
  extend Gem::Deprecate
551
- deprecate :Operator, :none, 2023, 7
552
- deprecate :Operator=, :none, 2023, 7
553
- deprecate :Organization, :none, 2023, 7
554
- deprecate :Organization=, :none, 2023, 7
551
+ deprecate :Operator, :none, 2023, 8
552
+ deprecate :Operator=, :none, 2023, 8
553
+ deprecate :Organization, :none, 2023, 8
554
+ deprecate :Organization=, :none, 2023, 8
555
555
 
556
556
  def initialize(agent=nil, resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, organization=nil)
557
557
  @Agent = agent
@@ -630,8 +630,8 @@ module TencentCloud
630
630
 
631
631
  attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator
632
632
  extend Gem::Deprecate
633
- deprecate :Operator, :none, 2023, 7
634
- deprecate :Operator=, :none, 2023, 7
633
+ deprecate :Operator, :none, 2023, 8
634
+ deprecate :Operator=, :none, 2023, 8
635
635
 
636
636
  def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil)
637
637
  @Agent = agent
@@ -722,8 +722,8 @@ module TencentCloud
722
722
 
723
723
  attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :CcInfos, :CcNotifyType, :AutoSignScene, :Operator
724
724
  extend Gem::Deprecate
725
- deprecate :Operator, :none, 2023, 7
726
- deprecate :Operator=, :none, 2023, 7
725
+ deprecate :Operator, :none, 2023, 8
726
+ deprecate :Operator=, :none, 2023, 8
727
727
 
728
728
  def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil)
729
729
  @Agent = agent
@@ -836,8 +836,8 @@ module TencentCloud
836
836
 
837
837
  attr_accessor :FlowFileInfos, :FlowGroupName, :Agent, :ApproverVerifyType, :Operator
838
838
  extend Gem::Deprecate
839
- deprecate :Operator, :none, 2023, 7
840
- deprecate :Operator=, :none, 2023, 7
839
+ deprecate :Operator, :none, 2023, 8
840
+ deprecate :Operator=, :none, 2023, 8
841
841
 
842
842
  def initialize(flowfileinfos=nil, flowgroupname=nil, agent=nil, approververifytype=nil, operator=nil)
843
843
  @FlowFileInfos = flowfileinfos
@@ -1095,10 +1095,10 @@ module TencentCloud
1095
1095
 
1096
1096
  attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl
1097
1097
  extend Gem::Deprecate
1098
- deprecate :Operator, :none, 2023, 7
1099
- deprecate :Operator=, :none, 2023, 7
1100
- deprecate :Organization, :none, 2023, 7
1101
- deprecate :Organization=, :none, 2023, 7
1098
+ deprecate :Operator, :none, 2023, 8
1099
+ deprecate :Operator=, :none, 2023, 8
1100
+ deprecate :Organization, :none, 2023, 8
1101
+ deprecate :Organization=, :none, 2023, 8
1102
1102
 
1103
1103
  def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil)
1104
1104
  @Agent = agent
@@ -1171,13 +1171,16 @@ module TencentCloud
1171
1171
  # @type TemplateId: String
1172
1172
  # @param FlowName: 签署流程名称,最大长度200个字符。
1173
1173
  # @type FlowName: String
1174
- # @param MaxFlowNum: 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
1174
+ # @param MaxFlowNum: 最大可发起签署流程份数
1175
+ # <br/>默认5份
1176
+ # <br/>备注:发起签署流程数量超过此上限后,二维码自动失效。
1175
1177
  # @type MaxFlowNum: Integer
1176
1178
  # @param FlowEffectiveDay: 签署流程有效天数 默认7天 最高设置不超过30天
1177
1179
  # @type FlowEffectiveDay: Integer
1178
1180
  # @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
1179
1181
  # @type QrEffectiveDay: Integer
1180
- # @param Restrictions: 限制二维码用户条件
1182
+ # @param Restrictions: 指定的签署二维码签署人
1183
+ # <br/>指定后,只允许知道的人操作和签署
1181
1184
  # @type Restrictions: Array
1182
1185
  # @param CallbackUrl: 回调地址,最大长度1000个字符
1183
1186
  # 不传默认使用第三方应用号配置的回调地址
@@ -1190,10 +1193,10 @@ module TencentCloud
1190
1193
 
1191
1194
  attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :CallbackUrl, :ApproverRestrictions, :Operator
1192
1195
  extend Gem::Deprecate
1193
- deprecate :ApproverRestrictions, :none, 2023, 7
1194
- deprecate :ApproverRestrictions=, :none, 2023, 7
1195
- deprecate :Operator, :none, 2023, 7
1196
- deprecate :Operator=, :none, 2023, 7
1196
+ deprecate :ApproverRestrictions, :none, 2023, 8
1197
+ deprecate :ApproverRestrictions=, :none, 2023, 8
1198
+ deprecate :Operator, :none, 2023, 8
1199
+ deprecate :Operator=, :none, 2023, 8
1197
1200
 
1198
1201
  def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, callbackurl=nil, approverrestrictions=nil, operator=nil)
1199
1202
  @Agent = agent
@@ -1336,12 +1339,12 @@ module TencentCloud
1336
1339
 
1337
1340
  attr_accessor :ResourceId, :ResourceType, :FlowInfo, :Agent, :FlowOption, :FlowApproverList, :FlowId, :NeedPreview, :Organization, :Operator
1338
1341
  extend Gem::Deprecate
1339
- deprecate :NeedPreview, :none, 2023, 7
1340
- deprecate :NeedPreview=, :none, 2023, 7
1341
- deprecate :Organization, :none, 2023, 7
1342
- deprecate :Organization=, :none, 2023, 7
1343
- deprecate :Operator, :none, 2023, 7
1344
- deprecate :Operator=, :none, 2023, 7
1342
+ deprecate :NeedPreview, :none, 2023, 8
1343
+ deprecate :NeedPreview=, :none, 2023, 8
1344
+ deprecate :Organization, :none, 2023, 8
1345
+ deprecate :Organization=, :none, 2023, 8
1346
+ deprecate :Operator, :none, 2023, 8
1347
+ deprecate :Operator=, :none, 2023, 8
1345
1348
 
1346
1349
  def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, agent=nil, flowoption=nil, flowapproverlist=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil)
1347
1350
  @ResourceId = resourceid
@@ -1437,10 +1440,10 @@ module TencentCloud
1437
1440
 
1438
1441
  attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline
1439
1442
  extend Gem::Deprecate
1440
- deprecate :Organization, :none, 2023, 7
1441
- deprecate :Organization=, :none, 2023, 7
1442
- deprecate :Operator, :none, 2023, 7
1443
- deprecate :Operator=, :none, 2023, 7
1443
+ deprecate :Organization, :none, 2023, 8
1444
+ deprecate :Organization=, :none, 2023, 8
1445
+ deprecate :Operator, :none, 2023, 8
1446
+ deprecate :Operator=, :none, 2023, 8
1444
1447
 
1445
1448
  def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil)
1446
1449
  @Agent = agent
@@ -1520,10 +1523,10 @@ module TencentCloud
1520
1523
 
1521
1524
  attr_accessor :Agent, :SealId, :UserIds, :Operator, :Organization
1522
1525
  extend Gem::Deprecate
1523
- deprecate :Operator, :none, 2023, 7
1524
- deprecate :Operator=, :none, 2023, 7
1525
- deprecate :Organization, :none, 2023, 7
1526
- deprecate :Organization=, :none, 2023, 7
1526
+ deprecate :Operator, :none, 2023, 8
1527
+ deprecate :Operator=, :none, 2023, 8
1528
+ deprecate :Organization, :none, 2023, 8
1529
+ deprecate :Organization=, :none, 2023, 8
1527
1530
 
1528
1531
  def initialize(agent=nil, sealid=nil, userids=nil, operator=nil, organization=nil)
1529
1532
  @Agent = agent
@@ -1587,8 +1590,8 @@ module TencentCloud
1587
1590
 
1588
1591
  attr_accessor :Agent, :RoleIds, :UserIds, :OpenIds, :Operator
1589
1592
  extend Gem::Deprecate
1590
- deprecate :Operator, :none, 2023, 7
1591
- deprecate :Operator=, :none, 2023, 7
1593
+ deprecate :Operator, :none, 2023, 8
1594
+ deprecate :Operator=, :none, 2023, 8
1592
1595
 
1593
1596
  def initialize(agent=nil, roleids=nil, userids=nil, openids=nil, operator=nil)
1594
1597
  @Agent = agent
@@ -1702,8 +1705,8 @@ module TencentCloud
1702
1705
 
1703
1706
  attr_accessor :Agent, :RoleId, :UserIds, :Operator, :OpenIds
1704
1707
  extend Gem::Deprecate
1705
- deprecate :Operator, :none, 2023, 7
1706
- deprecate :Operator=, :none, 2023, 7
1708
+ deprecate :Operator, :none, 2023, 8
1709
+ deprecate :Operator=, :none, 2023, 8
1707
1710
 
1708
1711
  def initialize(agent=nil, roleid=nil, userids=nil, operator=nil, openids=nil)
1709
1712
  @Agent = agent
@@ -1764,10 +1767,10 @@ module TencentCloud
1764
1767
 
1765
1768
  attr_accessor :Agent, :SealId, :UserIds, :Organization, :Operator
1766
1769
  extend Gem::Deprecate
1767
- deprecate :Organization, :none, 2023, 7
1768
- deprecate :Organization=, :none, 2023, 7
1769
- deprecate :Operator, :none, 2023, 7
1770
- deprecate :Operator=, :none, 2023, 7
1770
+ deprecate :Organization, :none, 2023, 8
1771
+ deprecate :Organization=, :none, 2023, 8
1772
+ deprecate :Operator, :none, 2023, 8
1773
+ deprecate :Operator=, :none, 2023, 8
1771
1774
 
1772
1775
  def initialize(agent=nil, sealid=nil, userids=nil, organization=nil, operator=nil)
1773
1776
  @Agent = agent
@@ -1828,8 +1831,8 @@ module TencentCloud
1828
1831
 
1829
1832
  attr_accessor :Limit, :Agent, :Filters, :Offset, :Operator
1830
1833
  extend Gem::Deprecate
1831
- deprecate :Operator, :none, 2023, 7
1832
- deprecate :Operator=, :none, 2023, 7
1834
+ deprecate :Operator, :none, 2023, 8
1835
+ deprecate :Operator=, :none, 2023, 8
1833
1836
 
1834
1837
  def initialize(limit=nil, agent=nil, filters=nil, offset=nil, operator=nil)
1835
1838
  @Limit = limit
@@ -2046,8 +2049,8 @@ module TencentCloud
2046
2049
 
2047
2050
  attr_accessor :Agent, :Offset, :Limit, :Filters, :Operator
2048
2051
  extend Gem::Deprecate
2049
- deprecate :Operator, :none, 2023, 7
2050
- deprecate :Operator=, :none, 2023, 7
2052
+ deprecate :Operator, :none, 2023, 8
2053
+ deprecate :Operator=, :none, 2023, 8
2051
2054
 
2052
2055
  def initialize(agent=nil, offset=nil, limit=nil, filters=nil, operator=nil)
2053
2056
  @Agent = agent
@@ -2132,10 +2135,10 @@ module TencentCloud
2132
2135
 
2133
2136
  attr_accessor :Agent, :TaskId, :Operator, :Organization
2134
2137
  extend Gem::Deprecate
2135
- deprecate :Operator, :none, 2023, 7
2136
- deprecate :Operator=, :none, 2023, 7
2137
- deprecate :Organization, :none, 2023, 7
2138
- deprecate :Organization=, :none, 2023, 7
2138
+ deprecate :Operator, :none, 2023, 8
2139
+ deprecate :Operator=, :none, 2023, 8
2140
+ deprecate :Organization, :none, 2023, 8
2141
+ deprecate :Organization=, :none, 2023, 8
2139
2142
 
2140
2143
  def initialize(agent=nil, taskid=nil, operator=nil, organization=nil)
2141
2144
  @Agent = agent
@@ -2192,8 +2195,8 @@ module TencentCloud
2192
2195
 
2193
2196
  attr_accessor :TaskId, :TaskStatus, :TaskMessage, :ResourceId, :PreviewUrl, :RequestId
2194
2197
  extend Gem::Deprecate
2195
- deprecate :PreviewUrl, :none, 2023, 7
2196
- deprecate :PreviewUrl=, :none, 2023, 7
2198
+ deprecate :PreviewUrl, :none, 2023, 8
2199
+ deprecate :PreviewUrl=, :none, 2023, 8
2197
2200
 
2198
2201
  def initialize(taskid=nil, taskstatus=nil, taskmessage=nil, resourceid=nil, previewurl=nil, requestid=nil)
2199
2202
  @TaskId = taskid
@@ -2256,8 +2259,8 @@ module TencentCloud
2256
2259
 
2257
2260
  attr_accessor :Agent, :Status, :SealId, :Reason, :Operator
2258
2261
  extend Gem::Deprecate
2259
- deprecate :Operator, :none, 2023, 7
2260
- deprecate :Operator=, :none, 2023, 7
2262
+ deprecate :Operator, :none, 2023, 8
2263
+ deprecate :Operator=, :none, 2023, 8
2261
2264
 
2262
2265
  def initialize(agent=nil, status=nil, sealid=nil, reason=nil, operator=nil)
2263
2266
  @Agent = agent
@@ -2309,8 +2312,8 @@ module TencentCloud
2309
2312
 
2310
2313
  attr_accessor :FlowId, :Agent, :Operator
2311
2314
  extend Gem::Deprecate
2312
- deprecate :Operator, :none, 2023, 7
2313
- deprecate :Operator=, :none, 2023, 7
2315
+ deprecate :Operator, :none, 2023, 8
2316
+ deprecate :Operator=, :none, 2023, 8
2314
2317
 
2315
2318
  def initialize(flowid=nil, agent=nil, operator=nil)
2316
2319
  @FlowId = flowid
@@ -2412,8 +2415,8 @@ module TencentCloud
2412
2415
 
2413
2416
  attr_accessor :NotChannelOrganization, :ApproverType, :OrganizationId, :OrganizationOpenId, :OrganizationName, :UserId, :OpenId, :ApproverName, :ApproverMobile, :RecipientId, :PreReadTime, :IsFullText, :NotifyType, :ApproverOption
2414
2417
  extend Gem::Deprecate
2415
- deprecate :NotifyType, :none, 2023, 7
2416
- deprecate :NotifyType=, :none, 2023, 7
2418
+ deprecate :NotifyType, :none, 2023, 8
2419
+ deprecate :NotifyType=, :none, 2023, 8
2417
2420
 
2418
2421
  def initialize(notchannelorganization=nil, approvertype=nil, organizationid=nil, organizationopenid=nil, organizationname=nil, userid=nil, openid=nil, approvername=nil, approvermobile=nil, recipientid=nil, prereadtime=nil, isfulltext=nil, notifytype=nil, approveroption=nil)
2419
2422
  @NotChannelOrganization = notchannelorganization
@@ -2468,8 +2471,7 @@ module TencentCloud
2468
2471
 
2469
2472
  # 注:
2470
2473
  # 当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
2471
- # 例:
2472
- # 当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
2474
+ # 例:当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
2473
2475
  # 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
2474
2476
 
2475
2477
  # 创建控件时,此值为空
@@ -2497,11 +2499,12 @@ module TencentCloud
2497
2499
 
2498
2500
  # 表单域的控件不能作为印章和签名控件
2499
2501
  # @type ComponentType: String
2500
- # @param ComponentName: 控件简称,不能超过30个字符
2502
+ # @param ComponentName: 控件简称,不超过30个字符
2501
2503
  # @type ComponentName: String
2502
- # @param ComponentRequired: 定义控件是否为必填项,默认为false
2504
+ # @param ComponentRequired: 控件是否为必填项,
2505
+ # 默认为false-非必填
2503
2506
  # @type ComponentRequired: Boolean
2504
- # @param ComponentRecipientId: 控件关联的签署方id
2507
+ # @param ComponentRecipientId: 控件关联的参与方ID,对应Recipient结构体中的RecipientId
2505
2508
  # @type ComponentRecipientId: String
2506
2509
  # @param FileIndex: 控件所属文件的序号 (文档中文件的排列序号,从0开始)
2507
2510
  # @type FileIndex: Integer
@@ -2640,9 +2643,9 @@ module TencentCloud
2640
2643
 
2641
2644
  # 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
2642
2645
  # @type ComponentDateFontSize: Integer
2643
- # @param DocumentId: 控件所属文档的Id, 模块相关接口为空值
2646
+ # @param DocumentId: 控件所属文档的Id, 模板相关接口为空值
2644
2647
  # @type DocumentId: String
2645
- # @param ComponentDescription: 控件描述,不能超过30个字符
2648
+ # @param ComponentDescription: 控件描述,不超过30个字符
2646
2649
  # @type ComponentDescription: String
2647
2650
  # @param OffsetX: 指定关键字时横坐标偏移量,单位pt
2648
2651
  # @type OffsetX: Float
@@ -2651,14 +2654,25 @@ module TencentCloud
2651
2654
  # @param ChannelComponentId: 平台企业控件ID。
2652
2655
  # 如果不为空,属于平台企业预设控件;
2653
2656
  # @type ChannelComponentId: String
2654
- # @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
2657
+ # @param KeywordOrder: 指定关键字排序规则,
2658
+ # Positive-正序,
2659
+ # Reverse-倒序。
2660
+ # 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
2655
2661
  # 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
2656
2662
  # @type KeywordOrder: String
2657
- # @param KeywordPage: 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
2663
+ # @param KeywordPage: 指定关键字页码。
2664
+ # 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
2658
2665
  # @type KeywordPage: Integer
2659
- # @param RelativeLocation: 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
2666
+ # @param RelativeLocation: 关键字位置模式,
2667
+ # Middle-居中,
2668
+ # Below-正下方,
2669
+ # Right-正右方,
2670
+ # LowerRight-右上角,
2671
+ # UpperRight-右下角。
2672
+ # 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
2660
2673
  # @type RelativeLocation: String
2661
- # @param KeywordIndexes: 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
2674
+ # @param KeywordIndexes: 关键字索引,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
2675
+ # 示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
2662
2676
  # @type KeywordIndexes: Array
2663
2677
  # @param Placeholder: 填写提示的内容
2664
2678
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -2734,8 +2748,8 @@ module TencentCloud
2734
2748
 
2735
2749
  attr_accessor :Agent, :FlowId, :Operator
2736
2750
  extend Gem::Deprecate
2737
- deprecate :Operator, :none, 2023, 7
2738
- deprecate :Operator=, :none, 2023, 7
2751
+ deprecate :Operator, :none, 2023, 8
2752
+ deprecate :Operator=, :none, 2023, 8
2739
2753
 
2740
2754
  def initialize(agent=nil, flowid=nil, operator=nil)
2741
2755
  @Agent = agent
@@ -2819,8 +2833,8 @@ module TencentCloud
2819
2833
 
2820
2834
  attr_accessor :Agent, :ProxyOrganizationName, :ProxyOperatorName, :Module, :ModuleId, :UniformSocialCreditCode, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
2821
2835
  extend Gem::Deprecate
2822
- deprecate :Operator, :none, 2023, 7
2823
- deprecate :Operator=, :none, 2023, 7
2836
+ deprecate :Operator, :none, 2023, 8
2837
+ deprecate :Operator=, :none, 2023, 8
2824
2838
 
2825
2839
  def initialize(agent=nil, proxyorganizationname=nil, proxyoperatorname=nil, _module=nil, moduleid=nil, uniformsocialcreditcode=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, operator=nil)
2826
2840
  @Agent = agent
@@ -2943,8 +2957,8 @@ module TencentCloud
2943
2957
 
2944
2958
  attr_accessor :Agent, :FlowInfos, :NeedPreview, :PreviewType, :Operator
2945
2959
  extend Gem::Deprecate
2946
- deprecate :Operator, :none, 2023, 7
2947
- deprecate :Operator=, :none, 2023, 7
2960
+ deprecate :Operator, :none, 2023, 8
2961
+ deprecate :Operator=, :none, 2023, 8
2948
2962
 
2949
2963
  def initialize(agent=nil, flowinfos=nil, needpreview=nil, previewtype=nil, operator=nil)
2950
2964
  @Agent = agent
@@ -3034,8 +3048,8 @@ module TencentCloud
3034
3048
 
3035
3049
  attr_accessor :Agent, :SealName, :SealImage, :Operator
3036
3050
  extend Gem::Deprecate
3037
- deprecate :Operator, :none, 2023, 7
3038
- deprecate :Operator=, :none, 2023, 7
3051
+ deprecate :Operator, :none, 2023, 8
3052
+ deprecate :Operator=, :none, 2023, 8
3039
3053
 
3040
3054
  def initialize(agent=nil, sealname=nil, sealimage=nil, operator=nil)
3041
3055
  @Agent = agent
@@ -3122,8 +3136,8 @@ module TencentCloud
3122
3136
 
3123
3137
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides
3124
3138
  extend Gem::Deprecate
3125
- deprecate :Operator, :none, 2023, 7
3126
- deprecate :Operator=, :none, 2023, 7
3139
+ deprecate :Operator, :none, 2023, 8
3140
+ deprecate :Operator=, :none, 2023, 8
3127
3141
 
3128
3142
  def initialize(agent=nil, flowids=nil, flowgroupid=nil, endpoint=nil, generatetype=nil, organizationname=nil, name=nil, mobile=nil, organizationopenid=nil, openid=nil, autojumpback=nil, jumpurl=nil, operator=nil, hides=nil)
3129
3143
  @Agent = agent
@@ -3230,8 +3244,8 @@ module TencentCloud
3230
3244
 
3231
3245
  attr_accessor :Agent, :ReportId, :Operator
3232
3246
  extend Gem::Deprecate
3233
- deprecate :Operator, :none, 2023, 7
3234
- deprecate :Operator=, :none, 2023, 7
3247
+ deprecate :Operator, :none, 2023, 8
3248
+ deprecate :Operator=, :none, 2023, 8
3235
3249
 
3236
3250
  def initialize(agent=nil, reportid=nil, operator=nil)
3237
3251
  @Agent = agent
@@ -3335,17 +3349,18 @@ module TencentCloud
3335
3349
  # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3336
3350
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3337
3351
  # @param FlowIds: 合同(流程)编号数组,最多支持100个。
3338
- # (备注:该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参)
3352
+ # <br/>备注:该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参
3339
3353
  # @type FlowIds: Array
3340
- # @param FlowGroupId: 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
3354
+ # @param FlowGroupId: 合同组编号
3355
+ # <br/>备注:该参数和合同(流程)编号数组必须二选一
3341
3356
  # @type FlowGroupId: String
3342
3357
  # @param Operator: 暂未开放
3343
3358
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3344
3359
 
3345
3360
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Operator
3346
3361
  extend Gem::Deprecate
3347
- deprecate :Operator, :none, 2023, 7
3348
- deprecate :Operator=, :none, 2023, 7
3362
+ deprecate :Operator, :none, 2023, 8
3363
+ deprecate :Operator=, :none, 2023, 8
3349
3364
 
3350
3365
  def initialize(agent=nil, flowids=nil, flowgroupid=nil, operator=nil)
3351
3366
  @Agent = agent
@@ -3426,8 +3441,8 @@ module TencentCloud
3426
3441
 
3427
3442
  attr_accessor :Agent, :FlowIds, :Operator
3428
3443
  extend Gem::Deprecate
3429
- deprecate :Operator, :none, 2023, 7
3430
- deprecate :Operator=, :none, 2023, 7
3444
+ deprecate :Operator, :none, 2023, 8
3445
+ deprecate :Operator=, :none, 2023, 8
3431
3446
 
3432
3447
  def initialize(agent=nil, flowids=nil, operator=nil)
3433
3448
  @Agent = agent
@@ -3482,23 +3497,33 @@ module TencentCloud
3482
3497
 
3483
3498
  # DescribeTemplates请求参数结构体
3484
3499
  class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
3485
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
3500
+ # @param Agent: 应用相关信息。
3501
+ # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
3486
3502
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3487
3503
  # @param TemplateId: 模板唯一标识,查询单个模板时使用
3488
3504
  # @type TemplateId: String
3489
- # @param ContentType: 查询内容:0-模板列表及详情(默认),1-仅模板列表
3505
+ # @param ContentType: 查询内容:
3506
+ # 0-模板列表及详情(默认),
3507
+ # 1-仅模板列表
3490
3508
  # @type ContentType: Integer
3491
- # @param Limit: 查询个数,默认20,最大100;在查询列表的时候有效
3509
+ # @param Limit: 指定每页多少条数据,如果不传默认为20,单页最大100
3492
3510
  # @type Limit: Integer
3493
- # @param Offset: 查询偏移位置,默认0;在查询列表的时候有效
3511
+ # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
3494
3512
  # @type Offset: Integer
3495
- # @param QueryAllComponents: 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
3513
+ # @param QueryAllComponents: 是否返回所有组件信息。
3514
+ # 默认false,只返回发起方控件;
3515
+ # true,返回所有签署方控件
3496
3516
  # @type QueryAllComponents: Boolean
3497
3517
  # @param TemplateName: 模糊搜索模板名称,最大长度200
3498
3518
  # @type TemplateName: String
3499
- # @param WithPreviewUrl: 是否获取模板预览链接
3519
+ # @param WithPreviewUrl: 是否获取模板预览链接,
3520
+ # 默认false-不获取
3521
+ # true-获取
3500
3522
  # @type WithPreviewUrl: Boolean
3501
- # @param WithPdfUrl: 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
3523
+ # @param WithPdfUrl: 是否获取模板的PDF文件链接。
3524
+ # 默认false-不获取
3525
+ # true-获取
3526
+ # 请联系客户经理开白后使用。
3502
3527
  # @type WithPdfUrl: Boolean
3503
3528
  # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID
3504
3529
  # @type ChannelTemplateId: String
@@ -3507,8 +3532,8 @@ module TencentCloud
3507
3532
 
3508
3533
  attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId, :Operator
3509
3534
  extend Gem::Deprecate
3510
- deprecate :Operator, :none, 2023, 7
3511
- deprecate :Operator=, :none, 2023, 7
3535
+ deprecate :Operator, :none, 2023, 8
3536
+ deprecate :Operator=, :none, 2023, 8
3512
3537
 
3513
3538
  def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, withpreviewurl=nil, withpdfurl=nil, channeltemplateid=nil, operator=nil)
3514
3539
  @Agent = agent
@@ -3547,13 +3572,13 @@ module TencentCloud
3547
3572
 
3548
3573
  # DescribeTemplates返回参数结构体
3549
3574
  class DescribeTemplatesResponse < TencentCloud::Common::AbstractModel
3550
- # @param Templates: 模板详情
3575
+ # @param Templates: 模板列表
3551
3576
  # @type Templates: Array
3552
- # @param TotalCount: 查询总数
3577
+ # @param TotalCount: 查询到的总数
3553
3578
  # @type TotalCount: Integer
3554
- # @param Limit: 查询数量
3579
+ # @param Limit: 每页多少条数据
3555
3580
  # @type Limit: Integer
3556
- # @param Offset: 查询起始偏移
3581
+ # @param Offset: 查询结果分页返回,此处指定第几页。页码从0开始,即首页为0。
3557
3582
  # @type Offset: Integer
3558
3583
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3559
3584
  # @type RequestId: String
@@ -3606,8 +3631,8 @@ module TencentCloud
3606
3631
 
3607
3632
  attr_accessor :Agent, :StartDate, :EndDate, :NeedAggregate, :Limit, :Offset, :Operator
3608
3633
  extend Gem::Deprecate
3609
- deprecate :Operator, :none, 2023, 7
3610
- deprecate :Operator=, :none, 2023, 7
3634
+ deprecate :Operator, :none, 2023, 8
3635
+ deprecate :Operator=, :none, 2023, 8
3611
3636
 
3612
3637
  def initialize(agent=nil, startdate=nil, enddate=nil, needaggregate=nil, limit=nil, offset=nil, operator=nil)
3613
3638
  @Agent = agent
@@ -3827,28 +3852,29 @@ module TencentCloud
3827
3852
  # 注意:此字段可能返回 null,表示取不到有效值。
3828
3853
  # @type ApproveName: String
3829
3854
  # @param ApproveStatus: 当前签署人的状态, 状态如下
3830
-
3831
- # PENDING 待签署
3832
- # FILLPENDING 待填写
3833
- # FILLACCEPT 填写完成
3834
- # FILLREJECT 拒绝填写
3835
- # WAITPICKUP 待领取
3836
- # ACCEPT 已签署
3837
- # REJECT 拒签
3838
- # DEADLINE 过期没人处理
3839
- # CANCEL 流程已撤回
3840
- # FORWARD 已经转他人处理
3841
- # STOP 流程已终止
3842
- # RELIEVED 解除协议(已解除)
3855
+ # <br/>PENDING 待签署
3856
+ # <br/>FILLPENDING 待填写
3857
+ # <br/>FILLACCEPT 填写完成
3858
+ # <br/>FILLREJECT 拒绝填写
3859
+ # <br/>WAITPICKUP 待领取
3860
+ # <br/>ACCEPT 已签署
3861
+ # <br/>REJECT 拒签
3862
+ # <br/>DEADLINE 过期没人处理
3863
+ # <br/>CANCEL 流程已撤回
3864
+ # <br/>FORWARD 已经转他人处理
3865
+ # <br/>STOP 流程已终止
3866
+ # <br/>RELIEVED 解除协议(已解除)
3843
3867
 
3844
3868
  # 注意:此字段可能返回 null,表示取不到有效值。
3845
3869
  # @type ApproveStatus: String
3846
- # @param ApproveMessage: 签署人信息
3870
+ # @param ApproveMessage: 签署人自定义信息
3847
3871
  # 注意:此字段可能返回 null,表示取不到有效值。
3848
3872
  # @type ApproveMessage: String
3849
3873
  # @param ApproveTime: 签署人签署时间戳,单位秒
3850
3874
  # @type ApproveTime: Integer
3851
- # @param ApproveType: 参与者类型 (ORGANIZATION企业/PERSON个人)
3875
+ # @param ApproveType: 参与者类型
3876
+ # <br/>ORGANIZATION:企业签署人
3877
+ # <br/>PERSON:个人签署人
3852
3878
  # 注意:此字段可能返回 null,表示取不到有效值。
3853
3879
  # @type ApproveType: String
3854
3880
 
@@ -3960,8 +3986,8 @@ module TencentCloud
3960
3986
 
3961
3987
  attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType
3962
3988
  extend Gem::Deprecate
3963
- deprecate :CallbackUrl, :none, 2023, 7
3964
- deprecate :CallbackUrl=, :none, 2023, 7
3989
+ deprecate :CallbackUrl, :none, 2023, 8
3990
+ deprecate :CallbackUrl=, :none, 2023, 8
3965
3991
 
3966
3992
  def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil, approveroption=nil, approverneedsignreview=nil, approververifytypes=nil, approversigntypes=nil, signid=nil, notifytype=nil)
3967
3993
  @Name = name
@@ -4493,8 +4519,8 @@ module TencentCloud
4493
4519
 
4494
4520
  attr_accessor :Agent, :DownLoadFlows, :Operator
4495
4521
  extend Gem::Deprecate
4496
- deprecate :Operator, :none, 2023, 7
4497
- deprecate :Operator=, :none, 2023, 7
4522
+ deprecate :Operator, :none, 2023, 8
4523
+ deprecate :Operator=, :none, 2023, 8
4498
4524
 
4499
4525
  def initialize(agent=nil, downloadflows=nil, operator=nil)
4500
4526
  @Agent = agent
@@ -4668,35 +4694,45 @@ module TencentCloud
4668
4694
 
4669
4695
  # OperateChannelTemplate请求参数结构体
4670
4696
  class OperateChannelTemplateRequest < TencentCloud::Common::AbstractModel
4671
- # @param Agent: 应用相关信息。 此接口Agent.AppId必填。
4697
+ # @param Agent: 应用相关信息。
4698
+ # 此接口Agent.AppId必填。
4672
4699
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4673
- # @param OperateType: 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
4700
+ # @param OperateType: 操作类型,
4701
+ # 查询:"SELECT",
4702
+ # 删除:"DELETE",
4703
+ # 更新:"UPDATE"
4674
4704
  # @type OperateType: String
4675
4705
  # @param TemplateId: 第三方应用平台模板库模板唯一标识
4676
4706
  # @type TemplateId: String
4677
- # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
4707
+ # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据.
4708
+ # 支持多个, 用","进行分隔
4678
4709
  # @type ProxyOrganizationOpenIds: String
4679
- # @param AuthTag: 模板可见性, 全部可见-"all", 部分可见-"part"
4710
+ # @param AuthTag: 模板可见性,
4711
+ # 全部可见-"all",
4712
+ # 部分可见-"part"
4680
4713
  # @type AuthTag: String
4681
- # @param Operator: 暂未开放
4682
- # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
4683
- # @param Available: 当OperateType=UPADATE时,可以通过设置此字段对模板启停用状态进行操作。若此字段值为0,则不会修改模板Available,1为启用模板,2为停用模板。
4714
+ # @param Available: 当OperateType=UPADATE时,可以通过设置此字段对模板启停用状态进行操作。
4715
+ # 若此字段值为0,则不会修改模板Available,
4716
+ # 1为启用模板,
4717
+ # 2为停用模板。
4684
4718
  # 启用后模板可以正常领取。停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败,会直接返回错误。
4685
4719
  # @type Available: Integer
4720
+ # @param Operator: 暂未开放
4721
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
4686
4722
 
4687
- attr_accessor :Agent, :OperateType, :TemplateId, :ProxyOrganizationOpenIds, :AuthTag, :Operator, :Available
4723
+ attr_accessor :Agent, :OperateType, :TemplateId, :ProxyOrganizationOpenIds, :AuthTag, :Available, :Operator
4688
4724
  extend Gem::Deprecate
4689
- deprecate :Operator, :none, 2023, 7
4690
- deprecate :Operator=, :none, 2023, 7
4725
+ deprecate :Operator, :none, 2023, 8
4726
+ deprecate :Operator=, :none, 2023, 8
4691
4727
 
4692
- def initialize(agent=nil, operatetype=nil, templateid=nil, proxyorganizationopenids=nil, authtag=nil, operator=nil, available=nil)
4728
+ def initialize(agent=nil, operatetype=nil, templateid=nil, proxyorganizationopenids=nil, authtag=nil, available=nil, operator=nil)
4693
4729
  @Agent = agent
4694
4730
  @OperateType = operatetype
4695
4731
  @TemplateId = templateid
4696
4732
  @ProxyOrganizationOpenIds = proxyorganizationopenids
4697
4733
  @AuthTag = authtag
4698
- @Operator = operator
4699
4734
  @Available = available
4735
+ @Operator = operator
4700
4736
  end
4701
4737
 
4702
4738
  def deserialize(params)
@@ -4708,11 +4744,11 @@ module TencentCloud
4708
4744
  @TemplateId = params['TemplateId']
4709
4745
  @ProxyOrganizationOpenIds = params['ProxyOrganizationOpenIds']
4710
4746
  @AuthTag = params['AuthTag']
4747
+ @Available = params['Available']
4711
4748
  unless params['Operator'].nil?
4712
4749
  @Operator = UserInfo.new
4713
4750
  @Operator.deserialize(params['Operator'])
4714
4751
  end
4715
- @Available = params['Available']
4716
4752
  end
4717
4753
  end
4718
4754
 
@@ -4724,10 +4760,15 @@ module TencentCloud
4724
4760
  # @param TemplateId: 第三方应用平台模板库模板唯一标识
4725
4761
  # 注意:此字段可能返回 null,表示取不到有效值。
4726
4762
  # @type TemplateId: String
4727
- # @param OperateResult: 描述模板可见性更改的结果,和参数中Available无关,全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示。
4763
+ # @param OperateResult: 描述模板可见性更改的结果,和参数中Available无关。
4764
+ # 全部成功-"all-success",
4765
+ # 部分成功-"part-success",
4766
+ # 全部失败-"fail",失败的会在FailMessageList中展示。
4728
4767
  # 注意:此字段可能返回 null,表示取不到有效值。
4729
4768
  # @type OperateResult: String
4730
- # @param AuthTag: 模板可见性, 全部可见-"all", 部分可见-"part"
4769
+ # @param AuthTag: 模板可见性,
4770
+ # 全部可见-"all",
4771
+ # 部分可见-"part"
4731
4772
  # 注意:此字段可能返回 null,表示取不到有效值。
4732
4773
  # @type AuthTag: String
4733
4774
  # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据
@@ -4784,10 +4825,10 @@ module TencentCloud
4784
4825
 
4785
4826
  attr_accessor :OrganizationOpenId, :OrganizationId, :Channel, :ClientIp, :ProxyIp
4786
4827
  extend Gem::Deprecate
4787
- deprecate :ClientIp, :none, 2023, 7
4788
- deprecate :ClientIp=, :none, 2023, 7
4789
- deprecate :ProxyIp, :none, 2023, 7
4790
- deprecate :ProxyIp=, :none, 2023, 7
4828
+ deprecate :ClientIp, :none, 2023, 8
4829
+ deprecate :ClientIp=, :none, 2023, 8
4830
+ deprecate :ProxyIp, :none, 2023, 8
4831
+ deprecate :ProxyIp=, :none, 2023, 8
4791
4832
 
4792
4833
  def initialize(organizationopenid=nil, organizationid=nil, channel=nil, clientip=nil, proxyip=nil)
4793
4834
  @OrganizationOpenId = organizationopenid
@@ -4887,8 +4928,8 @@ module TencentCloud
4887
4928
 
4888
4929
  attr_accessor :Agent, :FlowInfos, :JumpUrl, :Operator
4889
4930
  extend Gem::Deprecate
4890
- deprecate :Operator, :none, 2023, 7
4891
- deprecate :Operator=, :none, 2023, 7
4931
+ deprecate :Operator, :none, 2023, 8
4932
+ deprecate :Operator=, :none, 2023, 8
4892
4933
 
4893
4934
  def initialize(agent=nil, flowinfos=nil, jumpurl=nil, operator=nil)
4894
4935
  @Agent = agent
@@ -4980,25 +5021,34 @@ module TencentCloud
4980
5021
  end
4981
5022
  end
4982
5023
 
4983
- # 签署参与者信息
5024
+ # 流程中参与方的信息结构
4984
5025
  class Recipient < TencentCloud::Common::AbstractModel
4985
- # @param RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方Id
5026
+ # @param RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方ID
4986
5027
  # @type RecipientId: String
4987
- # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
5028
+ # @param RecipientType: 参与者类型,默认为空。
5029
+ # ENTERPRISE-企业;
5030
+ # INDIVIDUAL-个人;
5031
+ # PROMOTER-发起方
4988
5032
  # @type RecipientType: String
4989
- # @param Description: 描述
5033
+ # @param Description: 描述信息
4990
5034
  # @type Description: String
4991
- # @param RoleName: 签署方备注角色名
5035
+ # @param RoleName: 角色名称
4992
5036
  # @type RoleName: String
4993
- # @param RequireValidation: 是否需要校验,true-是,false-否
5037
+ # @param RequireValidation: 是否需要校验,
5038
+ # true-是,
5039
+ # false-否
4994
5040
  # @type RequireValidation: Boolean
4995
- # @param RequireSign: 是否必须填写,true-是,false-否
5041
+ # @param RequireSign: 是否必须填写,
5042
+ # true-是,
5043
+ # false-否
4996
5044
  # @type RequireSign: Boolean
4997
- # @param SignType: 签署类型
5045
+ # @param SignType: 内部字段,签署类型
4998
5046
  # @type SignType: Integer
4999
5047
  # @param RoutingOrder: 签署顺序:数字越小优先级越高
5000
5048
  # @type RoutingOrder: Integer
5001
- # @param IsPromoter: 是否是发起方
5049
+ # @param IsPromoter: 是否是发起方,
5050
+ # true-是
5051
+ # false-否
5002
5052
  # @type IsPromoter: Boolean
5003
5053
 
5004
5054
  attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :SignType, :RoutingOrder, :IsPromoter
@@ -5317,8 +5367,8 @@ module TencentCloud
5317
5367
 
5318
5368
  attr_accessor :SignUrl, :Deadline, :SignOrder, :SignId, :CustomUserId, :Name, :Mobile, :OrganizationName, :ApproverType, :IdCardNumber, :FlowId, :OpenId, :FlowGroupId
5319
5369
  extend Gem::Deprecate
5320
- deprecate :CustomUserId, :none, 2023, 7
5321
- deprecate :CustomUserId=, :none, 2023, 7
5370
+ deprecate :CustomUserId, :none, 2023, 8
5371
+ deprecate :CustomUserId=, :none, 2023, 8
5322
5372
 
5323
5373
  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, flowgroupid=nil)
5324
5374
  @SignUrl = signurl
@@ -5480,8 +5530,8 @@ module TencentCloud
5480
5530
 
5481
5531
  attr_accessor :Agent, :OperatorType, :ProxyOrganizationOperators, :Operator
5482
5532
  extend Gem::Deprecate
5483
- deprecate :Operator, :none, 2023, 7
5484
- deprecate :Operator=, :none, 2023, 7
5533
+ deprecate :Operator, :none, 2023, 8
5534
+ deprecate :Operator=, :none, 2023, 8
5485
5535
 
5486
5536
  def initialize(agent=nil, operatortype=nil, proxyorganizationoperators=nil, operator=nil)
5487
5537
  @Agent = agent
@@ -5564,8 +5614,8 @@ module TencentCloud
5564
5614
 
5565
5615
  attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator
5566
5616
  extend Gem::Deprecate
5567
- deprecate :Operator, :none, 2023, 7
5568
- deprecate :Operator=, :none, 2023, 7
5617
+ deprecate :Operator, :none, 2023, 8
5618
+ deprecate :Operator=, :none, 2023, 8
5569
5619
 
5570
5620
  def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil)
5571
5621
  @Agent = agent
@@ -5631,18 +5681,26 @@ module TencentCloud
5631
5681
  end
5632
5682
 
5633
5683
  # 此结构体 (TemplateInfo) 用于描述模板的信息。
5684
+
5685
+ # > **模板组成**
5686
+ # >
5687
+ # > 一个模板通常会包含以下结构信息
5688
+ # >- 模板基本信息
5689
+ # >- 签署参与方 Recipients,在模板发起合同时用于指定参与方
5690
+ # >- 填写控件 Components
5691
+ # >- 签署控件 SignComponents
5634
5692
  class TemplateInfo < TencentCloud::Common::AbstractModel
5635
- # @param TemplateId: 模板ID
5693
+ # @param TemplateId: 模板ID,模板的唯一标识
5636
5694
  # @type TemplateId: String
5637
- # @param TemplateName: 模板名字
5695
+ # @param TemplateName: 模板名
5638
5696
  # @type TemplateName: String
5639
5697
  # @param Description: 模板描述信息
5640
5698
  # @type Description: String
5641
- # @param Components: 模板的填充控件信息结构
5699
+ # @param Components: 模板的填充控件列表
5642
5700
  # @type Components: Array
5643
- # @param Recipients: 模板中的流程参与人信息
5701
+ # @param Recipients: 模板中的签署参与方列表
5644
5702
  # @type Recipients: Array
5645
- # @param SignComponents: 模板中的签署控件信息结构
5703
+ # @param SignComponents: 模板中的签署控件列表
5646
5704
  # @type SignComponents: Array
5647
5705
  # @param TemplateType: 模板类型:1-静默签;3-普通模板
5648
5706
  # @type TemplateType: Integer
@@ -5650,33 +5708,41 @@ module TencentCloud
5650
5708
  # @type IsPromoter: Boolean
5651
5709
  # @param Creator: 模板的创建者信息,电子签系统用户ID
5652
5710
  # @type Creator: String
5653
- # @param CreatedOn: 模板创建的时间戳,单位秒
5711
+ # @param CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
5654
5712
  # @type CreatedOn: Integer
5655
- # @param PreviewUrl: 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
5713
+ # @param PreviewUrl: 模板的H5预览链接,有效期5分钟。
5714
+ # 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
5715
+ # (此功能开放需要联系客户经理)
5656
5716
  # 注意:此字段可能返回 null,表示取不到有效值。
5657
5717
  # @type PreviewUrl: String
5658
- # @param PdfUrl: 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
5718
+ # @param PdfUrl: 第三方应用集成-模板PDF文件链接,有效期5分钟。
5719
+ # 请求参数WithPdfUrl=true时返回
5720
+ # (此功能开放需要联系客户经理)。
5659
5721
  # 注意:此字段可能返回 null,表示取不到有效值。
5660
5722
  # @type PdfUrl: String
5661
- # @param ChannelTemplateId: 关联的第三方应用平台企业模板ID
5723
+ # @param ChannelTemplateId: 本模板关联的第三方应用平台企业模板ID
5662
5724
  # @type ChannelTemplateId: String
5663
- # @param ChannelTemplateName: 关联的三方应用平台平台企业模板名称
5725
+ # @param ChannelTemplateName: 本模板关联的三方应用平台平台企业模板名称
5664
5726
  # 注意:此字段可能返回 null,表示取不到有效值。
5665
5727
  # @type ChannelTemplateName: String
5666
- # @param ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
5728
+ # @param ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认);
5729
+ # 1-平台自动设置子客模板
5667
5730
  # 注意:此字段可能返回 null,表示取不到有效值。
5668
5731
  # @type ChannelAutoSave: Integer
5669
- # @param TemplateVersion: 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
5732
+ # @param TemplateVersion: 模板版本,全数字字符。
5733
+ # 默认为空,初始版本为yyyyMMdd001。
5670
5734
  # 注意:此字段可能返回 null,表示取不到有效值。
5671
5735
  # @type TemplateVersion: String
5672
- # @param Available: 模板可用状态,取值:1启用(默认),2停用
5736
+ # @param Available: 模板可用状态:
5737
+ # 1启用(默认)
5738
+ # 2停用
5673
5739
  # 注意:此字段可能返回 null,表示取不到有效值。
5674
5740
  # @type Available: Integer
5675
5741
 
5676
5742
  attr_accessor :TemplateId, :TemplateName, :Description, :Components, :Recipients, :SignComponents, :TemplateType, :IsPromoter, :Creator, :CreatedOn, :PreviewUrl, :PdfUrl, :ChannelTemplateId, :ChannelTemplateName, :ChannelAutoSave, :TemplateVersion, :Available
5677
5743
  extend Gem::Deprecate
5678
- deprecate :IsPromoter, :none, 2023, 7
5679
- deprecate :IsPromoter=, :none, 2023, 7
5744
+ deprecate :IsPromoter, :none, 2023, 8
5745
+ deprecate :IsPromoter=, :none, 2023, 8
5680
5746
 
5681
5747
  def initialize(templateid=nil, templatename=nil, description=nil, components=nil, recipients=nil, signcomponents=nil, templatetype=nil, ispromoter=nil, creator=nil, createdon=nil, previewurl=nil, pdfurl=nil, channeltemplateid=nil, channeltemplatename=nil, channelautosave=nil, templateversion=nil, available=nil)
5682
5748
  @TemplateId = templateid
@@ -5775,8 +5841,8 @@ module TencentCloud
5775
5841
 
5776
5842
  attr_accessor :Agent, :BusinessType, :FileInfos, :Operator
5777
5843
  extend Gem::Deprecate
5778
- deprecate :Operator, :none, 2023, 7
5779
- deprecate :Operator=, :none, 2023, 7
5844
+ deprecate :Operator, :none, 2023, 8
5845
+ deprecate :Operator=, :none, 2023, 8
5780
5846
 
5781
5847
  def initialize(agent=nil, businesstype=nil, fileinfos=nil, operator=nil)
5782
5848
  @Agent = agent
@@ -5889,14 +5955,14 @@ module TencentCloud
5889
5955
 
5890
5956
  attr_accessor :OpenId, :Channel, :CustomUserId, :ClientIp, :ProxyIp
5891
5957
  extend Gem::Deprecate
5892
- deprecate :Channel, :none, 2023, 7
5893
- deprecate :Channel=, :none, 2023, 7
5894
- deprecate :CustomUserId, :none, 2023, 7
5895
- deprecate :CustomUserId=, :none, 2023, 7
5896
- deprecate :ClientIp, :none, 2023, 7
5897
- deprecate :ClientIp=, :none, 2023, 7
5898
- deprecate :ProxyIp, :none, 2023, 7
5899
- deprecate :ProxyIp=, :none, 2023, 7
5958
+ deprecate :Channel, :none, 2023, 8
5959
+ deprecate :Channel=, :none, 2023, 8
5960
+ deprecate :CustomUserId, :none, 2023, 8
5961
+ deprecate :CustomUserId=, :none, 2023, 8
5962
+ deprecate :ClientIp, :none, 2023, 8
5963
+ deprecate :ClientIp=, :none, 2023, 8
5964
+ deprecate :ProxyIp, :none, 2023, 8
5965
+ deprecate :ProxyIp=, :none, 2023, 8
5900
5966
 
5901
5967
  def initialize(openid=nil, channel=nil, customuserid=nil, clientip=nil, proxyip=nil)
5902
5968
  @OpenId = openid
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.624
4
+ version: 3.0.626
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-07-31 00:00:00.000000000 Z
11
+ date: 2023-08-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common