tencentcloud-sdk-essbasic 3.0.624 → 3.0.625

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: 26295f1f5cc6a8e4f338a0cd52a9cf58a47021cc
4
+ data.tar.gz: 001b653bb159e570b1b261ea3fa7e786d0bf6208
5
5
  SHA512:
6
- metadata.gz: 35656a85d1f89ede6e13c7bdceca30920d0c481f940f5b9aede3d86e03372558133488a673d40dabdeb280ac749bc5e728852abcdbb27da687cdc4d483ab873e
7
- data.tar.gz: 65435d5f84f49cf51c305fbfda94e371012f88f5b759fc113d4972304ed8144ccb7421d2fb667ef626ad0ec499a7aeb77a8c0f91150386632dd1a6bf15b3cccf
6
+ metadata.gz: 1744ae9e75be40a4b73abc6ac7be303d7b204e41fe99877fcf06643b8f2b825f8bb6a248cd5758b8658d7b32880095fbb86c62a7d317bced4958f6a8ca928d34
7
+ data.tar.gz: 03c1cc8af982e50fbe228ce06fea3d4a62a20f03947aaa90705a807c024ddda486ba4e3754641c752a10a663a32c3229c342ae4d7ac567455a92d84eafcb1869
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.624
1
+ 3.0.625
@@ -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
@@ -1190,10 +1190,10 @@ module TencentCloud
1190
1190
 
1191
1191
  attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :CallbackUrl, :ApproverRestrictions, :Operator
1192
1192
  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
1193
+ deprecate :ApproverRestrictions, :none, 2023, 8
1194
+ deprecate :ApproverRestrictions=, :none, 2023, 8
1195
+ deprecate :Operator, :none, 2023, 8
1196
+ deprecate :Operator=, :none, 2023, 8
1197
1197
 
1198
1198
  def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, callbackurl=nil, approverrestrictions=nil, operator=nil)
1199
1199
  @Agent = agent
@@ -1336,12 +1336,12 @@ module TencentCloud
1336
1336
 
1337
1337
  attr_accessor :ResourceId, :ResourceType, :FlowInfo, :Agent, :FlowOption, :FlowApproverList, :FlowId, :NeedPreview, :Organization, :Operator
1338
1338
  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
1339
+ deprecate :NeedPreview, :none, 2023, 8
1340
+ deprecate :NeedPreview=, :none, 2023, 8
1341
+ deprecate :Organization, :none, 2023, 8
1342
+ deprecate :Organization=, :none, 2023, 8
1343
+ deprecate :Operator, :none, 2023, 8
1344
+ deprecate :Operator=, :none, 2023, 8
1345
1345
 
1346
1346
  def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, agent=nil, flowoption=nil, flowapproverlist=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil)
1347
1347
  @ResourceId = resourceid
@@ -1437,10 +1437,10 @@ module TencentCloud
1437
1437
 
1438
1438
  attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline
1439
1439
  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
1440
+ deprecate :Organization, :none, 2023, 8
1441
+ deprecate :Organization=, :none, 2023, 8
1442
+ deprecate :Operator, :none, 2023, 8
1443
+ deprecate :Operator=, :none, 2023, 8
1444
1444
 
1445
1445
  def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil)
1446
1446
  @Agent = agent
@@ -1520,10 +1520,10 @@ module TencentCloud
1520
1520
 
1521
1521
  attr_accessor :Agent, :SealId, :UserIds, :Operator, :Organization
1522
1522
  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
1523
+ deprecate :Operator, :none, 2023, 8
1524
+ deprecate :Operator=, :none, 2023, 8
1525
+ deprecate :Organization, :none, 2023, 8
1526
+ deprecate :Organization=, :none, 2023, 8
1527
1527
 
1528
1528
  def initialize(agent=nil, sealid=nil, userids=nil, operator=nil, organization=nil)
1529
1529
  @Agent = agent
@@ -1587,8 +1587,8 @@ module TencentCloud
1587
1587
 
1588
1588
  attr_accessor :Agent, :RoleIds, :UserIds, :OpenIds, :Operator
1589
1589
  extend Gem::Deprecate
1590
- deprecate :Operator, :none, 2023, 7
1591
- deprecate :Operator=, :none, 2023, 7
1590
+ deprecate :Operator, :none, 2023, 8
1591
+ deprecate :Operator=, :none, 2023, 8
1592
1592
 
1593
1593
  def initialize(agent=nil, roleids=nil, userids=nil, openids=nil, operator=nil)
1594
1594
  @Agent = agent
@@ -1702,8 +1702,8 @@ module TencentCloud
1702
1702
 
1703
1703
  attr_accessor :Agent, :RoleId, :UserIds, :Operator, :OpenIds
1704
1704
  extend Gem::Deprecate
1705
- deprecate :Operator, :none, 2023, 7
1706
- deprecate :Operator=, :none, 2023, 7
1705
+ deprecate :Operator, :none, 2023, 8
1706
+ deprecate :Operator=, :none, 2023, 8
1707
1707
 
1708
1708
  def initialize(agent=nil, roleid=nil, userids=nil, operator=nil, openids=nil)
