tencentcloud-sdk-ess 3.0.624 → 3.0.625

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ec4f0ebc12c5d36c7a173d5985f87849f9247318
4
- data.tar.gz: 4df263779adca30edde79d9c94f94097ad151353
3
+ metadata.gz: 51acd12bd64d1deffcf445f8b448969a17af752f
4
+ data.tar.gz: 53114ff10e2ef6fb361507a5b5b28c5ab0d183fb
5
5
  SHA512:
6
- metadata.gz: d25169e815d3f3e2218e6d3fa202941877207dec64ede76d4452569232d7628cc4a1ce39d9e4084a80349d341f707514f239cbd2932c4116c0d9e154d1ffaaec
7
- data.tar.gz: 58e7f34630351eb9640ece81719baa4d1dd0f22693c4c3833a1c58d7436a1b23d10e34ff17fb8fc1d4fa8d4ba2183c3674c4cb0a771d75e4cd58a613fe48d346
6
+ metadata.gz: bb0900bde999a247be7b7e3a274d8e54c020b5bd033851c13e1547c83e1db212c14f09ead42007a43f19646fae725b069fb309d29e065dc4e947d9241fc3537e
7
+ data.tar.gz: bda863e8a7c3331b96d016ec62ebc510413a8b7cc77da9fe5358be1d392a60313bda19c315dd5ee022a779ad8c974ba9274382fac5656ea05f99ab8518ff2a48
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.624
1
+ 3.0.625
@@ -631,8 +631,8 @@ module TencentCloud
631
631
  end
632
632
 
633
633
  # 创建快速发起流程
634
- # 适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
635
- # 注:该接口文件的resourceId 是通过上传文件之后获取的。
634
+ # <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
635
+ # <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
636
636
 
637
637
  # @param request: Request instance for CreatePrepareFlow.
638
638
  # @type request: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowRequest`
@@ -1458,7 +1458,8 @@ module TencentCloud
1458
1458
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1459
1459
  end
1460
1460
 
1461
- # 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号
1461
+ # 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
1462
+ # 可进行批量操作,Employees中的userID与openID二选一必填
1462
1463
 
1463
1464
  # @param request: Request instance for UpdateIntegrationEmployees.
1464
1465
  # @type request: :class:`Tencentcloud::ess::V20201111::UpdateIntegrationEmployeesRequest`
@@ -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, 7
56
- deprecate :AppId=, :none, 2023, 7
57
- deprecate :ProxyAppId, :none, 2023, 7
58
- deprecate :ProxyAppId=, :none, 2023, 7
59
- deprecate :ProxyOperator, :none, 2023, 7
60
- deprecate :ProxyOperator=, :none, 2023, 7
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, 7
372
- deprecate :Token=, :none, 2023, 7
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, 7
403
- deprecate :ApplicationId=, :none, 2023, 7
404
- deprecate :OrganizationId, :none, 2023, 7
405
- deprecate :OrganizationId=, :none, 2023, 7
406
- deprecate :SubOrganizationId, :none, 2023, 7
407
- deprecate :SubOrganizationId=, :none, 2023, 7
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)。目前单文件的情况下,值是0
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: 查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
639
+ # @param ComponentId: 控件唯一ID。
640
+ # 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
639
641
  # @type ComponentId: String
640
- # @param ComponentName: 查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
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: 控件关联的签署人ID
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: 是否是表单域类型,默认不false-不是
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: 第三方应用集成平台模板控件 id 标识
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: 第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义
773
+ # @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。
774
+ # 0-平台指定;
775
+ # 1-用户自定义
771
776
  # @type ChannelComponentSource: Integer
772
- # @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
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: 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
784
+ # @param RelativeLocation: 关键字位置模式,
785
+ # Middle-居中,
786
+ # Below-正下方,
787
+ # Right-正右方,
788
+ # LowerRight-右上角,
789
+ # UpperRight-右下角。
790
+ # 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
778
791
  # @type RelativeLocation: String
779
- # @param KeywordIndexes: 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
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, 7
966
- deprecate :Agent=, :none, 2023, 7
967
- deprecate :Organization, :none, 2023, 7
968
- deprecate :Organization=, :none, 2023, 7
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 必填
@@ -1711,10 +1817,10 @@ module TencentCloud
1711
1817
 
1712
1818
  attr_accessor :Operator, :FlowName, :Approvers, :FlowType, :ClientToken, :DeadLine, :RemindedOn, :UserData, :FlowDescription, :Unordered, :CustomShowMap, :NeedSignReview, :Agent, :CcInfos, :AutoSignScene, :RelatedFlowId, :CallbackUrl
1713
1819
  extend Gem::Deprecate
1714
- deprecate :RelatedFlowId, :none, 2023, 7
1715
- deprecate :RelatedFlowId=, :none, 2023, 7
1716
- deprecate :CallbackUrl, :none, 2023, 7
1717
- deprecate :CallbackUrl=, :none, 2023, 7
1820
+ deprecate :RelatedFlowId, :none, 2023, 8
1821
+ deprecate :RelatedFlowId=, :none, 2023, 8
1822
+ deprecate :CallbackUrl, :none, 2023, 8
1823
+ deprecate :CallbackUrl=, :none, 2023, 8
1718
1824
 
