tencentcloud-sdk-essbasic 3.0.687 → 3.0.689

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: f19ca4be959390c27cb7865d7993e8c56b732c59
4
- data.tar.gz: 1105b9dc5c70f8b11c7ef04871be58d21effa257
3
+ metadata.gz: 8137a4e60a258742266b0b2aae0dc8e49e7a0cb0
4
+ data.tar.gz: fc1ccdf855324823e57267e4dd95532ca2638119
5
5
  SHA512:
6
- metadata.gz: 032848a8e2d5ed00a8a122c5cb3234ce270619eabc7664c134b5013d4517986b41e2a93aa51a548de02d7b10f3daa2f0b62b9666fabcc29219e58819df50d077
7
- data.tar.gz: b184c65ec380a4a9d9295b39168156a90e3d87f484bd11410e2e812f965d5f5602f1e4147973a1ca05ab1f8a217a93c720668794c1ea65eb41b8ab0e9de476b4
6
+ metadata.gz: 2998ddb2b75e6cf36301f0c8ad86c374d4964bb171ddfb892448baafaf35a62b5abc9a44328ec90e07b62529604cfebb42737b13dfe82795d1a3b8635d2b54b2
7
+ data.tar.gz: 7b2017efcbb87ab726f7b41e8ee1272c177605f5ad008eef4ddd2a509c789df1ce107bede8d04ded1b80d6be14535584b1b1f656aa79ba1140245edbf5486063
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.687
1
+ 3.0.689
@@ -29,18 +29,22 @@ module TencentCloud
29
29
  end
30
30
 
31
31
 
32
- # 指定需要批量撤销的签署流程Id,批量撤销合同
33
- # 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
34
-
35
- # 可以撤回:未全部签署完成
36
- # 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
37
-
38
- # **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
39
-
40
- # **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
41
-
42
- # **注意:
43
- # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
32
+ # 用于批量撤销合同流程<br/>
33
+ # 适用场景:
34
+ # 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
35
+ # 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
36
+ # - 已全部签署完成
37
+ # - 已拒签
38
+ # - 已过期
39
+ # - 已撤回
40
+ # - 拒绝填写
41
+ # - 已解除
42
+
43
+ # <br/>
44
+ # 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
45
+ # <br/><br/>
46
+ # 注:
47
+ # `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
44
48
 
45
49
  # @param request: Request instance for ChannelBatchCancelFlows.
46
50
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
@@ -615,7 +619,6 @@ module TencentCloud
615
619
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
616
620
  end
617
621
 
618
- # 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
619
622
  # 该接口用于发起合同后,生成C端签署人的签署链接<br/>
620
623
  # 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
621
624
  # 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
@@ -1042,7 +1045,7 @@ module TencentCloud
1042
1045
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1043
1046
  end
1044
1047
 
1045
- # 查询企业员工列表
1048
+ # 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
1046
1049
 
1047
1050
  # @param request: Request instance for ChannelDescribeEmployees.
1048
1051
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeEmployeesRequest`
@@ -1140,7 +1143,9 @@ module TencentCloud
1140
1143
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1141
1144
  end
1142
1145
 
1143
- # 企业方可以通过此接口查询个人用户自动签开启状态
1146
+ # 通过此接口获取个人用户自动签的开通状态。
1147
+
1148
+ # 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
1144
1149
 
1145
1150
  # @param request: Request instance for ChannelDescribeUserAutoSignStatus.
1146
1151
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeUserAutoSignStatusRequest`
@@ -1164,7 +1169,13 @@ module TencentCloud
1164
1169
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1165
1170
  end
1166
1171
 
1167
- # 企业方可以通过此接口关闭个人的自动签功能
1172
+ # 通过此接口可以关闭个人用户自动签功能。
1173
+ # 无需对应的用户刷脸等方式同意即可关闭。
1174
+
1175
+ # 注意:
1176
+
1177
+ # <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
1178
+ # <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
1168
1179
 
1169
1180
  # @param request: Request instance for ChannelDisableUserAutoSign.
