tencentcloud-sdk-ess 3.0.580 → 3.0.581

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20201111/models.rb +67 -40
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4f2639eebacc1d7d8a212c5da852f6a0c719af8b
4
- data.tar.gz: 9fc5b6693c589848e9bb9b6d98849a3ca1c53ce7
3
+ metadata.gz: 1dcbd8c18b55af36bb228c637215b841cd9c5d0a
4
+ data.tar.gz: 446c4d2bc9614d96e0d5bfba7ca27705d31471f8
5
5
  SHA512:
6
- metadata.gz: f3723b67058b940a01ed0d32e4770f8c081723e6034d92491327e046281f302a70f4bcc103edc1c5e9d105452f2fbd3f22092b81eda4f7c9d0487f7fa2de5501
7
- data.tar.gz: a0aff1db8a0a7983287eaa9d563dba0031f5104560901250e1d95721717916b888ea99dcf0330c3e4fbbf57d3bb0971b817ff8d27eb51b60ff43a32940c5bfa0
6
+ metadata.gz: c66e36efe42f87c9cd0ebc7f7602f74237c33a58e56256bc00482da22836a9308b89e9033ffccc5d4823c640ef9caddfe44cb6dd9862c4d8dd44e116361e81ca
7
+ data.tar.gz: f64cb6f57472c52dacffd8f045704ceb9226a8c50e0afb54db2bf5d0f8f0c39fd37157dce84869f2d6c34b7469a35d52780ed3cbd2dea59d1b0fd554d7824f90
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.580
1
+ 3.0.581
@@ -75,32 +75,32 @@ module TencentCloud
75
75
  # 3:企业静默签署
76
76
  # 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
77
77
  # @type ApproverType: Integer
78
- # @param ApproverName: 本环节需要操作人的名字
78
+ # @param ApproverName: 签署人的姓名
79
79
  # @type ApproverName: String
80
- # @param ApproverMobile: 本环节需要操作人的手机号
80
+ # @param ApproverMobile: 签署人的手机号,11位数字
81
81
  # @type ApproverMobile: String
82
- # @param SignComponents: 本环节操作人签署控件配置
82
+ # @param SignComponents: 签署人的签署控件列表
83
83
  # @type SignComponents: Array
84
- # @param OrganizationName: 如果是企业,则为企业的名字
84
+ # @param OrganizationName: 如果签署方是企业签署方,则为企业名
85
85
  # @type OrganizationName: String
86
- # @param ApproverIdCardNumber: 身份证号
86
+ # @param ApproverIdCardNumber: 签署人的身份证号
87
87
  # @type ApproverIdCardNumber: String
88
- # @param ApproverIdCardType: 证件类型
88
+ # @param ApproverIdCardType: 签署人的身份证件类型
89
89
  # ID_CARD 身份证
90
90
  # HONGKONG_AND_MACAO 港澳居民来往内地通行证
91
91
  # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
92
92
  # @type ApproverIdCardType: String
93
- # @param NotifyType: sms--短信,none--不通知
93
+ # @param NotifyType: 签署通知类型:sms--短信,none--不通知
94
94
  # @type NotifyType: String
95
- # @param ApproverRole: 1--收款人、2--开具人、3--见证人
95
+ # @param ApproverRole: 签署人角色类型:1--收款人、2--开具人、3--见证人
96
96
  # @type ApproverRole: Integer
97
- # @param VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
97
+ # @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
98
98
  # @type VerifyChannel: Array
99
99
  # @param PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
100
100
  # @type PreReadTime: Integer
101
101
  # @param UserId: 签署人userId,传此字段则不用传姓名、手机号
102
102
  # @type UserId: String
103
- # @param ApproverSource: 签署人用户来源,企微侧用户请传入:WEWORKAPP
103
+ # @param ApproverSource: 签署人用户来源,企微侧用户请传入:WEWORKAPP
104
104
  # @type ApproverSource: String
105
105
  # @param CustomApproverTag: 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
106
106
  # @type CustomApproverTag: String
@@ -192,11 +192,11 @@ module TencentCloud
192
192
  class ApproverRestriction < TencentCloud::Common::AbstractModel
193
193
  # @param Name: 指定签署人名字
194
194
  # @type Name: String
195
- # @param Mobile: 指定签署人手机号
195
+ # @param Mobile: 指定签署人手机号,11位数字
196
196
  # @type Mobile: String
197
- # @param IdCardType: 指定签署人证件类型
197
+ # @param IdCardType: 指定签署人证件类型,ID_CARD-身份证
198
198
  # @type IdCardType: String