1709
1709
  @Agent = agent
@@ -1764,10 +1764,10 @@ module TencentCloud
1764
1764
 
1765
1765
  attr_accessor :Agent, :SealId, :UserIds, :Organization, :Operator
1766
1766
  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
1767
+ deprecate :Organization, :none, 2023, 8
1768
+ deprecate :Organization=, :none, 2023, 8
1769
+ deprecate :Operator, :none, 2023, 8
1770
+ deprecate :Operator=, :none, 2023, 8
1771
1771
 
1772
1772
  def initialize(agent=nil, sealid=nil, userids=nil, organization=nil, operator=nil)
1773
1773
  @Agent = agent
@@ -1828,8 +1828,8 @@ module TencentCloud
1828
1828
 
1829
1829
  attr_accessor :Limit, :Agent, :Filters, :Offset, :Operator
1830
1830
  extend Gem::Deprecate
1831
- deprecate :Operator, :none, 2023, 7
1832
- deprecate :Operator=, :none, 2023, 7
1831
+ deprecate :Operator, :none, 2023, 8
1832
+ deprecate :Operator=, :none, 2023, 8
1833
1833
 
1834
1834
  def initialize(limit=nil, agent=nil, filters=nil, offset=nil, operator=nil)
1835
1835
  @Limit = limit
@@ -2046,8 +2046,8 @@ module TencentCloud
2046
2046
 
2047
2047
  attr_accessor :Agent, :Offset, :Limit, :Filters, :Operator
2048
2048
  extend Gem::Deprecate
2049
- deprecate :Operator, :none, 2023, 7
2050
- deprecate :Operator=, :none, 2023, 7
2049
+ deprecate :Operator, :none, 2023, 8
2050
+ deprecate :Operator=, :none, 2023, 8
2051
2051
 
2052
2052
  def initialize(agent=nil, offset=nil, limit=nil, filters=nil, operator=nil)
2053
2053
  @Agent = agent
@@ -2132,10 +2132,10 @@ module TencentCloud
2132
2132
 
2133
2133
  attr_accessor :Agent, :TaskId, :Operator, :Organization
2134
2134
  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
2135
+ deprecate :Operator, :none, 2023, 8
2136
+ deprecate :Operator=, :none, 2023, 8
2137
+ deprecate :Organization, :none, 2023, 8
2138
+ deprecate :Organization=, :none, 2023, 8
2139
2139
 
2140
2140
  def initialize(agent=nil, taskid=nil, operator=nil, organization=nil)
2141
2141
  @Agent = agent
@@ -2192,8 +2192,8 @@ module TencentCloud
2192
2192
 
2193
2193
  attr_accessor :TaskId, :TaskStatus, :TaskMessage, :ResourceId, :PreviewUrl, :RequestId
2194
2194
  extend Gem::Deprecate
2195
- deprecate :PreviewUrl, :none, 2023, 7
2196
- deprecate :PreviewUrl=, :none, 2023, 7
2195
+ deprecate :PreviewUrl, :none, 2023, 8
2196
+ deprecate :PreviewUrl=, :none, 2023, 8
2197
2197
 
2198
2198
  def initialize(taskid=nil, taskstatus=nil, taskmessage=nil, resourceid=nil, previewurl=nil, requestid=nil)
2199
2199
  @TaskId = taskid
@@ -2256,8 +2256,8 @@ module TencentCloud
2256
2256
 
2257
2257
  attr_accessor :Agent, :Status, :SealId, :Reason, :Operator
2258
2258
  extend Gem::Deprecate
2259
- deprecate :Operator, :none, 2023, 7
2260
- deprecate :Operator=, :none, 2023, 7
2259
+ deprecate :Operator, :none, 2023, 8
2260
+ deprecate :Operator=, :none, 2023, 8
2261
2261
 
2262
2262
  def initialize(agent=nil, status=nil, sealid=nil, reason=nil, operator=nil)
2263
2263
  @Agent = agent
@@ -2309,8 +2309,8 @@ module TencentCloud
2309
2309
 
2310
2310
  attr_accessor :FlowId, :Agent, :Operator
2311
2311
  extend Gem::Deprecate
2312
- deprecate :Operator, :none, 2023, 7
2313
- deprecate :Operator=, :none, 2023, 7
2312
+ deprecate :Operator, :none, 2023, 8
2313
+ deprecate :Operator=, :none, 2023, 8
2314
2314
 
2315
2315
  def initialize(flowid=nil, agent=nil, operator=nil)
2316
2316
  @FlowId = flowid
@@ -2412,8 +2412,8 @@ module TencentCloud
2412
2412
 
2413
2413
  attr_accessor :NotChannelOrganization, :ApproverType, :OrganizationId, :OrganizationOpenId, :OrganizationName, :UserId, :OpenId, :ApproverName, :ApproverMobile, :RecipientId, :PreReadTime, :IsFullText, :NotifyType, :ApproverOption
2414
2414
  extend Gem::Deprecate
2415
- deprecate :NotifyType, :none, 2023, 7
2416
- deprecate :NotifyType=, :none, 2023, 7
2415
+ deprecate :NotifyType, :none, 2023, 8
2416
+ deprecate :NotifyType=, :none, 2023, 8
2417
2417
 