1170
1181
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDisableUserAutoSignRequest`
@@ -1541,7 +1552,7 @@ module TencentCloud
1541
1552
 
1542
1553
  # 创建跳转小程序查看或签署的链接
1543
1554
 
1544
- # **腾讯电子签小程序的的AppID 和 原始Id如下:**
1555
+ # **腾讯电子签小程序的AppID 和 原始Id如下:**
1545
1556
 
1546
1557
  # | 小程序 | AppID | 原始ID |
1547
1558
  # | ------------ | ------------ | ------------ |
@@ -1552,10 +1563,10 @@ module TencentCloud
1552
1563
 
1553
1564
  # |EndPoint| 场景| 说明和示例|
1554
1565
  # | ---- | ---- | --- |
1555
- # | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
1556
- # | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
1566
+ # | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
1567
+ # | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
1557
1568
  # | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
1558
- # |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
1569
+ # |APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
1559
1570
  # |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
1560
1571
 
1561
1572
  # @param request: Request instance for CreateSignUrls.
@@ -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, 10
36
- deprecate :ProxyOrganizationId=, :none, 2023, 10
35
+ deprecate :ProxyOrganizationId, :none, 2023, 11
36
+ deprecate :ProxyOrganizationId=, :none, 2023, 11
37
37
 
38
38
  def initialize(appid=nil, proxyorganizationopenid=nil, proxyoperator=nil, proxyappid=nil, proxyorganizationid=nil)
39
39
  @AppId = appid
@@ -216,19 +216,34 @@ module TencentCloud
216
216
 
217
217
  # 自动签开启、签署相关配置
218
218
  class AutoSignConfig < TencentCloud::Common::AbstractModel
219
- # @param UserInfo: 自动签开通个人用户的三要素
219
+ # @param UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
220
220
  # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
221
- # @param CertInfoCallback: 是否回调证书信息
221
+ # @param CertInfoCallback: 是否回调证书信息:
222
+ # <ul><li>**false**: 不需要(默认)</li>
223
+ # <li>**true**:需要</li></ul>
222
224
  # @type CertInfoCallback: Boolean
223
- # @param UserDefineSeal: 是否支持用户自定义签名印章
225
+ # @param UserDefineSeal: 是否支持用户自定义签名印章:
226
+ # <ul><li>**false**: 不能自己定义(默认)</li>
227
+ # <li>**true**: 可以自己定义</li></ul>
224
228
  # @type UserDefineSeal: Boolean
225
- # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
229
+ # @param SealImgCallback: 回调中是否需要自动签将要使用的印章(签名)图片的 base64:
230
+ # <ul><li>**false**: 不需要(默认)</li>
231
+ # <li>**true**: 需要</li></ul>
226
232
  # @type SealImgCallback: Boolean
227
233
  # @param CallbackUrl: 回调链接,如果渠道已经配置了,可以不传
228
234
  # @type CallbackUrl: String
229
- # @param VerifyChannels: 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
235
+ # @param VerifyChannels: 开通时候的身份验证方式, 取值为:
236
+ # <ul><li>**WEIXINAPP** : 微信人脸识别</li>
237
+ # <li>**INSIGHT** : 慧眼人脸认别</li>
238
+ # <li>**TELECOM** : 运营商三要素验证</li></ul>
239
+ # 注:
240
+ # <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
241
+ # <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
230
242
  # @type VerifyChannels: Array
231
- # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
243
+ # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
244
+
245
+ # <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
246
+ # </ul>
232
247
  # @type LicenseType: Integer
233
248
 
234
249
  attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType
@@ -385,20 +400,27 @@ module TencentCloud
385
400
  # @type FlowIds: Array
386
401
  # @param CancelMessage: 撤销理由,不超过200个字符
387
402
  # @type CancelMessage: String
388
- # @param CancelMessageFormat: 撤销理由自定义格式;选项:
389
-
390
- # - 0 默认格式
391
- # - 1 只保留身份信息:展示为【发起方】
392
- # - 2 保留身份信息+企业名称:展示为【发起方xxx公司】
393
- # - 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
403
+ # @param CancelMessageFormat: 撤销理由自定义格式,支持以下格式
404
+ # <ul><li>0 : 默认值</li>
405
+ # <li>1 : 只保留身份信息</li>
406
+ # <li>2 : 保留身份信息+企业名称</li>
407
+ # <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
408
+ # 例如,假设合同的发起方是典子谦示例企业的经办人张三,撤销理由是"合同内容错误,需要修正",合同撤销后,各签署方看到的撤销理由是会是
409
+
410
+ # 0: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同
411
+ # 1: 发起方以"合同内容错误,需要修正"的理由撤销当前合同
412
+ # 2: 发起方-典子谦示例企业以"合同内容错误,需要修正"的理由撤销当前合同
413
+ # 3: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同</br>
414
+
415
+ # 备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
394
416
  # @type CancelMessageFormat: Integer
395
417
  # @param Operator: 暂未开放
396
418
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
397
419
 
398
420
  attr_accessor :Agent, :FlowIds, :CancelMessage, :CancelMessageFormat, :Operator
399
421
  extend Gem::Deprecate
400
- deprecate :Operator, :none, 2023, 10
401
- deprecate :Operator=, :none, 2023, 10
422
+ deprecate :Operator, :none, 2023, 11
423
+ deprecate :Operator=, :none, 2023, 11
402
424
 
403
425
  def initialize(agent=nil, flowids=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil)
404
426
  @Agent = agent
@@ -475,8 +497,8 @@ module TencentCloud
475
497
 
476
498
  attr_accessor :FlowId, :Agent, :CancelMessage, :CancelMessageFormat, :Operator
477
499
  extend Gem::Deprecate
478
- deprecate :Operator, :none, 2023, 10
479
- deprecate :Operator=, :none, 2023, 10
500
+ deprecate :Operator, :none, 2023, 11
501
+ deprecate :Operator=, :none, 2023, 11
480
502
 
481
503
  def initialize(flowid=nil, agent=nil, cancelmessage=nil, cancelmessageformat=nil, operator=nil)
482
504
  @FlowId = flowid
@@ -535,8 +557,8 @@ module TencentCloud
535
557
 
536
558
  attr_accessor :Agent, :QrCodeId, :Operator
537
559
  extend Gem::Deprecate
538
- deprecate :Operator, :none, 2023, 10
539
- deprecate :Operator=, :none, 2023, 10
560
+ deprecate :Operator, :none, 2023, 11
561
+ deprecate :Operator=, :none, 2023, 11
540
562
 
541
563
  def initialize(agent=nil, qrcodeid=nil, operator=nil)
542
564
  @Agent = agent
@@ -637,8 +659,8 @@ module TencentCloud
637
659
 
638
660
  attr_accessor :Agent, :FlowIds, :Operator
639
661
  extend Gem::Deprecate
640
- deprecate :Operator, :none, 2023, 10
641
- deprecate :Operator=, :none, 2023, 10
662
+ deprecate :Operator, :none, 2023, 11
663
+ deprecate :Operator=, :none, 2023, 11
642
664
 
643
665
  def initialize(agent=nil, flowids=nil, operator=nil)
644
666
  @Agent = agent
@@ -822,8 +844,8 @@ module TencentCloud
822
844
 
823
845
  attr_accessor :Agent, :FlowIds, :Operator
824
846
  extend Gem::Deprecate
825
- deprecate :Operator, :none, 2023, 10
826
- deprecate :Operator=, :none, 2023, 10
847
+ deprecate :Operator, :none, 2023, 11
848
+ deprecate :Operator=, :none, 2023, 11
827
849
 
828
850
  def initialize(agent=nil, flowids=nil, operator=nil)
829
851
  @Agent = agent
@@ -877,10 +899,10 @@ module TencentCloud
877
899
 
878
900
  attr_accessor :Agent, :ResourceType, :ResourceName, :ResourceId, :Operator, :Organization
879
901
  extend Gem::Deprecate
880
- deprecate :Operator, :none, 2023, 10
881
- deprecate :Operator=, :none, 2023, 10
882
- deprecate :Organization, :none, 2023, 10
883
- deprecate :Organization=, :none, 2023, 10
902
+ deprecate :Operator, :none, 2023, 11
903
+ deprecate :Operator=, :none, 2023, 11
904
+ deprecate :Organization, :none, 2023, 11
905
+ deprecate :Organization=, :none, 2023, 11
884
906
 
885
907
  def initialize(agent=nil, resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, organization=nil)
886
908
  @Agent = agent
@@ -959,8 +981,8 @@ module TencentCloud
959
981
 
960
982
  attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator
961
983
  extend Gem::Deprecate
962
- deprecate :Operator, :none, 2023, 10
963
- deprecate :Operator=, :none, 2023, 10
984
+ deprecate :Operator, :none, 2023, 11
985
+ deprecate :Operator=, :none, 2023, 11
964
986
 
965
987
  def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil)
966
988
  @Agent = agent
@@ -1185,8 +1207,8 @@ module TencentCloud
1185
1207
 
1186
1208
  attr_accessor :Agent, :FlowName, :FlowDescription, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :CcInfos, :CcNotifyType, :AutoSignScene, :Operator
1187
1209
  extend Gem::Deprecate
1188
- deprecate :Operator, :none, 2023, 10
1189
- deprecate :Operator=, :none, 2023, 10
1210
+ deprecate :Operator, :none, 2023, 11
1211
+ deprecate :Operator=, :none, 2023, 11
1190
1212
 
1191
1213
  def initialize(agent=nil, flowname=nil, flowdescription=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil)
1192
1214
  @Agent = agent
@@ -1324,8 +1346,8 @@ module TencentCloud
1324
1346
 
1325
1347
  attr_accessor :FlowFileInfos, :FlowGroupName, :Agent, :ApproverVerifyType, :FlowGroupOptions, :Operator
1326
1348
  extend Gem::Deprecate
1327
- deprecate :Operator, :none, 2023, 10
1328
- deprecate :Operator=, :none, 2023, 10
1349
+ deprecate :Operator, :none, 2023, 11
1350
+ deprecate :Operator=, :none, 2023, 11
1329
1351
 
1330
1352
  def initialize(flowfileinfos=nil, flowgroupname=nil, agent=nil, approververifytype=nil, flowgroupoptions=nil, operator=nil)
1331
1353
  @FlowFileInfos = flowfileinfos
@@ -1371,7 +1393,7 @@ module TencentCloud
1371
1393
  # @param FlowIds: 合同组中每个合同流程ID,每个ID均为32位字符串。
1372
1394
 
1373
1395
  # 注:
1374
- # `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
1396
+ # `此数组的顺序和入参中的FlowGroupInfos顺序一致`
1375
1397
  # 注意:此字段可能返回 null,表示取不到有效值。