199
- # @param IdCardNumber: 指定签署人证件号码
199
+ # @param IdCardNumber: 指定签署人证件号码,字母大写
200
200
  # @type IdCardNumber: String
201
201
 
202
202
  attr_accessor :Name, :Mobile, :IdCardType, :IdCardNumber
@@ -218,7 +218,7 @@ module TencentCloud
218
218
 
219
219
  # 授权用户
220
220
  class AuthorizedUser < TencentCloud::Common::AbstractModel
221
- # @param UserId: 用户id
221
+ # @param UserId: 电子签系统中的用户id
222
222
  # @type UserId: String
223
223
 
224
224
  attr_accessor :UserId
@@ -236,13 +236,13 @@ module TencentCloud
236
236
  class AutoSignConfig < TencentCloud::Common::AbstractModel
237
237
  # @param UserInfo: 自动签开通个人用户的三要素
238
238
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
239
- # @param CallbackUrl: 回调链接
239
+ # @param CallbackUrl: 接受自动签开启的回调地址。需要保证post返回200
240
240
  # @type CallbackUrl: String
241
- # @param CertInfoCallback: 是否回调证书信息
241
+ # @param CertInfoCallback: 是否回调证书信息,默认false-不需要
242
242
  # @type CertInfoCallback: Boolean
243
- # @param UserDefineSeal: 是否支持用户自定义签名印章
243
+ # @param UserDefineSeal: 是否支持用户自定义签名印章,默认false-不需要
244
244
  # @type UserDefineSeal: Boolean
245
- # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
245
+ # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要
246
246
  # @type SealImgCallback: Boolean
247
247
  # @param VerifyChannels: 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
248
248
  # @type VerifyChannels: Array
@@ -464,7 +464,7 @@ module TencentCloud
464
464
 
465
465
  # 抄送信息
466
466
  class CcInfo < TencentCloud::Common::AbstractModel
467
- # @param Mobile: 被抄送人手机号
467
+ # @param Mobile: 被抄送人手机号,11位数字
468
468
  # @type Mobile: String
469
469
  # @param Name: 被抄送人姓名
470
470
  # @type Name: String
@@ -496,7 +496,7 @@ module TencentCloud
496
496
 
497
497
  # 模板控件信息
498
498
  class Component < TencentCloud::Common::AbstractModel
499
- # @param ComponentType: 如果是Component控件类型,则可选的字段为:
499
+ # @param ComponentType: 如果是Component填写控件类型,则可选的字段为:
500
500
  # TEXT - 普通文本控件,输入文本字符串;
501
501
  # MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
502
502
  # CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
@@ -507,7 +507,7 @@ module TencentCloud
507
507
  # DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
508
508
  # DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
509
509
 
510
- # 如果是SignComponent控件类型,则可选的字段为
510
+ # 如果是SignComponent签署控件类型,则可选的字段为
511
511
  # SIGN_SEAL - 签署印章控件;
512
512
  # SIGN_DATE - 签署日期控件;
513
513
  # SIGN_SIGNATURE - 用户签名控件;
@@ -518,7 +518,7 @@ module TencentCloud
518
518
 
519
519
  # 表单域的控件不能作为印章和签名控件
520
520
  # @type ComponentType: String
521
- # @param FileIndex: 控件所属文件的序号(模板中的resourceId排列序号,取值为:0-N
521
+ # @param FileIndex: 控件所属文件的序号(取值为:0-N)。目前单文件的情况下,值是0
522
522
  # @type FileIndex: Integer
523
523
  # @param ComponentHeight: 参数控件高度,单位pt
524
524
  # @type ComponentHeight: Float
@@ -530,9 +530,9 @@ module TencentCloud
530
530
  # @type ComponentPosX: Float
531
531
  # @param ComponentPosY: 参数控件Y位置,单位pt
532
532
  # @type ComponentPosY: Float
533
- # @param ComponentId: GenerateMode==KEYWORD 指定关键字
533
+ # @param ComponentId: 查询时返回控件唯一Id。使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
534
534
  # @type ComponentId: String
535
- # @param ComponentName: GenerateMode==FIELD 指定表单域名称
535
+ # @param ComponentName: 查询时返回控件名。使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
536
536
  # @type ComponentName: String
537
537
  # @param ComponentRequired: 是否必选,默认为false
538
538
  # @type ComponentRequired: Boolean
@@ -565,7 +565,7 @@ module TencentCloud
565
565
  # 特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
566
566
  # 参数样例: "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
567
567
  # @type ComponentExtra: String
568
- # @param IsFormType: 是否是表单域类型,默认不存在
568
+ # @param IsFormType: 是否是表单域类型,默认不false-不是
569
569
  # @type IsFormType: Boolean