1719
1825
  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
1826
  @Operator = operator
@@ -1889,8 +1995,8 @@ module TencentCloud
1889
1995
 
1890
1996
  attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
1891
1997
  extend Gem::Deprecate
1892
- deprecate :Organization, :none, 2023, 7
1893
- deprecate :Organization=, :none, 2023, 7
1998
+ deprecate :Organization, :none, 2023, 8
1999
+ deprecate :Organization=, :none, 2023, 8
1894
2000
 
1895
2001
  def initialize(flowid=nil, flowapproverinfos=nil, operator=nil, agent=nil, organization=nil, jumpurl=nil)
1896
2002
  @FlowId = flowid
@@ -2166,10 +2272,10 @@ module TencentCloud
2166
2272
 
2167
2273
  attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
2168
2274
  extend Gem::Deprecate
2169
- deprecate :Agent, :none, 2023, 7
2170
- deprecate :Agent=, :none, 2023, 7
2171
- deprecate :ApproverRestrictions, :none, 2023, 7
2172
- deprecate :ApproverRestrictions=, :none, 2023, 7
2275
+ deprecate :Agent, :none, 2023, 8
2276
+ deprecate :Agent=, :none, 2023, 8
2277
+ deprecate :ApproverRestrictions, :none, 2023, 8
2278
+ deprecate :ApproverRestrictions=, :none, 2023, 8
2173
2279
 
2174
2280
  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
2281
  @Operator = operator
@@ -2320,23 +2426,60 @@ module TencentCloud
2320
2426
  # @type ResourceId: String
2321
2427
  # @param FlowName: 合同名称
2322
2428
  # @type FlowName: String
2323
- # @param Unordered: 是否顺序签署(true:无序签,false:顺序签)
2429
+ # @param Unordered: 是否顺序签署
2430
+ # true:无序签
2431
+ # false:顺序签
2324
2432
  # @type Unordered: Boolean
2325
2433
  # @param Deadline: 签署流程的签署截止时间。
2326
- # 值为unix时间戳,精确到秒,不传默认为当前时间一年后
2434
+ # 值为unix时间戳,精确到秒
2435
+ # 不传默认为当前时间一年后
2327
2436
  # @type Deadline: Integer
2328
- # @param UserFlowTypeId: 用户自定义合同类型
2437
+ # @param UserFlowTypeId: 用户自定义合同类型Id
2438
+ # 该id为电子签企业内的合同类型id
2329
2439
  # @type UserFlowTypeId: String
2330
2440
  # @param Approvers: 签署流程参与者信息,最大限制50方
2331
2441
  # @type Approvers: Array
2332
- # @param IntelligentStatus: 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
2442
+ # @param IntelligentStatus: 打开智能添加填写区
2443
+ # (默认开启,打开:"OPEN"
2444
+ # 关闭:"CLOSE"
2333
2445
  # @type IntelligentStatus: String
2446
+ # @param ResourceType: 资源类型,
2447
+ # 1:文件,
2448
+ # 2:模板
2449
+ # 不传默认为1:文件
2450
+ # 目前仅支持文件
2451
+ # @type ResourceType: Integer
2452
+ # @param Components: 发起方填写控件
2453
+ # 该类型控件由发起方完成填写
2454
+ # @type Components: :class:`Tencentcloud::Ess.v20201111.models.Component`
2455
+ # @param FlowOption: 发起合同个性化参数
2456
+ # 用于满足创建及页面操作过程中的个性化要求
2457
+ # 具体定制化内容详见数据接口说明
2458
+ # @type FlowOption: :class:`Tencentcloud::Ess.v20201111.models.CreateFlowOption`
2459
+ # @param NeedSignReview: 是否开启发起方签署审核
2460
+ # true:开启发起方签署审核
2461
+ # false:不开启发起方签署审核
2462
+ # 默认false:不开启发起方签署审核
2463
+ # @type NeedSignReview: Boolean
2464
+ # @param NeedCreateReview: 开启发起方发起合同审核
2465
+ # true:开启发起方发起合同审核
2466
+ # false:不开启发起方发起合同审核
2467
+ # 默认false:不开启发起方发起合同审核
2468
+ # @type NeedCreateReview: Boolean
2469
+ # @param UserData: 用户自定义参数
2470
+ # @type UserData: String
2471
+ # @param FlowId: 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
2472
+ # @type FlowId: String
2473
+ # @param FlowType: 合同类型名称
2474
+ # 该字段用于客户自定义合同类型
2475
+ # 建议使用时指定合同类型,便于之后合同分类以及查看
2476
+ # @type FlowType: String
2334
2477
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2335
2478
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2336
2479
 