1376
1398
  # @type FlowIds: Array
1377
1399
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1442,7 +1464,7 @@ module TencentCloud
1442
1464
  # @param FlowIds: 合同组中每个合同流程ID,每个ID均为32位字符串。
1443
1465
 
1444
1466
  # 注:
1445
- # `此数组的顺序和入参中的FlowInfos顺序回不一致`
1467
+ # `此数组的顺序和入参中的FlowInfos顺序一致`
1446
1468
  # @type FlowIds: Array
1447
1469
  # @param TaskInfos: 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
1448
1470
  # 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
@@ -1611,10 +1633,10 @@ module TencentCloud
1611
1633
 
1612
1634
  attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl
1613
1635
  extend Gem::Deprecate
1614
- deprecate :Operator, :none, 2023, 10
1615
- deprecate :Operator=, :none, 2023, 10
1616
- deprecate :Organization, :none, 2023, 10
1617
- deprecate :Organization=, :none, 2023, 10
1636
+ deprecate :Operator, :none, 2023, 11
1637
+ deprecate :Operator=, :none, 2023, 11
1638
+ deprecate :Organization, :none, 2023, 11
1639
+ deprecate :Organization=, :none, 2023, 11
1618
1640
 
1619
1641
  def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil)
1620
1642
  @Agent = agent
@@ -1715,12 +1737,12 @@ module TencentCloud
1715
1737
 
1716
1738
  attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :ApproverComponentLimitTypes, :CallbackUrl, :ApproverRestrictions, :Operator
1717
1739
  extend Gem::Deprecate
1718
- deprecate :CallbackUrl, :none, 2023, 10
1719
- deprecate :CallbackUrl=, :none, 2023, 10
1720
- deprecate :ApproverRestrictions, :none, 2023, 10
1721
- deprecate :ApproverRestrictions=, :none, 2023, 10
1722
- deprecate :Operator, :none, 2023, 10
1723
- deprecate :Operator=, :none, 2023, 10
1740
+ deprecate :CallbackUrl, :none, 2023, 11
1741
+ deprecate :CallbackUrl=, :none, 2023, 11
1742
+ deprecate :ApproverRestrictions, :none, 2023, 11
1743
+ deprecate :ApproverRestrictions=, :none, 2023, 11
1744
+ deprecate :Operator, :none, 2023, 11
1745
+ deprecate :Operator=, :none, 2023, 11
1724
1746
 
1725
1747
  def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, approvercomponentlimittypes=nil, callbackurl=nil, approverrestrictions=nil, operator=nil)
1726
1748
  @Agent = agent
@@ -1934,12 +1956,12 @@ module TencentCloud
1934
1956
 
1935
1957
  attr_accessor :ResourceId, :ResourceType, :FlowInfo, :Agent, :FlowOption, :FlowApproverList, :FlowId, :NeedPreview, :Organization, :Operator
1936
1958
  extend Gem::Deprecate
1937
- deprecate :NeedPreview, :none, 2023, 10
1938
- deprecate :NeedPreview=, :none, 2023, 10
1939
- deprecate :Organization, :none, 2023, 10
1940
- deprecate :Organization=, :none, 2023, 10
1941
- deprecate :Operator, :none, 2023, 10
1942
- deprecate :Operator=, :none, 2023, 10
1959
+ deprecate :NeedPreview, :none, 2023, 11
1960
+ deprecate :NeedPreview=, :none, 2023, 11
1961
+ deprecate :Organization, :none, 2023, 11
1962
+ deprecate :Organization=, :none, 2023, 11
1963
+ deprecate :Operator, :none, 2023, 11
1964
+ deprecate :Operator=, :none, 2023, 11
1943
1965
 
1944
1966
  def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, agent=nil, flowoption=nil, flowapproverlist=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil)