2418
2418
  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
2419
  @NotChannelOrganization = notchannelorganization
@@ -2468,8 +2468,7 @@ module TencentCloud
2468
2468
 
2469
2469
  # 注:
2470
2470
  # 当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
2471
- # 例:
2472
- # 当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
2471
+ # 例:当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
2473
2472
  # 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
2474
2473
 
2475
2474
  # 创建控件时,此值为空
@@ -2497,11 +2496,12 @@ module TencentCloud
2497
2496
 
2498
2497
  # 表单域的控件不能作为印章和签名控件
2499
2498
  # @type ComponentType: String
2500
- # @param ComponentName: 控件简称,不能超过30个字符
2499
+ # @param ComponentName: 控件简称,不超过30个字符
2501
2500
  # @type ComponentName: String
2502
- # @param ComponentRequired: 定义控件是否为必填项,默认为false
2501
+ # @param ComponentRequired: 控件是否为必填项,
2502
+ # 默认为false-非必填
2503
2503
  # @type ComponentRequired: Boolean
2504
- # @param ComponentRecipientId: 控件关联的签署方id
2504
+ # @param ComponentRecipientId: 控件关联的参与方ID,对应Recipient结构体中的RecipientId
2505
2505
  # @type ComponentRecipientId: String
2506
2506
  # @param FileIndex: 控件所属文件的序号 (文档中文件的排列序号,从0开始)
2507
2507
  # @type FileIndex: Integer
@@ -2640,9 +2640,9 @@ module TencentCloud
2640
2640
 
2641
2641
  # 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
2642
2642
  # @type ComponentDateFontSize: Integer
2643
- # @param DocumentId: 控件所属文档的Id, 模块相关接口为空值
2643
+ # @param DocumentId: 控件所属文档的Id, 模板相关接口为空值
2644
2644
  # @type DocumentId: String
2645
- # @param ComponentDescription: 控件描述,不能超过30个字符
2645
+ # @param ComponentDescription: 控件描述,不超过30个字符
2646
2646
  # @type ComponentDescription: String
2647
2647
  # @param OffsetX: 指定关键字时横坐标偏移量,单位pt
2648
2648
  # @type OffsetX: Float
@@ -2651,14 +2651,25 @@ module TencentCloud
2651
2651
  # @param ChannelComponentId: 平台企业控件ID。
2652
2652
  # 如果不为空,属于平台企业预设控件;
2653
2653
  # @type ChannelComponentId: String
2654
- # @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
2654
+ # @param KeywordOrder: 指定关键字排序规则,
2655
+ # Positive-正序,
2656
+ # Reverse-倒序。
2657
+ # 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
2655
2658
  # 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
2656
2659
  # @type KeywordOrder: String
2657
- # @param KeywordPage: 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
2660
+ # @param KeywordPage: 指定关键字页码。
2661
+ # 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
2658
2662
  # @type KeywordPage: Integer
2659
- # @param RelativeLocation: 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
2663
+ # @param RelativeLocation: 关键字位置模式,
2664
+ # Middle-居中,
2665
+ # Below-正下方,
2666
+ # Right-正右方,
2667
+ # LowerRight-右上角,
2668
+ # UpperRight-右下角。
2669
+ # 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
2660
2670
  # @type RelativeLocation: String
2661
- # @param KeywordIndexes: 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
2671
+ # @param KeywordIndexes: 关键字索引,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
2672
+ # 示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
2662
2673
  # @type KeywordIndexes: Array
2663
2674
  # @param Placeholder: 填写提示的内容
2664
2675
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -2734,8 +2745,8 @@ module TencentCloud
2734
2745
 
2735
2746
  attr_accessor :Agent, :FlowId, :Operator
2736
2747
  extend Gem::Deprecate
2737
- deprecate :Operator, :none, 2023, 7
2738
- deprecate :Operator=, :none, 2023, 7
2748
+ deprecate :Operator, :none, 2023, 8
2749
+ deprecate :Operator=, :none, 2023, 8
2739
2750
 
2740
2751
  def initialize(agent=nil, flowid=nil, operator=nil)
2741
2752
  @Agent = agent
@@ -2819,8 +2830,8 @@ module TencentCloud
2819
2830
 
2820
2831
  attr_accessor :Agent, :ProxyOrganizationName, :ProxyOperatorName, :Module, :ModuleId, :UniformSocialCreditCode, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
2821
2832
  extend Gem::Deprecate
2822
- deprecate :Operator, :none, 2023, 7
2823
- deprecate :Operator=, :none, 2023, 7
2833
+ deprecate :Operator, :none, 2023, 8
2834
+ deprecate :Operator=, :none, 2023, 8
2824
2835
 
2825
2836
  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
2837
  @Agent = agent
@@ -2943,8 +2954,8 @@ module TencentCloud
2943
2954
 
2944
2955
  attr_accessor :Agent, :FlowInfos, :NeedPreview, :PreviewType, :Operator
2945
2956
  extend Gem::Deprecate