2337
- attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :Approvers, :IntelligentStatus, :Agent
2480
+ attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :FlowType, :Agent
2338
2481
 
2339
- def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, approvers=nil, intelligentstatus=nil, agent=nil)
2482
+ 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
2483
  @Operator = operator
2341
2484
  @ResourceId = resourceid
2342
2485
  @FlowName = flowname
@@ -2345,6 +2488,14 @@ module TencentCloud
2345
2488
  @UserFlowTypeId = userflowtypeid
2346
2489
  @Approvers = approvers
2347
2490
  @IntelligentStatus = intelligentstatus
2491
+ @ResourceType = resourcetype
2492
+ @Components = components
2493
+ @FlowOption = flowoption
2494
+ @NeedSignReview = needsignreview
2495
+ @NeedCreateReview = needcreatereview
2496
+ @UserData = userdata
2497
+ @FlowId = flowid
2498
+ @FlowType = flowtype
2348
2499
  @Agent = agent
2349
2500
  end
2350
2501
 
@@ -2367,6 +2518,20 @@ module TencentCloud
2367
2518
  end
2368
2519
  end
2369
2520
  @IntelligentStatus = params['IntelligentStatus']
2521
+ @ResourceType = params['ResourceType']
2522
+ unless params['Components'].nil?
2523
+ @Components = Component.new
2524
+ @Components.deserialize(params['Components'])
2525
+ end
2526
+ unless params['FlowOption'].nil?
2527
+ @FlowOption = CreateFlowOption.new
2528
+ @FlowOption.deserialize(params['FlowOption'])
2529
+ end
2530
+ @NeedSignReview = params['NeedSignReview']
2531
+ @NeedCreateReview = params['NeedCreateReview']
2532
+ @UserData = params['UserData']
2533
+ @FlowId = params['FlowId']
2534
+ @FlowType = params['FlowType']
2370
2535
  unless params['Agent'].nil?
2371
2536
  @Agent = Agent.new
2372
2537
  @Agent.deserialize(params['Agent'])
@@ -2440,8 +2605,8 @@ module TencentCloud
2440
2605
 
2441
2606
  attr_accessor :UserName, :IdCardNumber, :SealName, :Operator, :IdCardType, :SealImage, :SealImageCompress, :Mobile, :EnableAutoSign, :SealColor, :ProcessSeal, :FileId
2442
2607
  extend Gem::Deprecate
2443
- deprecate :SealImage, :none, 2023, 7
2444
- deprecate :SealImage=, :none, 2023, 7
2608
+ deprecate :SealImage, :none, 2023, 8
2609
+ deprecate :SealImage=, :none, 2023, 8
2445
2610
 
2446
2611
  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
2612
  @UserName = username
@@ -3387,12 +3552,12 @@ module TencentCloud
3387
3552
 
3388
3553
  attr_accessor :Operator, :BusinessType, :BusinessIds, :FileName, :FileType, :Offset, :Limit, :UrlTtl, :CcToken, :Scene, :Agent
3389
3554
  extend Gem::Deprecate
3390
- deprecate :CcToken, :none, 2023, 7
3391
- deprecate :CcToken=, :none, 2023, 7
3392
- deprecate :Scene, :none, 2023, 7
3393
- deprecate :Scene=, :none, 2023, 7
3394
- deprecate :Agent, :none, 2023, 7
3395
- deprecate :Agent=, :none, 2023, 7
3555
+ deprecate :CcToken, :none, 2023, 8
3556
+ deprecate :CcToken=, :none, 2023, 8
3557
+ deprecate :Scene, :none, 2023, 8
3558
+ deprecate :Scene=, :none, 2023, 8
3559
+ deprecate :Agent, :none, 2023, 8
3560
+ deprecate :Agent=, :none, 2023, 8
3396
3561
 
3397
3562
  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
3563
  @Operator = operator
@@ -3711,7 +3876,7 @@ module TencentCloud
3711
3876
  class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
3712
3877
  # @param Operator: 调用方员工/经办人信息
3713
3878
  # UserId 必填,在企业控制台组织架构中可以查到员工的UserId
3714
- # 注:请保证对应
3879
+ # 注:请保证员工有相关的角色权限
3715
3880
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3716
3881
  # @param Agent: 代理相关应用信息
3717
3882
  # 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
@@ -3742,12 +3907,12 @@ module TencentCloud
3742
3907
 
3743
3908
  attr_accessor :Operator, :Agent, :ContentType, :Filters, :Offset, :Limit, :ApplicationId, :IsChannel, :Organization, :GenerateSource
3744
3909
  extend Gem::Deprecate
3745
- deprecate :IsChannel, :none, 2023, 7
3746
- deprecate :IsChannel=, :none, 2023, 7
3747
- deprecate :Organization, :none, 2023, 7
3748
- deprecate :Organization=, :none, 2023, 7
3749
- deprecate :GenerateSource, :none, 2023, 7
3750
- deprecate :GenerateSource=, :none, 2023, 7
3910
+ deprecate :IsChannel, :none, 2023, 8
3911
+ deprecate :IsChannel=, :none, 2023, 8
3912
+ deprecate :Organization, :none, 2023, 8
3913
+ deprecate :Organization=, :none, 2023, 8
3914
+ deprecate :GenerateSource, :none, 2023, 8
3915
+ deprecate :GenerateSource=, :none, 2023, 8
3751
3916
 
