tencentcloud-sdk-ess 3.0.623 → 3.0.625

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: aba895f8cbb6089156fb4361585e4b33c8e6a38f
4
- data.tar.gz: 19efb080f4975578c1a0be73cfcfec3169cc5a52
3
+ metadata.gz: 51acd12bd64d1deffcf445f8b448969a17af752f
4
+ data.tar.gz: 53114ff10e2ef6fb361507a5b5b28c5ab0d183fb
5
5
  SHA512:
6
- metadata.gz: a3f44616ad22e01bbb0e57651a5669a7a6a3cbf0d4d7cc98f891936e58a1c821ef7ad3d657d0a95c217fcd1b84875d875518398680a6ad370c17105af8fc4a3a
7
- data.tar.gz: b116fbfebdd782e85c23e5f8d2a310bbf3904e31841abff6e7b26d7a21194997484f51fb6bd06585234351f29a2b9282367520ddad8fe3b2890ba67dc48ec7a8
6
+ metadata.gz: bb0900bde999a247be7b7e3a274d8e54c020b5bd033851c13e1547c83e1db212c14f09ead42007a43f19646fae725b069fb309d29e065dc4e947d9241fc3537e
7
+ data.tar.gz: bda863e8a7c3331b96d016ec62ebc510413a8b7cc77da9fe5358be1d392a60313bda19c315dd5ee022a779ad8c974ba9274382fac5656ea05f99ab8518ff2a48
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.623
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`
@@ -979,9 +979,9 @@ module TencentCloud
979
979
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
980
980
  end
981
981
 
982
- # 查询流程摘要
982
+ # 查询流程基础信息
983
983
  # 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
984
- # 日调用量限制:10W
984
+ # 每个企业限制日调用量限制:10W, 当当日超过此限制后再调用接口返回错误
985
985
 
986
986
  # @param request: Request instance for DescribeFlowBriefs.
987
987
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -1083,6 +1083,7 @@ module TencentCloud
1083
1083
  # 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
1084
1084
 
1085
1085
  # > **适用场景**
1086
+ # >
1086
1087
  # > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
1087
1088
  # > 一个模板通常会包含以下结构信息
1088
1089
  # >- 模板基本信息
@@ -1332,8 +1333,8 @@ module TencentCloud
1332
1333
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1333
1334
  end
1334
1335
 
1335
- # 通过发起转换任务接口(CreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。<br/>
1336
- # 大文件转换所需的时间可能会比较长。
1336
+ # 查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。
1337
+ # 注意:大文件转换所需的时间可能会比较长。
1337
1338
 
1338
1339
  # @param request: Request instance for GetTaskResultApi.
1339
1340
  # @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest`
@@ -1457,7 +1458,8 @@ module TencentCloud
1457
1458
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1458
1459
  end
1459
1460
 
1460
- # 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号
1461
+ # 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
1462
+ # 可进行批量操作,Employees中的userID与openID二选一必填
1461
1463
 
1462
1464
  # @param request: Request instance for UpdateIntegrationEmployees.
1463
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
@@ -249,15 +249,32 @@ module TencentCloud
249
249
  class AutoSignConfig < TencentCloud::Common::AbstractModel
250
250
  # @param UserInfo: 自动签开通个人用户的三要素
251
251
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
252
- # @param CallbackUrl: 接受自动签开启的回调地址。需要保证post返回200
252
+ # @param CallbackUrl: 接受回调URL地址。支持http://或者https://协议
253
+
254
+ # Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
253
255
  # @type CallbackUrl: String
254
- # @param CertInfoCallback: 是否回调证书信息,默认false-不需要
256
+ # @param CertInfoCallback: 是否回调证书信息
257
+ # false-不需要 (默认值)
258
+ # true-需要
255
259
  # @type CertInfoCallback: Boolean
256
- # @param UserDefineSeal: 是否支持用户自定义签名印章,默认false-不需要
260
+ # @param UserDefineSeal: 是否支持用户自定义签名印章
261
+ # false-不需要(默认)
262
+ # true-需要
257
263
  # @type UserDefineSeal: Boolean
258
- # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要
264
+ # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
265
+
266
+ # false-不需要(默认)
267
+ # true-需要(
259
268
  # @type SealImgCallback: Boolean
260
- # @param VerifyChannels: 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
269
+ # @param VerifyChannels: 开通时候的验证方式, 分布为
270
+
271
+ # WEIXINAPP : 微信人脸识别
272
+ # INSIGHT : 慧眼人脸认别
273
+ # TELECOM : 运营商三要素验证
274
+
275
+ # 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
276
+
277
+ # 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
261
278
  # @type VerifyChannels: Array
262
279
 
263
280
  attr_accessor :UserInfo, :CallbackUrl, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :VerifyChannels
@@ -351,8 +368,8 @@ module TencentCloud
351
368
 
352
369
  attr_accessor :CallbackUrl, :Token, :CallbackKey, :CallbackToken
353
370
  extend Gem::Deprecate
354
- deprecate :Token, :none, 2023, 7
355
- deprecate :Token=, :none, 2023, 7
371
+ deprecate :Token, :none, 2023, 8
372
+ deprecate :Token=, :none, 2023, 8
356
373
 
357
374
  def initialize(callbackurl=nil, token=nil, callbackkey=nil, callbacktoken=nil)
358
375
  @CallbackUrl = callbackurl
@@ -382,12 +399,12 @@ module TencentCloud
382
399
 
383
400
  attr_accessor :ApplicationId, :OrganizationId, :OperatorId, :SubOrganizationId
384
401
  extend Gem::Deprecate
385
- deprecate :ApplicationId, :none, 2023, 7
386
- deprecate :ApplicationId=, :none, 2023, 7
387
- deprecate :OrganizationId, :none, 2023, 7
388
- deprecate :OrganizationId=, :none, 2023, 7
389
- deprecate :SubOrganizationId, :none, 2023, 7
390
- 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
391
408
 
392
409
  def initialize(applicationid=nil, organizationid=nil, operatorid=nil, suborganizationid=nil)
393
410
  @ApplicationId = applicationid
@@ -582,7 +599,7 @@ module TencentCloud
582
599
  end
583
600
  end
584
601
 
585
- # 模板控件信息
602
+ # 模板/流程中控件信息,可以是填充控件或签署控件
586
603
  class Component < TencentCloud::Common::AbstractModel