2946
- deprecate :Operator, :none, 2023, 7
2947
- deprecate :Operator=, :none, 2023, 7
2957
+ deprecate :Operator, :none, 2023, 8
2958
+ deprecate :Operator=, :none, 2023, 8
2948
2959
 
2949
2960
  def initialize(agent=nil, flowinfos=nil, needpreview=nil, previewtype=nil, operator=nil)
2950
2961
  @Agent = agent
@@ -3034,8 +3045,8 @@ module TencentCloud
3034
3045
 
3035
3046
  attr_accessor :Agent, :SealName, :SealImage, :Operator
3036
3047
  extend Gem::Deprecate
3037
- deprecate :Operator, :none, 2023, 7
3038
- deprecate :Operator=, :none, 2023, 7
3048
+ deprecate :Operator, :none, 2023, 8
3049
+ deprecate :Operator=, :none, 2023, 8
3039
3050
 
3040
3051
  def initialize(agent=nil, sealname=nil, sealimage=nil, operator=nil)
3041
3052
  @Agent = agent
@@ -3122,8 +3133,8 @@ module TencentCloud
3122
3133
 
3123
3134
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides
3124
3135
  extend Gem::Deprecate
3125
- deprecate :Operator, :none, 2023, 7
3126
- deprecate :Operator=, :none, 2023, 7
3136
+ deprecate :Operator, :none, 2023, 8
3137
+ deprecate :Operator=, :none, 2023, 8
3127
3138
 
3128
3139
  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
3140
  @Agent = agent
@@ -3230,8 +3241,8 @@ module TencentCloud
3230
3241
 
3231
3242
  attr_accessor :Agent, :ReportId, :Operator
3232
3243
  extend Gem::Deprecate
3233
- deprecate :Operator, :none, 2023, 7
3234
- deprecate :Operator=, :none, 2023, 7
3244
+ deprecate :Operator, :none, 2023, 8
3245
+ deprecate :Operator=, :none, 2023, 8
3235
3246
 
3236
3247
  def initialize(agent=nil, reportid=nil, operator=nil)
3237
3248
  @Agent = agent
@@ -3344,8 +3355,8 @@ module TencentCloud
3344
3355
 
3345
3356
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Operator
3346
3357
  extend Gem::Deprecate
3347
- deprecate :Operator, :none, 2023, 7
3348
- deprecate :Operator=, :none, 2023, 7
3358
+ deprecate :Operator, :none, 2023, 8
3359
+ deprecate :Operator=, :none, 2023, 8
3349
3360
 
3350
3361
  def initialize(agent=nil, flowids=nil, flowgroupid=nil, operator=nil)
3351
3362
  @Agent = agent
@@ -3426,8 +3437,8 @@ module TencentCloud
3426
3437
 
3427
3438
  attr_accessor :Agent, :FlowIds, :Operator
3428
3439
  extend Gem::Deprecate
3429
- deprecate :Operator, :none, 2023, 7
3430
- deprecate :Operator=, :none, 2023, 7
3440
+ deprecate :Operator, :none, 2023, 8
3441
+ deprecate :Operator=, :none, 2023, 8
3431
3442
 
3432
3443
  def initialize(agent=nil, flowids=nil, operator=nil)
3433
3444
  @Agent = agent
@@ -3482,23 +3493,33 @@ module TencentCloud
3482
3493
 
3483
3494
  # DescribeTemplates请求参数结构体
3484
3495
  class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
3485
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
3496
+ # @param Agent: 应用相关信息。
3497
+ # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
3486
3498
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3487
3499
  # @param TemplateId: 模板唯一标识,查询单个模板时使用
3488
3500
  # @type TemplateId: String
3489
- # @param ContentType: 查询内容:0-模板列表及详情(默认),1-仅模板列表
3501
+ # @param ContentType: 查询内容:
3502
+ # 0-模板列表及详情(默认),
3503
+ # 1-仅模板列表
3490
3504
  # @type ContentType: Integer
3491
- # @param Limit: 查询个数,默认20,最大100;在查询列表的时候有效
3505
+ # @param Limit: 指定每页多少条数据,如果不传默认为20,单页最大100
3492
3506
  # @type Limit: Integer
3493
- # @param Offset: 查询偏移位置,默认0;在查询列表的时候有效
3507
+ # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
3494
3508
  # @type Offset: Integer
3495
- # @param QueryAllComponents: 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
3509
+ # @param QueryAllComponents: 是否返回所有组件信息。
3510
+ # 默认false,只返回发起方控件;
3511
+ # true,返回所有签署方控件
3496
3512
  # @type QueryAllComponents: Boolean
3497
3513
  # @param TemplateName: 模糊搜索模板名称,最大长度200
3498
3514
  # @type TemplateName: String
3499
- # @param WithPreviewUrl: 是否获取模板预览链接
3515
+ # @param WithPreviewUrl: 是否获取模板预览链接,
3516
+ # 默认false-不获取
3517
+ # true-获取
3500
3518
  # @type WithPreviewUrl: Boolean
3501
- # @param WithPdfUrl: 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
3519
+ # @param WithPdfUrl: 是否获取模板的PDF文件链接。
3520
+ # 默认false-不获取
3521
+ # true-获取
3522
+ # 请联系客户经理开白后使用。
3502
3523
  # @type WithPdfUrl: Boolean