3752
3917
  def initialize(operator=nil, agent=nil, contenttype=nil, filters=nil, offset=nil, limit=nil, applicationid=nil, ischannel=nil, organization=nil, generatesource=nil)
3753
3918
  @Operator = operator
@@ -4445,6 +4610,32 @@ module TencentCloud
4445
4610
  end
4446
4611
  end
4447
4612
 
4613
+ # 个性化参数
4614
+ class EmbedUrlOption < TencentCloud::Common::AbstractModel
4615
+ # @param ShowFlowDetailComponent: 合同详情预览,允许展示控件信息
4616
+ # <br/>true:允许在合同详情页展示控件
4617
+ # <br/>false:不允许在合同详情页展示控件
4618
+ # <br/>默认false,合同详情页不展示控件
4619
+ # @type ShowFlowDetailComponent: Boolean
4620
+ # @param ShowTemplateComponent: 模版预览,允许展示模版控件信息
4621
+ # <br/>true:允许在模版预览页展示控件
4622
+ # <br/>false:不允许在模版预览页展示控件
4623
+ # <br/>默认false,模版预览页不展示控件
4624
+ # @type ShowTemplateComponent: Boolean
4625
+
4626
+ attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent
4627
+
4628
+ def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil)
4629
+ @ShowFlowDetailComponent = showflowdetailcomponent
4630
+ @ShowTemplateComponent = showtemplatecomponent
4631
+ end
4632
+
4633
+ def deserialize(params)
4634
+ @ShowFlowDetailComponent = params['ShowFlowDetailComponent']
4635
+ @ShowTemplateComponent = params['ShowTemplateComponent']
4636
+ end
4637
+ end
4638
+
4448
4639
  # 授权服务信息
4449
4640
  class ExtendAuthInfo < TencentCloud::Common::AbstractModel
4450
4641
  # @param Type: 授权服务类型
@@ -4607,13 +4798,13 @@ module TencentCloud
4607
4798
 
4608
4799
  # 模板中文件的信息结构
4609
4800
  class FileInfo < TencentCloud::Common::AbstractModel
4610
- # @param FileId: 文件Id
4801
+ # @param FileId: 文件ID
4611
4802
  # @type FileId: String
4612
4803
  # @param FileName: 文件名
4613
4804
  # @type FileName: String
4614
4805
  # @param FileSize: 文件大小,单位为Byte
4615
4806
  # @type FileSize: Integer
4616
- # @param CreatedOn: 文件上传时间,10位时间戳(精确到秒)
4807
+ # @param CreatedOn: 文件上传时间,格式为Unix标准时间戳(秒)
4617
4808
  # @type CreatedOn: Integer
4618
4809
 
4619
4810
  attr_accessor :FileId, :FileName, :FileSize, :CreatedOn
@@ -4656,16 +4847,17 @@ module TencentCloud
4656
4847
 
4657
4848
  # 补充签署人信息
4658
4849
  # - RecipientId 必须指定
4659
- # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填
4660
- # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填
4850
+ # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
4851
+ # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
4661
4852
  class FillApproverInfo < TencentCloud::Common::AbstractModel
4662
4853
  # @param RecipientId: 对应模板中的参与方ID
4663
4854
  # @type RecipientId: String
4664
4855
  # @param ApproverSource: 签署人来源
4665
4856
  # WEWORKAPP: 企业微信
4857
+ # <br/>仅【企微或签】时指定WEWORKAPP
4666
4858
  # @type ApproverSource: String
4667
4859
  # @param CustomUserId: 企业自定义账号ID
4668
- # WEWORKAPP场景下指企业自有应用获取企微明文的userid
4860
+ # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
4669
4861
  # @type CustomUserId: String
4670
4862
  # @param ApproverName: 补充签署人姓名
4671
4863
  # @type ApproverName: String
@@ -4950,11 +5142,15 @@ module TencentCloud
4950
5142
  # 3:企业静默签署
4951
5143
  # 注:类型为3(企业静默签署)时,会默认完成该签署方的签署。静默签署仅进行盖章操作,不能是手写签名。
4952
5144
  # @type ApproverType: Integer
4953
- # @param OrganizationName: 如果签署方为企业,需要填入企业全称
5145
+ # @param OrganizationName: 签署人企业名称
5146
+ # <br/>当approverType=1 或 approverType=3时,必须指定
5147
+
4954
5148
  # @type OrganizationName: String
4955
5149
  # @param ApproverName: 签署方经办人姓名
5150
+ # <br/>在未指定签署人电子签UserId情况下,为必填参数
4956
5151
  # @type ApproverName: String