587
604
  # @param ComponentType: 如果是Component填写控件类型,则可选的字段为:
588
605
  # TEXT - 普通文本控件,输入文本字符串;
@@ -606,7 +623,8 @@ module TencentCloud
606
623
 
607
624
  # 表单域的控件不能作为印章和签名控件
608
625
  # @type ComponentType: String
609
- # @param FileIndex: 控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0
626
+ # @param FileIndex: 控件所属文件的序号(取值为:0-N)。
627
+ # 目前单文件的情况下,值是0
610
628
  # @type FileIndex: Integer
611
629
  # @param ComponentHeight: 参数控件高度,单位pt
612
630
  # @type ComponentHeight: Float
@@ -618,13 +636,15 @@ module TencentCloud
618
636
  # @type ComponentPosX: Float
619
637
  # @param ComponentPosY: 参数控件Y位置,单位pt
620
638
  # @type ComponentPosY: Float
621
- # @param ComponentId: 查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
639
+ # @param ComponentId: 控件唯一ID。
640
+ # 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
622
641
  # @type ComponentId: String
623
- # @param ComponentName: 查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
642
+ # @param ComponentName: 控件名。
643
+ # 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
624
644
  # @type ComponentName: String
625
- # @param ComponentRequired: 是否必选,默认为false
645
+ # @param ComponentRequired: 是否必选,默认为false-非必选
626
646
  # @type ComponentRequired: Boolean
627
- # @param ComponentRecipientId: 控件关联的签署人ID
647
+ # @param ComponentRecipientId: 控件关联的参与方ID,对应Recipient结构体中的RecipientId
628
648
  # @type ComponentRecipientId: String
629
649
  # @param ComponentExtra: 扩展参数:
630
650
  # 为JSON格式。
@@ -656,7 +676,7 @@ module TencentCloud
656
676
  # 1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
657
677
  # 参数样例:"ComponentExtra":"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}"
658
678
  # @type ComponentExtra: String
659
- # @param IsFormType: 是否是表单域类型,默认不false-不是
679
+ # @param IsFormType: 是否是表单域类型,默认false-不是
660
680
  # 注意:此字段可能返回 null,表示取不到有效值。
661
681
  # @type IsFormType: Boolean
662
682
  # @param ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
@@ -742,7 +762,7 @@ module TencentCloud
742
762
  # @type GenerateMode: String
743
763
  # @param ComponentDateFontSize: 日期签署控件的字号,默认为 12
744
764
  # @type ComponentDateFontSize: Integer
745
- # @param ChannelComponentId: 第三方应用集成平台模板控件 id 标识
765
+ # @param ChannelComponentId: 第三方应用集成平台模板控件 ID 标识
746
766
  # @type ChannelComponentId: String
747
767
  # @param OffsetX: 指定关键字时横坐标偏移量,单位pt
748
768
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -750,21 +770,41 @@ module TencentCloud
750
770
  # @param OffsetY: 指定关键字时纵坐标偏移量,单位pt
751
771
  # 注意:此字段可能返回 null,表示取不到有效值。
752
772
  # @type OffsetY: Float
753
- # @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义
773
+ # @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。
774
+ # 0-平台指定;
775
+ # 1-用户自定义
754
776
  # @type ChannelComponentSource: Integer
755
- # @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
777
+ # @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。
778
+ # 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
756
779
  # 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
757
780
  # @type KeywordOrder: String
758
- # @param KeywordPage: 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
781
+ # @param KeywordPage: 指定关键字页码。
782
+ # 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
759
783
  # @type KeywordPage: Integer
760
- # @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,则印章在关键字的正下方
761
791
  # @type RelativeLocation: String
762
- # @param KeywordIndexes: 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
792
+ # @param KeywordIndexes: 关键字索引。
793
+ # 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
794
+ # 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
763
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
764
804
 
765
- 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
766
806
 
767
- 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)
768
808
  @ComponentType = componenttype
769
809
  @FileIndex = fileindex
770
810
  @ComponentHeight = componentheight
@@ -789,6 +829,8 @@ module TencentCloud
789
829
  @KeywordPage = keywordpage
790
830
  @RelativeLocation = relativelocation
791
831
  @KeywordIndexes = keywordindexes
832
+ @LockComponentValue = lockcomponentvalue
833
+ @ForbidMoveAndDelete = forbidmoveanddelete
792
834
  end
793
835
 
794
836
  def deserialize(params)
@@ -816,6 +858,8 @@ module TencentCloud
816
858
  @KeywordPage = params['KeywordPage']
817
859
  @RelativeLocation = params['RelativeLocation']
818
860
  @KeywordIndexes = params['KeywordIndexes']
861
+ @LockComponentValue = params['LockComponentValue']
862
+ @ForbidMoveAndDelete = params['ForbidMoveAndDelete']
819
863
  end
820
864
  end
821
865
 
@@ -823,7 +867,8 @@ module TencentCloud
823
867
  class CreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
824
868
  # @param Operator: 调用方用户信息,userId 必填
825
869
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
826
- # @param FlowIds: 需要执行撤回的签署流程id数组,最多100
870
+ # @param FlowIds: 需要执行撤回的流程(合同)的编号列表,最多100个.
871
+ # 列表中的流程(合同)编号不要重复.
827
872
  # @type FlowIds: Array
828
873
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
829
874
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -854,8 +899,11 @@ module TencentCloud
854
899
  # @param BatchCancelFlowUrl: 批量撤回签署流程链接
855
900
  # @type BatchCancelFlowUrl: String
856
901
  # @param FailMessages: 签署流程撤回失败信息
902
+ # 数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
857
903
  # @type FailMessages: Array
858
904
  # @param UrlExpireOn: 签署连接过期时间字符串:年月日-时分秒
905
+
906
+ # 例如:2023-07-28 17:25:59
859
907
  # @type UrlExpireOn: String
860
908
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
861
909
  # @type RequestId: String
@@ -941,10 +989,10 @@ module TencentCloud
941
989
 
942
990
  attr_accessor :ResourceType, :ResourceName, :ResourceId, :Operator, :Agent, :Organization
943
991
  extend Gem::Deprecate
944
- deprecate :Agent, :none, 2023, 7
945
- deprecate :Agent=, :none, 2023, 7
946
- deprecate :Organization, :none, 2023, 7
947
- 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
948
996
 