1945
1967
  @ResourceId = resourceid
@@ -2117,10 +2139,10 @@ module TencentCloud
2117
2139
 
2118
2140
  attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline
2119
2141
  extend Gem::Deprecate
2120
- deprecate :Organization, :none, 2023, 10
2121
- deprecate :Organization=, :none, 2023, 10
2122
- deprecate :Operator, :none, 2023, 10
2123
- deprecate :Operator=, :none, 2023, 10
2142
+ deprecate :Organization, :none, 2023, 11
2143
+ deprecate :Organization=, :none, 2023, 11
2144
+ deprecate :Operator, :none, 2023, 11
2145
+ deprecate :Operator=, :none, 2023, 11
2124
2146
 
2125
2147
  def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil)
2126
2148
  @Agent = agent
@@ -2258,10 +2280,10 @@ module TencentCloud
2258
2280
 
2259
2281
  attr_accessor :Agent, :SealId, :UserIds, :Operator, :Organization
2260
2282
  extend Gem::Deprecate
2261
- deprecate :Operator, :none, 2023, 10
2262
- deprecate :Operator=, :none, 2023, 10
2263
- deprecate :Organization, :none, 2023, 10
2264
- deprecate :Organization=, :none, 2023, 10
2283
+ deprecate :Operator, :none, 2023, 11
2284
+ deprecate :Operator=, :none, 2023, 11
2285
+ deprecate :Organization, :none, 2023, 11
2286
+ deprecate :Organization=, :none, 2023, 11
2265
2287
 
2266
2288
  def initialize(agent=nil, sealid=nil, userids=nil, operator=nil, organization=nil)
2267
2289
  @Agent = agent
@@ -2500,8 +2522,8 @@ module TencentCloud
2500
2522
 
2501
2523
  attr_accessor :Agent, :RoleIds, :UserIds, :OpenIds, :Operator
2502
2524
  extend Gem::Deprecate
2503
- deprecate :Operator, :none, 2023, 10
2504
- deprecate :Operator=, :none, 2023, 10
2525
+ deprecate :Operator, :none, 2023, 11
2526
+ deprecate :Operator=, :none, 2023, 11
2505
2527
 
2506
2528
  def initialize(agent=nil, roleids=nil, userids=nil, openids=nil, operator=nil)
2507
2529
  @Agent = agent
@@ -2654,8 +2676,8 @@ module TencentCloud
2654
2676
 
2655
2677
  attr_accessor :Agent, :RoleId, :UserIds, :Operator, :OpenIds
2656
2678
  extend Gem::Deprecate
2657
- deprecate :Operator, :none, 2023, 10
2658
- deprecate :Operator=, :none, 2023, 10
2679
+ deprecate :Operator, :none, 2023, 11
2680
+ deprecate :Operator=, :none, 2023, 11
2659
2681
 
2660
2682
  def initialize(agent=nil, roleid=nil, userids=nil, operator=nil, openids=nil)
2661
2683
  @Agent = agent
@@ -2716,10 +2738,10 @@ module TencentCloud
2716
2738
 
2717
2739
  attr_accessor :Agent, :SealId, :UserIds, :Organization, :Operator
2718
2740
  extend Gem::Deprecate
2719
- deprecate :Organization, :none, 2023, 10
2720
- deprecate :Organization=, :none, 2023, 10
2721
- deprecate :Operator, :none, 2023, 10
2722
- deprecate :Operator=, :none, 2023, 10
2741
+ deprecate :Organization, :none, 2023, 11
2742
+ deprecate :Organization=, :none, 2023, 11
2743
+ deprecate :Operator, :none, 2023, 11
2744
+ deprecate :Operator=, :none, 2023, 11
2723
2745
 
2724
2746
  def initialize(agent=nil, sealid=nil, userids=nil, organization=nil, operator=nil)
2725
2747
  @Agent = agent
@@ -2765,23 +2787,34 @@ module TencentCloud
2765
2787
 
2766
2788
  # ChannelDescribeEmployees请求参数结构体
2767
2789
  class ChannelDescribeEmployeesRequest < TencentCloud::Common::AbstractModel
2768
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
2790
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2791
+
2792
+ # 此接口下面信息必填。
2793
+ # <ul>
2794
+ # <li>渠道应用标识: Agent.AppId</li>
2795
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2796
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2797
+ # </ul>
2798
+ # 第三方平台子客企业和员工必须已经经过实名认证
2769
2799
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2770
- # @param Limit: 指定每页多少条数据,单页最大20
2800
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 20
2771
2801
  # @type Limit: Integer
2772
- # @param Filters: 查询过滤实名用户,Key为Status,Values为["IsVerified"]
2773
- # 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
2774
- # 查询离职员工时,KeyStatusValues为["QuiteJob"]
2802
+ # @param Filters: 查询的关键字段,支持Key-Values查询。可选键值如下:
2803
+ # <ul>
2804
+ # <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
2805
+ # <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
2806
+ # <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
2807
+ # </ul>
2775
2808
  # @type Filters: Array
2776
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大为20000
2809
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
2777
2810
  # @type Offset: Integer
2778
2811
  # @param Operator: 暂未开放
2779
2812
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
2780
2813
 
2781
2814
  attr_accessor :Agent, :Limit, :Filters, :Offset, :Operator
2782
2815
  extend Gem::Deprecate
2783
- deprecate :Operator, :none, 2023, 10
2784
- deprecate :Operator=, :none, 2023, 10
2816
+ deprecate :Operator, :none, 2023, 11
2817
+ deprecate :Operator=, :none, 2023, 11
2785
2818
 
2786
2819
  def initialize(agent=nil, limit=nil, filters=nil, offset=nil, operator=nil)
2787
2820
  @Agent = agent
@@ -2815,15 +2848,15 @@ module TencentCloud
2815
2848
 
2816
2849
  # ChannelDescribeEmployees返回参数结构体
2817
2850
  class ChannelDescribeEmployeesResponse < TencentCloud::Common::AbstractModel
2818
- # @param Employees: 员工数据列表
2851
+ # @param Employees: 员工信息列表。
2819
2852
  # 注意:此字段可能返回 null,表示取不到有效值。
2820
2853
  # @type Employees: Array
