tencentcloud-sdk-ess 3.0.624 → 3.0.626
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/v20201111/client.rb +28 -3
- data/lib/v20201111/models.rb +532 -147
- 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: fee00b70ce00e03c779e5a2a8a7bd055863582fd
|
4
|
+
data.tar.gz: 6fb1c49fad11b28a0e4a12e51d2bc0c409c41159
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9f77fbb764021056bfe837456e7c4558ba29815b5602ad07c6729f89f36e6fd910cd855ed562dac6ff58231ceae822a7cb5dfe7b7f1ec52f71b6f919c52e7ee1
|
7
|
+
data.tar.gz: ef37f96f01d7eff544b266cd9aac28bd0e610f88e30e6f7b7a3c0eeb0f61f060599ae5627ab201285cf18b2dfcd2bc36fb9cbd8653f295188caed1da49e244e6
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.626
|
data/lib/v20201111/client.rb
CHANGED
@@ -630,9 +630,33 @@ module TencentCloud
|
|
630
630
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
631
631
|
end
|
632
632
|
|
633
|
+
# 本接口(CreatePersonAuthCertificateImage)用于创建个人用户证书证明图片
|
634
|
+
|
635
|
+
# @param request: Request instance for CreatePersonAuthCertificateImage.
|
636
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
|
637
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageResponse`
|
638
|
+
def CreatePersonAuthCertificateImage(request)
|
639
|
+
body = send_request('CreatePersonAuthCertificateImage', request.serialize)
|
640
|
+
response = JSON.parse(body)
|
641
|
+
if response['Response'].key?('Error') == false
|
642
|
+
model = CreatePersonAuthCertificateImageResponse.new
|
643
|
+
model.deserialize(response['Response'])
|
644
|
+
model
|
645
|
+
else
|
646
|
+
code = response['Response']['Error']['Code']
|
647
|
+
message = response['Response']['Error']['Message']
|
648
|
+
reqid = response['Response']['RequestId']
|
649
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
650
|
+
end
|
651
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
652
|
+
raise e
|
653
|
+
rescue StandardError => e
|
654
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
655
|
+
end
|
656
|
+
|
633
657
|
# 创建快速发起流程
|
634
|
-
#
|
635
|
-
#
|
658
|
+
# <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
|
659
|
+
# <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
|
636
660
|
|
637
661
|
# @param request: Request instance for CreatePrepareFlow.
|
638
662
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowRequest`
|
@@ -1458,7 +1482,8 @@ module TencentCloud
|
|
1458
1482
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1459
1483
|
end
|
1460
1484
|
|
1461
|
-
# 更新员工信息(姓名,手机号,邮件、部门)
|
1485
|
+
# 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
|
1486
|
+
# 可进行批量操作,Employees中的userID与openID二选一必填
|
1462
1487
|
|
1463
1488
|
# @param request: Request instance for UpdateIntegrationEmployees.
|
1464
1489
|
# @type request: :class:`Tencentcloud::ess::V20201111::UpdateIntegrationEmployeesRequest`
|
data/lib/v20201111/models.rb
CHANGED
@@ -52,12 +52,12 @@ module TencentCloud
|
|
52
52
|
|
53
53
|
attr_accessor :AppId, :ProxyAppId, :ProxyOrganizationId, :ProxyOperator
|
54
54
|
extend Gem::Deprecate
|
55
|
-
deprecate :AppId, :none, 2023,
|
56
|
-
deprecate :AppId=, :none, 2023,
|
57
|
-
deprecate :ProxyAppId, :none, 2023,
|
58
|
-
deprecate :ProxyAppId=, :none, 2023,
|
59
|
-
deprecate :ProxyOperator, :none, 2023,
|
60
|
-
deprecate :ProxyOperator=, :none, 2023,
|
55
|
+
deprecate :AppId, :none, 2023, 8
|
56
|
+
deprecate :AppId=, :none, 2023, 8
|
57
|
+
deprecate :ProxyAppId, :none, 2023, 8
|
58
|
+
deprecate :ProxyAppId=, :none, 2023, 8
|
59
|
+
deprecate :ProxyOperator, :none, 2023, 8
|
60
|
+
deprecate :ProxyOperator=, :none, 2023, 8
|
61
61
|
|
62
62
|
def initialize(appid=nil, proxyappid=nil, proxyorganizationid=nil, proxyoperator=nil)
|
63
63
|
@AppId = appid
|
@@ -368,8 +368,8 @@ module TencentCloud
|
|
368
368
|
|
369
369
|
attr_accessor :CallbackUrl, :Token, :CallbackKey, :CallbackToken
|
370
370
|
extend Gem::Deprecate
|
371
|
-
deprecate :Token, :none, 2023,
|
372
|
-
deprecate :Token=, :none, 2023,
|
371
|
+
deprecate :Token, :none, 2023, 8
|
372
|
+
deprecate :Token=, :none, 2023, 8
|
373
373
|
|
374
374
|
def initialize(callbackurl=nil, token=nil, callbackkey=nil, callbacktoken=nil)
|
375
375
|
@CallbackUrl = callbackurl
|
@@ -399,12 +399,12 @@ module TencentCloud
|
|
399
399
|
|
400
400
|
attr_accessor :ApplicationId, :OrganizationId, :OperatorId, :SubOrganizationId
|
401
401
|
extend Gem::Deprecate
|
402
|
-
deprecate :ApplicationId, :none, 2023,
|
403
|
-
deprecate :ApplicationId=, :none, 2023,
|
404
|
-
deprecate :OrganizationId, :none, 2023,
|
405
|
-
deprecate :OrganizationId=, :none, 2023,
|
406
|
-
deprecate :SubOrganizationId, :none, 2023,
|
407
|
-
deprecate :SubOrganizationId=, :none, 2023,
|
402
|
+
deprecate :ApplicationId, :none, 2023, 8
|
403
|
+
deprecate :ApplicationId=, :none, 2023, 8
|
404
|
+
deprecate :OrganizationId, :none, 2023, 8
|
405
|
+
deprecate :OrganizationId=, :none, 2023, 8
|
406
|
+
deprecate :SubOrganizationId, :none, 2023, 8
|
407
|
+
deprecate :SubOrganizationId=, :none, 2023, 8
|
408
408
|
|
409
409
|
def initialize(applicationid=nil, organizationid=nil, operatorid=nil, suborganizationid=nil)
|
410
410
|
@ApplicationId = applicationid
|
@@ -599,7 +599,7 @@ module TencentCloud
|
|
599
599
|
end
|
600
600
|
end
|
601
601
|
|
602
|
-
#
|
602
|
+
# 模板/流程中控件信息,可以是填充控件或签署控件
|
603
603
|
class Component < TencentCloud::Common::AbstractModel
|
604
604
|
# @param ComponentType: 如果是Component填写控件类型,则可选的字段为:
|
605
605
|
# TEXT - 普通文本控件,输入文本字符串;
|
@@ -623,7 +623,8 @@ module TencentCloud
|
|
623
623
|
|
624
624
|
# 表单域的控件不能作为印章和签名控件
|
625
625
|
# @type ComponentType: String
|
626
|
-
# @param FileIndex: 控件所属文件的序号(取值为:0-N
|
626
|
+
# @param FileIndex: 控件所属文件的序号(取值为:0-N)。
|
627
|
+
# 目前单文件的情况下,值是0
|
627
628
|
# @type FileIndex: Integer
|
628
629
|
# @param ComponentHeight: 参数控件高度,单位pt
|
629
630
|
# @type ComponentHeight: Float
|
@@ -635,13 +636,15 @@ module TencentCloud
|
|
635
636
|
# @type ComponentPosX: Float
|
636
637
|
# @param ComponentPosY: 参数控件Y位置,单位pt
|
637
638
|
# @type ComponentPosY: Float
|
638
|
-
# @param ComponentId:
|
639
|
+
# @param ComponentId: 控件唯一ID。
|
640
|
+
# 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
|
639
641
|
# @type ComponentId: String
|
640
|
-
# @param ComponentName:
|
642
|
+
# @param ComponentName: 控件名。
|
643
|
+
# 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
|
641
644
|
# @type ComponentName: String
|
642
|
-
# @param ComponentRequired: 是否必选,默认为false
|
645
|
+
# @param ComponentRequired: 是否必选,默认为false-非必选
|
643
646
|
# @type ComponentRequired: Boolean
|
644
|
-
# @param ComponentRecipientId:
|
647
|
+
# @param ComponentRecipientId: 控件关联的参与方ID,对应Recipient结构体中的RecipientId
|
645
648
|
# @type ComponentRecipientId: String
|
646
649
|
# @param ComponentExtra: 扩展参数:
|
647
650
|
# 为JSON格式。
|
@@ -673,7 +676,7 @@ module TencentCloud
|
|
673
676
|
# 1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
|
674
677
|
# 参数样例:"ComponentExtra":"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}"
|
675
678
|
# @type ComponentExtra: String
|
676
|
-
# @param IsFormType:
|
679
|
+
# @param IsFormType: 是否是表单域类型,默认false-不是
|
677
680
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
678
681
|
# @type IsFormType: Boolean
|
679
682
|
# @param ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
|
@@ -759,7 +762,7 @@ module TencentCloud
|
|
759
762
|
# @type GenerateMode: String
|
760
763
|
# @param ComponentDateFontSize: 日期签署控件的字号,默认为 12
|
761
764
|
# @type ComponentDateFontSize: Integer
|
762
|
-
# @param ChannelComponentId: 第三方应用集成平台模板控件
|
765
|
+
# @param ChannelComponentId: 第三方应用集成平台模板控件 ID 标识
|
763
766
|
# @type ChannelComponentId: String
|
764
767
|
# @param OffsetX: 指定关键字时横坐标偏移量,单位pt
|
765
768
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
@@ -767,21 +770,41 @@ module TencentCloud
|
|
767
770
|
# @param OffsetY: 指定关键字时纵坐标偏移量,单位pt
|
768
771
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
769
772
|
# @type OffsetY: Float
|
770
|
-
# @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。
|
773
|
+
# @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。
|
774
|
+
# 0-平台指定;
|
775
|
+
# 1-用户自定义
|
771
776
|
# @type ChannelComponentSource: Integer
|
772
|
-
# @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse
|
777
|
+
# @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。
|
778
|
+
# 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
|
773
779
|
# 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
|
774
780
|
# @type KeywordOrder: String
|
775
|
-
# @param KeywordPage:
|
781
|
+
# @param KeywordPage: 指定关键字页码。
|
782
|
+
# 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
776
783
|
# @type KeywordPage: Integer
|
777
|
-
# @param RelativeLocation: 关键字位置模式,
|
784
|
+
# @param RelativeLocation: 关键字位置模式,
|
785
|
+
# Middle-居中,
|
786
|
+
# Below-正下方,
|
787
|
+
# Right-正右方,
|
788
|
+
# LowerRight-右上角,
|
789
|
+
# UpperRight-右下角。
|
790
|
+
# 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
|
778
791
|
# @type RelativeLocation: String
|
779
|
-
# @param KeywordIndexes:
|
792
|
+
# @param KeywordIndexes: 关键字索引。
|
793
|
+
# 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
|
794
|
+
# 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
|
780
795
|
# @type KeywordIndexes: Array
|
796
|
+
# @param LockComponentValue: 是否锁定控件值不允许编辑(嵌入式发起使用)
|
797
|
+
# <br/>默认false:不锁定控件值,允许在页面编辑控件值
|
798
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
799
|
+
# @type LockComponentValue: Boolean
|
800
|
+
# @param ForbidMoveAndDelete: 是否禁止移动和删除控件
|
801
|
+
# <br/>默认false,不禁止移动和删除控件
|
802
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
803
|
+
# @type ForbidMoveAndDelete: Boolean
|
781
804
|
|
782
|
-
attr_accessor :ComponentType, :FileIndex, :ComponentHeight, :ComponentWidth, :ComponentPage, :ComponentPosX, :ComponentPosY, :ComponentId, :ComponentName, :ComponentRequired, :ComponentRecipientId, :ComponentExtra, :IsFormType, :ComponentValue, :GenerateMode, :ComponentDateFontSize, :ChannelComponentId, :OffsetX, :OffsetY, :ChannelComponentSource, :KeywordOrder, :KeywordPage, :RelativeLocation, :KeywordIndexes
|
805
|
+
attr_accessor :ComponentType, :FileIndex, :ComponentHeight, :ComponentWidth, :ComponentPage, :ComponentPosX, :ComponentPosY, :ComponentId, :ComponentName, :ComponentRequired, :ComponentRecipientId, :ComponentExtra, :IsFormType, :ComponentValue, :GenerateMode, :ComponentDateFontSize, :ChannelComponentId, :OffsetX, :OffsetY, :ChannelComponentSource, :KeywordOrder, :KeywordPage, :RelativeLocation, :KeywordIndexes, :LockComponentValue, :ForbidMoveAndDelete
|
783
806
|
|
784
|
-
def initialize(componenttype=nil, fileindex=nil, componentheight=nil, componentwidth=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentid=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, componentextra=nil, isformtype=nil, componentvalue=nil, generatemode=nil, componentdatefontsize=nil, channelcomponentid=nil, offsetx=nil, offsety=nil, channelcomponentsource=nil, keywordorder=nil, keywordpage=nil, relativelocation=nil, keywordindexes=nil)
|
807
|
+
def initialize(componenttype=nil, fileindex=nil, componentheight=nil, componentwidth=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentid=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, componentextra=nil, isformtype=nil, componentvalue=nil, generatemode=nil, componentdatefontsize=nil, channelcomponentid=nil, offsetx=nil, offsety=nil, channelcomponentsource=nil, keywordorder=nil, keywordpage=nil, relativelocation=nil, keywordindexes=nil, lockcomponentvalue=nil, forbidmoveanddelete=nil)
|
785
808
|
@ComponentType = componenttype
|
786
809
|
@FileIndex = fileindex
|
787
810
|
@ComponentHeight = componentheight
|
@@ -806,6 +829,8 @@ module TencentCloud
|
|
806
829
|
@KeywordPage = keywordpage
|
807
830
|
@RelativeLocation = relativelocation
|
808
831
|
@KeywordIndexes = keywordindexes
|
832
|
+
@LockComponentValue = lockcomponentvalue
|
833
|
+
@ForbidMoveAndDelete = forbidmoveanddelete
|
809
834
|
end
|
810
835
|
|
811
836
|
def deserialize(params)
|
@@ -833,6 +858,8 @@ module TencentCloud
|
|
833
858
|
@KeywordPage = params['KeywordPage']
|
834
859
|
@RelativeLocation = params['RelativeLocation']
|
835
860
|
@KeywordIndexes = params['KeywordIndexes']
|
861
|
+
@LockComponentValue = params['LockComponentValue']
|
862
|
+
@ForbidMoveAndDelete = params['ForbidMoveAndDelete']
|
836
863
|
end
|
837
864
|
end
|
838
865
|
|
@@ -962,10 +989,10 @@ module TencentCloud
|
|
962
989
|
|
963
990
|
attr_accessor :ResourceType, :ResourceName, :ResourceId, :Operator, :Agent, :Organization
|
964
991
|
extend Gem::Deprecate
|
965
|
-
deprecate :Agent, :none, 2023,
|
966
|
-
deprecate :Agent=, :none, 2023,
|
967
|
-
deprecate :Organization, :none, 2023,
|
968
|
-
deprecate :Organization=, :none, 2023,
|
992
|
+
deprecate :Agent, :none, 2023, 8
|
993
|
+
deprecate :Agent=, :none, 2023, 8
|
994
|
+
deprecate :Organization, :none, 2023, 8
|
995
|
+
deprecate :Organization=, :none, 2023, 8
|
969
996
|
|
970
997
|
def initialize(resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, agent=nil, organization=nil)
|
971
998
|
@ResourceType = resourcetype
|
@@ -1111,6 +1138,8 @@ module TencentCloud
|
|
1111
1138
|
# <br/>PREVIEW_SEAL_LIST:预览印章列表
|
1112
1139
|
# <br/>PREVIEW_SEAL_DETAIL:预览印章详情
|
1113
1140
|
# <br/>EXTEND_SERVICE:拓展服务
|
1141
|
+
# <br/>PREVIEW_FLOW:预览合同
|
1142
|
+
# <br/>PREVIEW_FLOW_DETAIL:查看合同详情
|
1114
1143
|
# @type EmbedType: String
|
1115
1144
|
# @param BusinessId: WEB嵌入的业务资源ID
|
1116
1145
|
# <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
|
@@ -1119,15 +1148,18 @@ module TencentCloud
|
|
1119
1148
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1120
1149
|
# @param Reviewer: 抄送方信息
|
1121
1150
|
# @type Reviewer: :class:`Tencentcloud::Ess.v20201111.models.ReviewerInfo`
|
1151
|
+
# @param Option: 个性化参数
|
1152
|
+
# @type Option: :class:`Tencentcloud::Ess.v20201111.models.EmbedUrlOption`
|
1122
1153
|
|
1123
|
-
attr_accessor :Operator, :EmbedType, :BusinessId, :Agent, :Reviewer
|
1154
|
+
attr_accessor :Operator, :EmbedType, :BusinessId, :Agent, :Reviewer, :Option
|
1124
1155
|
|
1125
|
-
def initialize(operator=nil, embedtype=nil, businessid=nil, agent=nil, reviewer=nil)
|
1156
|
+
def initialize(operator=nil, embedtype=nil, businessid=nil, agent=nil, reviewer=nil, option=nil)
|
1126
1157
|
@Operator = operator
|
1127
1158
|
@EmbedType = embedtype
|
1128
1159
|
@BusinessId = businessid
|
1129
1160
|
@Agent = agent
|
1130
1161
|
@Reviewer = reviewer
|
1162
|
+
@Option = option
|
1131
1163
|
end
|
1132
1164
|
|
1133
1165
|
def deserialize(params)
|
@@ -1145,6 +1177,10 @@ module TencentCloud
|
|
1145
1177
|
@Reviewer = ReviewerInfo.new
|
1146
1178
|
@Reviewer.deserialize(params['Reviewer'])
|
1147
1179
|
end
|
1180
|
+
unless params['Option'].nil?
|
1181
|
+
@Option = EmbedUrlOption.new
|
1182
|
+
@Option.deserialize(params['Option'])
|
1183
|
+
end
|
1148
1184
|
end
|
1149
1185
|
end
|
1150
1186
|
|
@@ -1607,6 +1643,76 @@ module TencentCloud
|
|
1607
1643
|
end
|
1608
1644
|
end
|
1609
1645
|
|
1646
|
+
# 创建合同个性化参数
|
1647
|
+
class CreateFlowOption < TencentCloud::Common::AbstractModel
|
1648
|
+
# @param CanEditFlow: 是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。
|
1649
|
+
# <br/>true:允许编辑(默认),<br/>false:不允许编辑<br/>默认:false:不允许编辑
|
1650
|
+
# @type CanEditFlow: Boolean
|
1651
|
+
# @param CanEditFormField: 是否允许编辑模版控件
|
1652
|
+
# <br/>true:允许编辑模版控件信息
|
1653
|
+
# <br/>false:不允许编辑模版控件信息
|
1654
|
+
# <br/>默认false:不允许编辑模版控件信息
|
1655
|
+
# @type CanEditFormField: Boolean
|
1656
|
+
# @param HideShowFlowName: 发起页面隐藏合同名称展示
|
1657
|
+
# <br/>true:发起页面隐藏合同名称展示
|
1658
|
+
# <br/>false:发起页面不隐藏合同名称展示
|
1659
|
+
# <br/>默认false:发起页面不隐藏合同名称展示
|
1660
|
+
# @type HideShowFlowName: Boolean
|
1661
|
+
# @param HideShowFlowType: 发起页面隐藏合同类型展示
|
1662
|
+
# <br/>true:发起页面隐藏合同类型展示
|
1663
|
+
# <br/>false:发起页面不隐藏合同类型展示
|
1664
|
+
# <br/>默认false:发起页面不隐藏合同类型展示
|
1665
|
+
# @type HideShowFlowType: Boolean
|
1666
|
+
# @param HideShowDeadline: 发起页面隐藏合同截止日期展示
|
1667
|
+
# <br/>true:发起页面隐藏合同截止日期展示
|
1668
|
+
# <br/>false:发起页面不隐藏合同截止日期展示
|
1669
|
+
# <br/>默认false:发起页面不隐藏合同截止日期展示
|
1670
|
+
# @type HideShowDeadline: Boolean
|
1671
|
+
# @param CanSkipAddApprover: 发起页面允许跳过添加签署人环节
|
1672
|
+
# <br/>true:发起页面允许跳过添加签署人环节
|
1673
|
+
# <br/>false:发起页面不允许跳过添加签署人环节
|
1674
|
+
# <br/>默认false:发起页面不允许跳过添加签署人环节
|
1675
|
+
# @type CanSkipAddApprover: Boolean
|
1676
|
+
# @param SkipUploadFile: 文件发起页面跳过文件上传步骤
|
1677
|
+
# <br/>true:文件发起页面跳过文件上传步骤
|
1678
|
+
# <br/>false:文件发起页面不跳过文件上传步骤
|
1679
|
+
# <br/>默认false:文件发起页面不跳过文件上传步骤
|
1680
|
+
# @type SkipUploadFile: Boolean
|
1681
|
+
# @param ForbidEditFillComponent: 禁止编辑填写控件
|
1682
|
+
# <br/>true:禁止编辑填写控件
|
1683
|
+
# <br/>false:允许编辑填写控件
|
1684
|
+
# <br/>默认false:允许编辑填写控件
|
1685
|
+
# @type ForbidEditFillComponent: Boolean
|
1686
|
+
# @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
|
1687
|
+
# @type CustomCreateFlowDescription: String
|
1688
|
+
|
1689
|
+
attr_accessor :CanEditFlow, :CanEditFormField, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :SkipUploadFile, :ForbidEditFillComponent, :CustomCreateFlowDescription
|
1690
|
+
|
1691
|
+
def initialize(caneditflow=nil, caneditformfield=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, skipuploadfile=nil, forbideditfillcomponent=nil, customcreateflowdescription=nil)
|
1692
|
+
@CanEditFlow = caneditflow
|
1693
|
+
@CanEditFormField = caneditformfield
|
1694
|
+
@HideShowFlowName = hideshowflowname
|
1695
|
+
@HideShowFlowType = hideshowflowtype
|
1696
|
+
@HideShowDeadline = hideshowdeadline
|
1697
|
+
@CanSkipAddApprover = canskipaddapprover
|
1698
|
+
@SkipUploadFile = skipuploadfile
|
1699
|
+
@ForbidEditFillComponent = forbideditfillcomponent
|
1700
|
+
@CustomCreateFlowDescription = customcreateflowdescription
|
1701
|
+
end
|
1702
|
+
|
1703
|
+
def deserialize(params)
|
1704
|
+
@CanEditFlow = params['CanEditFlow']
|
1705
|
+
@CanEditFormField = params['CanEditFormField']
|
1706
|
+
@HideShowFlowName = params['HideShowFlowName']
|
1707
|
+
@HideShowFlowType = params['HideShowFlowType']
|
1708
|
+
@HideShowDeadline = params['HideShowDeadline']
|
1709
|
+
@CanSkipAddApprover = params['CanSkipAddApprover']
|
1710
|
+
@SkipUploadFile = params['SkipUploadFile']
|
1711
|
+
@ForbidEditFillComponent = params['ForbidEditFillComponent']
|
1712
|
+
@CustomCreateFlowDescription = params['CustomCreateFlowDescription']
|
1713
|
+
end
|
1714
|
+
end
|
1715
|
+
|
1610
1716
|
# CreateFlowReminds请求参数结构体
|
1611
1717
|
class CreateFlowRemindsRequest < TencentCloud::Common::AbstractModel
|
1612
1718
|
# @param Operator: 调用方用户信息,userId 必填
|
@@ -1671,6 +1777,7 @@ module TencentCloud
|
|
1671
1777
|
# @param FlowName: 签署流程名称,最大长度200个字符
|
1672
1778
|
# @type FlowName: String
|
1673
1779
|
# @param Approvers: 签署流程参与者信息,最大限制50方
|
1780
|
+
# 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
|
1674
1781
|
# @type Approvers: Array
|
1675
1782
|
# @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
1676
1783
|
# @type FlowType: String
|
@@ -1711,10 +1818,10 @@ module TencentCloud
|
|
1711
1818
|
|
1712
1819
|
attr_accessor :Operator, :FlowName, :Approvers, :FlowType, :ClientToken, :DeadLine, :RemindedOn, :UserData, :FlowDescription, :Unordered, :CustomShowMap, :NeedSignReview, :Agent, :CcInfos, :AutoSignScene, :RelatedFlowId, :CallbackUrl
|
1713
1820
|
extend Gem::Deprecate
|
1714
|
-
deprecate :RelatedFlowId, :none, 2023,
|
1715
|
-
deprecate :RelatedFlowId=, :none, 2023,
|
1716
|
-
deprecate :CallbackUrl, :none, 2023,
|
1717
|
-
deprecate :CallbackUrl=, :none, 2023,
|
1821
|
+
deprecate :RelatedFlowId, :none, 2023, 8
|
1822
|
+
deprecate :RelatedFlowId=, :none, 2023, 8
|
1823
|
+
deprecate :CallbackUrl, :none, 2023, 8
|
1824
|
+
deprecate :CallbackUrl=, :none, 2023, 8
|
1718
1825
|
|
1719
1826
|
def initialize(operator=nil, flowname=nil, approvers=nil, flowtype=nil, clienttoken=nil, deadline=nil, remindedon=nil, userdata=nil, flowdescription=nil, unordered=nil, customshowmap=nil, needsignreview=nil, agent=nil, ccinfos=nil, autosignscene=nil, relatedflowid=nil, callbackurl=nil)
|
1720
1827
|
@Operator = operator
|
@@ -1889,8 +1996,8 @@ module TencentCloud
|
|
1889
1996
|
|
1890
1997
|
attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
|
1891
1998
|
extend Gem::Deprecate
|
1892
|
-
deprecate :Organization, :none, 2023,
|
1893
|
-
deprecate :Organization=, :none, 2023,
|
1999
|
+
deprecate :Organization, :none, 2023, 8
|
2000
|
+
deprecate :Organization=, :none, 2023, 8
|
1894
2001
|
|
1895
2002
|
def initialize(flowid=nil, flowapproverinfos=nil, operator=nil, agent=nil, organization=nil, jumpurl=nil)
|
1896
2003
|
@FlowId = flowid
|
@@ -2145,19 +2252,22 @@ module TencentCloud
|
|
2145
2252
|
# @param FlowName: 签署流程名称,最大长度不超过200字符
|
2146
2253
|
# @type FlowName: String
|
2147
2254
|
# @param MaxFlowNum: 最大可发起签署流程份数,默认5份
|
2148
|
-
#
|
2255
|
+
# <br/>发起流程数量超过此上限后二维码自动失效
|
2149
2256
|
# @type MaxFlowNum: Integer
|
2150
|
-
# @param FlowEffectiveDay: 签署流程有效天数
|
2257
|
+
# @param FlowEffectiveDay: 签署流程有效天数
|
2258
|
+
# <br/>默认7天
|
2259
|
+
# <br/>最高设置不超过30天
|
2151
2260
|
# @type FlowEffectiveDay: Integer
|
2152
2261
|
# @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
|
2153
2262
|
# @type QrEffectiveDay: Integer
|
2154
|
-
# @param Restrictions:
|
2263
|
+
# @param Restrictions: 指定的签署人信息
|
2264
|
+
# <br/>指定后,则只允许指定的签署人扫码签署
|
2155
2265
|
# @type Restrictions: Array
|
2156
|
-
# @param UserData:
|
2266
|
+
# @param UserData: 用户自定义字段
|
2267
|
+
# <br/>回调的时候会进行透传,长度需要小于20480
|
2157
2268
|
# @type UserData: String
|
2158
2269
|
# @param CallbackUrl: 回调地址,最大长度1000字符串
|
2159
|
-
#
|
2160
|
-
# 用户通过签署二维码发起签署流程时,企业额度不足导致失败
|
2270
|
+
# <br/>回调时机:用户通过签署二维码发起签署流程时,企业额度不足导致失败
|
2161
2271
|
# @type CallbackUrl: String
|
2162
2272
|
# @param Agent: 应用信息
|
2163
2273
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
@@ -2166,10 +2276,10 @@ module TencentCloud
|
|
2166
2276
|
|
2167
2277
|
attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
|
2168
2278
|
extend Gem::Deprecate
|
2169
|
-
deprecate :Agent, :none, 2023,
|
2170
|
-
deprecate :Agent=, :none, 2023,
|
2171
|
-
deprecate :ApproverRestrictions, :none, 2023,
|
2172
|
-
deprecate :ApproverRestrictions=, :none, 2023,
|
2279
|
+
deprecate :Agent, :none, 2023, 8
|
2280
|
+
deprecate :Agent=, :none, 2023, 8
|
2281
|
+
deprecate :ApproverRestrictions, :none, 2023, 8
|
2282
|
+
deprecate :ApproverRestrictions=, :none, 2023, 8
|
2173
2283
|
|
2174
2284
|
def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, userdata=nil, callbackurl=nil, agent=nil, approverrestrictions=nil)
|
2175
2285
|
@Operator = operator
|
@@ -2312,6 +2422,62 @@ module TencentCloud
|
|
2312
2422
|
end
|
2313
2423
|
end
|
2314
2424
|
|
2425
|
+
# CreatePersonAuthCertificateImage请求参数结构体
|
2426
|
+
class CreatePersonAuthCertificateImageRequest < TencentCloud::Common::AbstractModel
|
2427
|
+
# @param Operator: 操作人信息
|
2428
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2429
|
+
# @param UserName: 个人用户名称
|
2430
|
+
# @type UserName: String
|
2431
|
+
# @param IdCardType: 身份证件类型取值:
|
2432
|
+
# ID_CARD 身居民身份证
|
2433
|
+
# PASSPORT 护照
|
2434
|
+
# HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
2435
|
+
# FOREIGN_ID_CARD 外国人永久居留身份证
|
2436
|
+
# HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
2437
|
+
# @type IdCardType: String
|
2438
|
+
# @param IdCardNumber: 身份证件号码
|
2439
|
+
# @type IdCardNumber: String
|
2440
|
+
|
2441
|
+
attr_accessor :Operator, :UserName, :IdCardType, :IdCardNumber
|
2442
|
+
|
2443
|
+
def initialize(operator=nil, username=nil, idcardtype=nil, idcardnumber=nil)
|
2444
|
+
@Operator = operator
|
2445
|
+
@UserName = username
|
2446
|
+
@IdCardType = idcardtype
|
2447
|
+
@IdCardNumber = idcardnumber
|
2448
|
+
end
|
2449
|
+
|
2450
|
+
def deserialize(params)
|
2451
|
+
unless params['Operator'].nil?
|
2452
|
+
@Operator = UserInfo.new
|
2453
|
+
@Operator.deserialize(params['Operator'])
|
2454
|
+
end
|
2455
|
+
@UserName = params['UserName']
|
2456
|
+
@IdCardType = params['IdCardType']
|
2457
|
+
@IdCardNumber = params['IdCardNumber']
|
2458
|
+
end
|
2459
|
+
end
|
2460
|
+
|
2461
|
+
# CreatePersonAuthCertificateImage返回参数结构体
|
2462
|
+
class CreatePersonAuthCertificateImageResponse < TencentCloud::Common::AbstractModel
|
2463
|
+
# @param AuthCertUrl: 个人用户证明证书的下载链接
|
2464
|
+
# @type AuthCertUrl: String
|
2465
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
2466
|
+
# @type RequestId: String
|
2467
|
+
|
2468
|
+
attr_accessor :AuthCertUrl, :RequestId
|
2469
|
+
|
2470
|
+
def initialize(authcerturl=nil, requestid=nil)
|
2471
|
+
@AuthCertUrl = authcerturl
|
2472
|
+
@RequestId = requestid
|
2473
|
+
end
|
2474
|
+
|
2475
|
+
def deserialize(params)
|
2476
|
+
@AuthCertUrl = params['AuthCertUrl']
|
2477
|
+
@RequestId = params['RequestId']
|
2478
|
+
end
|
2479
|
+
end
|
2480
|
+
|
2315
2481
|
# CreatePrepareFlow请求参数结构体
|
2316
2482
|
class CreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
|
2317
2483
|
# @param Operator: 调用方用户信息,userId 必填
|
@@ -2320,23 +2486,60 @@ module TencentCloud
|
|
2320
2486
|
# @type ResourceId: String
|
2321
2487
|
# @param FlowName: 合同名称
|
2322
2488
|
# @type FlowName: String
|
2323
|
-
# @param Unordered: 是否顺序签署
|
2489
|
+
# @param Unordered: 是否顺序签署
|
2490
|
+
# true:无序签
|
2491
|
+
# false:顺序签
|
2324
2492
|
# @type Unordered: Boolean
|
2325
2493
|
# @param Deadline: 签署流程的签署截止时间。
|
2326
|
-
# 值为unix
|
2494
|
+
# 值为unix时间戳,精确到秒
|
2495
|
+
# 不传默认为当前时间一年后
|
2327
2496
|
# @type Deadline: Integer
|
2328
|
-
# @param UserFlowTypeId: 用户自定义合同类型
|
2497
|
+
# @param UserFlowTypeId: 用户自定义合同类型Id
|
2498
|
+
# 该id为电子签企业内的合同类型id
|
2329
2499
|
# @type UserFlowTypeId: String
|
2330
2500
|
# @param Approvers: 签署流程参与者信息,最大限制50方
|
2331
2501
|
# @type Approvers: Array
|
2332
|
-
# @param IntelligentStatus: 打开智能添加填写区
|
2502
|
+
# @param IntelligentStatus: 打开智能添加填写区
|
2503
|
+
# (默认开启,打开:"OPEN"
|
2504
|
+
# 关闭:"CLOSE"
|
2333
2505
|
# @type IntelligentStatus: String
|
2506
|
+
# @param ResourceType: 资源类型,
|
2507
|
+
# 1:文件,
|
2508
|
+
# 2:模板
|
2509
|
+
# 不传默认为1:文件
|
2510
|
+
# 目前仅支持文件
|
2511
|
+
# @type ResourceType: Integer
|
2512
|
+
# @param Components: 发起方填写控件
|
2513
|
+
# 该类型控件由发起方完成填写
|
2514
|
+
# @type Components: :class:`Tencentcloud::Ess.v20201111.models.Component`
|
2515
|
+
# @param FlowOption: 发起合同个性化参数
|
2516
|
+
# 用于满足创建及页面操作过程中的个性化要求
|
2517
|
+
# 具体定制化内容详见数据接口说明
|
2518
|
+
# @type FlowOption: :class:`Tencentcloud::Ess.v20201111.models.CreateFlowOption`
|
2519
|
+
# @param NeedSignReview: 是否开启发起方签署审核
|
2520
|
+
# true:开启发起方签署审核
|
2521
|
+
# false:不开启发起方签署审核
|
2522
|
+
# 默认false:不开启发起方签署审核
|
2523
|
+
# @type NeedSignReview: Boolean
|
2524
|
+
# @param NeedCreateReview: 开启发起方发起合同审核
|
2525
|
+
# true:开启发起方发起合同审核
|
2526
|
+
# false:不开启发起方发起合同审核
|
2527
|
+
# 默认false:不开启发起方发起合同审核
|
2528
|
+
# @type NeedCreateReview: Boolean
|
2529
|
+
# @param UserData: 用户自定义参数
|
2530
|
+
# @type UserData: String
|
2531
|
+
# @param FlowId: 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
|
2532
|
+
# @type FlowId: String
|
2533
|
+
# @param FlowType: 合同类型名称
|
2534
|
+
# 该字段用于客户自定义合同类型
|
2535
|
+
# 建议使用时指定合同类型,便于之后合同分类以及查看
|
2536
|
+
# @type FlowType: String
|
2334
2537
|
# @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
2335
2538
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2336
2539
|
|
2337
|
-
attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :Approvers, :IntelligentStatus, :Agent
|
2540
|
+
attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :FlowType, :Agent
|
2338
2541
|
|
2339
|
-
def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, approvers=nil, intelligentstatus=nil, agent=nil)
|
2542
|
+
def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, flowtype=nil, agent=nil)
|
2340
2543
|
@Operator = operator
|
2341
2544
|
@ResourceId = resourceid
|
2342
2545
|
@FlowName = flowname
|
@@ -2345,6 +2548,14 @@ module TencentCloud
|
|
2345
2548
|
@UserFlowTypeId = userflowtypeid
|
2346
2549
|
@Approvers = approvers
|
2347
2550
|
@IntelligentStatus = intelligentstatus
|
2551
|
+
@ResourceType = resourcetype
|
2552
|
+
@Components = components
|
2553
|
+
@FlowOption = flowoption
|
2554
|
+
@NeedSignReview = needsignreview
|
2555
|
+
@NeedCreateReview = needcreatereview
|
2556
|
+
@UserData = userdata
|
2557
|
+
@FlowId = flowid
|
2558
|
+
@FlowType = flowtype
|
2348
2559
|
@Agent = agent
|
2349
2560
|
end
|
2350
2561
|
|
@@ -2367,6 +2578,20 @@ module TencentCloud
|
|
2367
2578
|
end
|
2368
2579
|
end
|
2369
2580
|
@IntelligentStatus = params['IntelligentStatus']
|
2581
|
+
@ResourceType = params['ResourceType']
|
2582
|
+
unless params['Components'].nil?
|
2583
|
+
@Components = Component.new
|
2584
|
+
@Components.deserialize(params['Components'])
|
2585
|
+
end
|
2586
|
+
unless params['FlowOption'].nil?
|
2587
|
+
@FlowOption = CreateFlowOption.new
|
2588
|
+
@FlowOption.deserialize(params['FlowOption'])
|
2589
|
+
end
|
2590
|
+
@NeedSignReview = params['NeedSignReview']
|
2591
|
+
@NeedCreateReview = params['NeedCreateReview']
|
2592
|
+
@UserData = params['UserData']
|
2593
|
+
@FlowId = params['FlowId']
|
2594
|
+
@FlowType = params['FlowType']
|
2370
2595
|
unless params['Agent'].nil?
|
2371
2596
|
@Agent = Agent.new
|
2372
2597
|
@Agent.deserialize(params['Agent'])
|
@@ -2440,8 +2665,8 @@ module TencentCloud
|
|
2440
2665
|
|
2441
2666
|
attr_accessor :UserName, :IdCardNumber, :SealName, :Operator, :IdCardType, :SealImage, :SealImageCompress, :Mobile, :EnableAutoSign, :SealColor, :ProcessSeal, :FileId
|
2442
2667
|
extend Gem::Deprecate
|
2443
|
-
deprecate :SealImage, :none, 2023,
|
2444
|
-
deprecate :SealImage=, :none, 2023,
|
2668
|
+
deprecate :SealImage, :none, 2023, 8
|
2669
|
+
deprecate :SealImage=, :none, 2023, 8
|
2445
2670
|
|
2446
2671
|
def initialize(username=nil, idcardnumber=nil, sealname=nil, operator=nil, idcardtype=nil, sealimage=nil, sealimagecompress=nil, mobile=nil, enableautosign=nil, sealcolor=nil, processseal=nil, fileid=nil)
|
2447
2672
|
@UserName = username
|
@@ -3387,12 +3612,12 @@ module TencentCloud
|
|
3387
3612
|
|
3388
3613
|
attr_accessor :Operator, :BusinessType, :BusinessIds, :FileName, :FileType, :Offset, :Limit, :UrlTtl, :CcToken, :Scene, :Agent
|
3389
3614
|
extend Gem::Deprecate
|
3390
|
-
deprecate :CcToken, :none, 2023,
|
3391
|
-
deprecate :CcToken=, :none, 2023,
|
3392
|
-
deprecate :Scene, :none, 2023,
|
3393
|
-
deprecate :Scene=, :none, 2023,
|
3394
|
-
deprecate :Agent, :none, 2023,
|
3395
|
-
deprecate :Agent=, :none, 2023,
|
3615
|
+
deprecate :CcToken, :none, 2023, 8
|
3616
|
+
deprecate :CcToken=, :none, 2023, 8
|
3617
|
+
deprecate :Scene, :none, 2023, 8
|
3618
|
+
deprecate :Scene=, :none, 2023, 8
|
3619
|
+
deprecate :Agent, :none, 2023, 8
|
3620
|
+
deprecate :Agent=, :none, 2023, 8
|
3396
3621
|
|
3397
3622
|
def initialize(operator=nil, businesstype=nil, businessids=nil, filename=nil, filetype=nil, offset=nil, limit=nil, urlttl=nil, cctoken=nil, scene=nil, agent=nil)
|
3398
3623
|
@Operator = operator
|
@@ -3711,7 +3936,7 @@ module TencentCloud
|
|
3711
3936
|
class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
|
3712
3937
|
# @param Operator: 调用方员工/经办人信息
|
3713
3938
|
# UserId 必填,在企业控制台组织架构中可以查到员工的UserId
|
3714
|
-
#
|
3939
|
+
# 注:请保证员工有相关的角色权限
|
3715
3940
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3716
3941
|
# @param Agent: 代理相关应用信息
|
3717
3942
|
# 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
|
@@ -3742,12 +3967,12 @@ module TencentCloud
|
|
3742
3967
|
|
3743
3968
|
attr_accessor :Operator, :Agent, :ContentType, :Filters, :Offset, :Limit, :ApplicationId, :IsChannel, :Organization, :GenerateSource
|
3744
3969
|
extend Gem::Deprecate
|
3745
|
-
deprecate :IsChannel, :none, 2023,
|
3746
|
-
deprecate :IsChannel=, :none, 2023,
|
3747
|
-
deprecate :Organization, :none, 2023,
|
3748
|
-
deprecate :Organization=, :none, 2023,
|
3749
|
-
deprecate :GenerateSource, :none, 2023,
|
3750
|
-
deprecate :GenerateSource=, :none, 2023,
|
3970
|
+
deprecate :IsChannel, :none, 2023, 8
|
3971
|
+
deprecate :IsChannel=, :none, 2023, 8
|
3972
|
+
deprecate :Organization, :none, 2023, 8
|
3973
|
+
deprecate :Organization=, :none, 2023, 8
|
3974
|
+
deprecate :GenerateSource, :none, 2023, 8
|
3975
|
+
deprecate :GenerateSource=, :none, 2023, 8
|
3751
3976
|
|
3752
3977
|
def initialize(operator=nil, agent=nil, contenttype=nil, filters=nil, offset=nil, limit=nil, applicationid=nil, ischannel=nil, organization=nil, generatesource=nil)
|
3753
3978
|
@Operator = operator
|
@@ -4445,6 +4670,32 @@ module TencentCloud
|
|
4445
4670
|
end
|
4446
4671
|
end
|
4447
4672
|
|
4673
|
+
# 个性化参数
|
4674
|
+
class EmbedUrlOption < TencentCloud::Common::AbstractModel
|
4675
|
+
# @param ShowFlowDetailComponent: 合同详情预览,允许展示控件信息
|
4676
|
+
# <br/>true:允许在合同详情页展示控件
|
4677
|
+
# <br/>false:不允许在合同详情页展示控件
|
4678
|
+
# <br/>默认false,合同详情页不展示控件
|
4679
|
+
# @type ShowFlowDetailComponent: Boolean
|
4680
|
+
# @param ShowTemplateComponent: 模版预览,允许展示模版控件信息
|
4681
|
+
# <br/>true:允许在模版预览页展示控件
|
4682
|
+
# <br/>false:不允许在模版预览页展示控件
|
4683
|
+
# <br/>默认false,模版预览页不展示控件
|
4684
|
+
# @type ShowTemplateComponent: Boolean
|
4685
|
+
|
4686
|
+
attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent
|
4687
|
+
|
4688
|
+
def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil)
|
4689
|
+
@ShowFlowDetailComponent = showflowdetailcomponent
|
4690
|
+
@ShowTemplateComponent = showtemplatecomponent
|
4691
|
+
end
|
4692
|
+
|
4693
|
+
def deserialize(params)
|
4694
|
+
@ShowFlowDetailComponent = params['ShowFlowDetailComponent']
|
4695
|
+
@ShowTemplateComponent = params['ShowTemplateComponent']
|
4696
|
+
end
|
4697
|
+
end
|
4698
|
+
|
4448
4699
|
# 授权服务信息
|
4449
4700
|
class ExtendAuthInfo < TencentCloud::Common::AbstractModel
|
4450
4701
|
# @param Type: 授权服务类型
|
@@ -4607,13 +4858,13 @@ module TencentCloud
|
|
4607
4858
|
|
4608
4859
|
# 模板中文件的信息结构
|
4609
4860
|
class FileInfo < TencentCloud::Common::AbstractModel
|
4610
|
-
# @param FileId: 文件
|
4861
|
+
# @param FileId: 文件ID
|
4611
4862
|
# @type FileId: String
|
4612
4863
|
# @param FileName: 文件名
|
4613
4864
|
# @type FileName: String
|
4614
4865
|
# @param FileSize: 文件大小,单位为Byte
|
4615
4866
|
# @type FileSize: Integer
|
4616
|
-
# @param CreatedOn:
|
4867
|
+
# @param CreatedOn: 文件上传时间,格式为Unix标准时间戳(秒)
|
4617
4868
|
# @type CreatedOn: Integer
|
4618
4869
|
|
4619
4870
|
attr_accessor :FileId, :FileName, :FileSize, :CreatedOn
|
@@ -4656,16 +4907,17 @@ module TencentCloud
|
|
4656
4907
|
|
4657
4908
|
# 补充签署人信息
|
4658
4909
|
# - RecipientId 必须指定
|
4659
|
-
# - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId
|
4660
|
-
# - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile
|
4910
|
+
# - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
|
4911
|
+
# - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
|
4661
4912
|
class FillApproverInfo < TencentCloud::Common::AbstractModel
|
4662
4913
|
# @param RecipientId: 对应模板中的参与方ID
|
4663
4914
|
# @type RecipientId: String
|
4664
4915
|
# @param ApproverSource: 签署人来源
|
4665
4916
|
# WEWORKAPP: 企业微信
|
4917
|
+
# <br/>仅【企微或签】时指定WEWORKAPP
|
4666
4918
|
# @type ApproverSource: String
|
4667
4919
|
# @param CustomUserId: 企业自定义账号ID
|
4668
|
-
# WEWORKAPP
|
4920
|
+
# <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
|
4669
4921
|
# @type CustomUserId: String
|
4670
4922
|
# @param ApproverName: 补充签署人姓名
|
4671
4923
|
# @type ApproverName: String
|
@@ -4947,14 +5199,21 @@ module TencentCloud
|
|
4947
5199
|
# @param ApproverType: 参与者类型:
|
4948
5200
|
# 0:企业
|
4949
5201
|
# 1:个人
|
4950
|
-
# 3
|
4951
|
-
# 注:类型为3
|
5202
|
+
# 3:企业自动签署
|
5203
|
+
# 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
|
5204
|
+
# 自动签署仅进行盖章操作,不能是手写签名。
|
5205
|
+
# 本方企业自动签署的签署人会默认是当前的发起人
|
5206
|
+
# 他方企业自动签署的签署人是自动签模板的他方企业授权人
|
4952
5207
|
# @type ApproverType: Integer
|
4953
|
-
# @param OrganizationName:
|
5208
|
+
# @param OrganizationName: 签署人企业名称
|
5209
|
+
# <br/>当approverType=1 或 approverType=3时,必须指定
|
5210
|
+
|
4954
5211
|
# @type OrganizationName: String
|
4955
5212
|
# @param ApproverName: 签署方经办人姓名
|
5213
|
+
# <br/>在未指定签署人电子签UserId情况下,为必填参数
|
4956
5214
|
# @type ApproverName: String
|
4957
5215
|
# @param ApproverMobile: 签署方经办人手机号码
|
5216
|
+
# <br/>在未指定签署人电子签UserId情况下,为必填参数
|
4958
5217
|
# @type ApproverMobile: String
|
4959
5218
|
# @param ApproverIdCardType: 签署方经办人证件类型ID_CARD 身份证
|
4960
5219
|
# HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
@@ -4963,22 +5222,33 @@ module TencentCloud
|
|
4963
5222
|
# @param ApproverIdCardNumber: 签署方经办人证件号码
|
4964
5223
|
# @type ApproverIdCardNumber: String
|
4965
5224
|
# @param RecipientId: 签署方经办人在模板中的参与方ID
|
5225
|
+
# <br/>模版发起合同时,该参数为必填项
|
5226
|
+
# <br/>文件发起合同是,该参数无序传值
|
4966
5227
|
# @type RecipientId: String
|
4967
5228
|
# @param VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
|
4968
5229
|
# @type VerifyChannel: Array
|
4969
|
-
# @param NotifyType:
|
5230
|
+
# @param NotifyType: 是否发送短信
|
5231
|
+
# <br/>sms--短信通知
|
5232
|
+
# <br/>none--不通知
|
5233
|
+
# <br/>默认为sms
|
5234
|
+
# <br/>发起方=签署方时不发送短信
|
4970
5235
|
# @type NotifyType: String
|
4971
5236
|
# @param IsFullText: 合同强制需要阅读全文,无需传此参数
|
4972
5237
|
# @type IsFullText: Boolean
|
4973
5238
|
# @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
4974
5239
|
# @type PreReadTime: Integer
|
4975
|
-
# @param UserId:
|
5240
|
+
# @param UserId: 签署方经办人的电子签用户ID
|
5241
|
+
# <br/>当未指定签署人姓名+手机号的情况下,该字段毕传
|
4976
5242
|
# @type UserId: String
|
4977
5243
|
# @param Required: 当前只支持true,默认为true
|
4978
5244
|
# @type Required: Boolean
|
4979
|
-
# @param ApproverSource:
|
5245
|
+
# @param ApproverSource: 签署人用户来源
|
5246
|
+
# <br/>企微侧用户请传入:WEWORKAPP
|
4980
5247
|
# @type ApproverSource: String
|
4981
|
-
# @param CustomApproverTag: 企业签署方或签标识,客户自定义,64
|
5248
|
+
# @param CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度
|
5249
|
+
# <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
|
5250
|
+
# <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
|
5251
|
+
# <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
|
4982
5252
|
# @type CustomApproverTag: String
|
4983
5253
|
# @param RegisterInfo: 快速注册相关信息,目前暂未开放!
|
4984
5254
|
# @type RegisterInfo: :class:`Tencentcloud::Ess.v20201111.models.RegisterInfo`
|
@@ -4990,11 +5260,16 @@ module TencentCloud
|
|
4990
5260
|
# - 发起流程时系统自动补充
|
4991
5261
|
# - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
4992
5262
|
# @type SignId: String
|
4993
|
-
# @param ApproverNeedSignReview:
|
5263
|
+
# @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批
|
5264
|
+
# <br>true 则为需要
|
5265
|
+
# <br/>false,无序企业内部审批(默认)
|
5266
|
+
# <br/>为个人签署方时则由发起方企业审核。
|
4994
5267
|
# @type ApproverNeedSignReview: Boolean
|
4995
5268
|
# @param SignComponents: 签署人签署控件
|
5269
|
+
# <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
|
4996
5270
|
# @type SignComponents: Array
|
4997
5271
|
# @param Components: 签署人填写控件
|
5272
|
+
# <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
|
4998
5273
|
# @type Components: Array
|
4999
5274
|
# @param ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
|
5000
5275
|
# HANDWRITE – 手写签名
|
@@ -5009,8 +5284,8 @@ module TencentCloud
|
|
5009
5284
|
|
5010
5285
|
attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes
|
5011
5286
|
extend Gem::Deprecate
|
5012
|
-
deprecate :JumpUrl, :none, 2023,
|
5013
|
-
deprecate :JumpUrl=, :none, 2023,
|
5287
|
+
deprecate :JumpUrl, :none, 2023, 8
|
5288
|
+
deprecate :JumpUrl=, :none, 2023, 8
|
5014
5289
|
|
5015
5290
|
def initialize(approvertype=nil, organizationname=nil, approvername=nil, approvermobile=nil, approveridcardtype=nil, approveridcardnumber=nil, recipientid=nil, verifychannel=nil, notifytype=nil, isfulltext=nil, prereadtime=nil, userid=nil, required=nil, approversource=nil, customapprovertag=nil, registerinfo=nil, approveroption=nil, jumpurl=nil, signid=nil, approverneedsignreview=nil, signcomponents=nil, components=nil, componentlimittype=nil, approververifytypes=nil, approversigntypes=nil)
|
5016
5291
|
@ApproverType = approvertype
|
@@ -5280,8 +5555,72 @@ module TencentCloud
|
|
5280
5555
|
|
5281
5556
|
# 电子文档的控件填充信息。按照控件类型进行相应的填充。
|
5282
5557
|
|
5558
|
+
# 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
|
5559
|
+
# ```
|
5560
|
+
# FormFiled输入示例:
|
5561
|
+
# {
|
5562
|
+
# "ComponentId": "componentId1",
|
5563
|
+
# "ComponentValue": "文本内容"
|
5564
|
+
# }
|
5565
|
+
# ```
|
5566
|
+
# 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
|
5567
|
+
# ```
|
5568
|
+
# FormFiled输入示例:
|
5569
|
+
# {
|
5570
|
+
# "ComponentId": "componentId1",
|
5571
|
+
# "ComponentValue": "多行文本内容"
|
5572
|
+
# }
|
5573
|
+
# ```
|
5574
|
+
# 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
|
5575
|
+
# ```
|
5576
|
+
# FormFiled输入示例:
|
5577
|
+
# {
|
5578
|
+
# "ComponentId": "componentId1",
|
5579
|
+
# "ComponentValue": "true"
|
5580
|
+
# }
|
5581
|
+
# ```
|
5582
|
+
# 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
|
5583
|
+
# ```
|
5584
|
+
# FormFiled输入示例:
|
5585
|
+
# {
|
5586
|
+
# "ComponentId": "componentId1",
|
5587
|
+
# "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
5588
|
+
# }
|
5589
|
+
# ```
|
5590
|
+
# 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
|
5591
|
+
# ```
|
5592
|
+
# FormFiled输入示例:
|
5593
|
+
# {
|
5594
|
+
# "ComponentId": "componentId1",
|
5595
|
+
# "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
|
5596
|
+
# }
|
5597
|
+
# ```
|
5598
|
+
# 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
|
5599
|
+
# ```
|
5600
|
+
# FormFiled输入示例:
|
5601
|
+
# {
|
5602
|
+
# "ComponentId": "componentId1",
|
5603
|
+
# "ComponentValue": "选择的内容"
|
5604
|
+
# }
|
5605
|
+
# ```
|
5606
|
+
# 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
|
5607
|
+
# ```
|
5608
|
+
# FormFiled输入示例:
|
5609
|
+
# {
|
5610
|
+
# "ComponentId": "componentId1",
|
5611
|
+
# "ComponentValue": "2023年01月01日"
|
5612
|
+
# }
|
5613
|
+
# ```
|
5614
|
+
# 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
|
5615
|
+
# ```
|
5616
|
+
# FormFiled输入示例:
|
5617
|
+
# {
|
5618
|
+
# "ComponentId": "componentId1",
|
5619
|
+
# "ComponentValue": "广东省深圳市福田区"
|
5620
|
+
# }
|
5621
|
+
# ```
|
5283
5622
|
# 【数据表格传参说明】
|
5284
|
-
#
|
5623
|
+
# 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
5285
5624
|
# 输入示例1:
|
5286
5625
|
|
5287
5626
|
# ```
|
@@ -5431,10 +5770,10 @@ module TencentCloud
|
|
5431
5770
|
|
5432
5771
|
attr_accessor :TaskId, :Operator, :Agent, :Organization
|
5433
5772
|
extend Gem::Deprecate
|
5434
|
-
deprecate :Agent, :none, 2023,
|
5435
|
-
deprecate :Agent=, :none, 2023,
|
5436
|
-
deprecate :Organization, :none, 2023,
|
5437
|
-
deprecate :Organization=, :none, 2023,
|
5773
|
+
deprecate :Agent, :none, 2023, 8
|
5774
|
+
deprecate :Agent=, :none, 2023, 8
|
5775
|
+
deprecate :Organization, :none, 2023, 8
|
5776
|
+
deprecate :Organization=, :none, 2023, 8
|
5438
5777
|
|
5439
5778
|
def initialize(taskid=nil, operator=nil, agent=nil, organization=nil)
|
5440
5779
|
@TaskId = taskid
|
@@ -5892,16 +6231,16 @@ module TencentCloud
|
|
5892
6231
|
|
5893
6232
|
attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
|
5894
6233
|
extend Gem::Deprecate
|
5895
|
-
deprecate :OrganizationId, :none, 2023,
|
5896
|
-
deprecate :OrganizationId=, :none, 2023,
|
5897
|
-
deprecate :Channel, :none, 2023,
|
5898
|
-
deprecate :Channel=, :none, 2023,
|
5899
|
-
deprecate :OrganizationOpenId, :none, 2023,
|
5900
|
-
deprecate :OrganizationOpenId=, :none, 2023,
|
5901
|
-
deprecate :ClientIp, :none, 2023,
|
5902
|
-
deprecate :ClientIp=, :none, 2023,
|
5903
|
-
deprecate :ProxyIp, :none, 2023,
|
5904
|
-
deprecate :ProxyIp=, :none, 2023,
|
6234
|
+
deprecate :OrganizationId, :none, 2023, 8
|
6235
|
+
deprecate :OrganizationId=, :none, 2023, 8
|
6236
|
+
deprecate :Channel, :none, 2023, 8
|
6237
|
+
deprecate :Channel=, :none, 2023, 8
|
6238
|
+
deprecate :OrganizationOpenId, :none, 2023, 8
|
6239
|
+
deprecate :OrganizationOpenId=, :none, 2023, 8
|
6240
|
+
deprecate :ClientIp, :none, 2023, 8
|
6241
|
+
deprecate :ClientIp=, :none, 2023, 8
|
6242
|
+
deprecate :ProxyIp, :none, 2023, 8
|
6243
|
+
deprecate :ProxyIp=, :none, 2023, 8
|
5905
6244
|
|
5906
6245
|
def initialize(organizationid=nil, channel=nil, organizationopenid=nil, clientip=nil, proxyip=nil)
|
5907
6246
|
@OrganizationId = organizationid
|
@@ -5934,9 +6273,9 @@ module TencentCloud
|
|
5934
6273
|
# @type SignAlgorithm: String
|
5935
6274
|
# @param CertSn: 签名证书序列号
|
5936
6275
|
# @type CertSn: String
|
5937
|
-
# @param CertNotBefore:
|
6276
|
+
# @param CertNotBefore: 证书起始时间戳,单位毫秒
|
5938
6277
|
# @type CertNotBefore: Integer
|
5939
|
-
# @param CertNotAfter:
|
6278
|
+
# @param CertNotAfter: 证书过期时间戳,单位毫秒
|
5940
6279
|
# @type CertNotAfter: Integer
|
5941
6280
|
# @param ComponentPosX: 签名域横坐标,单位pt
|
5942
6281
|
# @type ComponentPosX: Float
|
@@ -5984,33 +6323,43 @@ module TencentCloud
|
|
5984
6323
|
end
|
5985
6324
|
end
|
5986
6325
|
|
5987
|
-
#
|
6326
|
+
# 流程中参与方的信息结构
|
5988
6327
|
class Recipient < TencentCloud::Common::AbstractModel
|
5989
|
-
# @param RecipientId: 签署参与者ID
|
6328
|
+
# @param RecipientId: 签署参与者ID,唯一标识
|
5990
6329
|
# @type RecipientId: String
|
5991
|
-
# @param RecipientType:
|
6330
|
+
# @param RecipientType: 参与者类型。
|
6331
|
+
# 默认为空。
|
6332
|
+
# ENTERPRISE-企业;
|
6333
|
+
# INDIVIDUAL-个人;
|
6334
|
+
# PROMOTER-发起方
|
5992
6335
|
# @type RecipientType: String
|
5993
6336
|
# @param Description: 描述信息
|
5994
6337
|
# @type Description: String
|
5995
6338
|
# @param RoleName: 角色名称
|
5996
6339
|
# @type RoleName: String
|
5997
|
-
# @param RequireValidation:
|
6340
|
+
# @param RequireValidation: 是否需要验证,
|
6341
|
+
# 默认为false-不需要验证
|
5998
6342
|
# @type RequireValidation: Boolean
|
5999
|
-
# @param RequireSign:
|
6343
|
+
# @param RequireSign: 是否需要签署,
|
6344
|
+
# 默认为true-需要签署
|
6000
6345
|
# @type RequireSign: Boolean
|
6001
|
-
# @param RoutingOrder:
|
6346
|
+
# @param RoutingOrder: 此参与方添加的顺序,从0~N
|
6002
6347
|
# @type RoutingOrder: Integer
|
6003
|
-
# @param RequireDelivery:
|
6348
|
+
# @param RequireDelivery: 是否需要发送,
|
6349
|
+
# 默认为true-需要发送
|
6004
6350
|
# @type RequireDelivery: Boolean
|
6005
6351
|
# @param Email: 邮箱地址
|
6006
6352
|
# @type Email: String
|
6007
6353
|
# @param Mobile: 电话号码
|
6008
6354
|
# @type Mobile: String
|
6009
|
-
# @param UserId: 关联的用户ID
|
6355
|
+
# @param UserId: 关联的用户ID,电子签系统的用户ID
|
6010
6356
|
# @type UserId: String
|
6011
|
-
# @param DeliveryMethod:
|
6357
|
+
# @param DeliveryMethod: 发送方式,默认为EMAIL。
|
6358
|
+
# EMAIL-邮件;
|
6359
|
+
# MOBILE-手机短信;
|
6360
|
+
# WECHAT-微信通知
|
6012
6361
|
# @type DeliveryMethod: String
|
6013
|
-
# @param RecipientExtra:
|
6362
|
+
# @param RecipientExtra: 参与方的一些附属信息,json格式
|
6014
6363
|
# @type RecipientExtra: String
|
6015
6364
|
|
6016
6365
|
attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra
|
@@ -6098,8 +6447,8 @@ module TencentCloud
|
|
6098
6447
|
|
6099
6448
|
attr_accessor :LegalName, :Uscc, :UnifiedSocialCreditCode
|
6100
6449
|
extend Gem::Deprecate
|
6101
|
-
deprecate :Uscc, :none, 2023,
|
6102
|
-
deprecate :Uscc=, :none, 2023,
|
6450
|
+
deprecate :Uscc, :none, 2023, 8
|
6451
|
+
deprecate :Uscc=, :none, 2023, 8
|
6103
6452
|
|
6104
6453
|
def initialize(legalname=nil, uscc=nil, unifiedsocialcreditcode=nil)
|
6105
6454
|
@LegalName = legalname
|
@@ -6233,14 +6582,33 @@ module TencentCloud
|
|
6233
6582
|
end
|
6234
6583
|
end
|
6235
6584
|
|
6236
|
-
#
|
6585
|
+
# 模板中指定的印章信息
|
6237
6586
|
class SealInfo < TencentCloud::Common::AbstractModel
|
6587
|
+
# @param SealId: 印章ID
|
6588
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6589
|
+
# @type SealId: String
|
6590
|
+
# @param SealType: 印章类型。LEGAL_PERSON_SEAL: 法定代表人章;
|
6591
|
+
# ORGANIZATIONSEAL:企业印章;
|
6592
|
+
# OFFICIAL:企业公章;
|
6593
|
+
# CONTRACT:合同专用章
|
6594
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6595
|
+
# @type SealType: String
|
6596
|
+
# @param SealName: 印章名称
|
6597
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6598
|
+
# @type SealName: String
|
6238
6599
|
|
6600
|
+
attr_accessor :SealId, :SealType, :SealName
|
6239
6601
|
|
6240
|
-
def initialize()
|
6602
|
+
def initialize(sealid=nil, sealtype=nil, sealname=nil)
|
6603
|
+
@SealId = sealid
|
6604
|
+
@SealType = sealtype
|
6605
|
+
@SealName = sealname
|
6241
6606
|
end
|
6242
6607
|
|
6243
6608
|
def deserialize(params)
|
6609
|
+
@SealId = params['SealId']
|
6610
|
+
@SealType = params['SealType']
|
6611
|
+
@SealName = params['SealName']
|
6244
6612
|
end
|
6245
6613
|
end
|
6246
6614
|
|
@@ -6547,44 +6915,59 @@ module TencentCloud
|
|
6547
6915
|
end
|
6548
6916
|
end
|
6549
6917
|
|
6550
|
-
#
|
6918
|
+
# 此结构体 (TemplateInfo) 用于描述模板的信息。
|
6919
|
+
|
6920
|
+
# > **模板组成**
|
6921
|
+
# >
|
6922
|
+
# > 一个模板通常会包含以下结构信息
|
6923
|
+
# >- 模板基本信息
|
6924
|
+
# >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
6925
|
+
# >- 填写控件 Components
|
6926
|
+
# >- 签署控件 SignComponents
|
6927
|
+
# >- 生成模板的文件基础信息 FileInfos
|
6551
6928
|
class TemplateInfo < TencentCloud::Common::AbstractModel
|
6552
|
-
# @param TemplateId: 模板ID
|
6929
|
+
# @param TemplateId: 模板ID,模板的唯一标识
|
6553
6930
|
# @type TemplateId: String
|
6554
|
-
# @param TemplateName:
|
6931
|
+
# @param TemplateName: 模板名
|
6555
6932
|
# @type TemplateName: String
|
6556
6933
|
# @param Description: 模板描述信息
|
6557
6934
|
# @type Description: String
|
6558
6935
|
# @param DocumentResourceIds: 模板关联的资源ID列表
|
6559
6936
|
# @type DocumentResourceIds: Array
|
6560
|
-
# @param FileInfos:
|
6937
|
+
# @param FileInfos: 生成模板的文件基础信息
|
6561
6938
|
# @type FileInfos: Array
|
6562
6939
|
# @param AttachmentResourceIds: 附件关联的资源ID
|
6563
6940
|
# @type AttachmentResourceIds: Array
|
6564
6941
|
# @param SignOrder: 签署顺序
|
6942
|
+
# 无序 -1
|
6943
|
+
# 有序为序列数字 0,1,2
|
6565
6944
|
# @type SignOrder: Array
|
6566
|
-
# @param Recipients:
|
6945
|
+
# @param Recipients: 模板中的签署参与方列表
|
6567
6946
|
# @type Recipients: Array
|
6568
|
-
# @param Components:
|
6947
|
+
# @param Components: 模板的填充控件列表
|
6569
6948
|
# @type Components: Array
|
6570
|
-
# @param SignComponents:
|
6949
|
+
# @param SignComponents: 模板中的签署控件列表
|
6571
6950
|
# @type SignComponents: Array
|
6572
|
-
# @param Status: 模板状态
|
6951
|
+
# @param Status: 模板状态
|
6952
|
+
# -1:不可用
|
6953
|
+
# 0:草稿态
|
6954
|
+
# 1:正式态,可以正常使用
|
6573
6955
|
# @type Status: Integer
|
6574
|
-
# @param Creator:
|
6956
|
+
# @param Creator: 模板的创建者信息,电子签系统用户ID
|
6575
6957
|
# @type Creator: String
|
6576
|
-
# @param CreatedOn:
|
6958
|
+
# @param CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
|
6577
6959
|
# @type CreatedOn: Integer
|
6578
|
-
# @param Promoter:
|
6960
|
+
# @param Promoter: 发起方参与信息Promoter
|
6579
6961
|
# @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
|
6580
|
-
# @param TemplateType:
|
6581
|
-
# 取值:
|
6962
|
+
# @param TemplateType: 模板类型:
|
6582
6963
|
# 1 静默签,
|
6583
6964
|
# 3 普通模板
|
6584
6965
|
# @type TemplateType: Integer
|
6585
|
-
# @param Available:
|
6966
|
+
# @param Available: 模板可用状态:
|
6967
|
+
# 1 启用(默认)
|
6968
|
+
# 2 停用
|
6586
6969
|
# @type Available: Integer
|
6587
|
-
# @param OrganizationId:
|
6970
|
+
# @param OrganizationId: 创建模板的企业ID,电子签的机构ID
|
6588
6971
|
# @type OrganizationId: String
|
6589
6972
|
# @param PreviewUrl: 模板预览链接,有效时间5分钟
|
6590
6973
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
@@ -6592,7 +6975,9 @@ module TencentCloud
|
|
6592
6975
|
# @param TemplateVersion: 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
|
6593
6976
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6594
6977
|
# @type TemplateVersion: String
|
6595
|
-
# @param Published:
|
6978
|
+
# @param Published: 模板是否已发布:
|
6979
|
+
# true-已发布
|
6980
|
+
# false-未发布
|
6596
6981
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6597
6982
|
# @type Published: Boolean
|
6598
6983
|
# @param TemplateSeals: 模板内部指定的印章列表
|
@@ -6604,8 +6989,8 @@ module TencentCloud
|
|
6604
6989
|
|
6605
6990
|
attr_accessor :TemplateId, :TemplateName, :Description, :DocumentResourceIds, :FileInfos, :AttachmentResourceIds, :SignOrder, :Recipients, :Components, :SignComponents, :Status, :Creator, :CreatedOn, :Promoter, :TemplateType, :Available, :OrganizationId, :PreviewUrl, :TemplateVersion, :Published, :TemplateSeals, :Seals
|
6606
6991
|
extend Gem::Deprecate
|
6607
|
-
deprecate :Seals, :none, 2023,
|
6608
|
-
deprecate :Seals=, :none, 2023,
|
6992
|
+
deprecate :Seals, :none, 2023, 8
|
6993
|
+
deprecate :Seals=, :none, 2023, 8
|
6609
6994
|
|
6610
6995
|
def initialize(templateid=nil, templatename=nil, description=nil, documentresourceids=nil, fileinfos=nil, attachmentresourceids=nil, signorder=nil, recipients=nil, components=nil, signcomponents=nil, status=nil, creator=nil, createdon=nil, promoter=nil, templatetype=nil, available=nil, organizationid=nil, previewurl=nil, templateversion=nil, published=nil, templateseals=nil, seals=nil)
|
6611
6996
|
@TemplateId = templateid
|
@@ -6759,7 +7144,7 @@ module TencentCloud
|
|
6759
7144
|
|
6760
7145
|
# UpdateIntegrationEmployees请求参数结构体
|
6761
7146
|
class UpdateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
|
6762
|
-
# @param Operator:
|
7147
|
+
# @param Operator: 当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;
|
6763
7148
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
6764
7149
|
# @param Employees: 员工信息,不超过100个。
|
6765
7150
|
# 根据UserId或OpenId更新员工,必填一个,优先UserId。
|
@@ -6879,8 +7264,8 @@ module TencentCloud
|
|
6879
7264
|
|
6880
7265
|
attr_accessor :BusinessType, :Caller, :FileInfos, :FileType, :CoverRect, :CustomIds, :FileUrls
|
6881
7266
|
extend Gem::Deprecate
|
6882
|
-
deprecate :FileUrls, :none, 2023,
|
6883
|
-
deprecate :FileUrls=, :none, 2023,
|
7267
|
+
deprecate :FileUrls, :none, 2023, 8
|
7268
|
+
deprecate :FileUrls=, :none, 2023, 8
|
6884
7269
|
|
6885
7270
|
def initialize(businesstype=nil, caller=nil, fileinfos=nil, filetype=nil, coverrect=nil, customids=nil, fileurls=nil)
|
6886
7271
|
@BusinessType = businesstype
|
@@ -6952,14 +7337,14 @@ module TencentCloud
|
|
6952
7337
|
|
6953
7338
|
attr_accessor :UserId, :Channel, :OpenId, :ClientIp, :ProxyIp
|
6954
7339
|
extend Gem::Deprecate
|
6955
|
-
deprecate :Channel, :none, 2023,
|
6956
|
-
deprecate :Channel=, :none, 2023,
|
6957
|
-
deprecate :OpenId, :none, 2023,
|
6958
|
-
deprecate :OpenId=, :none, 2023,
|
6959
|
-
deprecate :ClientIp, :none, 2023,
|
6960
|
-
deprecate :ClientIp=, :none, 2023,
|
6961
|
-
deprecate :ProxyIp, :none, 2023,
|
6962
|
-
deprecate :ProxyIp=, :none, 2023,
|
7340
|
+
deprecate :Channel, :none, 2023, 8
|
7341
|
+
deprecate :Channel=, :none, 2023, 8
|
7342
|
+
deprecate :OpenId, :none, 2023, 8
|
7343
|
+
deprecate :OpenId=, :none, 2023, 8
|
7344
|
+
deprecate :ClientIp, :none, 2023, 8
|
7345
|
+
deprecate :ClientIp=, :none, 2023, 8
|
7346
|
+
deprecate :ProxyIp, :none, 2023, 8
|
7347
|
+
deprecate :ProxyIp=, :none, 2023, 8
|
6963
7348
|
|
6964
7349
|
def initialize(userid=nil, channel=nil, openid=nil, clientip=nil, proxyip=nil)
|
6965
7350
|
@UserId = userid
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tencentcloud-sdk-ess
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.626
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-08-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|