4957
5152
  # @param ApproverMobile: 签署方经办人手机号码
5153
+ # <br/>在未指定签署人电子签UserId情况下,为必填参数
4958
5154
  # @type ApproverMobile: String
4959
5155
  # @param ApproverIdCardType: 签署方经办人证件类型ID_CARD 身份证
4960
5156
  # HONGKONG_AND_MACAO 港澳居民来往内地通行证
@@ -4963,22 +5159,33 @@ module TencentCloud
4963
5159
  # @param ApproverIdCardNumber: 签署方经办人证件号码
4964
5160
  # @type ApproverIdCardNumber: String
4965
5161
  # @param RecipientId: 签署方经办人在模板中的参与方ID
5162
+ # <br/>模版发起合同时,该参数为必填项
5163
+ # <br/>文件发起合同是,该参数无序传值
4966
5164
  # @type RecipientId: String
4967
5165
  # @param VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
4968
5166
  # @type VerifyChannel: Array
4969
- # @param NotifyType: 是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信
5167
+ # @param NotifyType: 是否发送短信
5168
+ # <br/>sms--短信通知
5169
+ # <br/>none--不通知
5170
+ # <br/>默认为sms
5171
+ # <br/>发起方=签署方时不发送短信
4970
5172
  # @type NotifyType: String
4971
5173
  # @param IsFullText: 合同强制需要阅读全文,无需传此参数
4972
5174
  # @type IsFullText: Boolean
4973
5175
  # @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
4974
5176
  # @type PreReadTime: Integer
4975
- # @param UserId: 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
5177
+ # @param UserId: 签署方经办人的电子签用户ID
5178
+ # <br/>当未指定签署人姓名+手机号的情况下,该字段毕传
4976
5179
  # @type UserId: String
4977
5180
  # @param Required: 当前只支持true,默认为true
4978
5181
  # @type Required: Boolean
4979
- # @param ApproverSource: 签署人用户来源,企微侧用户请传入:WEWORKAPP
5182
+ # @param ApproverSource: 签署人用户来源
5183
+ # <br/>企微侧用户请传入:WEWORKAPP
4980
5184
  # @type ApproverSource: String
4981
- # @param CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
5185
+ # @param CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度
5186
+ # <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
5187
+ # <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
5188
+ # <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
4982
5189
  # @type CustomApproverTag: String
4983
5190
  # @param RegisterInfo: 快速注册相关信息,目前暂未开放!
4984
5191
  # @type RegisterInfo: :class:`Tencentcloud::Ess.v20201111.models.RegisterInfo`
@@ -4990,11 +5197,16 @@ module TencentCloud
4990
5197
  # - 发起流程时系统自动补充
4991
5198
  # - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
4992
5199
  # @type SignId: String
4993
- # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。
5200
+ # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批
5201
+ # <br>true 则为需要
5202
+ # <br/>false,无序企业内部审批(默认)
5203
+ # <br/>为个人签署方时则由发起方企业审核。
4994
5204
  # @type ApproverNeedSignReview: Boolean
4995
5205
  # @param SignComponents: 签署人签署控件
5206
+ # <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
4996
5207
  # @type SignComponents: Array
4997
5208
  # @param Components: 签署人填写控件
5209
+ # <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
4998
5210
  # @type Components: Array
4999
5211
  # @param ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
5000
5212
  # HANDWRITE – 手写签名
@@ -5009,8 +5221,8 @@ module TencentCloud
5009
5221
 
5010
5222
  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
5223
  extend Gem::Deprecate
5012
- deprecate :JumpUrl, :none, 2023, 7
5013
- deprecate :JumpUrl=, :none, 2023, 7
5224
+ deprecate :JumpUrl, :none, 2023, 8
5225
+ deprecate :JumpUrl=, :none, 2023, 8
5014
5226
 
5015
5227
  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
5228
  @ApproverType = approvertype
@@ -5431,10 +5643,10 @@ module TencentCloud
5431
5643
 
5432
5644
  attr_accessor :TaskId, :Operator, :Agent, :Organization
5433
5645
  extend Gem::Deprecate
5434
- deprecate :Agent, :none, 2023, 7
5435
- deprecate :Agent=, :none, 2023, 7
5436
- deprecate :Organization, :none, 2023, 7
5437
- deprecate :Organization=, :none, 2023, 7
5646
+ deprecate :Agent, :none, 2023, 8
5647
+ deprecate :Agent=, :none, 2023, 8
5648
+ deprecate :Organization, :none, 2023, 8
5649
+ deprecate :Organization=, :none, 2023, 8
5438
5650
 
5439
5651
  def initialize(taskid=nil, operator=nil, agent=nil, organization=nil)
5440
5652
  @TaskId = taskid
@@ -5892,16 +6104,16 @@ module TencentCloud
5892
6104
 
5893
6105
  attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
5894
6106
  extend Gem::Deprecate