2821
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
2854
+ # @param Offset: 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
2822
2855
  # 注意:此字段可能返回 null,表示取不到有效值。
2823
2856
  # @type Offset: Integer
2824
- # @param Limit: 指定每页多少条数据,单页最大20
2857
+ # @param Limit: 指定分页每页返回的数据条数,单页最大支持 20
2825
2858
  # @type Limit: Integer
2826
- # @param TotalCount: 符合条件的员工数量
2859
+ # @param TotalCount: 符合条件的员工数量。
2827
2860
  # @type TotalCount: Integer
2828
2861
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2829
2862
  # @type RequestId: String
@@ -2999,8 +3032,8 @@ module TencentCloud
2999
3032
 
3000
3033
  attr_accessor :Agent, :Limit, :Filters, :Offset, :Operator
3001
3034
  extend Gem::Deprecate
3002
- deprecate :Operator, :none, 2023, 10
3003
- deprecate :Operator=, :none, 2023, 10
3035
+ deprecate :Operator, :none, 2023, 11
3036
+ deprecate :Operator=, :none, 2023, 11
3004
3037
 
3005
3038
  def initialize(agent=nil, limit=nil, filters=nil, offset=nil, operator=nil)
3006
3039
  @Agent = agent
@@ -3074,14 +3107,17 @@ module TencentCloud
3074
3107
 
3075
3108
  # ChannelDescribeUserAutoSignStatus请求参数结构体
3076
3109
  class ChannelDescribeUserAutoSignStatusRequest < TencentCloud::Common::AbstractModel
3077
- # @param Agent: 渠道应用相关信息
3110
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3078
3111
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3079
- # @param SceneKey: 自动签场景:
3080
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
3112
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
3113
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
3114
+
3115
+ # 注: `现在仅支持电子处方场景`
3081
3116
  # @type SceneKey: String
3082
- # @param UserInfo: 查询开启状态的用户信息
3117
+ # @param UserInfo: 要查询状态的用户信息, 包括名字,身份证等
3083
3118
  # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
3084
- # @param Operator: 操作人信息
3119
+ # @param Operator: 执行本接口操作的员工信息。
3120
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3085
3121
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3086
3122
 
3087
3123
  attr_accessor :Agent, :SceneKey, :UserInfo, :Operator
@@ -3112,13 +3148,19 @@ module TencentCloud
3112
3148
 
3113
3149
  # ChannelDescribeUserAutoSignStatus返回参数结构体
3114
3150
  class ChannelDescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
3115
- # @param IsOpen: 是否开通
3151
+ # @param IsOpen: 查询用户是否已开通自动签
3116
3152
  # @type IsOpen: Boolean
3117
- # @param LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
3153
+ # @param LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
3154
+
3155
+ # 值为unix时间戳,单位为秒。
3118
3156
  # @type LicenseFrom: Integer
3119
- # @param LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
3157
+ # @param LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
3158
+
3159
+ # 值为unix时间戳,单位为秒。
3120
3160
  # @type LicenseTo: Integer
3121
- # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
3161
+ # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
3162
+
3163
+ # <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
3122
3164
  # @type LicenseType: Integer
3123
3165
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3124
3166
  # @type RequestId: String
@@ -3144,14 +3186,15 @@ module TencentCloud
3144
3186
 
3145
3187
  # ChannelDisableUserAutoSign请求参数结构体
3146
3188
  class ChannelDisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
3147
- # @param Agent: 渠道应用相关信息
3189
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3148
3190
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3149
- # @param SceneKey: 自动签场景:
3150
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
3191
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
3192
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
3151
3193
  # @type SceneKey: String
3152
- # @param UserInfo: 关闭自动签的个人的三要素
3194
+ # @param UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
3153
3195
  # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
3154
- # @param Operator: 操作人信息
3196
+ # @param Operator: 执行本接口操作的员工信息。
3197
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3155
3198
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
3156
3199
 
3157
3200
  attr_accessor :Agent, :SceneKey, :UserInfo, :Operator
@@ -3209,10 +3252,10 @@ module TencentCloud
3209
3252
 
3210
3253
  attr_accessor :Agent, :TaskId, :Operator, :Organization
3211
3254
  extend Gem::Deprecate
3212
- deprecate :Operator, :none, 2023, 10
3213
- deprecate :Operator=, :none, 2023, 10
3214
- deprecate :Organization, :none, 2023, 10
3215
- deprecate :Organization=, :none, 2023, 10
3255
+ deprecate :Operator, :none, 2023, 11
3256
+ deprecate :Operator=, :none, 2023, 11
3257
+ deprecate :Organization, :none, 2023, 11
3258
+ deprecate :Organization=, :none, 2023, 11
3216
3259
 
3217
3260
  def initialize(agent=nil, taskid=nil, operator=nil, organization=nil)
3218
3261
  @Agent = agent
@@ -3269,8 +3312,8 @@ module TencentCloud
3269
3312
 
3270
3313
  attr_accessor :TaskId, :TaskStatus, :TaskMessage, :ResourceId, :PreviewUrl, :RequestId
3271
3314
  extend Gem::Deprecate
3272
- deprecate :PreviewUrl, :none, 2023, 10
3273
- deprecate :PreviewUrl=, :none, 2023, 10
3315
+ deprecate :PreviewUrl, :none, 2023, 11
3316
+ deprecate :PreviewUrl=, :none, 2023, 11
3274
3317
 
3275
3318
  def initialize(taskid=nil, taskstatus=nil, taskmessage=nil, resourceid=nil, previewurl=nil, requestid=nil)
3276
3319
  @TaskId = taskid
@@ -3407,8 +3450,8 @@ module TencentCloud
3407
3450
 
3408
3451
  attr_accessor :Agent, :Status, :SealId, :Reason, :Operator
3409
3452
  extend Gem::Deprecate
3410
- deprecate :Operator, :none, 2023, 10
3411
- deprecate :Operator=, :none, 2023, 10
3453
+ deprecate :Operator, :none, 2023, 11
3454
+ deprecate :Operator=, :none, 2023, 11
3412
3455
 
3413
3456
  def initialize(agent=nil, status=nil, sealid=nil, reason=nil, operator=nil)
3414
3457
  @Agent = agent