949
997
  def initialize(resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, agent=nil, organization=nil)
950
998
  @ResourceType = resourcetype
@@ -1090,6 +1138,8 @@ module TencentCloud
1090
1138
  # <br/>PREVIEW_SEAL_LIST:预览印章列表
1091
1139
  # <br/>PREVIEW_SEAL_DETAIL:预览印章详情
1092
1140
  # <br/>EXTEND_SERVICE:拓展服务
1141
+ # <br/>PREVIEW_FLOW:预览合同
1142
+ # <br/>PREVIEW_FLOW_DETAIL:查看合同详情
1093
1143
  # @type EmbedType: String
1094
1144
  # @param BusinessId: WEB嵌入的业务资源ID
1095
1145
  # <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
@@ -1098,15 +1148,18 @@ module TencentCloud
1098
1148
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1099
1149
  # @param Reviewer: 抄送方信息
1100
1150
  # @type Reviewer: :class:`Tencentcloud::Ess.v20201111.models.ReviewerInfo`
1151
+ # @param Option: 个性化参数
1152
+ # @type Option: :class:`Tencentcloud::Ess.v20201111.models.EmbedUrlOption`
1101
1153
 
1102
- attr_accessor :Operator, :EmbedType, :BusinessId, :Agent, :Reviewer
1154
+ attr_accessor :Operator, :EmbedType, :BusinessId, :Agent, :Reviewer, :Option
1103
1155
 
1104
- 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)
1105
1157
  @Operator = operator
1106
1158
  @EmbedType = embedtype
1107
1159
  @BusinessId = businessid
1108
1160
  @Agent = agent
1109
1161
  @Reviewer = reviewer
1162
+ @Option = option
1110
1163
  end
1111
1164
 
1112
1165
  def deserialize(params)
@@ -1124,6 +1177,10 @@ module TencentCloud
1124
1177
  @Reviewer = ReviewerInfo.new
1125
1178
  @Reviewer.deserialize(params['Reviewer'])
1126
1179
  end
1180
+ unless params['Option'].nil?
1181
+ @Option = EmbedUrlOption.new
1182
+ @Option.deserialize(params['Option'])
1183
+ end
1127
1184
  end
1128
1185
  end
1129
1186
 
@@ -1586,6 +1643,76 @@ module TencentCloud
1586
1643
  end
1587
1644
  end
1588
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
+
1589
1716
  # CreateFlowReminds请求参数结构体
1590
1717
  class CreateFlowRemindsRequest < TencentCloud::Common::AbstractModel
1591
1718
  # @param Operator: 调用方用户信息,userId 必填
@@ -1690,10 +1817,10 @@ module TencentCloud
1690
1817
 
1691
1818
  attr_accessor :Operator, :FlowName, :Approvers, :FlowType, :ClientToken, :DeadLine, :RemindedOn, :UserData, :FlowDescription, :Unordered, :CustomShowMap, :NeedSignReview, :Agent, :CcInfos, :AutoSignScene, :RelatedFlowId, :CallbackUrl
1692
1819
  extend Gem::Deprecate
1693
- deprecate :RelatedFlowId, :none, 2023, 7
1694
- deprecate :RelatedFlowId=, :none, 2023, 7
1695
- deprecate :CallbackUrl, :none, 2023, 7
1696
- 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
1697
1824
 
1698
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)
1699
1826
  @Operator = operator
@@ -1801,7 +1928,7 @@ module TencentCloud
1801
1928
  # 默认:SignReview;SignReview:签署审核
1802
1929
 
1803
1930
  # 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
1804
- # 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
1931
+ # 若发起个人审核,则指定该字段为:SignReview
1805
1932
  # @type OperateType: String
1806
1933
 
1807
1934
  attr_accessor :Operator, :FlowId, :ReviewType, :ReviewMessage, :Agent, :RecipientId, :OperateType
@@ -1868,8 +1995,8 @@ module TencentCloud
1868
1995
 
1869
1996
  attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
1870
1997
  extend Gem::Deprecate
1871
- deprecate :Organization, :none, 2023, 7
1872
- deprecate :Organization=, :none, 2023, 7
1998
+ deprecate :Organization, :none, 2023, 8
1999
+ deprecate :Organization=, :none, 2023, 8
1873
2000
 
1874
2001
  def initialize(flowid=nil, flowapproverinfos=nil, operator=nil, agent=nil, organization=nil, jumpurl=nil)
1875
2002
  @FlowId = flowid
@@ -2145,10 +2272,10 @@ module TencentCloud
2145
2272
 
2146
2273
  attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
2147
2274
  extend Gem::Deprecate
2148
- deprecate :Agent, :none, 2023, 7
2149
- deprecate :Agent=, :none, 2023, 7
2150
- deprecate :ApproverRestrictions, :none, 2023, 7
2151
- 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
2152
2279
 
2153
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)
2154
2281
  @Operator = operator
@@ -2299,23 +2426,60 @@ module TencentCloud
2299
2426
  # @type ResourceId: String
2300
2427
  # @param FlowName: 合同名称
2301
2428
  # @type FlowName: String
2302
- # @param Unordered: 是否顺序签署(true:无序签,false:顺序签)
2429
+ # @param Unordered: 是否顺序签署
2430
+ # true:无序签
2431
+ # false:顺序签
2303
2432
  # @type Unordered: Boolean
2304
2433
  # @param Deadline: 签署流程的签署截止时间。
2305
- # 值为unix时间戳,精确到秒,不传默认为当前时间一年后
2434
+ # 值为unix时间戳,精确到秒
2435
+ # 不传默认为当前时间一年后
2306
2436
  # @type Deadline: Integer
2307
- # @param UserFlowTypeId: 用户自定义合同类型
2437
+ # @param UserFlowTypeId: 用户自定义合同类型Id
2438
+ # 该id为电子签企业内的合同类型id
2308
2439
  # @type UserFlowTypeId: String
2309
2440
  # @param Approvers: 签署流程参与者信息,最大限制50方
2310
2441
  # @type Approvers: Array
2311
- # @param IntelligentStatus: 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
2442
+ # @param IntelligentStatus: 打开智能添加填写区
2443
+ # (默认开启,打开:"OPEN"
2444
+ # 关闭:"CLOSE"
2312
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
2313
2477
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2314
2478
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2315
2479
 