3503
3524
  # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID
3504
3525
  # @type ChannelTemplateId: String
@@ -3507,8 +3528,8 @@ module TencentCloud
3507
3528
 
3508
3529
  attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId, :Operator
3509
3530
  extend Gem::Deprecate
3510
- deprecate :Operator, :none, 2023, 7
3511
- deprecate :Operator=, :none, 2023, 7
3531
+ deprecate :Operator, :none, 2023, 8
3532
+ deprecate :Operator=, :none, 2023, 8
3512
3533
 
3513
3534
  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
3535
  @Agent = agent
@@ -3547,13 +3568,13 @@ module TencentCloud
3547
3568
 
3548
3569
  # DescribeTemplates返回参数结构体
3549
3570
  class DescribeTemplatesResponse < TencentCloud::Common::AbstractModel
3550
- # @param Templates: 模板详情
3571
+ # @param Templates: 模板列表
3551
3572
  # @type Templates: Array
3552
- # @param TotalCount: 查询总数
3573
+ # @param TotalCount: 查询到的总数
3553
3574
  # @type TotalCount: Integer
3554
- # @param Limit: 查询数量
3575
+ # @param Limit: 每页多少条数据
3555
3576
  # @type Limit: Integer
3556
- # @param Offset: 查询起始偏移
3577
+ # @param Offset: 查询结果分页返回,此处指定第几页。页码从0开始,即首页为0。
3557
3578
  # @type Offset: Integer
3558
3579
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3559
3580
  # @type RequestId: String
@@ -3606,8 +3627,8 @@ module TencentCloud
3606
3627
 
3607
3628
  attr_accessor :Agent, :StartDate, :EndDate, :NeedAggregate, :Limit, :Offset, :Operator
3608
3629
  extend Gem::Deprecate
3609
- deprecate :Operator, :none, 2023, 7
3610
- deprecate :Operator=, :none, 2023, 7
3630
+ deprecate :Operator, :none, 2023, 8
3631
+ deprecate :Operator=, :none, 2023, 8
3611
3632
 
3612
3633
  def initialize(agent=nil, startdate=nil, enddate=nil, needaggregate=nil, limit=nil, offset=nil, operator=nil)
3613
3634
  @Agent = agent
@@ -3960,8 +3981,8 @@ module TencentCloud
3960
3981
 
3961
3982
  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
3983
  extend Gem::Deprecate
3963
- deprecate :CallbackUrl, :none, 2023, 7
3964
- deprecate :CallbackUrl=, :none, 2023, 7
3984
+ deprecate :CallbackUrl, :none, 2023, 8
3985
+ deprecate :CallbackUrl=, :none, 2023, 8
3965
3986
 
3966
3987
  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
3988
  @Name = name
@@ -4493,8 +4514,8 @@ module TencentCloud
4493
4514
 
4494
4515
  attr_accessor :Agent, :DownLoadFlows, :Operator
4495
4516
  extend Gem::Deprecate
4496
- deprecate :Operator, :none, 2023, 7
4497
- deprecate :Operator=, :none, 2023, 7
4517
+ deprecate :Operator, :none, 2023, 8
4518
+ deprecate :Operator=, :none, 2023, 8
4498
4519
 
4499
4520
  def initialize(agent=nil, downloadflows=nil, operator=nil)
4500
4521
  @Agent = agent
@@ -4668,35 +4689,45 @@ module TencentCloud
4668
4689
 
4669
4690
  # OperateChannelTemplate请求参数结构体
4670
4691
  class OperateChannelTemplateRequest < TencentCloud::Common::AbstractModel
4671
- # @param Agent: 应用相关信息。 此接口Agent.AppId必填。
4692
+ # @param Agent: 应用相关信息。
4693
+ # 此接口Agent.AppId必填。
4672
4694
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4673
- # @param OperateType: 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
4695
+ # @param OperateType: 操作类型,
4696
+ # 查询:"SELECT",
4697
+ # 删除:"DELETE",
4698
+ # 更新:"UPDATE"
4674
4699
  # @type OperateType: String
4675
4700
  # @param TemplateId: 第三方应用平台模板库模板唯一标识
4676
4701
  # @type TemplateId: String
4677
- # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
4702
+ # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据.
4703
+ # 支持多个, 用","进行分隔
4678
4704
  # @type ProxyOrganizationOpenIds: String
4679
- # @param AuthTag: 模板可见性, 全部可见-"all", 部分可见-"part"
4705
+ # @param AuthTag: 模板可见性,
4706
+ # 全部可见-"all",
4707
+ # 部分可见-"part"
4680
4708
  # @type AuthTag: String
4681
- # @param Operator: 暂未开放
4682
- # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
4683
- # @param Available: 当OperateType=UPADATE时,可以通过设置此字段对模板启停用状态进行操作。若此字段值为0,则不会修改模板Available,1为启用模板,2为停用模板。
4709
+ # @param Available: 当OperateType=UPADATE时,可以通过设置此字段对模板启停用状态进行操作。
4710
+ # 若此字段值为0,则不会修改模板Available,
4711
+ # 1为启用模板,
4712
+ # 2为停用模板。
4684
4713
  # 启用后模板可以正常领取。停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败,会直接返回错误。
