tencentcloud-sdk-essbasic 3.0.430 → 3.0.432
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20210526/client.rb +33 -11
- data/lib/v20210526/models.rb +74 -37
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1ca0e11e61192474626cf3267e145ba09b8b1dce
|
4
|
+
data.tar.gz: 5b6f31cf2dde9b502a90c119f21941fd3f069f38
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: deb155cfe334528315644a8824a6c688f90f03b7a0d8f89d80dcb62952e1fb5fb0adc026ae06ff9ad84f1c45bb9eb497539ab9e99581764d1ffcf4e4f4707b6a
|
7
|
+
data.tar.gz: ec2cd6b10363127210c16339e21ca85f0ffb82a542bb6081cf50ac38a6c45d3c1824ce35903bf3ac5755cce4ea8f7a50e3bf91fb1627394827d5310ef42a2808
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.432
|
data/lib/v20210526/client.rb
CHANGED
@@ -232,7 +232,7 @@ module TencentCloud
|
|
232
232
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
233
233
|
end
|
234
234
|
|
235
|
-
#
|
235
|
+
# 查询企业员工列表
|
236
236
|
|
237
237
|
# @param request: Request instance for ChannelDescribeEmployees.
|
238
238
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeEmployeesRequest`
|
@@ -308,6 +308,7 @@ module TencentCloud
|
|
308
308
|
# 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
309
309
|
# 若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
310
310
|
# 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
311
|
+
# 返回的Url仅支持PC端操作。
|
311
312
|
|
312
313
|
# @param request: Request instance for CreateConsoleLoginUrl.
|
313
314
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlRequest`
|
@@ -332,6 +333,7 @@ module TencentCloud
|
|
332
333
|
end
|
333
334
|
|
334
335
|
# 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
|
336
|
+
# 合同发起人必须在电子签已经进行实名。
|
335
337
|
|
336
338
|
# @param request: Request instance for CreateFlowsByTemplates.
|
337
339
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateFlowsByTemplatesRequest`
|
@@ -355,7 +357,7 @@ module TencentCloud
|
|
355
357
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
356
358
|
end
|
357
359
|
|
358
|
-
# 渠道通过图片为子客代创建印章,图片最大5m
|
360
|
+
# 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
|
359
361
|
|
360
362
|
# @param request: Request instance for CreateSealByImage.
|
361
363
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSealByImageRequest`
|
@@ -379,7 +381,23 @@ module TencentCloud
|
|
379
381
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
380
382
|
end
|
381
383
|
|
382
|
-
#
|
384
|
+
# 创建跳转小程序查看或签署的链接。
|
385
|
+
|
386
|
+
# 跳转小程序的几种方式:主要是设置不同的EndPoint
|
387
|
+
# 1. 通过链接Url直接跳转到小程序,不需要返回
|
388
|
+
# 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
|
389
|
+
# 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
|
390
|
+
# 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
|
391
|
+
# 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
|
392
|
+
# 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
|
393
|
+
# 全屏方式:
|
394
|
+
# (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
395
|
+
# 半屏方式:
|
396
|
+
# (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
397
|
+
# 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
398
|
+
# 使用CreateSignUrls,设置EndPoint为APP,得到path。
|
399
|
+
# 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
|
400
|
+
# 实现方式同App跳小程序。
|
383
401
|
|
384
402
|
# @param request: Request instance for CreateSignUrls.
|
385
403
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSignUrlsRequest`
|
@@ -427,7 +445,8 @@ module TencentCloud
|
|
427
445
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
428
446
|
end
|
429
447
|
|
430
|
-
#
|
448
|
+
# 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
|
449
|
+
# 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
|
431
450
|
|
432
451
|
# @param request: Request instance for DescribeResourceUrlsByFlows.
|
433
452
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeResourceUrlsByFlowsRequest`
|
@@ -451,7 +470,7 @@ module TencentCloud
|
|
451
470
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
452
471
|
end
|
453
472
|
|
454
|
-
# 通过此接口(DescribeTemplates
|
473
|
+
# 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的的有效模板,不包括渠道模版
|
455
474
|
|
456
475
|
# @param request: Request instance for DescribeTemplates.
|
457
476
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesRequest`
|
@@ -525,11 +544,11 @@ module TencentCloud
|
|
525
544
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
526
545
|
end
|
527
546
|
|
528
|
-
# 此接口(OperateChannelTemplate
|
529
|
-
# 1
|
530
|
-
#
|
531
|
-
# 2
|
532
|
-
#
|
547
|
+
# 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。
|
548
|
+
# 1、OperateType=select时:
|
549
|
+
# 查询渠道模板库
|
550
|
+
# 2、OperateType=update或者delete时:
|
551
|
+
# 对子客企业进行模板库中模板可见性的修改、删除操作。
|
533
552
|
|
534
553
|
# @param request: Request instance for OperateChannelTemplate.
|
535
554
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::OperateChannelTemplateRequest`
|
@@ -629,7 +648,10 @@ module TencentCloud
|
|
629
648
|
end
|
630
649
|
|
631
650
|
# 此接口(UploadFiles)用于文件上传。
|
632
|
-
# 调用时需要设置Domain
|
651
|
+
# 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。
|
652
|
+
# 代码示例:
|
653
|
+
# HttpProfile httpProfile = new HttpProfile();
|
654
|
+
# httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
633
655
|
|
634
656
|
# @param request: Request instance for UploadFiles.
|
635
657
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::UploadFilesRequest`
|
data/lib/v20210526/models.rb
CHANGED
@@ -576,27 +576,30 @@ module TencentCloud
|
|
576
576
|
# @type FlowEffectiveDay: Integer
|
577
577
|
# @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
|
578
578
|
# @type QrEffectiveDay: Integer
|
579
|
+
# @param Restrictions: 限制二维码用户条件
|
580
|
+
# @type Restrictions: Array
|
579
581
|
# @param CallbackUrl: 回调地址,最大长度1000个字符
|
580
582
|
# 不传默认使用渠道应用号配置的回调地址
|
581
583
|
# 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
582
584
|
# @type CallbackUrl: String
|
583
|
-
# @param ApproverRestrictions: 限制二维码用户条件
|
584
|
-
# @type ApproverRestrictions: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverRestriction`
|
585
585
|
# @param Operator: 用户信息
|
586
586
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
587
|
+
# @param ApproverRestrictions: 限制二维码用户条件(已弃用)
|
588
|
+
# @type ApproverRestrictions: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverRestriction`
|
587
589
|
|
588
|
-
attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :CallbackUrl, :
|
590
|
+
attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :CallbackUrl, :Operator, :ApproverRestrictions
|
589
591
|
|
590
|
-
def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil,
|
592
|
+
def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, callbackurl=nil, operator=nil, approverrestrictions=nil)
|
591
593
|
@Agent = agent
|
592
594
|
@TemplateId = templateid
|
593
595
|
@FlowName = flowname
|
594
596
|
@MaxFlowNum = maxflownum
|
595
597
|
@FlowEffectiveDay = floweffectiveday
|
596
598
|
@QrEffectiveDay = qreffectiveday
|
599
|
+
@Restrictions = restrictions
|
597
600
|
@CallbackUrl = callbackurl
|
598
|
-
@ApproverRestrictions = approverrestrictions
|
599
601
|
@Operator = operator
|
602
|
+
@ApproverRestrictions = approverrestrictions
|
600
603
|
end
|
601
604
|
|
602
605
|
def deserialize(params)
|
@@ -609,15 +612,23 @@ module TencentCloud
|
|
609
612
|
@MaxFlowNum = params['MaxFlowNum']
|
610
613
|
@FlowEffectiveDay = params['FlowEffectiveDay']
|
611
614
|
@QrEffectiveDay = params['QrEffectiveDay']
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
615
|
+
unless params['Restrictions'].nil?
|
616
|
+
@Restrictions = []
|
617
|
+
params['Restrictions'].each do |i|
|
618
|
+
approverrestriction_tmp = ApproverRestriction.new
|
619
|
+
approverrestriction_tmp.deserialize(i)
|
620
|
+
@Restrictions << approverrestriction_tmp
|
621
|
+
end
|
616
622
|
end
|
623
|
+
@CallbackUrl = params['CallbackUrl']
|
617
624
|
unless params['Operator'].nil?
|
618
625
|
@Operator = UserInfo.new
|
619
626
|
@Operator.deserialize(params['Operator'])
|
620
627
|
end
|
628
|
+
unless params['ApproverRestrictions'].nil?
|
629
|
+
@ApproverRestrictions = ApproverRestriction.new
|
630
|
+
@ApproverRestrictions.deserialize(params['ApproverRestrictions'])
|
631
|
+
end
|
621
632
|
end
|
622
633
|
end
|
623
634
|
|
@@ -657,21 +668,21 @@ module TencentCloud
|
|
657
668
|
# @type Limit: Integer
|
658
669
|
# @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
659
670
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
660
|
-
# @param Operator: 操作者的信息
|
661
|
-
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
662
671
|
# @param Filters: 查询过滤实名用户,key为Status,Values为["IsVerified"]
|
663
672
|
# @type Filters: Array
|
664
673
|
# @param Offset: 偏移量,默认为0,最大为20000
|
665
674
|
# @type Offset: Integer
|
675
|
+
# @param Operator: 操作者的信息
|
676
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
666
677
|
|
667
|
-
attr_accessor :Limit, :Agent, :
|
678
|
+
attr_accessor :Limit, :Agent, :Filters, :Offset, :Operator
|
668
679
|
|
669
|
-
def initialize(limit=nil, agent=nil,
|
680
|
+
def initialize(limit=nil, agent=nil, filters=nil, offset=nil, operator=nil)
|
670
681
|
@Limit = limit
|
671
682
|
@Agent = agent
|
672
|
-
@Operator = operator
|
673
683
|
@Filters = filters
|
674
684
|
@Offset = offset
|
685
|
+
@Operator = operator
|
675
686
|
end
|
676
687
|
|
677
688
|
def deserialize(params)
|
@@ -680,10 +691,6 @@ module TencentCloud
|
|
680
691
|
@Agent = Agent.new
|
681
692
|
@Agent.deserialize(params['Agent'])
|
682
693
|
end
|
683
|
-
unless params['Operator'].nil?
|
684
|
-
@Operator = UserInfo.new
|
685
|
-
@Operator.deserialize(params['Operator'])
|
686
|
-
end
|
687
694
|
unless params['Filters'].nil?
|
688
695
|
@Filters = []
|
689
696
|
params['Filters'].each do |i|
|
@@ -693,6 +700,10 @@ module TencentCloud
|
|
693
700
|
end
|
694
701
|
end
|
695
702
|
@Offset = params['Offset']
|
703
|
+
unless params['Operator'].nil?
|
704
|
+
@Operator = UserInfo.new
|
705
|
+
@Operator.deserialize(params['Operator'])
|
706
|
+
end
|
696
707
|
end
|
697
708
|
end
|
698
709
|
|
@@ -886,6 +897,13 @@ module TencentCloud
|
|
886
897
|
end
|
887
898
|
|
888
899
|
# 此结构体 (Component) 用于描述控件属性。
|
900
|
+
|
901
|
+
# 在通过文件发起合同时,对应的component有三种定位方式
|
902
|
+
# 1. 绝对定位方式
|
903
|
+
# 2. 表单域(FIELD)定位方式
|
904
|
+
# 3. 关键字(KEYWORD)定位方式
|
905
|
+
# 可以参考官网说明
|
906
|
+
# https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
|
889
907
|
class Component < TencentCloud::Common::AbstractModel
|
890
908
|
# @param ComponentId: 控件编号
|
891
909
|
|
@@ -919,6 +937,8 @@ module TencentCloud
|
|
919
937
|
# @type ComponentName: String
|
920
938
|
# @param ComponentRequired: 定义控件是否为必填项,默认为false
|
921
939
|
# @type ComponentRequired: Boolean
|
940
|
+
# @param ComponentRecipientId: 控件关联的签署方id
|
941
|
+
# @type ComponentRecipientId: String
|
922
942
|
# @param FileIndex: 控件所属文件的序号 (文档中文件的排列序号,从0开始)
|
923
943
|
# @type FileIndex: Integer
|
924
944
|
# @param GenerateMode: 控件生成的方式:
|
@@ -940,7 +960,10 @@ module TencentCloud
|
|
940
960
|
# @type ComponentPosY: Float
|
941
961
|
# @param ComponentExtra: 参数控件样式,json格式表述
|
942
962
|
# 不同类型的控件会有部分非通用参数
|
943
|
-
# TEXT
|
963
|
+
# TEXT/MULTI_LINE_TEXT控件可以指定
|
964
|
+
# 1 Font:目前只支持黑体、宋体
|
965
|
+
# 2 FontSize: 范围12-72
|
966
|
+
# 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
|
944
967
|
# 例如:{"FontSize":12}
|
945
968
|
# @type ComponentExtra: String
|
946
969
|
# @param ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
|
@@ -964,13 +987,14 @@ module TencentCloud
|
|
964
987
|
# @param OffsetY: 指定关键字时纵坐标偏移量,单位pt
|
965
988
|
# @type OffsetY: Float
|
966
989
|
|
967
|
-
attr_accessor :ComponentId, :ComponentType, :ComponentName, :ComponentRequired, :FileIndex, :GenerateMode, :ComponentWidth, :ComponentHeight, :ComponentPage, :ComponentPosX, :ComponentPosY, :ComponentExtra, :ComponentValue, :ComponentDateFontSize, :DocumentId, :ComponentDescription, :OffsetX, :OffsetY
|
990
|
+
attr_accessor :ComponentId, :ComponentType, :ComponentName, :ComponentRequired, :ComponentRecipientId, :FileIndex, :GenerateMode, :ComponentWidth, :ComponentHeight, :ComponentPage, :ComponentPosX, :ComponentPosY, :ComponentExtra, :ComponentValue, :ComponentDateFontSize, :DocumentId, :ComponentDescription, :OffsetX, :OffsetY
|
968
991
|
|
969
|
-
def initialize(componentid=nil, componenttype=nil, componentname=nil, componentrequired=nil, fileindex=nil, generatemode=nil, componentwidth=nil, componentheight=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentextra=nil, componentvalue=nil, componentdatefontsize=nil, documentid=nil, componentdescription=nil, offsetx=nil, offsety=nil)
|
992
|
+
def initialize(componentid=nil, componenttype=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, fileindex=nil, generatemode=nil, componentwidth=nil, componentheight=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentextra=nil, componentvalue=nil, componentdatefontsize=nil, documentid=nil, componentdescription=nil, offsetx=nil, offsety=nil)
|
970
993
|
@ComponentId = componentid
|
971
994
|
@ComponentType = componenttype
|
972
995
|
@ComponentName = componentname
|
973
996
|
@ComponentRequired = componentrequired
|
997
|
+
@ComponentRecipientId = componentrecipientid
|
974
998
|
@FileIndex = fileindex
|
975
999
|
@GenerateMode = generatemode
|
976
1000
|
@ComponentWidth = componentwidth
|
@@ -992,6 +1016,7 @@ module TencentCloud
|
|
992
1016
|
@ComponentType = params['ComponentType']
|
993
1017
|
@ComponentName = params['ComponentName']
|
994
1018
|
@ComponentRequired = params['ComponentRequired']
|
1019
|
+
@ComponentRecipientId = params['ComponentRecipientId']
|
995
1020
|
@FileIndex = params['FileIndex']
|
996
1021
|
@GenerateMode = params['GenerateMode']
|
997
1022
|
@ComponentWidth = params['ComponentWidth']
|
@@ -1062,9 +1087,11 @@ module TencentCloud
|
|
1062
1087
|
|
1063
1088
|
# CreateConsoleLoginUrl返回参数结构体
|
1064
1089
|
class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
|
1065
|
-
# @param ConsoleUrl: 子客Web控制台url,此链接5
|
1090
|
+
# @param ConsoleUrl: 子客Web控制台url,此链接5分钟内有效,且只能访问一次。同时需要注意:
|
1091
|
+
# 1. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接);
|
1092
|
+
# 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
|
1066
1093
|
# @type ConsoleUrl: String
|
1067
|
-
# @param IsActivated:
|
1094
|
+
# @param IsActivated: 渠道子客企业是否已开通腾讯电子签
|
1068
1095
|
# @type IsActivated: Boolean
|
1069
1096
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1070
1097
|
# @type RequestId: String
|
@@ -1090,7 +1117,7 @@ module TencentCloud
|
|
1090
1117
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
1091
1118
|
# @param FlowInfos: 多个合同(签署流程)信息,最多支持20个
|
1092
1119
|
# @type FlowInfos: Array
|
1093
|
-
# @param NeedPreview: 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds
|
1120
|
+
# @param NeedPreview: 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls(此Url返回的是PDF文件流 );
|
1094
1121
|
# 预览链接有效期300秒;
|
1095
1122
|
# @type NeedPreview: Boolean
|
1096
1123
|
# @param Operator: 操作者的信息
|
@@ -1235,7 +1262,7 @@ module TencentCloud
|
|
1235
1262
|
# @param Endpoint: 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
|
1236
1263
|
# @type Endpoint: String
|
1237
1264
|
# @param GenerateType: 签署链接生成类型,默认是 "ALL";
|
1238
|
-
# "ALL"
|
1265
|
+
# "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
1239
1266
|
# "CHANNEL":渠道合作企业;
|
1240
1267
|
# "NOT_CHANNEL":非渠道合作企业;
|
1241
1268
|
# "PERSON":个人;
|
@@ -1439,7 +1466,7 @@ module TencentCloud
|
|
1439
1466
|
# @param Agent: 渠道应用相关信息。
|
1440
1467
|
# 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
1441
1468
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
1442
|
-
# @param FlowIds: 查询资源所对应的签署流程Id,最多支持50
|
1469
|
+
# @param FlowIds: 查询资源所对应的签署流程Id,最多支持50个
|
1443
1470
|
# @type FlowIds: Array
|
1444
1471
|
# @param Operator: 操作者的信息
|
1445
1472
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
@@ -1501,7 +1528,7 @@ module TencentCloud
|
|
1501
1528
|
class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
|
1502
1529
|
# @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
1503
1530
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
1504
|
-
# @param TemplateId:
|
1531
|
+
# @param TemplateId: 模板唯一标识,查询单个模版时使用
|
1505
1532
|
# @type TemplateId: String
|
1506
1533
|
# @param ContentType: 查询内容:0-模板列表及详情(默认),1-仅模板列表
|
1507
1534
|
# @type ContentType: Integer
|
@@ -1509,24 +1536,24 @@ module TencentCloud
|
|
1509
1536
|
# @type Limit: Integer
|
1510
1537
|
# @param Offset: 查询偏移位置,默认0;在查询列表的时候有效
|
1511
1538
|
# @type Offset: Integer
|
1512
|
-
# @param Operator: 操作者的信息
|
1513
|
-
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
1514
1539
|
# @param QueryAllComponents: 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
|
1515
1540
|
# @type QueryAllComponents: Boolean
|
1516
1541
|
# @param TemplateName: 模糊搜索模板名称,最大长度200
|
1517
1542
|
# @type TemplateName: String
|
1543
|
+
# @param Operator: 操作者的信息
|
1544
|
+
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
1518
1545
|
|
1519
|
-
attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :
|
1546
|
+
attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :QueryAllComponents, :TemplateName, :Operator
|
1520
1547
|
|
1521
|
-
def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil,
|
1548
|
+
def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil, queryallcomponents=nil, templatename=nil, operator=nil)
|
1522
1549
|
@Agent = agent
|
1523
1550
|
@TemplateId = templateid
|
1524
1551
|
@ContentType = contenttype
|
1525
1552
|
@Limit = limit
|
1526
1553
|
@Offset = offset
|
1527
|
-
@Operator = operator
|
1528
1554
|
@QueryAllComponents = queryallcomponents
|
1529
1555
|
@TemplateName = templatename
|
1556
|
+
@Operator = operator
|
1530
1557
|
end
|
1531
1558
|
|
1532
1559
|
def deserialize(params)
|
@@ -1538,12 +1565,12 @@ module TencentCloud
|
|
1538
1565
|
@ContentType = params['ContentType']
|
1539
1566
|
@Limit = params['Limit']
|
1540
1567
|
@Offset = params['Offset']
|
1568
|
+
@QueryAllComponents = params['QueryAllComponents']
|
1569
|
+
@TemplateName = params['TemplateName']
|
1541
1570
|
unless params['Operator'].nil?
|
1542
1571
|
@Operator = UserInfo.new
|
1543
1572
|
@Operator.deserialize(params['Operator'])
|
1544
1573
|
end
|
1545
|
-
@QueryAllComponents = params['QueryAllComponents']
|
1546
|
-
@TemplateName = params['TemplateName']
|
1547
1574
|
end
|
1548
1575
|
end
|
1549
1576
|
|
@@ -1768,7 +1795,17 @@ module TencentCloud
|
|
1768
1795
|
end
|
1769
1796
|
end
|
1770
1797
|
|
1771
|
-
#
|
1798
|
+
# 创建签署流程签署人入参。
|
1799
|
+
|
1800
|
+
# 其中签署方FlowApproverInfo需要传递的参数
|
1801
|
+
# 非单C、单B、B2C合同,ApproverType、RecipientId(模版发起合同时)必传,建议都传。其他身份标识
|
1802
|
+
# 1-个人:Name、Mobile必传
|
1803
|
+
# 2-渠道子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
1804
|
+
# 3-渠道合作企业不指定经办人:(暂不支持)
|
1805
|
+
# 4-非渠道合作企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
1806
|
+
|
1807
|
+
# RecipientId参数:
|
1808
|
+
# 从DescribeTemplates接口中,可以得到模版下的签署方Recipient列表,根据模版自定义的Rolename在此结构体中确定其RecipientId
|
1772
1809
|
class FlowApproverInfo < TencentCloud::Common::AbstractModel
|
1773
1810
|
# @param Name: 签署人姓名,最大长度50个字符
|
1774
1811
|
# @type Name: String
|
@@ -3011,7 +3048,7 @@ module TencentCloud
|
|
3011
3048
|
# @type Recipients: Array
|
3012
3049
|
# @param TemplateType: 模板类型:1-静默签;3-普通模板
|
3013
3050
|
# @type TemplateType: Integer
|
3014
|
-
# @param IsPromoter: 是否是发起人
|
3051
|
+
# @param IsPromoter: 是否是发起人 ,已弃用
|
3015
3052
|
# @type IsPromoter: Boolean
|
3016
3053
|
# @param Creator: 模板的创建者信息
|
3017
3054
|
# @type Creator: String
|
@@ -3133,7 +3170,7 @@ module TencentCloud
|
|
3133
3170
|
|
3134
3171
|
# UploadFiles返回参数结构体
|
3135
3172
|
class UploadFilesResponse < TencentCloud::Common::AbstractModel
|
3136
|
-
# @param FileIds: 文件id
|
3173
|
+
# @param FileIds: 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
|
3137
3174
|
# @type FileIds: Array
|
3138
3175
|
# @param TotalCount: 上传成功文件数量
|
3139
3176
|
# @type TotalCount: Integer
|
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.
|
4
|
+
version: 3.0.432
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-10-
|
11
|
+
date: 2022-10-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|