2316
- 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
2317
2481
 
2318
- 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)
2319
2483
  @Operator = operator
2320
2484
  @ResourceId = resourceid
2321
2485
  @FlowName = flowname
@@ -2324,6 +2488,14 @@ module TencentCloud
2324
2488
  @UserFlowTypeId = userflowtypeid
2325
2489
  @Approvers = approvers
2326
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
2327
2499
  @Agent = agent
2328
2500
  end
2329
2501
 
@@ -2346,6 +2518,20 @@ module TencentCloud
2346
2518
  end
2347
2519
  end
2348
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']
2349
2535
  unless params['Agent'].nil?
2350
2536
  @Agent = Agent.new
2351
2537
  @Agent.deserialize(params['Agent'])
@@ -2419,8 +2605,8 @@ module TencentCloud
2419
2605
 
2420
2606
  attr_accessor :UserName, :IdCardNumber, :SealName, :Operator, :IdCardType, :SealImage, :SealImageCompress, :Mobile, :EnableAutoSign, :SealColor, :ProcessSeal, :FileId
2421
2607
  extend Gem::Deprecate
2422
- deprecate :SealImage, :none, 2023, 7
2423
- deprecate :SealImage=, :none, 2023, 7
2608
+ deprecate :SealImage, :none, 2023, 8
2609
+ deprecate :SealImage=, :none, 2023, 8
2424
2610
 
2425
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)
2426
2612
  @UserName = username
@@ -2571,7 +2757,10 @@ module TencentCloud
2571
2757
  # @type FlowGroupId: String
2572
2758
  # @param PathType: 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
2573
2759
  # @type PathType: Integer
2574
- # @param AutoJumpBack: 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
2760
+ # @param AutoJumpBack: 是否自动回跳
2761
+ # true:是,
2762
+ # false:否。
2763
+ # 该参数只针对"APP" 类型的签署链接有效
2575
2764
  # @type AutoJumpBack: Boolean
2576
2765
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2577
2766
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -2857,11 +3046,16 @@ module TencentCloud
2857
3046
  # @type SceneKey: String
2858
3047
  # @param AutoSignConfig: 自动签开通,签署相关配置
2859
3048
  # @type AutoSignConfig: :class:`Tencentcloud::Ess.v20201111.models.AutoSignConfig`
2860
- # @param UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
3049
+ # @param UrlType: 链接类型,
3050
+ # 空-默认小程序端链接
3051
+ # H5SIGN-h5端链接
2861
3052
  # @type UrlType: String
2862
- # @param NotifyType: 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
3053
+ # @param NotifyType: 通知类型
3054
+
3055
+ # 默认不设置为不通知开通方,
3056
+ # SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
2863
3057
  # @type NotifyType: String
2864
- # @param NotifyAddress: 若上方填写为 SMS,则此处为手机号
3058
+ # @param NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
2865
3059
  # @type NotifyAddress: String
2866
3060
  # @param ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
2867
3061
  # @type ExpiredTime: Integer
@@ -2912,7 +3106,7 @@ module TencentCloud
2912
3106
  # @type AppOriginalId: String
2913
3107
  # @param Path: 跳转路径
2914
3108
  # @type Path: String
2915
- # @param QrCode: base64格式跳转二维码
3109
+ # @param QrCode: base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
2916
3110
  # @type QrCode: String
2917
3111
  # @param UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
2918
3112
  # @type UrlType: String
@@ -3358,12 +3552,12 @@ module TencentCloud
3358
3552
 
3359
3553
  attr_accessor :Operator, :BusinessType, :BusinessIds, :FileName, :FileType, :Offset, :Limit, :UrlTtl, :CcToken, :Scene, :Agent
3360
3554
  extend Gem::Deprecate
3361
- deprecate :CcToken, :none, 2023, 7
3362
- deprecate :CcToken=, :none, 2023, 7
3363
- deprecate :Scene, :none, 2023, 7
3364
- deprecate :Scene=, :none, 2023, 7
3365
- deprecate :Agent, :none, 2023, 7
3366
- 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
3367
3561
 
3368
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)
3369
3563
  @Operator = operator
@@ -3579,12 +3773,14 @@ module TencentCloud
3579
3773
 
3580
3774
  # DescribeFlowEvidenceReport返回参数结构体
3581
3775
  class DescribeFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
3582
- # @param ReportUrl: 报告 URL
3776
+ # @param ReportUrl: 出证报告PDF的下载 URL
3583
3777
  # 注意:此字段可能返回 null,表示取不到有效值。
3584
3778
  # @type ReportUrl: String
3585
- # @param Status: 执行中:EvidenceStatusExecuting
3586
- # 成功:EvidenceStatusSuccess
3587
- # 失败:EvidenceStatusFailed
3779
+ # @param Status: 出证任务执行的状态, 分布表示下面的含义
3780
+
3781
+ # EvidenceStatusExecuting 出证任务在执行中
3782
+ # EvidenceStatusSuccess 出证任务执行成功
3783
+ # EvidenceStatusFailed 出征任务执行失败
3588
3784
  # @type Status: String
3589
3785
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3590
3786
  # @type RequestId: String
@@ -3609,10 +3805,13 @@ module TencentCloud
3609
3805
  # @param Operator: 调用方用户信息,userId 必填
3610
3806
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3611
3807
  # @param FlowIds: 需要查询的流程ID列表,限制最大100个
3808
+
3809
+ # 如果查询合同组的信息,不要传此参数
3612
3810
  # @type FlowIds: Array
3613
3811
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3614
3812
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3615
- # @param FlowGroupId: 合同组ID
3813
+ # @param FlowGroupId: 合同组ID, 如果传此参数会忽略FlowIds入参
3814
+ # 所以如传此参数不要传FlowIds参数
3616
3815
  # @type FlowGroupId: String
3617
3816
 
3618
3817
  attr_accessor :Operator, :FlowIds, :Agent, :FlowGroupId
@@ -3677,7 +3876,7 @@ module TencentCloud
3677
3876
  class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
3678
3877
  # @param Operator: 调用方员工/经办人信息
3679
3878
  # UserId 必填,在企业控制台组织架构中可以查到员工的UserId