4685
4714
  # @type Available: Integer
4715
+ # @param Operator: 暂未开放
4716
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
4686
4717
 
4687
- attr_accessor :Agent, :OperateType, :TemplateId, :ProxyOrganizationOpenIds, :AuthTag, :Operator, :Available
4718
+ attr_accessor :Agent, :OperateType, :TemplateId, :ProxyOrganizationOpenIds, :AuthTag, :Available, :Operator
4688
4719
  extend Gem::Deprecate
4689
- deprecate :Operator, :none, 2023, 7
4690
- deprecate :Operator=, :none, 2023, 7
4720
+ deprecate :Operator, :none, 2023, 8
4721
+ deprecate :Operator=, :none, 2023, 8
4691
4722
 
4692
- def initialize(agent=nil, operatetype=nil, templateid=nil, proxyorganizationopenids=nil, authtag=nil, operator=nil, available=nil)
4723
+ def initialize(agent=nil, operatetype=nil, templateid=nil, proxyorganizationopenids=nil, authtag=nil, available=nil, operator=nil)
4693
4724
  @Agent = agent
4694
4725
  @OperateType = operatetype
4695
4726
  @TemplateId = templateid
4696
4727
  @ProxyOrganizationOpenIds = proxyorganizationopenids
4697
4728
  @AuthTag = authtag
4698
- @Operator = operator
4699
4729
  @Available = available
4730
+ @Operator = operator
4700
4731
  end
4701
4732
 
4702
4733
  def deserialize(params)
@@ -4708,11 +4739,11 @@ module TencentCloud
4708
4739
  @TemplateId = params['TemplateId']
4709
4740
  @ProxyOrganizationOpenIds = params['ProxyOrganizationOpenIds']
4710
4741
  @AuthTag = params['AuthTag']
4742
+ @Available = params['Available']
4711
4743
  unless params['Operator'].nil?
4712
4744
  @Operator = UserInfo.new
4713
4745
  @Operator.deserialize(params['Operator'])
4714
4746
  end
4715
- @Available = params['Available']
4716
4747
  end
4717
4748
  end
4718
4749
 
@@ -4724,10 +4755,15 @@ module TencentCloud
4724
4755
  # @param TemplateId: 第三方应用平台模板库模板唯一标识
4725
4756
  # 注意:此字段可能返回 null,表示取不到有效值。
4726
4757
  # @type TemplateId: String
4727
- # @param OperateResult: 描述模板可见性更改的结果,和参数中Available无关,全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示。
4758
+ # @param OperateResult: 描述模板可见性更改的结果,和参数中Available无关。
4759
+ # 全部成功-"all-success",
4760
+ # 部分成功-"part-success",
4761
+ # 全部失败-"fail",失败的会在FailMessageList中展示。
4728
4762
  # 注意:此字段可能返回 null,表示取不到有效值。
4729
4763
  # @type OperateResult: String
4730
- # @param AuthTag: 模板可见性, 全部可见-"all", 部分可见-"part"
4764
+ # @param AuthTag: 模板可见性,
4765
+ # 全部可见-"all",
4766
+ # 部分可见-"part"
4731
4767
  # 注意:此字段可能返回 null,表示取不到有效值。
4732
4768
  # @type AuthTag: String
4733
4769
  # @param ProxyOrganizationOpenIds: 合作企业方第三方机构唯一标识数据
@@ -4784,10 +4820,10 @@ module TencentCloud
4784
4820
 
4785
4821
  attr_accessor :OrganizationOpenId, :OrganizationId, :Channel, :ClientIp, :ProxyIp
4786
4822
  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
4823
+ deprecate :ClientIp, :none, 2023, 8
4824
+ deprecate :ClientIp=, :none, 2023, 8
4825
+ deprecate :ProxyIp, :none, 2023, 8
4826
+ deprecate :ProxyIp=, :none, 2023, 8
4791
4827
 
4792
4828
  def initialize(organizationopenid=nil, organizationid=nil, channel=nil, clientip=nil, proxyip=nil)
4793
4829
  @OrganizationOpenId = organizationopenid
@@ -4887,8 +4923,8 @@ module TencentCloud
4887
4923
 
4888
4924
  attr_accessor :Agent, :FlowInfos, :JumpUrl, :Operator
4889
4925
  extend Gem::Deprecate
4890
- deprecate :Operator, :none, 2023, 7
4891
- deprecate :Operator=, :none, 2023, 7
4926
+ deprecate :Operator, :none, 2023, 8
4927
+ deprecate :Operator=, :none, 2023, 8
4892
4928
 
4893
4929
  def initialize(agent=nil, flowinfos=nil, jumpurl=nil, operator=nil)
4894
4930
  @Agent = agent
@@ -4980,25 +5016,34 @@ module TencentCloud
4980
5016
  end
4981
5017
  end
4982
5018
 
4983
- # 签署参与者信息
5019
+ # 流程中参与方的信息结构
4984
5020
  class Recipient < TencentCloud::Common::AbstractModel
