tencentcloud-sdk-ess 3.0.774 → 3.0.776
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +30 -0
- data/lib/v20201111/models.rb +328 -50
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 52deea27cd920a0a7cb90df03c38fc9398bb9a8b
|
4
|
+
data.tar.gz: 27c3c73c552f1785b28ed4050c1bc24db9b42036
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: efe31d18741d06dd6d345fea378e96eb87b05602638338dbae844075298660edd7bbde96bb924cf0193fa6524e9ac213ee4f27ec333c9f635d5ff1f4bb9136b1
|
7
|
+
data.tar.gz: 38775c0e6c100ead137feaccc1bebe795494fbb0219d95ebc9895245b11634453ac5af8be55c879c64005d4d8172796fa9fe84d924db4b123c9c5a2d32a53fff
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.776
|
data/lib/v20201111/client.rb
CHANGED
@@ -1888,6 +1888,36 @@ module TencentCloud
|
|
1888
1888
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1889
1889
|
end
|
1890
1890
|
|
1891
|
+
# 该接口用于在使用视频认证方式签署合同后,获取用户的签署人脸认证视频。
|
1892
|
+
|
1893
|
+
# 1. 该接口**仅适用于在H5端签署**的合同,**在通过视频认证后**获取人脸图片。
|
1894
|
+
# 2. 该接口**不支持小程序端**的签署人脸图片获取。
|
1895
|
+
# 3. 请在**签署完成后的三天内**获取人脸图片,**过期后将无法获取**。
|
1896
|
+
|
1897
|
+
# **注意:该接口需要开通白名单,请联系客户经理开通后使用。**
|
1898
|
+
|
1899
|
+
# @param request: Request instance for DescribeSignFaceVideo.
|
1900
|
+
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeSignFaceVideoRequest`
|
1901
|
+
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeSignFaceVideoResponse`
|
1902
|
+
def DescribeSignFaceVideo(request)
|
1903
|
+
body = send_request('DescribeSignFaceVideo', request.serialize)
|
1904
|
+
response = JSON.parse(body)
|
1905
|
+
if response['Response'].key?('Error') == false
|
1906
|
+
model = DescribeSignFaceVideoResponse.new
|
1907
|
+
model.deserialize(response['Response'])
|
1908
|
+
model
|
1909
|
+
else
|
1910
|
+
code = response['Response']['Error']['Code']
|
1911
|
+
message = response['Response']['Error']['Message']
|
1912
|
+
reqid = response['Response']['RequestId']
|
1913
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
1914
|
+
end
|
1915
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
1916
|
+
raise e
|
1917
|
+
rescue StandardError => e
|
1918
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1919
|
+
end
|
1920
|
+
|
1891
1921
|
# 通过AuthCode查询个人用户是否实名
|
1892
1922
|
|
1893
1923
|
|
data/lib/v20201111/models.rb
CHANGED
@@ -6354,6 +6354,81 @@ module TencentCloud
|
|
6354
6354
|
end
|
6355
6355
|
end
|
6356
6356
|
|
6357
|
+
# DescribeSignFaceVideo请求参数结构体
|
6358
|
+
class DescribeSignFaceVideoRequest < TencentCloud::Common::AbstractModel
|
6359
|
+
# @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
6360
|
+
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
6361
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
6362
|
+
# @type FlowId: String
|
6363
|
+
# @param SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
|
6364
|
+
# @type SignId: String
|
6365
|
+
# @param Agent: 代理企业和员工的信息。
|
6366
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
6367
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
6368
|
+
|
6369
|
+
attr_accessor :Operator, :FlowId, :SignId, :Agent
|
6370
|
+
|
6371
|
+
def initialize(operator=nil, flowid=nil, signid=nil, agent=nil)
|
6372
|
+
@Operator = operator
|
6373
|
+
@FlowId = flowid
|
6374
|
+
@SignId = signid
|
6375
|
+
@Agent = agent
|
6376
|
+
end
|
6377
|
+
|
6378
|
+
def deserialize(params)
|
6379
|
+
unless params['Operator'].nil?
|
6380
|
+
@Operator = UserInfo.new
|
6381
|
+
@Operator.deserialize(params['Operator'])
|
6382
|
+
end
|
6383
|
+
@FlowId = params['FlowId']
|
6384
|
+
@SignId = params['SignId']
|
6385
|
+
unless params['Agent'].nil?
|
6386
|
+
@Agent = Agent.new
|
6387
|
+
@Agent.deserialize(params['Agent'])
|
6388
|
+
end
|
6389
|
+
end
|
6390
|
+
end
|
6391
|
+
|
6392
|
+
# DescribeSignFaceVideo返回参数结构体
|
6393
|
+
class DescribeSignFaceVideoResponse < TencentCloud::Common::AbstractModel
|
6394
|
+
# @param VideoData: 核身视频结果。
|
6395
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6396
|
+
# @type VideoData: :class:`Tencentcloud::Ess.v20201111.models.DetectInfoVideoData`
|
6397
|
+
# @param IntentionQuestionResult: 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
|
6398
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6399
|
+
# @type IntentionQuestionResult: :class:`Tencentcloud::Ess.v20201111.models.IntentionQuestionResult`
|
6400
|
+
# @param IntentionActionResult: 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
|
6401
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6402
|
+
# @type IntentionActionResult: :class:`Tencentcloud::Ess.v20201111.models.IntentionActionResult`
|
6403
|
+
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
6404
|
+
# @type RequestId: String
|
6405
|
+
|
6406
|
+
attr_accessor :VideoData, :IntentionQuestionResult, :IntentionActionResult, :RequestId
|
6407
|
+
|
6408
|
+
def initialize(videodata=nil, intentionquestionresult=nil, intentionactionresult=nil, requestid=nil)
|
6409
|
+
@VideoData = videodata
|
6410
|
+
@IntentionQuestionResult = intentionquestionresult
|
6411
|
+
@IntentionActionResult = intentionactionresult
|
6412
|
+
@RequestId = requestid
|
6413
|
+
end
|
6414
|
+
|
6415
|
+
def deserialize(params)
|
6416
|
+
unless params['VideoData'].nil?
|
6417
|
+
@VideoData = DetectInfoVideoData.new
|
6418
|
+
@VideoData.deserialize(params['VideoData'])
|
6419
|
+
end
|
6420
|
+
unless params['IntentionQuestionResult'].nil?
|
6421
|
+
@IntentionQuestionResult = IntentionQuestionResult.new
|
6422
|
+
@IntentionQuestionResult.deserialize(params['IntentionQuestionResult'])
|
6423
|
+
end
|
6424
|
+
unless params['IntentionActionResult'].nil?
|
6425
|
+
@IntentionActionResult = IntentionActionResult.new
|
6426
|
+
@IntentionActionResult.deserialize(params['IntentionActionResult'])
|
6427
|
+
end
|
6428
|
+
@RequestId = params['RequestId']
|
6429
|
+
end
|
6430
|
+
end
|
6431
|
+
|
6357
6432
|
# DescribeThirdPartyAuthCode请求参数结构体
|
6358
6433
|
class DescribeThirdPartyAuthCodeRequest < TencentCloud::Common::AbstractModel
|
6359
6434
|
# @param AuthCode: 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
|
@@ -6487,6 +6562,25 @@ module TencentCloud
|
|
6487
6562
|
end
|
6488
6563
|
end
|
6489
6564
|
|
6565
|
+
# 视频认证结果
|
6566
|
+
class DetectInfoVideoData < TencentCloud::Common::AbstractModel
|
6567
|
+
# @param LiveNessVideo: 活体视频的base64编码,mp4格式
|
6568
|
+
|
6569
|
+
# 注:`需进行base64解码获取活体视频文件`
|
6570
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
6571
|
+
# @type LiveNessVideo: String
|
6572
|
+
|
6573
|
+
attr_accessor :LiveNessVideo
|
6574
|
+
|
6575
|
+
def initialize(livenessvideo=nil)
|
6576
|
+
@LiveNessVideo = livenessvideo
|
6577
|
+
end
|
6578
|
+
|
6579
|
+
def deserialize(params)
|
6580
|
+
@LiveNessVideo = params['LiveNessVideo']
|
6581
|
+
end
|
6582
|
+
end
|
6583
|
+
|
6490
6584
|
# DisableUserAutoSign请求参数结构体
|
6491
6585
|
class DisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
|
6492
6586
|
# @param Operator: 执行本接口操作的员工信息。
|
@@ -7267,13 +7361,19 @@ module TencentCloud
|
|
7267
7361
|
|
7268
7362
|
# 注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
|
7269
7363
|
# @type Deadline: Integer
|
7364
|
+
# @param Intention: 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
|
7365
|
+
|
7366
|
+
# 注:
|
7367
|
+
# `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
|
7368
|
+
# `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
|
7369
|
+
# @type Intention: :class:`Tencentcloud::Ess.v20201111.models.Intention`
|
7270
7370
|
|
7271
|
-
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, :SignTypeSelector, :Deadline
|
7371
|
+
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, :SignTypeSelector, :Deadline, :Intention
|
7272
7372
|
extend Gem::Deprecate
|
7273
7373
|
deprecate :JumpUrl, :none, 2024, 3
|
7274
7374
|
deprecate :JumpUrl=, :none, 2024, 3
|
7275
7375
|
|
7276
|
-
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, signtypeselector=nil, deadline=nil)
|
7376
|
+
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, signtypeselector=nil, deadline=nil, intention=nil)
|
7277
7377
|
@ApproverType = approvertype
|
7278
7378
|
@OrganizationName = organizationname
|
7279
7379
|
@ApproverName = approvername
|
@@ -7301,6 +7401,7 @@ module TencentCloud
|
|
7301
7401
|
@ApproverSignTypes = approversigntypes
|
7302
7402
|
@SignTypeSelector = signtypeselector
|
7303
7403
|
@Deadline = deadline
|
7404
|
+
@Intention = intention
|
7304
7405
|
end
|
7305
7406
|
|
7306
7407
|
def deserialize(params)
|
@@ -7351,6 +7452,10 @@ module TencentCloud
|
|
7351
7452
|
@ApproverSignTypes = params['ApproverSignTypes']
|
7352
7453
|
@SignTypeSelector = params['SignTypeSelector']
|
7353
7454
|
@Deadline = params['Deadline']
|
7455
|
+
unless params['Intention'].nil?
|
7456
|
+
@Intention = Intention.new
|
7457
|
+
@Intention.deserialize(params['Intention'])
|
7458
|
+
end
|
7354
7459
|
end
|
7355
7460
|
end
|
7356
7461
|
|
@@ -8185,6 +8290,156 @@ module TencentCloud
|
|
8185
8290
|
end
|
8186
8291
|
end
|
8187
8292
|
|
8293
|
+
# 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
|
8294
|
+
|
8295
|
+
# 注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
|
8296
|
+
class Intention < TencentCloud::Common::AbstractModel
|
8297
|
+
# @param IntentionType: 视频认证类型,支持以下类型
|
8298
|
+
# <ul><li>1 : 问答模式</li>
|
8299
|
+
# <li>2 : 点头模式</li></ul>
|
8300
|
+
|
8301
|
+
# 注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
|
8302
|
+
# @type IntentionType: Integer
|
8303
|
+
# @param IntentionQuestions: 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
|
8304
|
+
# @type IntentionQuestions: Array
|
8305
|
+
# @param IntentionActions: 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
|
8306
|
+
# @type IntentionActions: Array
|
8307
|
+
|
8308
|
+
attr_accessor :IntentionType, :IntentionQuestions, :IntentionActions
|
8309
|
+
|
8310
|
+
def initialize(intentiontype=nil, intentionquestions=nil, intentionactions=nil)
|
8311
|
+
@IntentionType = intentiontype
|
8312
|
+
@IntentionQuestions = intentionquestions
|
8313
|
+
@IntentionActions = intentionactions
|
8314
|
+
end
|
8315
|
+
|
8316
|
+
def deserialize(params)
|
8317
|
+
@IntentionType = params['IntentionType']
|
8318
|
+
unless params['IntentionQuestions'].nil?
|
8319
|
+
@IntentionQuestions = []
|
8320
|
+
params['IntentionQuestions'].each do |i|
|
8321
|
+
intentionquestion_tmp = IntentionQuestion.new
|
8322
|
+
intentionquestion_tmp.deserialize(i)
|
8323
|
+
@IntentionQuestions << intentionquestion_tmp
|
8324
|
+
end
|
8325
|
+
end
|
8326
|
+
unless params['IntentionActions'].nil?
|
8327
|
+
@IntentionActions = []
|
8328
|
+
params['IntentionActions'].each do |i|
|
8329
|
+
intentionaction_tmp = IntentionAction.new
|
8330
|
+
intentionaction_tmp.deserialize(i)
|
8331
|
+
@IntentionActions << intentionaction_tmp
|
8332
|
+
end
|
8333
|
+
end
|
8334
|
+
end
|
8335
|
+
end
|
8336
|
+
|
8337
|
+
# 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
|
8338
|
+
class IntentionAction < TencentCloud::Common::AbstractModel
|
8339
|
+
# @param Text: 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
|
8340
|
+
# @type Text: String
|
8341
|
+
|
8342
|
+
attr_accessor :Text
|
8343
|
+
|
8344
|
+
def initialize(text=nil)
|
8345
|
+
@Text = text
|
8346
|
+
end
|
8347
|
+
|
8348
|
+
def deserialize(params)
|
8349
|
+
@Text = params['Text']
|
8350
|
+
end
|
8351
|
+
end
|
8352
|
+
|
8353
|
+
# 意愿核身点头确认模式结果
|
8354
|
+
class IntentionActionResult < TencentCloud::Common::AbstractModel
|
8355
|
+
# @param Details: 意愿核身结果详细数据,与每段点头确认过程一一对应
|
8356
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
8357
|
+
# @type Details: Array
|
8358
|
+
|
8359
|
+
attr_accessor :Details
|
8360
|
+
|
8361
|
+
def initialize(details=nil)
|
8362
|
+
@Details = details
|
8363
|
+
end
|
8364
|
+
|
8365
|
+
def deserialize(params)
|
8366
|
+
unless params['Details'].nil?
|
8367
|
+
@Details = []
|
8368
|
+
params['Details'].each do |i|
|
8369
|
+
intentionactionresultdetail_tmp = IntentionActionResultDetail.new
|
8370
|
+
intentionactionresultdetail_tmp.deserialize(i)
|
8371
|
+
@Details << intentionactionresultdetail_tmp
|
8372
|
+
end
|
8373
|
+
end
|
8374
|
+
end
|
8375
|
+
end
|
8376
|
+
|
8377
|
+
# 意愿核身点头确认模式结果详细数据
|
8378
|
+
class IntentionActionResultDetail < TencentCloud::Common::AbstractModel
|
8379
|
+
# @param Video: 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
|
8380
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
8381
|
+
# @type Video: String
|
8382
|
+
|
8383
|
+
attr_accessor :Video
|
8384
|
+
|
8385
|
+
def initialize(video=nil)
|
8386
|
+
@Video = video
|
8387
|
+
end
|
8388
|
+
|
8389
|
+
def deserialize(params)
|
8390
|
+
@Video = params['Video']
|
8391
|
+
end
|
8392
|
+
end
|
8393
|
+
|
8394
|
+
# 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
|
8395
|
+
class IntentionQuestion < TencentCloud::Common::AbstractModel
|
8396
|
+
# @param Question: 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
|
8397
|
+
# @type Question: String
|
8398
|
+
# @param Answers: 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。
|
8399
|
+
# @type Answers: Array
|
8400
|
+
|
8401
|
+
attr_accessor :Question, :Answers
|
8402
|
+
|
8403
|
+
def initialize(question=nil, answers=nil)
|
8404
|
+
@Question = question
|
8405
|
+
@Answers = answers
|
8406
|
+
end
|
8407
|
+
|
8408
|
+
def deserialize(params)
|
8409
|
+
@Question = params['Question']
|
8410
|
+
@Answers = params['Answers']
|
8411
|
+
end
|
8412
|
+
end
|
8413
|
+
|
8414
|
+
# 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
|
8415
|
+
class IntentionQuestionResult < TencentCloud::Common::AbstractModel
|
8416
|
+
# @param Video: 视频base64(其中包含全程问题和回答音频,mp4格式)
|
8417
|
+
|
8418
|
+
# 注:`需进行base64解码获取视频文件`
|
8419
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
8420
|
+
# @type Video: String
|
8421
|
+
# @param ResultCode: 和答案匹配结果列表
|
8422
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
8423
|
+
# @type ResultCode: Array
|
8424
|
+
# @param AsrResult: 回答问题语音识别结果列表
|
8425
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
8426
|
+
# @type AsrResult: Array
|
8427
|
+
|
8428
|
+
attr_accessor :Video, :ResultCode, :AsrResult
|
8429
|
+
|
8430
|
+
def initialize(video=nil, resultcode=nil, asrresult=nil)
|
8431
|
+
@Video = video
|
8432
|
+
@ResultCode = resultcode
|
8433
|
+
@AsrResult = asrresult
|
8434
|
+
end
|
8435
|
+
|
8436
|
+
def deserialize(params)
|
8437
|
+
@Video = params['Video']
|
8438
|
+
@ResultCode = params['ResultCode']
|
8439
|
+
@AsrResult = params['AsrResult']
|
8440
|
+
end
|
8441
|
+
end
|
8442
|
+
|
8188
8443
|
# ModifyApplicationCallbackInfo请求参数结构体
|
8189
8444
|
class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
|
8190
8445
|
# @param Operator: 执行本接口操作的员工信息。
|
@@ -9530,84 +9785,105 @@ module TencentCloud
|
|
9530
9785
|
class TemplateInfo < TencentCloud::Common::AbstractModel
|
9531
9786
|
# @param TemplateId: 模板ID,模板的唯一标识
|
9532
9787
|
# @type TemplateId: String
|
9533
|
-
# @param TemplateName:
|
9788
|
+
# @param TemplateName: 模板的名字
|
9534
9789
|
# @type TemplateName: String
|
9790
|
+
# @param Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
|
9791
|
+
|
9792
|
+
# [点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
|
9793
|
+
|
9794
|
+
# @type Recipients: Array
|
9795
|
+
# @param Components: 模板的填充控件列表
|
9796
|
+
|
9797
|
+
# [点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
|
9798
|
+
# @type Components: Array
|
9799
|
+
# @param SignComponents: 此模板中的签署控件列表
|
9800
|
+
|
9801
|
+
# [点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
|
9802
|
+
# @type SignComponents: Array
|
9535
9803
|
# @param Description: 模板描述信息
|
9536
9804
|
# @type Description: String
|
9537
|
-
# @param DocumentResourceIds:
|
9805
|
+
# @param DocumentResourceIds: 此模板的资源ID
|
9538
9806
|
# @type DocumentResourceIds: Array
|
9539
9807
|
# @param FileInfos: 生成模板的文件基础信息
|
9540
9808
|
# @type FileInfos: Array
|
9541
|
-
# @param AttachmentResourceIds:
|
9809
|
+
# @param AttachmentResourceIds: 此模板里边附件的资源ID
|
9542
9810
|
# @type AttachmentResourceIds: Array
|
9543
|
-
# @param SignOrder:
|
9544
|
-
|
9545
|
-
#
|
9811
|
+
# @param SignOrder: 签署人参与签署的顺序,可以分为以下两种方式:
|
9812
|
+
|
9813
|
+
# <b>无序</b>:不限定签署人的签署顺序,签署人可以在任何时间签署。此种方式值为 :{-1}
|
9814
|
+
# <b>有序</b>:通过序列数字标识签署顺序,从0开始编码,数字越大签署顺序越靠后,签署人按照指定的顺序依次签署。此种方式值为: {0,1,2,3………}
|
9546
9815
|
# @type SignOrder: Array
|
9547
|
-
# @param
|
9548
|
-
|
9549
|
-
#
|
9550
|
-
#
|
9551
|
-
#
|
9552
|
-
# @type SignComponents: Array
|
9553
|
-
# @param Status: 模板状态
|
9554
|
-
# -1:不可用
|
9555
|
-
# 0:草稿态
|
9556
|
-
# 1:正式态,可以正常使用
|
9816
|
+
# @param Status: 此模板的状态可以分为以下几种:
|
9817
|
+
|
9818
|
+
# <b>-1</b>:不可用状态。
|
9819
|
+
# <b>0</b>:草稿态,即模板正在编辑或未发布状态。
|
9820
|
+
# <b>1</b>:正式态,只有正式态的模板才可以发起合同。
|
9557
9821
|
# @type Status: Integer
|
9558
|
-
# @param Creator:
|
9822
|
+
# @param Creator: 模板的创建者信息,用户的名字
|
9823
|
+
|
9824
|
+
# 注: `是创建者的名字,而非创建者的用户ID`
|
9559
9825
|
# @type Creator: String
|
9560
9826
|
# @param CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
|
9561
9827
|
# @type CreatedOn: Integer
|
9562
|
-
# @param Promoter:
|
9828
|
+
# @param Promoter: 此模板创建方角色信息。
|
9829
|
+
|
9830
|
+
# [点击查看在模板中配置的创建方角色的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
|
9563
9831
|
# @type Promoter: :class:`Tencentcloud::Ess.v20201111.models.Recipient`
|
9564
|
-
# @param TemplateType:
|
9565
|
-
|
9566
|
-
#
|
9832
|
+
# @param TemplateType: 模板类型可以分为以下两种:
|
9833
|
+
|
9834
|
+
# <b>1</b>:带有本企业自动签署的模板,即签署过程无需签署人手动操作,系统自动完成签署。
|
9835
|
+
# <b>3</b>:普通模板,即签署人需要手动进行签署操作。
|
9567
9836
|
# @type TemplateType: Integer
|
9568
|
-
# @param Available:
|
9569
|
-
|
9570
|
-
#
|
9837
|
+
# @param Available: 模板可用状态可以分为以下两种:
|
9838
|
+
|
9839
|
+
# <b>1</b>:(默认)启用状态,即模板可以正常使用。
|
9840
|
+
# <b>2</b>:停用状态,即模板暂时无法使用。
|
9841
|
+
|
9842
|
+
# 可到控制台启停模板
|
9571
9843
|
# @type Available: Integer
|
9572
9844
|
# @param OrganizationId: 创建模板的企业ID,电子签的机构ID
|
9573
9845
|
# @type OrganizationId: String
|
9574
|
-
# @param
|
9846
|
+
# @param CreatorId: 模板创建人用户ID
|
9847
|
+
# @type CreatorId: String
|
9848
|
+
# @param PreviewUrl: 模板的H5预览链接,有效期5分钟。
|
9849
|
+
# 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
9575
9850
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9576
9851
|
# @type PreviewUrl: String
|
9577
|
-
# @param TemplateVersion:
|
9852
|
+
# @param TemplateVersion: 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
|
9578
9853
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9579
9854
|
# @type TemplateVersion: String
|
9580
|
-
# @param Published:
|
9581
|
-
|
9582
|
-
#
|
9855
|
+
# @param Published: 模板是否已发布可以分为以下两种状态:
|
9856
|
+
|
9857
|
+
# <b>true</b>:已发布状态,表示该模板已经发布并可以正常使用。
|
9858
|
+
# <b>false</b>:未发布状态,表示该模板还未发布,无法使用。
|
9583
9859
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9584
9860
|
# @type Published: Boolean
|
9585
|
-
# @param ShareTemplateId:
|
9861
|
+
# @param ShareTemplateId: <b>集体账号场景下</b>: 集团账号分享给子企业的模板的来源模板ID。
|
9586
9862
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9587
9863
|
# @type ShareTemplateId: String
|
9588
|
-
# @param TemplateSeals:
|
9864
|
+
# @param TemplateSeals: 此模板配置的预填印章列表(包括自动签署指定的印章)
|
9589
9865
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9590
9866
|
# @type TemplateSeals: Array
|
9591
9867
|
# @param Seals: 模板内部指定的印章列表
|
9592
9868
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9593
9869
|
# @type Seals: Array
|
9594
9870
|
|
9595
|
-
attr_accessor :TemplateId, :TemplateName, :
|
9871
|
+
attr_accessor :TemplateId, :TemplateName, :Recipients, :Components, :SignComponents, :Description, :DocumentResourceIds, :FileInfos, :AttachmentResourceIds, :SignOrder, :Status, :Creator, :CreatedOn, :Promoter, :TemplateType, :Available, :OrganizationId, :CreatorId, :PreviewUrl, :TemplateVersion, :Published, :ShareTemplateId, :TemplateSeals, :Seals
|
9596
9872
|
extend Gem::Deprecate
|
9597
9873
|
deprecate :Seals, :none, 2024, 3
|
9598
9874
|
deprecate :Seals=, :none, 2024, 3
|
9599
9875
|
|
9600
|
-
def initialize(templateid=nil, templatename=nil,
|
9876
|
+
def initialize(templateid=nil, templatename=nil, recipients=nil, components=nil, signcomponents=nil, description=nil, documentresourceids=nil, fileinfos=nil, attachmentresourceids=nil, signorder=nil, status=nil, creator=nil, createdon=nil, promoter=nil, templatetype=nil, available=nil, organizationid=nil, creatorid=nil, previewurl=nil, templateversion=nil, published=nil, sharetemplateid=nil, templateseals=nil, seals=nil)
|
9601
9877
|
@TemplateId = templateid
|
9602
9878
|
@TemplateName = templatename
|
9879
|
+
@Recipients = recipients
|
9880
|
+
@Components = components
|
9881
|
+
@SignComponents = signcomponents
|
9603
9882
|
@Description = description
|
9604
9883
|
@DocumentResourceIds = documentresourceids
|
9605
9884
|
@FileInfos = fileinfos
|
9606
9885
|
@AttachmentResourceIds = attachmentresourceids
|
9607
9886
|
@SignOrder = signorder
|
9608
|
-
@Recipients = recipients
|
9609
|
-
@Components = components
|
9610
|
-
@SignComponents = signcomponents
|
9611
9887
|
@Status = status
|
9612
9888
|
@Creator = creator
|
9613
9889
|
@CreatedOn = createdon
|
@@ -9615,6 +9891,7 @@ module TencentCloud
|
|
9615
9891
|
@TemplateType = templatetype
|
9616
9892
|
@Available = available
|
9617
9893
|
@OrganizationId = organizationid
|
9894
|
+
@CreatorId = creatorid
|
9618
9895
|
@PreviewUrl = previewurl
|
9619
9896
|
@TemplateVersion = templateversion
|
9620
9897
|
@Published = published
|
@@ -9626,18 +9903,6 @@ module TencentCloud
|
|
9626
9903
|
def deserialize(params)
|
9627
9904
|
@TemplateId = params['TemplateId']
|
9628
9905
|
@TemplateName = params['TemplateName']
|
9629
|
-
@Description = params['Description']
|
9630
|
-
@DocumentResourceIds = params['DocumentResourceIds']
|
9631
|
-
unless params['FileInfos'].nil?
|
9632
|
-
@FileInfos = []
|
9633
|
-
params['FileInfos'].each do |i|
|
9634
|
-
fileinfo_tmp = FileInfo.new
|
9635
|
-
fileinfo_tmp.deserialize(i)
|
9636
|
-
@FileInfos << fileinfo_tmp
|
9637
|
-
end
|
9638
|
-
end
|
9639
|
-
@AttachmentResourceIds = params['AttachmentResourceIds']
|
9640
|
-
@SignOrder = params['SignOrder']
|
9641
9906
|
unless params['Recipients'].nil?
|
9642
9907
|
@Recipients = []
|
9643
9908
|
params['Recipients'].each do |i|
|
@@ -9662,6 +9927,18 @@ module TencentCloud
|
|
9662
9927
|
@SignComponents << component_tmp
|
9663
9928
|
end
|
9664
9929
|
end
|
9930
|
+
@Description = params['Description']
|
9931
|
+
@DocumentResourceIds = params['DocumentResourceIds']
|
9932
|
+
unless params['FileInfos'].nil?
|
9933
|
+
@FileInfos = []
|
9934
|
+
params['FileInfos'].each do |i|
|
9935
|
+
fileinfo_tmp = FileInfo.new
|
9936
|
+
fileinfo_tmp.deserialize(i)
|
9937
|
+
@FileInfos << fileinfo_tmp
|
9938
|
+
end
|
9939
|
+
end
|
9940
|
+
@AttachmentResourceIds = params['AttachmentResourceIds']
|
9941
|
+
@SignOrder = params['SignOrder']
|
9665
9942
|
@Status = params['Status']
|
9666
9943
|
@Creator = params['Creator']
|
9667
9944
|
@CreatedOn = params['CreatedOn']
|
@@ -9672,6 +9949,7 @@ module TencentCloud
|
|
9672
9949
|
@TemplateType = params['TemplateType']
|
9673
9950
|
@Available = params['Available']
|
9674
9951
|
@OrganizationId = params['OrganizationId']
|
9952
|
+
@CreatorId = params['CreatorId']
|
9675
9953
|
@PreviewUrl = params['PreviewUrl']
|
9676
9954
|
@TemplateVersion = params['TemplateVersion']
|
9677
9955
|
@Published = params['Published']
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tencentcloud-sdk-ess
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.776
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-03-
|
11
|
+
date: 2024-03-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|