3680
- # 注:请保证对应
3879
+ # 注:请保证员工有相关的角色权限
3681
3880
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3682
3881
  # @param Agent: 代理相关应用信息
3683
3882
  # 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
@@ -3708,12 +3907,12 @@ module TencentCloud
3708
3907
 
3709
3908
  attr_accessor :Operator, :Agent, :ContentType, :Filters, :Offset, :Limit, :ApplicationId, :IsChannel, :Organization, :GenerateSource
3710
3909
  extend Gem::Deprecate
3711
- deprecate :IsChannel, :none, 2023, 7
3712
- deprecate :IsChannel=, :none, 2023, 7
3713
- deprecate :Organization, :none, 2023, 7
3714
- deprecate :Organization=, :none, 2023, 7
3715
- deprecate :GenerateSource, :none, 2023, 7
3716
- 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
3717
3916
 
3718
3917
  def initialize(operator=nil, agent=nil, contenttype=nil, filters=nil, offset=nil, limit=nil, applicationid=nil, ischannel=nil, organization=nil, generatesource=nil)
3719
3918
  @Operator = operator
@@ -4295,7 +4494,7 @@ module TencentCloud
4295
4494
  # @param SceneKey: 自动签场景:
4296
4495
  # E_PRESCRIPTION_AUTO_SIGN 电子处方
4297
4496
  # @type SceneKey: String
4298
- # @param UserInfo: 查询开启状态的用户信息
4497
+ # @param UserInfo: 要查询开启状态的用户信息
4299
4498
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
4300
4499
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4301
4500
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -4328,11 +4527,14 @@ module TencentCloud
4328
4527
 
4329
4528
  # DescribeUserAutoSignStatus返回参数结构体
4330
4529
  class DescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
4331
- # @param IsOpen: 是否已开通自动签
4530
+ # @param IsOpen: 查询用户是否已开通自动签
4332
4531
  # @type IsOpen: Boolean
4333
4532
  # @param LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
4533
+
4534
+ # 值为unix时间戳,单位为秒。
4334
4535
  # @type LicenseFrom: Integer
4335
4536
  # @param LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
4537
+ # 值为unix时间戳,单位为秒。
4336
4538
  # @type LicenseTo: Integer
4337
4539
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4338
4540
  # @type RequestId: String
@@ -4408,6 +4610,32 @@ module TencentCloud
4408
4610
  end
4409
4611
  end
4410
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
+
4411
4639
  # 授权服务信息
4412
4640
  class ExtendAuthInfo < TencentCloud::Common::AbstractModel
4413
4641
  # @param Type: 授权服务类型
@@ -4570,13 +4798,13 @@ module TencentCloud
4570
4798
 
4571
4799
  # 模板中文件的信息结构
4572
4800
  class FileInfo < TencentCloud::Common::AbstractModel
4573
- # @param FileId: 文件Id
4801
+ # @param FileId: 文件ID
4574
4802
  # @type FileId: String
4575
4803
  # @param FileName: 文件名
4576
4804
  # @type FileName: String
4577
4805
  # @param FileSize: 文件大小,单位为Byte
4578
4806
  # @type FileSize: Integer
4579
- # @param CreatedOn: 文件上传时间,10位时间戳(精确到秒)
4807
+ # @param CreatedOn: 文件上传时间,格式为Unix标准时间戳(秒)
4580
4808
  # @type CreatedOn: Integer
4581
4809
 
4582
4810
  attr_accessor :FileId, :FileName, :FileSize, :CreatedOn
@@ -4619,16 +4847,17 @@ module TencentCloud
4619
4847
 
4620
4848
  # 补充签署人信息
4621
4849
  # - RecipientId 必须指定
4622
- # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填
4623
- # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填
4850
+ # - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
4851
+ # - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
4624
4852
  class FillApproverInfo < TencentCloud::Common::AbstractModel
4625
4853
  # @param RecipientId: 对应模板中的参与方ID
4626
4854
  # @type RecipientId: String
4627
4855
  # @param ApproverSource: 签署人来源
4628
4856
  # WEWORKAPP: 企业微信
4857
+ # <br/>仅【企微或签】时指定WEWORKAPP
4629
4858
  # @type ApproverSource: String
4630
4859
  # @param CustomUserId: 企业自定义账号ID
4631
- # WEWORKAPP场景下指企业自有应用获取企微明文的userid
4860
+ # <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
4632
4861
  # @type CustomUserId: String
4633
4862
  # @param ApproverName: 补充签署人姓名
4634
4863
  # @type ApproverName: String
@@ -4866,7 +5095,9 @@ module TencentCloud
4866
5095
  # @param CreatedOn: 流程创建的时间戳,单位秒
4867
5096
  # 注意:此字段可能返回 null,表示取不到有效值。
4868
5097
  # @type CreatedOn: Integer
4869
- # @param FlowMessage: 拒签或者取消的原因描述
5098
+ # @param FlowMessage: 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
5099
+ # 此字段展示拒签或者取消的原因描述
5100
+
4870
5101
  # 注意:此字段可能返回 null,表示取不到有效值。
4871
5102
  # @type FlowMessage: String
4872
5103
  # @param Creator: 合同发起人userId
@@ -4911,11 +5142,15 @@ module TencentCloud
4911
5142
  # 3:企业静默签署
4912
5143
  # 注:类型为3(企业静默签署)时,会默认完成该签署方的签署。静默签署仅进行盖章操作,不能是手写签名。
4913
5144
  # @type ApproverType: Integer
4914
- # @param OrganizationName: 如果签署方为企业,需要填入企业全称
5145
+ # @param OrganizationName: 签署人企业名称
5146
+ # <br/>当approverType=1 或 approverType=3时,必须指定
5147
+
4915
5148
  # @type OrganizationName: String
4916
5149
  # @param ApproverName: 签署方经办人姓名
5150
+ # <br/>在未指定签署人电子签UserId情况下,为必填参数
4917
5151
  # @type ApproverName: String
4918
5152
  # @param ApproverMobile: 签署方经办人手机号码
5153
+ # <br/>在未指定签署人电子签UserId情况下,为必填参数
4919
5154
  # @type ApproverMobile: String
4920
5155
  # @param ApproverIdCardType: 签署方经办人证件类型ID_CARD 身份证
4921
5156
  # HONGKONG_AND_MACAO 港澳居民来往内地通行证