@@ -3462,8 +3505,8 @@ module TencentCloud
3462
3505
 
3463
3506
  attr_accessor :FlowId, :Agent, :Operator
3464
3507
  extend Gem::Deprecate
3465
- deprecate :Operator, :none, 2023, 10
3466
- deprecate :Operator=, :none, 2023, 10
3508
+ deprecate :Operator, :none, 2023, 11
3509
+ deprecate :Operator=, :none, 2023, 11
3467
3510
 
3468
3511
  def initialize(flowid=nil, agent=nil, operator=nil)
3469
3512
  @FlowId = flowid
@@ -3987,8 +4030,8 @@ module TencentCloud
3987
4030
 
3988
4031
  attr_accessor :Agent, :FlowId, :Operator
3989
4032
  extend Gem::Deprecate
3990
- deprecate :Operator, :none, 2023, 10
3991
- deprecate :Operator=, :none, 2023, 10
4033
+ deprecate :Operator, :none, 2023, 11
4034
+ deprecate :Operator=, :none, 2023, 11
3992
4035
 
3993
4036
  def initialize(agent=nil, flowid=nil, operator=nil)
3994
4037
  @Agent = agent
@@ -4139,7 +4182,7 @@ module TencentCloud
4139
4182
  # @param ModuleId: 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
4140
4183
 
4141
4184
  # 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到)。当前支持:
4142
- # <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模版的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
4185
+ # <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模板的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
4143
4186
  # 注意:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
4144
4187
  # @type ModuleId: String
4145
4188
  # @param MenuStatus: 是否展示左侧菜单栏
@@ -4171,8 +4214,8 @@ module TencentCloud
4171
4214
 
4172
4215
  attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
4173
4216
  extend Gem::Deprecate
4174
- deprecate :Operator, :none, 2023, 10
4175
- deprecate :Operator=, :none, 2023, 10
4217
+ deprecate :Operator, :none, 2023, 11
4218
+ deprecate :Operator=, :none, 2023, 11
4176
4219
 
4177
4220
  def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, _module=nil, moduleid=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, operator=nil)
4178
4221
  @Agent = agent
@@ -4315,8 +4358,8 @@ module TencentCloud
4315
4358
 
4316
4359
  attr_accessor :Agent, :FlowInfos, :NeedPreview, :PreviewType, :Operator
4317
4360
  extend Gem::Deprecate
4318
- deprecate :Operator, :none, 2023, 10
4319
- deprecate :Operator=, :none, 2023, 10
4361
+ deprecate :Operator, :none, 2023, 11
4362
+ deprecate :Operator=, :none, 2023, 11
4320
4363
 
4321
4364
  def initialize(agent=nil, flowinfos=nil, needpreview=nil, previewtype=nil, operator=nil)
4322
4365
  @Agent = agent
@@ -4460,8 +4503,8 @@ module TencentCloud
4460
4503
 
4461
4504
  attr_accessor :Agent, :SealName, :SealImage, :Operator, :GenerateSource, :SealType, :SealHorizontalText, :SealStyle, :SealSize
4462
4505
  extend Gem::Deprecate
4463
- deprecate :Operator, :none, 2023, 10
4464
- deprecate :Operator=, :none, 2023, 10
4506
+ deprecate :Operator, :none, 2023, 11
4507
+ deprecate :Operator=, :none, 2023, 11
4465
4508
 
4466
4509
  def initialize(agent=nil, sealname=nil, sealimage=nil, operator=nil, generatesource=nil, sealtype=nil, sealhorizontaltext=nil, sealstyle=nil, sealsize=nil)
4467
4510
  @Agent = agent
@@ -4532,7 +4575,7 @@ module TencentCloud
4532
4575
  # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4533
4576
  # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4534
4577
  # </ul>
4535
- # 第三方平台子客企业和员工必须已经经过实名认证
4578
+ # 第三方平台子客企业和员工必须已经过实名认证
4536
4579
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4537
4580
  # @param FlowIds: 合同流程ID数组,最多支持100个。
4538
4581
  # 注: `该参数和合同组编号必须二选一`
@@ -4543,7 +4586,7 @@ module TencentCloud
4543
4586
  # @param Endpoint: 签署链接类型,可以设置的参数如下
4544
4587
  # <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
4545
4588
  # <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
4546
- # <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
4589
+ # <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
4547
4590
  # <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
4548
4591
 
4549
4592
  # 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
@@ -4595,8 +4638,8 @@ module TencentCloud
4595
4638
 
4596
4639
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides, :RecipientIds
4597
4640
  extend Gem::Deprecate
4598
- deprecate :Operator, :none, 2023, 10
4599
- deprecate :Operator=, :none, 2023, 10
4641
+ deprecate :Operator, :none, 2023, 11
4642
+ deprecate :Operator=, :none, 2023, 11
4600
4643
 
4601
4644
  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, recipientids=nil)
4602
4645
  @Agent = agent
@@ -4705,8 +4748,8 @@ module TencentCloud
4705
4748
 
4706
4749
  attr_accessor :Agent, :ReportId, :Operator
4707
4750
  extend Gem::Deprecate
4708
- deprecate :Operator, :none, 2023, 10
4709
- deprecate :Operator=, :none, 2023, 10
4751
+ deprecate :Operator, :none, 2023, 11
4752
+ deprecate :Operator=, :none, 2023, 11
4710
4753
 
4711
4754
  def initialize(agent=nil, reportid=nil, operator=nil)
4712
4755
  @Agent = agent
@@ -4825,8 +4868,8 @@ module TencentCloud
4825
4868
 
4826
4869
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Operator
4827
4870
  extend Gem::Deprecate
4828
- deprecate :Operator, :none, 2023, 10
4829
- deprecate :Operator=, :none, 2023, 10
4871
+ deprecate :Operator, :none, 2023, 11
4872
+ deprecate :Operator=, :none, 2023, 11
4830
4873
 
4831
4874
  def initialize(agent=nil, flowids=nil, flowgroupid=nil, operator=nil)
4832
4875
  @Agent = agent
@@ -4914,8 +4957,8 @@ module TencentCloud
4914
4957
 
4915
4958
  attr_accessor :Agent, :FlowIds, :Operator