570
570
  # @param ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
571
571
  # TEXT - 文本内容
@@ -650,13 +650,13 @@ module TencentCloud
650
650
  # @type GenerateMode: String
651
651
  # @param ComponentDateFontSize: 日期签署控件的字号,默认为 12
652
652
  # @type ComponentDateFontSize: Integer
653
- # @param ChannelComponentId: 平台模板控件 id 标识
653
+ # @param ChannelComponentId: 第三方应用集成平台模板控件 id 标识
654
654
  # @type ChannelComponentId: String
655
655
  # @param OffsetX: 指定关键字时横坐标偏移量,单位pt
656
656
  # @type OffsetX: Float
657
657
  # @param OffsetY: 指定关键字时纵坐标偏移量,单位pt
658
658
  # @type OffsetY: Float
659
- # @param ChannelComponentSource: //子客控件来源。0-平台指定;1-用户自定义
659
+ # @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。0-平台指定;1-用户自定义
660
660
  # @type ChannelComponentSource: Integer
661
661
  # @param KeywordOrder: 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
662
662
  # 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
@@ -1855,14 +1855,14 @@ module TencentCloud
1855
1855
 
1856
1856
  # CreatePreparedPersonalEsign请求参数结构体
1857
1857
  class CreatePreparedPersonalEsignRequest < TencentCloud::Common::AbstractModel
1858
- # @param UserName: 个人用户名称
1858
+ # @param UserName: 个人用户姓名
1859
1859
  # @type UserName: String
1860
1860
  # @param IdCardNumber: 身份证件号码
1861
1861
  # @type IdCardNumber: String
1862
- # @param SealImage: 印章图片的base64
1863
- # @type SealImage: String
1864
1862
  # @param SealName: 印章名称
1865
1863
  # @type SealName: String
1864
+ # @param SealImage: 印章图片的base64,最大不超过 8M
1865
+ # @type SealImage: String
1866
1866
  # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
1867
1867
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1868
1868
  # @param IdCardType: 身份证件类型:
@@ -1872,36 +1872,56 @@ module TencentCloud
1872
1872
  # FOREIGN_ID_CARD 境外身份
1873
1873
  # HONGKONG_MACAO_AND_TAIWAN 中国台湾
1874
1874
  # @type IdCardType: String
1875
+ # @param SealImageCompress: 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。
1876
+ # @type SealImageCompress: Boolean
1875
1877
  # @param Mobile: 手机号码;当需要开通自动签时,该参数必传
1876
1878
  # @type Mobile: String
1877
1879
  # @param EnableAutoSign: 是否开通自动签,该功能需联系运营工作人员开通后使用
1878
1880
  # @type EnableAutoSign: Boolean
1879
-
1880
- attr_accessor :UserName, :IdCardNumber, :SealImage, :SealName, :Operator, :IdCardType, :Mobile, :EnableAutoSign
1881
-
1882
- def initialize(username=nil, idcardnumber=nil, sealimage=nil, sealname=nil, operator=nil, idcardtype=nil, mobile=nil, enableautosign=nil)
1881
+ # @param SealColor: 印章颜色(参数ProcessSeal=true时生效)
1882
+ # 默认值:BLACK黑色
1883
+ # 取值:
1884
+ # BLACK 黑色,
1885
+ # RED 红色,
1886
+ # BLUE 蓝色。
1887
+ # @type SealColor: String
1888
+ # @param ProcessSeal: 是否处理印章
1889
+ # 默认不做印章处理。
1890
+ # 取值:false:不做任何处理;
1891
+ # true:做透明化处理和颜色增强。
1892
+ # @type ProcessSeal: Boolean
1893
+
1894
+ attr_accessor :UserName, :IdCardNumber, :SealName, :SealImage, :Operator, :IdCardType, :SealImageCompress, :Mobile, :EnableAutoSign, :SealColor, :ProcessSeal
1895
+
1896
+ def initialize(username=nil, idcardnumber=nil, sealname=nil, sealimage=nil, operator=nil, idcardtype=nil, sealimagecompress=nil, mobile=nil, enableautosign=nil, sealcolor=nil, processseal=nil)
1883
1897
  @UserName = username
1884
1898
  @IdCardNumber = idcardnumber
1885
- @SealImage = sealimage
1886
1899
  @SealName = sealname
1900
+ @SealImage = sealimage
1887
1901
  @Operator = operator
1888
1902
  @IdCardType = idcardtype
1903
+ @SealImageCompress = sealimagecompress
1889
1904
  @Mobile = mobile
1890
1905
  @EnableAutoSign = enableautosign