5895
- deprecate :OrganizationId, :none, 2023, 7
5896
- deprecate :OrganizationId=, :none, 2023, 7
5897
- deprecate :Channel, :none, 2023, 7
5898
- deprecate :Channel=, :none, 2023, 7
5899
- deprecate :OrganizationOpenId, :none, 2023, 7
5900
- deprecate :OrganizationOpenId=, :none, 2023, 7
5901
- deprecate :ClientIp, :none, 2023, 7
5902
- deprecate :ClientIp=, :none, 2023, 7
5903
- deprecate :ProxyIp, :none, 2023, 7
5904
- deprecate :ProxyIp=, :none, 2023, 7
6107
+ deprecate :OrganizationId, :none, 2023, 8
6108
+ deprecate :OrganizationId=, :none, 2023, 8
6109
+ deprecate :Channel, :none, 2023, 8
6110
+ deprecate :Channel=, :none, 2023, 8
6111
+ deprecate :OrganizationOpenId, :none, 2023, 8
6112
+ deprecate :OrganizationOpenId=, :none, 2023, 8
6113
+ deprecate :ClientIp, :none, 2023, 8
6114
+ deprecate :ClientIp=, :none, 2023, 8
6115
+ deprecate :ProxyIp, :none, 2023, 8
6116
+ deprecate :ProxyIp=, :none, 2023, 8
5905
6117
 
5906
6118
  def initialize(organizationid=nil, channel=nil, organizationopenid=nil, clientip=nil, proxyip=nil)
5907
6119
  @OrganizationId = organizationid
@@ -5934,9 +6146,9 @@ module TencentCloud
5934
6146
  # @type SignAlgorithm: String
5935
6147
  # @param CertSn: 签名证书序列号
5936
6148
  # @type CertSn: String
5937
- # @param CertNotBefore: 证书起始时间戳,单位秒
6149
+ # @param CertNotBefore: 证书起始时间戳,单位毫秒
5938
6150
  # @type CertNotBefore: Integer
5939
- # @param CertNotAfter: 证书过期时间戳,单位秒
6151
+ # @param CertNotAfter: 证书过期时间戳,单位毫秒
5940
6152
  # @type CertNotAfter: Integer
5941
6153
  # @param ComponentPosX: 签名域横坐标,单位pt
5942
6154
  # @type ComponentPosX: Float
@@ -5984,33 +6196,43 @@ module TencentCloud
5984
6196
  end
5985
6197
  end
5986
6198
 
5987
- # 签署参与者信息
6199
+ # 流程中参与方的信息结构
5988
6200
  class Recipient < TencentCloud::Common::AbstractModel
5989
- # @param RecipientId: 签署参与者ID
6201
+ # @param RecipientId: 签署参与者ID,唯一标识
5990
6202
  # @type RecipientId: String
5991
- # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
6203
+ # @param RecipientType: 参与者类型。
6204
+ # 默认为空。
6205
+ # ENTERPRISE-企业;
6206
+ # INDIVIDUAL-个人;
6207
+ # PROMOTER-发起方
5992
6208
  # @type RecipientType: String
5993
6209
  # @param Description: 描述信息
5994
6210
  # @type Description: String
5995
6211
  # @param RoleName: 角色名称
5996
6212
  # @type RoleName: String
5997
- # @param RequireValidation: 是否需要验证,默认为false
6213
+ # @param RequireValidation: 是否需要验证,
6214
+ # 默认为false-不需要验证
5998
6215
  # @type RequireValidation: Boolean
5999
- # @param RequireSign: 是否需要签署,默认为true
6216
+ # @param RequireSign: 是否需要签署,
6217
+ # 默认为true-需要签署
6000
6218
  # @type RequireSign: Boolean
6001
- # @param RoutingOrder: 添加序列,0~N
6219
+ # @param RoutingOrder: 此参与方添加的顺序,从0~N
6002
6220
  # @type RoutingOrder: Integer
6003
- # @param RequireDelivery: 是否需要发送,默认为true
6221
+ # @param RequireDelivery: 是否需要发送,
6222
+ # 默认为true-需要发送
6004
6223
  # @type RequireDelivery: Boolean
6005
6224
  # @param Email: 邮箱地址
6006
6225
  # @type Email: String
6007
6226
  # @param Mobile: 电话号码
6008
6227
  # @type Mobile: String
6009
- # @param UserId: 关联的用户ID
6228
+ # @param UserId: 关联的用户ID,电子签系统的用户ID
6010
6229
  # @type UserId: String
6011
- # @param DeliveryMethod: 发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知
6230
+ # @param DeliveryMethod: 发送方式,默认为EMAIL。
6231
+ # EMAIL-邮件;
6232
+ # MOBILE-手机短信;
6233
+ # WECHAT-微信通知
6012
6234
  # @type DeliveryMethod: String
6013
- # @param RecipientExtra: 附属信息
6235
+ # @param RecipientExtra: 参与方的一些附属信息,json格式
6014
6236
  # @type RecipientExtra: String
6015
6237
 
6016
6238
  attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra
@@ -6098,8 +6320,8 @@ module TencentCloud
6098
6320
 
6099
6321
  attr_accessor :LegalName, :Uscc, :UnifiedSocialCreditCode
6100
6322
  extend Gem::Deprecate
6101
- deprecate :Uscc, :none, 2023, 7
6102
- deprecate :Uscc=, :none, 2023, 7
6323
+ deprecate :Uscc, :none, 2023, 8
6324
+ deprecate :Uscc=, :none, 2023, 8
6103
6325
 
6104
6326
  def initialize(legalname=nil, uscc=nil, unifiedsocialcreditcode=nil)
6105
6327
  @LegalName = legalname
@@ -6233,14 +6455,33 @@ module TencentCloud
6233
6455
  end
6234
6456
  end
6235
6457
 
6236
- # 模板结构体中的印章信息
6458
+ # 模板中指定的印章信息
6237
6459
  class SealInfo < TencentCloud::Common::AbstractModel
6460
+ # @param SealId: 印章ID
6461
+ # 注意:此字段可能返回 null,表示取不到有效值。
6462
+ # @type SealId: String
6463
+ # @param SealType: 印章类型。LEGAL_PERSON_SEAL: 法定代表人章;
6464
+ # ORGANIZATIONSEAL:企业印章;
6465
+ # OFFICIAL:企业公章;
6466
+ # CONTRACT:合同专用章
6467
+ # 注意:此字段可能返回 null,表示取不到有效值。
6468
+ # @type SealType: String
6469
+ # @param SealName: 印章名称
6470
+ # 注意:此字段可能返回 null,表示取不到有效值。
6471
+ # @type SealName: String
6238
6472
 
6473
+ attr_accessor :SealId, :SealType, :SealName
6239
6474
 
6240
- def initialize()
6475
+ def initialize(sealid=nil, sealtype=nil, sealname=nil)
6476
+ @SealId = sealid
6477
+ @SealType = sealtype
6478
+ @SealName = sealname
6241
6479
  end
6242
6480
 
6243
6481
  def deserialize(params)
6482
+ @SealId = params['SealId']
6483
+ @SealType = params['SealType']
6484
+ @SealName = params['SealName']
6244
6485
  end
6245
6486
  end
6246
6487
 
@@ -6547,44 +6788,59 @@ module TencentCloud
6547
6788
  end
6548
6789
  end
6549
6790
 
6550
- # 企业模板的信息结构
6791
+ # 此结构体 (TemplateInfo) 用于描述模板的信息。
6792
+
6793
+ # > **模板组成**
6794
+ # >
6795
+ # > 一个模板通常会包含以下结构信息
6796
+ # >- 模板基本信息
6797
+ # >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
6798
+ # >- 填写控件 Components
6799
+ # >- 签署控件 SignComponents
6800
+ # >- 生成模板的文件基础信息 FileInfos
6551
6801
  class TemplateInfo < TencentCloud::Common::AbstractModel
6552
- # @param TemplateId: 模板ID
6802
+ # @param TemplateId: 模板ID,模板的唯一标识
6553
6803
  # @type TemplateId: String
6554
- # @param TemplateName: 模板名字
6804
+ # @param TemplateName: 模板名
6555
6805
  # @type TemplateName: String
6556
6806
  # @param Description: 模板描述信息
6557
6807
  # @type Description: String
6558
6808
  # @param DocumentResourceIds: 模板关联的资源ID列表
6559
6809
  # @type DocumentResourceIds: Array
6560
- # @param FileInfos: 返回的文件信息结构
6810
+ # @param FileInfos: 生成模板的文件基础信息
6561
6811
  # @type FileInfos: Array
6562
6812
  # @param AttachmentResourceIds: 附件关联的资源ID
6563
6813
  # @type AttachmentResourceIds: Array
6564
6814
  # @param SignOrder: 签署顺序
6815
+ # 无序 -1
6816
+ # 有序为序列数字 0,1,2
6565
6817
  # @type SignOrder: Array
6566
- # @param Recipients: 签署参与者的信息
6818
+ # @param Recipients: 模板中的签署参与方列表
6567
6819
  # @type Recipients: Array
6568
- # @param Components: 模板信息结构
6820
+ # @param Components: 模板的填充控件列表
6569
6821
  # @type Components: Array
6570
- # @param SignComponents: 签署区模板信息结构
6822
+ # @param SignComponents: 模板中的签署控件列表
6571
6823
  # @type SignComponents: Array
6572
- # @param Status: 模板状态(-1:不可用;0:草稿态;1:正式态)
6824
+ # @param Status: 模板状态
6825
+ # -1:不可用
6826
+ # 0:草稿态
6827
+ # 1:正式态,可以正常使用
6573
6828
  # @type Status: Integer
6574
- # @param Creator: 模板的创建人UserId
6829
+ # @param Creator: 模板的创建者信息,电子签系统用户ID
6575
6830
  # @type Creator: String