@@ -4924,22 +5159,33 @@ module TencentCloud
4924
5159
  # @param ApproverIdCardNumber: 签署方经办人证件号码
4925
5160
  # @type ApproverIdCardNumber: String
4926
5161
  # @param RecipientId: 签署方经办人在模板中的参与方ID
5162
+ # <br/>模版发起合同时,该参数为必填项
5163
+ # <br/>文件发起合同是,该参数无序传值
4927
5164
  # @type RecipientId: String
4928
5165
  # @param VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
4929
5166
  # @type VerifyChannel: Array
4930
- # @param NotifyType: 是否发送短信,sms--短信通知,none--不通知,默认为sms;发起方=签署方时不发送短信
5167
+ # @param NotifyType: 是否发送短信
5168
+ # <br/>sms--短信通知
5169
+ # <br/>none--不通知
5170
+ # <br/>默认为sms
5171
+ # <br/>发起方=签署方时不发送短信
4931
5172
  # @type NotifyType: String
4932
5173
  # @param IsFullText: 合同强制需要阅读全文,无需传此参数
4933
5174
  # @type IsFullText: Boolean
4934
5175
  # @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
4935
5176
  # @type PreReadTime: Integer
4936
- # @param UserId: 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。
5177
+ # @param UserId: 签署方经办人的电子签用户ID
5178
+ # <br/>当未指定签署人姓名+手机号的情况下,该字段毕传
4937
5179
  # @type UserId: String
4938
5180
  # @param Required: 当前只支持true,默认为true
4939
5181
  # @type Required: Boolean
4940
- # @param ApproverSource: 签署人用户来源,企微侧用户请传入:WEWORKAPP
5182
+ # @param ApproverSource: 签署人用户来源
5183
+ # <br/>企微侧用户请传入:WEWORKAPP
4941
5184
  # @type ApproverSource: String
4942
- # @param CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
5185
+ # @param CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度
5186
+ # <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
5187
+ # <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
5188
+ # <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
4943
5189
  # @type CustomApproverTag: String
4944
5190
  # @param RegisterInfo: 快速注册相关信息,目前暂未开放!
4945
5191
  # @type RegisterInfo: :class:`Tencentcloud::Ess.v20201111.models.RegisterInfo`
@@ -4951,11 +5197,16 @@ module TencentCloud
4951
5197
  # - 发起流程时系统自动补充
4952
5198
  # - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
4953
5199
  # @type SignId: String
4954
- # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。
5200
+ # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批
5201
+ # <br>true 则为需要
5202
+ # <br/>false,无序企业内部审批(默认)
5203
+ # <br/>为个人签署方时则由发起方企业审核。
4955
5204
  # @type ApproverNeedSignReview: Boolean
4956
5205
  # @param SignComponents: 签署人签署控件
5206
+ # <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
4957
5207
  # @type SignComponents: Array
4958
5208
  # @param Components: 签署人填写控件
5209
+ # <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
4959
5210
  # @type Components: Array
4960
5211
  # @param ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
4961
5212
  # HANDWRITE – 手写签名
@@ -4970,8 +5221,8 @@ module TencentCloud
4970
5221
 
4971
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
4972
5223
  extend Gem::Deprecate
4973
- deprecate :JumpUrl, :none, 2023, 7
4974
- deprecate :JumpUrl=, :none, 2023, 7
5224
+ deprecate :JumpUrl, :none, 2023, 8
5225
+ deprecate :JumpUrl=, :none, 2023, 8
4975
5226
 
4976
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)
4977
5228
  @ApproverType = approvertype
@@ -5381,7 +5632,7 @@ module TencentCloud
5381
5632
 
5382
5633
  # GetTaskResultApi请求参数结构体
5383
5634
  class GetTaskResultApiRequest < TencentCloud::Common::AbstractModel
5384
- # @param TaskId: 任务Id,通过CreateConvertTaskApi得到
5635
+ # @param TaskId: 任务Id,通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id
5385
5636
  # @type TaskId: String
5386
5637
  # @param Operator: 操作人信息,UserId必填
5387
5638
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
@@ -5392,10 +5643,10 @@ module TencentCloud
5392
5643
 
5393
5644
  attr_accessor :TaskId, :Operator, :Agent, :Organization
5394
5645
  extend Gem::Deprecate
5395
- deprecate :Agent, :none, 2023, 7
5396
- deprecate :Agent=, :none, 2023, 7
5397
- deprecate :Organization, :none, 2023, 7
5398
- 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
5399
5650
 
5400
5651
  def initialize(taskid=nil, operator=nil, agent=nil, organization=nil)
5401
5652
  @TaskId = taskid
@@ -5441,7 +5692,7 @@ module TencentCloud
5441
5692
  # ProcessFailed - 转换失败
5442
5693
  # ProcessTimeout - 转换文件超时
5443
5694
  # @type TaskMessage: String
5444
- # @param ResourceId: 资源Id,也是FileId,用于文件发起使用
5695
+ # @param ResourceId: 资源Id,也是FileId,用于文件发起时使用
5445
5696
  # @type ResourceId: String
5446
5697
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5447
5698
  # @type RequestId: String
@@ -5853,16 +6104,16 @@ module TencentCloud
5853
6104
 
5854
6105
  attr_accessor :OrganizationId, :Channel, :OrganizationOpenId, :ClientIp, :ProxyIp
5855
6106
  extend Gem::Deprecate
5856
- deprecate :OrganizationId, :none, 2023, 7
5857
- deprecate :OrganizationId=, :none, 2023, 7
5858
- deprecate :Channel, :none, 2023, 7
5859
- deprecate :Channel=, :none, 2023, 7
5860
- deprecate :OrganizationOpenId, :none, 2023, 7
5861
- deprecate :OrganizationOpenId=, :none, 2023, 7
5862
- deprecate :ClientIp, :none, 2023, 7
5863
- deprecate :ClientIp=, :none, 2023, 7
5864
- deprecate :ProxyIp, :none, 2023, 7
5865
- 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
5866
6117
 
5867
6118
  def initialize(organizationid=nil, channel=nil, organizationopenid=nil, clientip=nil, proxyip=nil)
5868
6119
  @OrganizationId = organizationid
@@ -5895,9 +6146,9 @@ module TencentCloud
5895
6146
  # @type SignAlgorithm: String