4916
4959
  extend Gem::Deprecate
4917
- deprecate :Operator, :none, 2023, 10
4918
- deprecate :Operator=, :none, 2023, 10
4960
+ deprecate :Operator, :none, 2023, 11
4961
+ deprecate :Operator=, :none, 2023, 11
4919
4962
 
4920
4963
  def initialize(agent=nil, flowids=nil, operator=nil)
4921
4964
  @Agent = agent
@@ -5005,8 +5048,8 @@ module TencentCloud
5005
5048
 
5006
5049
  attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :WithPreviewUrl, :WithPdfUrl, :ChannelTemplateId, :Operator
5007
5050
  extend Gem::Deprecate
5008
- deprecate :Operator, :none, 2023, 10
5009
- deprecate :Operator=, :none, 2023, 10
5051
+ deprecate :Operator, :none, 2023, 11
5052
+ deprecate :Operator=, :none, 2023, 11
5010
5053
 
5011
5054
  def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, withpreviewurl=nil, withpdfurl=nil, channeltemplateid=nil, operator=nil)
5012
5055
  @Agent = agent
@@ -5104,8 +5147,8 @@ module TencentCloud
5104
5147
 
5105
5148
  attr_accessor :Agent, :StartDate, :EndDate, :NeedAggregate, :Limit, :Offset, :Operator
5106
5149
  extend Gem::Deprecate
5107
- deprecate :Operator, :none, 2023, 10
5108
- deprecate :Operator=, :none, 2023, 10
5150
+ deprecate :Operator, :none, 2023, 11
5151
+ deprecate :Operator=, :none, 2023, 11
5109
5152
 
5110
5153
  def initialize(agent=nil, startdate=nil, enddate=nil, needaggregate=nil, limit=nil, offset=nil, operator=nil)
5111
5154
  @Agent = agent
@@ -5594,7 +5637,13 @@ module TencentCloud
5594
5637
  # (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
5595
5638
  # @type ApproverVerifyTypes: Array
5596
5639
  # @param ApproverSignTypes: 签署人签署合同时的认证方式
5597
- # 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
5640
+ # <ul><li> **1** :人脸认证</li>
5641
+ # <li> **2** :签署密码</li>
5642
+ # <li> **3** :运营商三要素</li></ul>
5643
+
5644
+ # 默认为1(人脸认证 ),2(签署密码)
5645
+
5646
+ # 注: `用模版创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在此创建合同指定无效`
5598
5647
  # @type ApproverSignTypes: Array
5599
5648
  # @param SignId: 签署ID
5600
5649
  # - 发起流程时系统自动补充
@@ -5615,8 +5664,8 @@ module TencentCloud
5615
5664
 
5616
5665
  attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType, :AddSignComponentsLimits, :ApproverRoleName
5617
5666
  extend Gem::Deprecate
5618
- deprecate :CallbackUrl, :none, 2023, 10
5619
- deprecate :CallbackUrl=, :none, 2023, 10
5667
+ deprecate :CallbackUrl, :none, 2023, 11
5668
+ deprecate :CallbackUrl=, :none, 2023, 11
5620
5669
 
5621
5670
  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, addsigncomponentslimits=nil, approverrolename=nil)
5622
5671
  @Name = name
@@ -6405,8 +6454,8 @@ module TencentCloud
6405
6454
 
6406
6455
  attr_accessor :Agent, :DownLoadFlows, :Operator
6407
6456
  extend Gem::Deprecate
6408
- deprecate :Operator, :none, 2023, 10
6409
- deprecate :Operator=, :none, 2023, 10
6457
+ deprecate :Operator, :none, 2023, 11
6458
+ deprecate :Operator=, :none, 2023, 11
6410
6459
 
6411
6460
  def initialize(agent=nil, downloadflows=nil, operator=nil)
6412
6461
  @Agent = agent
@@ -6637,8 +6686,8 @@ module TencentCloud
6637
6686
 
6638
6687
  attr_accessor :Agent, :OperateType, :TemplateId, :ProxyOrganizationOpenIds, :AuthTag, :Available, :Operator
6639
6688
  extend Gem::Deprecate
6640
- deprecate :Operator, :none, 2023, 10
6641
- deprecate :Operator=, :none, 2023, 10
6689
+ deprecate :Operator, :none, 2023, 11
6690
+ deprecate :Operator=, :none, 2023, 11
6642
6691
 
6643
6692
  def initialize(agent=nil, operatetype=nil, templateid=nil, proxyorganizationopenids=nil, authtag=nil, available=nil, operator=nil)
6644
6693
  @Agent = agent
@@ -6746,10 +6795,10 @@ module TencentCloud
6746
6795
 
6747
6796
  attr_accessor :OrganizationOpenId, :OrganizationId, :Channel, :ClientIp, :ProxyIp
6748
6797
  extend Gem::Deprecate
6749
- deprecate :ClientIp, :none, 2023, 10
6750
- deprecate :ClientIp=, :none, 2023, 10
6751
- deprecate :ProxyIp, :none, 2023, 10
6752
- deprecate :ProxyIp=, :none, 2023, 10
6798
+ deprecate :ClientIp, :none, 2023, 11
6799
+ deprecate :ClientIp=, :none, 2023, 11
6800
+ deprecate :ProxyIp, :none, 2023, 11
6801
+ deprecate :ProxyIp=, :none, 2023, 11
6753
6802
 
6754
6803
  def initialize(organizationopenid=nil, organizationid=nil, channel=nil, clientip=nil, proxyip=nil)
6755
6804
  @OrganizationOpenId = organizationopenid
@@ -6962,8 +7011,8 @@ module TencentCloud
6962
7011
 
6963
7012
  attr_accessor :Agent, :FlowInfos, :JumpUrl, :Operator
6964
7013
  extend Gem::Deprecate
6965
- deprecate :Operator, :none, 2023, 10
6966
- deprecate :Operator=, :none, 2023, 10
7014
+ deprecate :Operator, :none, 2023, 11
7015
+ deprecate :Operator=, :none, 2023, 11
6967
7016
 
6968
7017
  def initialize(agent=nil, flowinfos=nil, jumpurl=nil, operator=nil)
6969
7018
  @Agent = agent