6576
- # @param CreatedOn: 模板创建的时间戳,单位秒
6831
+ # @param CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
6577
6832
  # @type CreatedOn: Integer
6578
- # @param Promoter: 发起人角色信息
6833
+ # @param Promoter: 发起方参与信息Promoter
6579
6834
  # @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
6580
- # @param TemplateType: 模板类型
6581
- # 取值:
6835
+ # @param TemplateType: 模板类型:
6582
6836
  # 1 静默签,
6583
6837
  # 3 普通模板
6584
6838
  # @type TemplateType: Integer
6585
- # @param Available: 模板可用状态,取值:1启用(默认),2停用
6839
+ # @param Available: 模板可用状态:
6840
+ # 1 启用(默认)
6841
+ # 2 停用
6586
6842
  # @type Available: Integer
6587
- # @param OrganizationId: 创建模板的机构id
6843
+ # @param OrganizationId: 创建模板的企业ID,电子签的机构ID
6588
6844
  # @type OrganizationId: String
6589
6845
  # @param PreviewUrl: 模板预览链接,有效时间5分钟
6590
6846
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -6592,7 +6848,9 @@ module TencentCloud
6592
6848
  # @param TemplateVersion: 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
6593
6849
  # 注意:此字段可能返回 null,表示取不到有效值。
6594
6850
  # @type TemplateVersion: String
6595
- # @param Published: 模板是否已发布。true-已发布;false-未发布
6851
+ # @param Published: 模板是否已发布:
6852
+ # true-已发布
6853
+ # false-未发布
6596
6854
  # 注意:此字段可能返回 null,表示取不到有效值。
6597
6855
  # @type Published: Boolean
6598
6856
  # @param TemplateSeals: 模板内部指定的印章列表
@@ -6604,8 +6862,8 @@ module TencentCloud
6604
6862
 
6605
6863
  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
6864
  extend Gem::Deprecate
6607
- deprecate :Seals, :none, 2023, 7
6608
- deprecate :Seals=, :none, 2023, 7
6865
+ deprecate :Seals, :none, 2023, 8
6866
+ deprecate :Seals=, :none, 2023, 8
6609
6867
 
6610
6868
  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
6869
  @TemplateId = templateid
@@ -6759,7 +7017,7 @@ module TencentCloud
6759
7017
 
6760
7018
  # UpdateIntegrationEmployees请求参数结构体
6761
7019
  class UpdateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
6762
- # @param Operator: 操作人信息,userId必填
7020
+ # @param Operator: 当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;
6763
7021
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
6764
7022
  # @param Employees: 员工信息,不超过100个。
6765
7023
  # 根据UserId或OpenId更新员工,必填一个,优先UserId。
@@ -6879,8 +7137,8 @@ module TencentCloud
6879
7137
 
6880
7138
  attr_accessor :BusinessType, :Caller, :FileInfos, :FileType, :CoverRect, :CustomIds, :FileUrls
6881
7139
  extend Gem::Deprecate
6882
- deprecate :FileUrls, :none, 2023, 7
6883
- deprecate :FileUrls=, :none, 2023, 7
7140
+ deprecate :FileUrls, :none, 2023, 8
7141
+ deprecate :FileUrls=, :none, 2023, 8
6884
7142
 
6885
7143
  def initialize(businesstype=nil, caller=nil, fileinfos=nil, filetype=nil, coverrect=nil, customids=nil, fileurls=nil)
6886
7144
  @BusinessType = businesstype
@@ -6952,14 +7210,14 @@ module TencentCloud
6952
7210
 
6953
7211
  attr_accessor :UserId, :Channel, :OpenId, :ClientIp, :ProxyIp
6954
7212
  extend Gem::Deprecate
6955
- deprecate :Channel, :none, 2023, 7
6956
- deprecate :Channel=, :none, 2023, 7
6957
- deprecate :OpenId, :none, 2023, 7
6958
- deprecate :OpenId=, :none, 2023, 7
6959
- deprecate :ClientIp, :none, 2023, 7
6960
- deprecate :ClientIp=, :none, 2023, 7
6961
- deprecate :ProxyIp, :none, 2023, 7
6962
- deprecate :ProxyIp=, :none, 2023, 7
7213
+ deprecate :Channel, :none, 2023, 8
7214
+ deprecate :Channel=, :none, 2023, 8
7215
+ deprecate :OpenId, :none, 2023, 8
7216
+ deprecate :OpenId=, :none, 2023, 8
7217
+ deprecate :ClientIp, :none, 2023, 8
7218
+ deprecate :ClientIp=, :none, 2023, 8
7219
+ deprecate :ProxyIp, :none, 2023, 8
7220
+ deprecate :ProxyIp=, :none, 2023, 8
6963
7221
 
6964
7222
  def initialize(userid=nil, channel=nil, openid=nil, clientip=nil, proxyip=nil)
6965
7223
  @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.624
4
+ version: 3.0.625
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-31 00:00:00.000000000 Z
11
+ date: 2023-08-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common