5896
6147
  # @param CertSn: 签名证书序列号
5897
6148
  # @type CertSn: String
5898
- # @param CertNotBefore: 证书起始时间戳,单位秒
6149
+ # @param CertNotBefore: 证书起始时间戳,单位毫秒
5899
6150
  # @type CertNotBefore: Integer
5900
- # @param CertNotAfter: 证书过期时间戳,单位秒
6151
+ # @param CertNotAfter: 证书过期时间戳,单位毫秒
5901
6152
  # @type CertNotAfter: Integer
5902
6153
  # @param ComponentPosX: 签名域横坐标,单位pt
5903
6154
  # @type ComponentPosX: Float
@@ -5945,33 +6196,43 @@ module TencentCloud
5945
6196
  end
5946
6197
  end
5947
6198
 
5948
- # 签署参与者信息
6199
+ # 流程中参与方的信息结构
5949
6200
  class Recipient < TencentCloud::Common::AbstractModel
5950
- # @param RecipientId: 签署参与者ID
6201
+ # @param RecipientId: 签署参与者ID,唯一标识
5951
6202
  # @type RecipientId: String
5952
- # @param RecipientType: 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
6203
+ # @param RecipientType: 参与者类型。
6204
+ # 默认为空。
6205
+ # ENTERPRISE-企业;
6206
+ # INDIVIDUAL-个人;
6207
+ # PROMOTER-发起方
5953
6208
  # @type RecipientType: String
5954
6209
  # @param Description: 描述信息
5955
6210
  # @type Description: String
5956
6211
  # @param RoleName: 角色名称
5957
6212
  # @type RoleName: String
5958
- # @param RequireValidation: 是否需要验证,默认为false
6213
+ # @param RequireValidation: 是否需要验证,
6214
+ # 默认为false-不需要验证
5959
6215
  # @type RequireValidation: Boolean
5960
- # @param RequireSign: 是否需要签署,默认为true
6216
+ # @param RequireSign: 是否需要签署,
6217
+ # 默认为true-需要签署
5961
6218
  # @type RequireSign: Boolean
5962
- # @param RoutingOrder: 添加序列,0~N
6219
+ # @param RoutingOrder: 此参与方添加的顺序,从0~N
5963
6220
  # @type RoutingOrder: Integer
5964
- # @param RequireDelivery: 是否需要发送,默认为true
6221
+ # @param RequireDelivery: 是否需要发送,
6222
+ # 默认为true-需要发送
5965
6223
  # @type RequireDelivery: Boolean
5966
6224
  # @param Email: 邮箱地址
5967
6225
  # @type Email: String
5968
6226
  # @param Mobile: 电话号码
5969
6227
  # @type Mobile: String
5970
- # @param UserId: 关联的用户ID
6228
+ # @param UserId: 关联的用户ID,电子签系统的用户ID
5971
6229
  # @type UserId: String
5972
- # @param DeliveryMethod: 发送方式。默认为EMAIL。EMAIL-邮件;MOBILE-手机短信;WECHAT-微信通知
6230
+ # @param DeliveryMethod: 发送方式,默认为EMAIL。
6231
+ # EMAIL-邮件;
6232
+ # MOBILE-手机短信;
6233
+ # WECHAT-微信通知
5973
6234
  # @type DeliveryMethod: String
5974
- # @param RecipientExtra: 附属信息
6235
+ # @param RecipientExtra: 参与方的一些附属信息,json格式
5975
6236
  # @type RecipientExtra: String
5976
6237
 
5977
6238
  attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra
@@ -6059,8 +6320,8 @@ module TencentCloud
6059
6320
 
6060
6321
  attr_accessor :LegalName, :Uscc, :UnifiedSocialCreditCode
6061
6322
  extend Gem::Deprecate
6062
- deprecate :Uscc, :none, 2023, 7
6063
- deprecate :Uscc=, :none, 2023, 7
6323
+ deprecate :Uscc, :none, 2023, 8
6324
+ deprecate :Uscc=, :none, 2023, 8
6064
6325
 
6065
6326
  def initialize(legalname=nil, uscc=nil, unifiedsocialcreditcode=nil)
6066
6327
  @LegalName = legalname
@@ -6094,7 +6355,7 @@ module TencentCloud
6094
6355
  # - SIGN_SEAL-默认为印章控件类型
6095
6356
  # - SIGN_SIGNATURE-手写签名控件类型
6096
6357
  # @type ApproverSignComponentType: String
6097
- # @param ApproverSignRole: 签署方自定义控件别名,最大长度20个字符
6358
+ # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推. 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
6098
6359
  # @type ApproverSignRole: String
6099
6360
 
6100
6361
  attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole
@@ -6194,14 +6455,33 @@ module TencentCloud
6194
6455
  end
6195
6456
  end
6196
6457
 
6197
- # 模板结构体中的印章信息
6458
+ # 模板中指定的印章信息
6198
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
6199
6472
 
6473
+ attr_accessor :SealId, :SealType, :SealName
6200
6474
 
6201
- def initialize()
6475
+ def initialize(sealid=nil, sealtype=nil, sealname=nil)
6476
+ @SealId = sealid
6477
+ @SealType = sealtype
6478
+ @SealName = sealname
6202
6479
  end
6203
6480
 
6204
6481
  def deserialize(params)
6482
+ @SealId = params['SealId']
6483
+ @SealType = params['SealType']
6484
+ @SealName = params['SealName']
6205
6485
  end
6206
6486
  end
6207
6487
 
@@ -6508,44 +6788,59 @@ module TencentCloud
6508
6788
  end
6509
6789
  end
6510
6790
 
6511
- # 企业模板的信息结构
6791
+ # 此结构体 (TemplateInfo) 用于描述模板的信息。
6792
+
6793
+ # > **模板组成**
6794
+ # >
6795
+ # > 一个模板通常会包含以下结构信息
6796
+ # >- 模板基本信息
6797
+ # >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
6798
+ # >- 填写控件 Components
6799
+ # >- 签署控件 SignComponents
6800
+ # >- 生成模板的文件基础信息 FileInfos
6512
6801
  class TemplateInfo < TencentCloud::Common::AbstractModel
6513
- # @param TemplateId: 模板ID
6802
+ # @param TemplateId: 模板ID,模板的唯一标识
6514
6803
  # @type TemplateId: String