@@ -7404,8 +7453,8 @@ module TencentCloud
7404
7453
 
7405
7454
  attr_accessor :SignUrl, :Deadline, :SignOrder, :SignId, :CustomUserId, :Name, :Mobile, :OrganizationName, :ApproverType, :IdCardNumber, :FlowId, :OpenId, :FlowGroupId, :SignQrcodeUrl
7406
7455
  extend Gem::Deprecate
7407
- deprecate :CustomUserId, :none, 2023, 10
7408
- deprecate :CustomUserId=, :none, 2023, 10
7456
+ deprecate :CustomUserId, :none, 2023, 11
7457
+ deprecate :CustomUserId=, :none, 2023, 11
7409
7458
 
7410
7459
  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, signqrcodeurl=nil)
7411
7460
  @SignUrl = signurl
@@ -7569,8 +7618,8 @@ module TencentCloud
7569
7618
 
7570
7619
  attr_accessor :Agent, :OperatorType, :ProxyOrganizationOperators, :Operator
7571
7620
  extend Gem::Deprecate
7572
- deprecate :Operator, :none, 2023, 10
7573
- deprecate :Operator=, :none, 2023, 10
7621
+ deprecate :Operator, :none, 2023, 11
7622
+ deprecate :Operator=, :none, 2023, 11
7574
7623
 
7575
7624
  def initialize(agent=nil, operatortype=nil, proxyorganizationoperators=nil, operator=nil)
7576
7625
  @Agent = agent
@@ -7657,8 +7706,8 @@ module TencentCloud
7657
7706
 
7658
7707
  attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator, :ProxyLegalIdCardType, :ProxyLegalIdCardNumber
7659
7708
  extend Gem::Deprecate
7660
- deprecate :Operator, :none, 2023, 10
7661
- deprecate :Operator=, :none, 2023, 10
7709
+ deprecate :Operator, :none, 2023, 11
7710
+ deprecate :Operator=, :none, 2023, 11
7662
7711
 
7663
7712
  def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil, proxylegalidcardtype=nil, proxylegalidcardnumber=nil)
7664
7713
  @Agent = agent
@@ -7788,8 +7837,8 @@ module TencentCloud
7788
7837
 
7789
7838
  attr_accessor :TemplateId, :TemplateName, :Description, :Components, :Recipients, :SignComponents, :TemplateType, :IsPromoter, :Creator, :CreatedOn, :PreviewUrl, :PdfUrl, :ChannelTemplateId, :ChannelTemplateName, :ChannelAutoSave, :TemplateVersion, :Available
7790
7839
  extend Gem::Deprecate
7791
- deprecate :IsPromoter, :none, 2023, 10
7792
- deprecate :IsPromoter=, :none, 2023, 10
7840
+ deprecate :IsPromoter, :none, 2023, 11
7841
+ deprecate :IsPromoter=, :none, 2023, 11
7793
7842
 
7794
7843
  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)
7795
7844
  @TemplateId = templateid
@@ -7896,8 +7945,8 @@ module TencentCloud
7896
7945
 
7897
7946
  attr_accessor :Agent, :BusinessType, :FileInfos, :Operator
7898
7947
  extend Gem::Deprecate
7899
- deprecate :Operator, :none, 2023, 10
7900
- deprecate :Operator=, :none, 2023, 10
7948
+ deprecate :Operator, :none, 2023, 11
7949
+ deprecate :Operator=, :none, 2023, 11
7901
7950
 
7902
7951
  def initialize(agent=nil, businesstype=nil, fileinfos=nil, operator=nil)
7903
7952
  @Agent = agent
@@ -8013,14 +8062,14 @@ module TencentCloud
8013
8062
 
8014
8063
  attr_accessor :OpenId, :Channel, :CustomUserId, :ClientIp, :ProxyIp
8015
8064
  extend Gem::Deprecate
8016
- deprecate :Channel, :none, 2023, 10
8017
- deprecate :Channel=, :none, 2023, 10
8018
- deprecate :CustomUserId, :none, 2023, 10
8019
- deprecate :CustomUserId=, :none, 2023, 10
8020
- deprecate :ClientIp, :none, 2023, 10
8021
- deprecate :ClientIp=, :none, 2023, 10
8022
- deprecate :ProxyIp, :none, 2023, 10
8023
- deprecate :ProxyIp=, :none, 2023, 10
8065
+ deprecate :Channel, :none, 2023, 11
8066
+ deprecate :Channel=, :none, 2023, 11
8067
+ deprecate :CustomUserId, :none, 2023, 11
8068
+ deprecate :CustomUserId=, :none, 2023, 11
8069
+ deprecate :ClientIp, :none, 2023, 11
8070
+ deprecate :ClientIp=, :none, 2023, 11
8071
+ deprecate :ProxyIp, :none, 2023, 11
8072
+ deprecate :ProxyIp=, :none, 2023, 11
8024
8073
 
8025
8074
  def initialize(openid=nil, channel=nil, customuserid=nil, clientip=nil, proxyip=nil)
8026
8075
  @OpenId = openid
@@ -8041,14 +8090,18 @@ module TencentCloud
8041
8090
 
8042
8091
  # 用户的三要素:姓名,证件号,证件类型
8043
8092
  class UserThreeFactor < TencentCloud::Common::AbstractModel
8044
- # @param Name: 姓名
8093
+ # @param Name: 签署方经办人的姓名。
8094
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
8045
8095
  # @type Name: String
8046
- # @param IdCardType: 证件类型:
8047
- # ID_CARD 身份证
8048
- # HONGKONG_AND_MACAO 港澳居民来往内地通行证
8049
- # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
8096
+ # @param IdCardType: 证件类型,支持以下类型
8097
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
8098
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
8099
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
8050
8100
  # @type IdCardType: String
8051
- # @param IdCardNumber: 证件号,如果有 X 请大写
8101
+ # @param IdCardNumber: 证件号码,应符合以下规则
8102
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
8103
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
8104
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
8052
8105
  # @type IdCardNumber: String
8053
8106
 
8054
8107
  attr_accessor :Name, :IdCardType, :IdCardNumber
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.687
4
+ version: 3.0.689
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-10-30 00:00:00.000000000 Z
11
+ date: 2023-10-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common