4985
- # @param RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方Id
5021
+ # @param RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方ID
4986
5022
  # @type RecipientId: String
4987
- # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
5023
+ # @param RecipientType: 参与者类型,默认为空。
5024
+ # ENTERPRISE-企业;
5025
+ # INDIVIDUAL-个人;
5026
+ # PROMOTER-发起方
4988
5027
  # @type RecipientType: String
4989
- # @param Description: 描述
5028
+ # @param Description: 描述信息
4990
5029
  # @type Description: String
4991
- # @param RoleName: 签署方备注角色名
5030
+ # @param RoleName: 角色名称
4992
5031
  # @type RoleName: String
4993
- # @param RequireValidation: 是否需要校验,true-是,false-否
5032
+ # @param RequireValidation: 是否需要校验,
5033
+ # true-是,
5034
+ # false-否
4994
5035
  # @type RequireValidation: Boolean
4995
- # @param RequireSign: 是否必须填写,true-是,false-否
5036
+ # @param RequireSign: 是否必须填写,
5037
+ # true-是,
5038
+ # false-否
4996
5039
  # @type RequireSign: Boolean
4997
- # @param SignType: 签署类型
5040
+ # @param SignType: 内部字段,签署类型
4998
5041
  # @type SignType: Integer
4999
5042
  # @param RoutingOrder: 签署顺序:数字越小优先级越高
5000
5043
  # @type RoutingOrder: Integer
5001
- # @param IsPromoter: 是否是发起方
5044
+ # @param IsPromoter: 是否是发起方,
5045
+ # true-是
5046
+ # false-否
5002
5047
  # @type IsPromoter: Boolean
5003
5048
 
5004
5049
  attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :SignType, :RoutingOrder, :IsPromoter
@@ -5317,8 +5362,8 @@ module TencentCloud
5317
5362
 
5318
5363
  attr_accessor :SignUrl, :Deadline, :SignOrder, :SignId, :CustomUserId, :Name, :Mobile, :OrganizationName, :ApproverType, :IdCardNumber, :FlowId, :OpenId, :FlowGroupId
5319
5364
  extend Gem::Deprecate
5320
- deprecate :CustomUserId, :none, 2023, 7
5321
- deprecate :CustomUserId=, :none, 2023, 7
5365
+ deprecate :CustomUserId, :none, 2023, 8
5366
+ deprecate :CustomUserId=, :none, 2023, 8
5322
5367
 
5323
5368
  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
5369
  @SignUrl = signurl
@@ -5480,8 +5525,8 @@ module TencentCloud
5480
5525
 
5481
5526
  attr_accessor :Agent, :OperatorType, :ProxyOrganizationOperators, :Operator
5482
5527
  extend Gem::Deprecate
5483
- deprecate :Operator, :none, 2023, 7
5484
- deprecate :Operator=, :none, 2023, 7
5528
+ deprecate :Operator, :none, 2023, 8
5529
+ deprecate :Operator=, :none, 2023, 8
5485
5530
 
5486
5531
  def initialize(agent=nil, operatortype=nil, proxyorganizationoperators=nil, operator=nil)
5487
5532
  @Agent = agent
@@ -5564,8 +5609,8 @@ module TencentCloud
5564
5609
 
5565
5610
  attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator
5566
5611
  extend Gem::Deprecate
5567
- deprecate :Operator, :none, 2023, 7
5568
- deprecate :Operator=, :none, 2023, 7
5612
+ deprecate :Operator, :none, 2023, 8
5613
+ deprecate :Operator=, :none, 2023, 8
5569
5614
 
5570
5615
  def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil)
5571
5616
  @Agent = agent
@@ -5631,18 +5676,26 @@ module TencentCloud
5631
5676
  end
5632
5677
 
5633
5678
  # 此结构体 (TemplateInfo) 用于描述模板的信息。
5679
+
5680
+ # > **模板组成**
5681
+ # >
5682
+ # > 一个模板通常会包含以下结构信息
5683
+ # >- 模板基本信息
5684
+ # >- 签署参与方 Recipients,在模板发起合同时用于指定参与方
5685
+ # >- 填写控件 Components
5686
+ # >- 签署控件 SignComponents
5634
5687
  class TemplateInfo < TencentCloud::Common::AbstractModel
5635
- # @param TemplateId: 模板ID
5688
+ # @param TemplateId: 模板ID,模板的唯一标识
5636
5689
  # @type TemplateId: String
5637
- # @param TemplateName: 模板名字
5690
+ # @param TemplateName: 模板名
5638
5691
  # @type TemplateName: String
5639
5692
  # @param Description: 模板描述信息
5640
5693
  # @type Description: String
5641
- # @param Components: 模板的填充控件信息结构
5694
+ # @param Components: 模板的填充控件列表
5642
5695
  # @type Components: Array
5643
- # @param Recipients: 模板中的流程参与人信息
5696
+ # @param Recipients: 模板中的签署参与方列表
5644
5697
  # @type Recipients: Array
5645
- # @param SignComponents: 模板中的签署控件信息结构
5698
+ # @param SignComponents: 模板中的签署控件列表
5646
5699
  # @type SignComponents: Array