6515
- # @param TemplateName: 模板名字
6804
+ # @param TemplateName: 模板名
6516
6805
  # @type TemplateName: String
6517
6806
  # @param Description: 模板描述信息
6518
6807
  # @type Description: String
6519
6808
  # @param DocumentResourceIds: 模板关联的资源ID列表
6520
6809
  # @type DocumentResourceIds: Array
6521
- # @param FileInfos: 返回的文件信息结构
6810
+ # @param FileInfos: 生成模板的文件基础信息
6522
6811
  # @type FileInfos: Array
6523
6812
  # @param AttachmentResourceIds: 附件关联的资源ID
6524
6813
  # @type AttachmentResourceIds: Array
6525
6814
  # @param SignOrder: 签署顺序
6815
+ # 无序 -1
6816
+ # 有序为序列数字 0,1,2
6526
6817
  # @type SignOrder: Array
6527
- # @param Recipients: 签署参与者的信息
6818
+ # @param Recipients: 模板中的签署参与方列表
6528
6819
  # @type Recipients: Array
6529
- # @param Components: 模板信息结构
6820
+ # @param Components: 模板的填充控件列表
6530
6821
  # @type Components: Array
6531
- # @param SignComponents: 签署区模板信息结构
6822
+ # @param SignComponents: 模板中的签署控件列表
6532
6823
  # @type SignComponents: Array
6533
- # @param Status: 模板状态(-1:不可用;0:草稿态;1:正式态)
6824
+ # @param Status: 模板状态
6825
+ # -1:不可用
6826
+ # 0:草稿态
6827
+ # 1:正式态,可以正常使用
6534
6828
  # @type Status: Integer
6535
- # @param Creator: 模板的创建人UserId
6829
+ # @param Creator: 模板的创建者信息,电子签系统用户ID
6536
6830
  # @type Creator: String
6537
- # @param CreatedOn: 模板创建的时间戳,单位秒
6831
+ # @param CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
6538
6832
  # @type CreatedOn: Integer
6539
- # @param Promoter: 发起人角色信息
6833
+ # @param Promoter: 发起方参与信息Promoter
6540
6834
  # @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
6541
- # @param TemplateType: 模板类型
6542
- # 取值:
6835
+ # @param TemplateType: 模板类型:
6543
6836
  # 1 静默签,
6544
6837
  # 3 普通模板
6545
6838
  # @type TemplateType: Integer
6546
- # @param Available: 模板可用状态,取值:1启用(默认),2停用
6839
+ # @param Available: 模板可用状态:
6840
+ # 1 启用(默认)
6841
+ # 2 停用
6547
6842
  # @type Available: Integer
6548
- # @param OrganizationId: 创建模板的机构id
6843
+ # @param OrganizationId: 创建模板的企业ID,电子签的机构ID
6549
6844
  # @type OrganizationId: String
6550
6845
  # @param PreviewUrl: 模板预览链接,有效时间5分钟
6551
6846
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -6553,7 +6848,9 @@ module TencentCloud
6553
6848
  # @param TemplateVersion: 模板版本。默认为空时,全数字字符,初始版本为yyyyMMdd001。
6554
6849
  # 注意:此字段可能返回 null,表示取不到有效值。
6555
6850
  # @type TemplateVersion: String
6556
- # @param Published: 模板是否已发布。true-已发布;false-未发布
6851
+ # @param Published: 模板是否已发布:
6852
+ # true-已发布
6853
+ # false-未发布
6557
6854
  # 注意:此字段可能返回 null,表示取不到有效值。
6558
6855
  # @type Published: Boolean
6559
6856
  # @param TemplateSeals: 模板内部指定的印章列表
@@ -6565,8 +6862,8 @@ module TencentCloud
6565
6862
 
6566
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
6567
6864
  extend Gem::Deprecate
6568
- deprecate :Seals, :none, 2023, 7
6569
- deprecate :Seals=, :none, 2023, 7
6865
+ deprecate :Seals, :none, 2023, 8
6866
+ deprecate :Seals=, :none, 2023, 8
6570
6867
 
6571
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)
6572
6869
  @TemplateId = templateid
@@ -6720,7 +7017,7 @@ module TencentCloud
6720
7017
 
6721
7018
  # UpdateIntegrationEmployees请求参数结构体
6722
7019
  class UpdateIntegrationEmployeesRequest < TencentCloud::Common::AbstractModel
6723
- # @param Operator: 操作人信息,userId必填
7020
+ # @param Operator: 当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;
6724
7021
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
6725
7022
  # @param Employees: 员工信息,不超过100个。
6726
7023
  # 根据UserId或OpenId更新员工,必填一个,优先UserId。
@@ -6840,8 +7137,8 @@ module TencentCloud
6840
7137
 
6841
7138
  attr_accessor :BusinessType, :Caller, :FileInfos, :FileType, :CoverRect, :CustomIds, :FileUrls
6842
7139
  extend Gem::Deprecate
6843
- deprecate :FileUrls, :none, 2023, 7
6844
- deprecate :FileUrls=, :none, 2023, 7
7140
+ deprecate :FileUrls, :none, 2023, 8
7141
+ deprecate :FileUrls=, :none, 2023, 8
6845
7142
 
6846
7143
  def initialize(businesstype=nil, caller=nil, fileinfos=nil, filetype=nil, coverrect=nil, customids=nil, fileurls=nil)
6847
7144
  @BusinessType = businesstype
@@ -6913,14 +7210,14 @@ module TencentCloud
6913
7210
 
6914
7211
  attr_accessor :UserId, :Channel, :OpenId, :ClientIp, :ProxyIp
6915
7212
  extend Gem::Deprecate
6916
- deprecate :Channel, :none, 2023, 7
6917
- deprecate :Channel=, :none, 2023, 7
6918
- deprecate :OpenId, :none, 2023, 7
6919
- deprecate :OpenId=, :none, 2023, 7
6920
- deprecate :ClientIp, :none, 2023, 7
6921
- deprecate :ClientIp=, :none, 2023, 7
6922
- deprecate :ProxyIp, :none, 2023, 7
6923
- 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
6924
7221
 
6925
7222
  def initialize(userid=nil, channel=nil, openid=nil, clientip=nil, proxyip=nil)
6926
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.623
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-28 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