1906
+ @SealColor = sealcolor
1907
+ @ProcessSeal = processseal
1891
1908
  end
1892
1909
 
1893
1910
  def deserialize(params)
1894
1911
  @UserName = params['UserName']
1895
1912
  @IdCardNumber = params['IdCardNumber']
1896
- @SealImage = params['SealImage']
1897
1913
  @SealName = params['SealName']
1914
+ @SealImage = params['SealImage']
1898
1915
  unless params['Operator'].nil?
1899
1916
  @Operator = UserInfo.new
1900
1917
  @Operator.deserialize(params['Operator'])
1901
1918
  end
1902
1919
  @IdCardType = params['IdCardType']
1920
+ @SealImageCompress = params['SealImageCompress']
1903
1921
  @Mobile = params['Mobile']
1904
1922
  @EnableAutoSign = params['EnableAutoSign']
1923
+ @SealColor = params['SealColor']
1924
+ @ProcessSeal = params['ProcessSeal']
1905
1925
  end
1906
1926
  end
1907
1927
 
@@ -3466,7 +3486,7 @@ module TencentCloud
3466
3486
  # @type Reason: String
3467
3487
  # @param UserId: 用户Id
3468
3488
  # @type UserId: String
3469
- # @param OpenId: 用户OpenId
3489
+ # @param OpenId: 员工在第三方平台的openId
3470
3490
  # @type OpenId: String
3471
3491
 
3472
3492
  attr_accessor :DisplayName, :Mobile, :Reason, :UserId, :OpenId
@@ -3488,7 +3508,7 @@ module TencentCloud
3488
3508
  end
3489
3509
  end
3490
3510
 
3491
- # 二期接口返回的模板中文件的信息结构
3511
+ # 模板中文件的信息结构
3492
3512
  class FileInfo < TencentCloud::Common::AbstractModel
3493
3513
  # @param FileId: 文件Id
3494
3514
  # @type FileId: String
@@ -4990,6 +5010,11 @@ module TencentCloud
4990
5010
  # @type CreatedOn: Integer
4991
5011
  # @param Promoter: 发起人角色信息
4992
5012
  # @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
5013
+ # @param TemplateType: 模板类型
5014
+ # 取值:
5015
+ # 1 静默签,
5016
+ # 3 普通模板
5017
+ # @type TemplateType: Integer
4993
5018
  # @param Available: 模板可用状态,取值:1启用(默认),2停用
4994
5019
  # @type Available: Integer
4995
5020
  # @param OrganizationId: 模板创建组织id
@@ -5004,9 +5029,9 @@ module TencentCloud
5004
5029
  # 注意:此字段可能返回 null,表示取不到有效值。
5005
5030
  # @type Published: Boolean
5006
5031
 
5007
- attr_accessor :TemplateId, :TemplateName, :Description, :DocumentResourceIds, :FileInfos, :AttachmentResourceIds, :SignOrder, :Recipients, :Components, :SignComponents, :Status, :Creator, :CreatedOn, :Promoter, :Available, :OrganizationId, :PreviewUrl, :TemplateVersion, :Published
5032
+ attr_accessor :TemplateId, :TemplateName, :Description, :DocumentResourceIds, :FileInfos, :AttachmentResourceIds, :SignOrder, :Recipients, :Components, :SignComponents, :Status, :Creator, :CreatedOn, :Promoter, :TemplateType, :Available, :OrganizationId, :PreviewUrl, :TemplateVersion, :Published
5008
5033
 
5009
- 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, available=nil, organizationid=nil, previewurl=nil, templateversion=nil, published=nil)
5034
+ 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)
5010
5035
  @TemplateId = templateid
5011
5036
  @TemplateName = templatename
5012
5037
  @Description = description
@@ -5021,6 +5046,7 @@ module TencentCloud
5021
5046
  @Creator = creator
5022
5047
  @CreatedOn = createdon
5023
5048
  @Promoter = promoter
5049
+ @TemplateType = templatetype
5024
5050
  @Available = available
5025
5051
  @OrganizationId = organizationid
5026
5052
  @PreviewUrl = previewurl
@@ -5074,6 +5100,7 @@ module TencentCloud
5074
5100
  @Promoter = Recipient.new
5075
5101
  @Promoter.deserialize(params['Promoter'])
5076
5102
  end
5103
+ @TemplateType = params['TemplateType']
5077
5104
  @Available = params['Available']
5078
5105
  @OrganizationId = params['OrganizationId']
5079
5106
  @PreviewUrl = params['PreviewUrl']
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.580
4
+ version: 3.0.581
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-05-30 00:00:00.000000000 Z
11
+ date: 2023-05-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common