5647
5700
  # @param TemplateType: 模板类型:1-静默签;3-普通模板
5648
5701
  # @type TemplateType: Integer
@@ -5650,33 +5703,41 @@ module TencentCloud
5650
5703
  # @type IsPromoter: Boolean
5651
5704
  # @param Creator: 模板的创建者信息,电子签系统用户ID
5652
5705
  # @type Creator: String
5653
- # @param CreatedOn: 模板创建的时间戳,单位秒
5706
+ # @param CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
5654
5707
  # @type CreatedOn: Integer
5655
- # @param PreviewUrl: 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
5708
+ # @param PreviewUrl: 模板的H5预览链接,有效期5分钟。
5709
+ # 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
5710
+ # (此功能开放需要联系客户经理)
5656
5711
  # 注意:此字段可能返回 null,表示取不到有效值。
5657
5712
  # @type PreviewUrl: String
5658
- # @param PdfUrl: 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
5713
+ # @param PdfUrl: 第三方应用集成-模板PDF文件链接,有效期5分钟。
5714
+ # 请求参数WithPdfUrl=true时返回
5715
+ # (此功能开放需要联系客户经理)。
5659
5716
  # 注意:此字段可能返回 null,表示取不到有效值。
5660
5717
  # @type PdfUrl: String
5661
- # @param ChannelTemplateId: 关联的第三方应用平台企业模板ID
5718
+ # @param ChannelTemplateId: 本模板关联的第三方应用平台企业模板ID
5662
5719
  # @type ChannelTemplateId: String
5663
- # @param ChannelTemplateName: 关联的三方应用平台平台企业模板名称
5720
+ # @param ChannelTemplateName: 本模板关联的三方应用平台平台企业模板名称
5664
5721
  # 注意:此字段可能返回 null,表示取不到有效值。
5665
5722
  # @type ChannelTemplateName: String
5666
- # @param ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
5723
+ # @param ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认);
5724
+ # 1-平台自动设置子客模板
5667
5725
  # 注意:此字段可能返回 null,表示取不到有效值。
5668
5726
  # @type ChannelAutoSave: Integer
5669
- # @param TemplateVersion: 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
5727
+ # @param TemplateVersion: 模板版本,全数字字符。
5728
+ # 默认为空,初始版本为yyyyMMdd001。
5670
5729
  # 注意:此字段可能返回 null,表示取不到有效值。
5671
5730
  # @type TemplateVersion: String
5672
- # @param Available: 模板可用状态,取值:1启用(默认),2停用
5731
+ # @param Available: 模板可用状态:
5732
+ # 1启用(默认)
5733
+ # 2停用
5673
5734
  # 注意:此字段可能返回 null,表示取不到有效值。
5674
5735
  # @type Available: Integer
5675
5736
 
5676
5737
  attr_accessor :TemplateId, :TemplateName, :Description, :Components, :Recipients, :SignComponents, :TemplateType, :IsPromoter, :Creator, :CreatedOn, :PreviewUrl, :PdfUrl, :ChannelTemplateId, :ChannelTemplateName, :ChannelAutoSave, :TemplateVersion, :Available
5677
5738
  extend Gem::Deprecate
5678
- deprecate :IsPromoter, :none, 2023, 7
5679
- deprecate :IsPromoter=, :none, 2023, 7
5739
+ deprecate :IsPromoter, :none, 2023, 8
5740
+ deprecate :IsPromoter=, :none, 2023, 8
5680
5741
 
5681
5742
  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
5743
  @TemplateId = templateid
@@ -5775,8 +5836,8 @@ module TencentCloud
5775
5836
 
5776
5837
  attr_accessor :Agent, :BusinessType, :FileInfos, :Operator
5777
5838
  extend Gem::Deprecate
5778
- deprecate :Operator, :none, 2023, 7
5779
- deprecate :Operator=, :none, 2023, 7
5839
+ deprecate :Operator, :none, 2023, 8
5840
+ deprecate :Operator=, :none, 2023, 8
5780
5841
 
5781
5842
  def initialize(agent=nil, businesstype=nil, fileinfos=nil, operator=nil)
5782
5843
  @Agent = agent
@@ -5889,14 +5950,14 @@ module TencentCloud
5889
5950
 
5890
5951
  attr_accessor :OpenId, :Channel, :CustomUserId, :ClientIp, :ProxyIp
5891
5952
  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
5953
+ deprecate :Channel, :none, 2023, 8
5954
+ deprecate :Channel=, :none, 2023, 8
5955
+ deprecate :CustomUserId, :none, 2023, 8
5956
+ deprecate :CustomUserId=, :none, 2023, 8
5957
+ deprecate :ClientIp, :none, 2023, 8
5958
+ deprecate :ClientIp=, :none, 2023, 8
5959
+ deprecate :ProxyIp, :none, 2023, 8
5960
+ deprecate :ProxyIp=, :none, 2023, 8
5900
5961
 
5901
5962
  def initialize(openid=nil, channel=nil, customuserid=nil, clientip=nil, proxyip=nil)
5902
5963
  @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.625
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-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common