tencentcloud-sdk-essbasic 1.0.200

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.
@@ -0,0 +1,1357 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ require 'json'
18
+
19
+ module TencentCloud
20
+ module Essbasic
21
+ module V20201222
22
+ class Client < TencentCloud::Common::AbstractClient
23
+
24
+ def initialize(credential, region, profile = nil)
25
+ api_version = '2020-12-22'
26
+ api_endpoint = 'essbasic.tencentcloudapi.com'
27
+ sdk_version = 'ESSBASIC_' + File.read(File.expand_path('../VERSION', __dir__)).strip
28
+ super(credential, region, api_version, api_endpoint, sdk_version, profile)
29
+ end
30
+
31
+
32
+ # 此接口(ArchiveFlow)用于流程的归档。
33
+
34
+ # 注意:归档后的流程不可再进行发送、签署、拒签、撤回等一系列操作。
35
+
36
+ # @param request: Request instance for ArchiveFlow.
37
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::ArchiveFlowRequest`
38
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::ArchiveFlowResponse`
39
+ def ArchiveFlow(request)
40
+ body = send_request('ArchiveFlow', request.serialize)
41
+ response = JSON.parse(body)
42
+ if response['Response'].key?('Error') == false
43
+ model = ArchiveFlowResponse.new
44
+ model.deserialize(response['Response'])
45
+ model
46
+ else
47
+ code = response['Response']['Error']['Code']
48
+ message = response['Response']['Error']['Message']
49
+ reqid = response['Response']['RequestId']
50
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
51
+ end
52
+ rescue TencentCloud::Common::TencentCloudSDKException => e
53
+ raise e
54
+ rescue StandardError => e
55
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
56
+ end
57
+
58
+ # 此接口(CancelFlow)用于撤销正在进行中的流程。
59
+
60
+ # 注:已归档流程不可完成撤销动作。
61
+
62
+ # @param request: Request instance for CancelFlow.
63
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CancelFlowRequest`
64
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CancelFlowResponse`
65
+ def CancelFlow(request)
66
+ body = send_request('CancelFlow', request.serialize)
67
+ response = JSON.parse(body)
68
+ if response['Response'].key?('Error') == false
69
+ model = CancelFlowResponse.new
70
+ model.deserialize(response['Response'])
71
+ model
72
+ else
73
+ code = response['Response']['Error']['Code']
74
+ message = response['Response']['Error']['Message']
75
+ reqid = response['Response']['RequestId']
76
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
77
+ end
78
+ rescue TencentCloud::Common::TencentCloudSDKException => e
79
+ raise e
80
+ rescue StandardError => e
81
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
82
+ end
83
+
84
+ # 该接口为第三方平台向电子签平台验证银行卡二要素
85
+
86
+ # @param request: Request instance for CheckBankCard2EVerification.
87
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckBankCard2EVerificationRequest`
88
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckBankCard2EVerificationResponse`
89
+ def CheckBankCard2EVerification(request)
90
+ body = send_request('CheckBankCard2EVerification', request.serialize)
91
+ response = JSON.parse(body)
92
+ if response['Response'].key?('Error') == false
93
+ model = CheckBankCard2EVerificationResponse.new
94
+ model.deserialize(response['Response'])
95
+ model
96
+ else
97
+ code = response['Response']['Error']['Code']
98
+ message = response['Response']['Error']['Message']
99
+ reqid = response['Response']['RequestId']
100
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
101
+ end
102
+ rescue TencentCloud::Common::TencentCloudSDKException => e
103
+ raise e
104
+ rescue StandardError => e
105
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
106
+ end
107
+
108
+ # 该接口为第三方平台向电子签平台验证银行卡三要素
109
+
110
+ # @param request: Request instance for CheckBankCard3EVerification.
111
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckBankCard3EVerificationRequest`
112
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckBankCard3EVerificationResponse`
113
+ def CheckBankCard3EVerification(request)
114
+ body = send_request('CheckBankCard3EVerification', request.serialize)
115
+ response = JSON.parse(body)
116
+ if response['Response'].key?('Error') == false
117
+ model = CheckBankCard3EVerificationResponse.new
118
+ model.deserialize(response['Response'])
119
+ model
120
+ else
121
+ code = response['Response']['Error']['Code']
122
+ message = response['Response']['Error']['Message']
123
+ reqid = response['Response']['RequestId']
124
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
125
+ end
126
+ rescue TencentCloud::Common::TencentCloudSDKException => e
127
+ raise e
128
+ rescue StandardError => e
129
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
130
+ end
131
+
132
+ # 该接口为第三方平台向电子签平台验证银行卡四要素
133
+
134
+ # @param request: Request instance for CheckBankCard4EVerification.
135
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckBankCard4EVerificationRequest`
136
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckBankCard4EVerificationResponse`
137
+ def CheckBankCard4EVerification(request)
138
+ body = send_request('CheckBankCard4EVerification', request.serialize)
139
+ response = JSON.parse(body)
140
+ if response['Response'].key?('Error') == false
141
+ model = CheckBankCard4EVerificationResponse.new
142
+ model.deserialize(response['Response'])
143
+ model
144
+ else
145
+ code = response['Response']['Error']['Code']
146
+ message = response['Response']['Error']['Message']
147
+ reqid = response['Response']['RequestId']
148
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
149
+ end
150
+ rescue TencentCloud::Common::TencentCloudSDKException => e
151
+ raise e
152
+ rescue StandardError => e
153
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
154
+ end
155
+
156
+ # 该接口为第三方平台向电子签平台验证银行卡二/三/四要素
157
+ # 银行卡二要素(同CheckBankCard2EVerification): bank_card + name
158
+ # 银行卡三要素(同CheckBankCard3EVerification): bank_card + name + id_card_number
159
+ # 银行卡四要素(同CheckBankCard4EVerification): bank_card + name + id_card_number + mobile
160
+
161
+ # @param request: Request instance for CheckBankCardVerification.
162
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckBankCardVerificationRequest`
163
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckBankCardVerificationResponse`
164
+ def CheckBankCardVerification(request)
165
+ body = send_request('CheckBankCardVerification', request.serialize)
166
+ response = JSON.parse(body)
167
+ if response['Response'].key?('Error') == false
168
+ model = CheckBankCardVerificationResponse.new
169
+ model.deserialize(response['Response'])
170
+ model
171
+ else
172
+ code = response['Response']['Error']['Code']
173
+ message = response['Response']['Error']['Message']
174
+ reqid = response['Response']['RequestId']
175
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
176
+ end
177
+ rescue TencentCloud::Common::TencentCloudSDKException => e
178
+ raise e
179
+ rescue StandardError => e
180
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
181
+ end
182
+
183
+ # 该接口为第三方平台向电子签平台检测慧眼或腾讯电子签小程序人脸核身结果
184
+
185
+ # @param request: Request instance for CheckFaceIdentify.
186
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckFaceIdentifyRequest`
187
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckFaceIdentifyResponse`
188
+ def CheckFaceIdentify(request)
189
+ body = send_request('CheckFaceIdentify', request.serialize)
190
+ response = JSON.parse(body)
191
+ if response['Response'].key?('Error') == false
192
+ model = CheckFaceIdentifyResponse.new
193
+ model.deserialize(response['Response'])
194
+ model
195
+ else
196
+ code = response['Response']['Error']['Code']
197
+ message = response['Response']['Error']['Message']
198
+ reqid = response['Response']['RequestId']
199
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
200
+ end
201
+ rescue TencentCloud::Common::TencentCloudSDKException => e
202
+ raise e
203
+ rescue StandardError => e
204
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
205
+ end
206
+
207
+ # 该接口为第三方平台向电子签平台验证姓名和身份证信息
208
+
209
+ # @param request: Request instance for CheckIdCardVerification.
210
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckIdCardVerificationRequest`
211
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckIdCardVerificationResponse`
212
+ def CheckIdCardVerification(request)
213
+ body = send_request('CheckIdCardVerification', request.serialize)
214
+ response = JSON.parse(body)
215
+ if response['Response'].key?('Error') == false
216
+ model = CheckIdCardVerificationResponse.new
217
+ model.deserialize(response['Response'])
218
+ model
219
+ else
220
+ code = response['Response']['Error']['Code']
221
+ message = response['Response']['Error']['Message']
222
+ reqid = response['Response']['RequestId']
223
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
224
+ end
225
+ rescue TencentCloud::Common::TencentCloudSDKException => e
226
+ raise e
227
+ rescue StandardError => e
228
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
229
+ end
230
+
231
+ # 该接口为第三方平台向电子签平台验证手机号二要素
232
+
233
+ # @param request: Request instance for CheckMobileAndName.
234
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckMobileAndNameRequest`
235
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckMobileAndNameResponse`
236
+ def CheckMobileAndName(request)
237
+ body = send_request('CheckMobileAndName', request.serialize)
238
+ response = JSON.parse(body)
239
+ if response['Response'].key?('Error') == false
240
+ model = CheckMobileAndNameResponse.new
241
+ model.deserialize(response['Response'])
242
+ model
243
+ else
244
+ code = response['Response']['Error']['Code']
245
+ message = response['Response']['Error']['Message']
246
+ reqid = response['Response']['RequestId']
247
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
248
+ end
249
+ rescue TencentCloud::Common::TencentCloudSDKException => e
250
+ raise e
251
+ rescue StandardError => e
252
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
253
+ end
254
+
255
+ # 该接口为第三方平台向电子签平台验证手机号三要素
256
+
257
+ # @param request: Request instance for CheckMobileVerification.
258
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckMobileVerificationRequest`
259
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckMobileVerificationResponse`
260
+ def CheckMobileVerification(request)
261
+ body = send_request('CheckMobileVerification', request.serialize)
262
+ response = JSON.parse(body)
263
+ if response['Response'].key?('Error') == false
264
+ model = CheckMobileVerificationResponse.new
265
+ model.deserialize(response['Response'])
266
+ model
267
+ else
268
+ code = response['Response']['Error']['Code']
269
+ message = response['Response']['Error']['Message']
270
+ reqid = response['Response']['RequestId']
271
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
272
+ end
273
+ rescue TencentCloud::Common::TencentCloudSDKException => e
274
+ raise e
275
+ rescue StandardError => e
276
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
277
+ end
278
+
279
+ # 此接口用于确认验证码是否正确
280
+
281
+ # @param request: Request instance for CheckVerifyCodeMatchFlowId.
282
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CheckVerifyCodeMatchFlowIdRequest`
283
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CheckVerifyCodeMatchFlowIdResponse`
284
+ def CheckVerifyCodeMatchFlowId(request)
285
+ body = send_request('CheckVerifyCodeMatchFlowId', request.serialize)
286
+ response = JSON.parse(body)
287
+ if response['Response'].key?('Error') == false
288
+ model = CheckVerifyCodeMatchFlowIdResponse.new
289
+ model.deserialize(response['Response'])
290
+ model
291
+ else
292
+ code = response['Response']['Error']['Code']
293
+ message = response['Response']['Error']['Message']
294
+ reqid = response['Response']['RequestId']
295
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
296
+ end
297
+ rescue TencentCloud::Common::TencentCloudSDKException => e
298
+ raise e
299
+ rescue StandardError => e
300
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
301
+ end
302
+
303
+ # 该接口为第三方平台向电子签平台获取慧眼慧眼API签名
304
+
305
+ # @param request: Request instance for CreateFaceIdSign.
306
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateFaceIdSignRequest`
307
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateFaceIdSignResponse`
308
+ def CreateFaceIdSign(request)
309
+ body = send_request('CreateFaceIdSign', request.serialize)
310
+ response = JSON.parse(body)
311
+ if response['Response'].key?('Error') == false
312
+ model = CreateFaceIdSignResponse.new
313
+ model.deserialize(response['Response'])
314
+ model
315
+ else
316
+ code = response['Response']['Error']['Code']
317
+ message = response['Response']['Error']['Message']
318
+ reqid = response['Response']['RequestId']
319
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
320
+ end
321
+ rescue TencentCloud::Common::TencentCloudSDKException => e
322
+ raise e
323
+ rescue StandardError => e
324
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
325
+ end
326
+
327
+ # 此接口(CreateFlowByFiles)用于通过PDF文件创建签署流程。
328
+
329
+ # 注意:调用此接口前,请先调用多文件上传接口 (UploadFiles),提前上传合同文件。
330
+
331
+ # @param request: Request instance for CreateFlowByFiles.
332
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateFlowByFilesRequest`
333
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateFlowByFilesResponse`
334
+ def CreateFlowByFiles(request)
335
+ body = send_request('CreateFlowByFiles', request.serialize)
336
+ response = JSON.parse(body)
337
+ if response['Response'].key?('Error') == false
338
+ model = CreateFlowByFilesResponse.new
339
+ model.deserialize(response['Response'])
340
+ model
341
+ else
342
+ code = response['Response']['Error']['Code']
343
+ message = response['Response']['Error']['Message']
344
+ reqid = response['Response']['RequestId']
345
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
346
+ end
347
+ rescue TencentCloud::Common::TencentCloudSDKException => e
348
+ raise e
349
+ rescue StandardError => e
350
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
351
+ end
352
+
353
+ # 该接口为第三方平台向电子签平台获取慧眼H5人脸核身Url
354
+
355
+ # @param request: Request instance for CreateH5FaceIdUrl.
356
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateH5FaceIdUrlRequest`
357
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateH5FaceIdUrlResponse`
358
+ def CreateH5FaceIdUrl(request)
359
+ body = send_request('CreateH5FaceIdUrl', request.serialize)
360
+ response = JSON.parse(body)
361
+ if response['Response'].key?('Error') == false
362
+ model = CreateH5FaceIdUrlResponse.new
363
+ model.deserialize(response['Response'])
364
+ model
365
+ else
366
+ code = response['Response']['Error']['Code']
367
+ message = response['Response']['Error']['Message']
368
+ reqid = response['Response']['RequestId']
369
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
370
+ end
371
+ rescue TencentCloud::Common::TencentCloudSDKException => e
372
+ raise e
373
+ rescue StandardError => e
374
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
375
+ end
376
+
377
+ # 此接口(CreatePreviewSignUrl)用于生成生成预览签署URL。
378
+
379
+ # 注:调用此接口前,请确保您已提前调用了发送流程接口(SendFlow)指定相关签署方。
380
+
381
+ # @param request: Request instance for CreatePreviewSignUrl.
382
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreatePreviewSignUrlRequest`
383
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreatePreviewSignUrlResponse`
384
+ def CreatePreviewSignUrl(request)
385
+ body = send_request('CreatePreviewSignUrl', request.serialize)
386
+ response = JSON.parse(body)
387
+ if response['Response'].key?('Error') == false
388
+ model = CreatePreviewSignUrlResponse.new
389
+ model.deserialize(response['Response'])
390
+ model
391
+ else
392
+ code = response['Response']['Error']['Code']
393
+ message = response['Response']['Error']['Message']
394
+ reqid = response['Response']['RequestId']
395
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
396
+ end
397
+ rescue TencentCloud::Common::TencentCloudSDKException => e
398
+ raise e
399
+ rescue StandardError => e
400
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
401
+ end
402
+
403
+ # 此接口(CreateSeal)用于创建个人/企业印章。
404
+
405
+ # 注意:使用FileId参数指定印章,需先调用多文件上传 (UploadFiles) 上传印章图片。
406
+
407
+ # @param request: Request instance for CreateSeal.
408
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateSealRequest`
409
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateSealResponse`
410
+ def CreateSeal(request)
411
+ body = send_request('CreateSeal', request.serialize)
412
+ response = JSON.parse(body)
413
+ if response['Response'].key?('Error') == false
414
+ model = CreateSealResponse.new
415
+ model.deserialize(response['Response'])
416
+ model
417
+ else
418
+ code = response['Response']['Error']['Code']
419
+ message = response['Response']['Error']['Message']
420
+ reqid = response['Response']['RequestId']
421
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
422
+ end
423
+ rescue TencentCloud::Common::TencentCloudSDKException => e
424
+ raise e
425
+ rescue StandardError => e
426
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
427
+ end
428
+
429
+ # 此接口(CreateServerFlowSign)用于静默签署文件。
430
+
431
+ # 注:
432
+ # 1、此接口为白名单接口,调用前请提前与客服经理或邮件至e-contract@tencent.com进行联系。
433
+ # 2、仅合同发起者可使用流程静默签署能力。
434
+
435
+ # @param request: Request instance for CreateServerFlowSign.
436
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateServerFlowSignRequest`
437
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateServerFlowSignResponse`
438
+ def CreateServerFlowSign(request)
439
+ body = send_request('CreateServerFlowSign', request.serialize)
440
+ response = JSON.parse(body)
441
+ if response['Response'].key?('Error') == false
442
+ model = CreateServerFlowSignResponse.new
443
+ model.deserialize(response['Response'])
444
+ model
445
+ else
446
+ code = response['Response']['Error']['Code']
447
+ message = response['Response']['Error']['Message']
448
+ reqid = response['Response']['RequestId']
449
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
450
+ end
451
+ rescue TencentCloud::Common::TencentCloudSDKException => e
452
+ raise e
453
+ rescue StandardError => e
454
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
455
+ end
456
+
457
+ # 此接口(CreateSignUrl)用于生成指定用户的签署URL。
458
+
459
+ # 注:调用此接口前,请确保您已提前调用了发送流程接口(SendFlow)指定相关签署方。
460
+
461
+ # @param request: Request instance for CreateSignUrl.
462
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateSignUrlRequest`
463
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateSignUrlResponse`
464
+ def CreateSignUrl(request)
465
+ body = send_request('CreateSignUrl', request.serialize)
466
+ response = JSON.parse(body)
467
+ if response['Response'].key?('Error') == false
468
+ model = CreateSignUrlResponse.new
469
+ model.deserialize(response['Response'])
470
+ model
471
+ else
472
+ code = response['Response']['Error']['Code']
473
+ message = response['Response']['Error']['Message']
474
+ reqid = response['Response']['RequestId']
475
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
476
+ end
477
+ rescue TencentCloud::Common::TencentCloudSDKException => e
478
+ raise e
479
+ rescue StandardError => e
480
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
481
+ end
482
+
483
+ # 此接口(CreateSubOrganization)用于在腾讯电子签内注册子机构。
484
+
485
+ # @param request: Request instance for CreateSubOrganization.
486
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateSubOrganizationRequest`
487
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateSubOrganizationResponse`
488
+ def CreateSubOrganization(request)
489
+ body = send_request('CreateSubOrganization', request.serialize)
490
+ response = JSON.parse(body)
491
+ if response['Response'].key?('Error') == false
492
+ model = CreateSubOrganizationResponse.new
493
+ model.deserialize(response['Response'])
494
+ model
495
+ else
496
+ code = response['Response']['Error']['Code']
497
+ message = response['Response']['Error']['Message']
498
+ reqid = response['Response']['RequestId']
499
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
500
+ end
501
+ rescue TencentCloud::Common::TencentCloudSDKException => e
502
+ raise e
503
+ rescue StandardError => e
504
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
505
+ end
506
+
507
+ # 此接口(CreateSubOrganizationAndSeal)用于注册子机构,同时系统将为该子企业自动生成一个默认电子印章图片。
508
+
509
+ # 注意:
510
+ # 1. 在后续的签署流程中,若未指定签署使用的印章ID,则默认调用自动生成的印章图片进行签署。
511
+ # 2. 此接口为白名单接口,如您需要使用此能力,请提前与客户经理沟通或邮件至e-contract@tencent.com与我们联系。
512
+
513
+ # @param request: Request instance for CreateSubOrganizationAndSeal.
514
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateSubOrganizationAndSealRequest`
515
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateSubOrganizationAndSealResponse`
516
+ def CreateSubOrganizationAndSeal(request)
517
+ body = send_request('CreateSubOrganizationAndSeal', request.serialize)
518
+ response = JSON.parse(body)
519
+ if response['Response'].key?('Error') == false
520
+ model = CreateSubOrganizationAndSealResponse.new
521
+ model.deserialize(response['Response'])
522
+ model
523
+ else
524
+ code = response['Response']['Error']['Code']
525
+ message = response['Response']['Error']['Message']
526
+ reqid = response['Response']['RequestId']
527
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
528
+ end
529
+ rescue TencentCloud::Common::TencentCloudSDKException => e
530
+ raise e
531
+ rescue StandardError => e
532
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
533
+ end
534
+
535
+ # 此接口(CreateUser)用于注册腾讯电子签个人用户。
536
+
537
+ # @param request: Request instance for CreateUser.
538
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateUserRequest`
539
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateUserResponse`
540
+ def CreateUser(request)
541
+ body = send_request('CreateUser', request.serialize)
542
+ response = JSON.parse(body)
543
+ if response['Response'].key?('Error') == false
544
+ model = CreateUserResponse.new
545
+ model.deserialize(response['Response'])
546
+ model
547
+ else
548
+ code = response['Response']['Error']['Code']
549
+ message = response['Response']['Error']['Message']
550
+ reqid = response['Response']['RequestId']
551
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
552
+ end
553
+ rescue TencentCloud::Common::TencentCloudSDKException => e
554
+ raise e
555
+ rescue StandardError => e
556
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
557
+ end
558
+
559
+ # 第三方应用可通过此接口(CreateUserAndSeal)注册腾讯电子签实名个人用户,同时系统将为该用户自动生成一个默认电子签名图片。
560
+
561
+ # 注意:
562
+ # 1. 在后续的签署流程中,若未指定签署使用的印章ID,则默认调用自动生成的签名图片进行签署。
563
+ # 2. 此接口为白名单接口,如您需要使用此能力,请提前与客户经理沟通或邮件至e-contract@tencent.com与我们联系。
564
+
565
+ # @param request: Request instance for CreateUserAndSeal.
566
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::CreateUserAndSealRequest`
567
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::CreateUserAndSealResponse`
568
+ def CreateUserAndSeal(request)
569
+ body = send_request('CreateUserAndSeal', request.serialize)
570
+ response = JSON.parse(body)
571
+ if response['Response'].key?('Error') == false
572
+ model = CreateUserAndSealResponse.new
573
+ model.deserialize(response['Response'])
574
+ model
575
+ else
576
+ code = response['Response']['Error']['Code']
577
+ message = response['Response']['Error']['Message']
578
+ reqid = response['Response']['RequestId']
579
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
580
+ end
581
+ rescue TencentCloud::Common::TencentCloudSDKException => e
582
+ raise e
583
+ rescue StandardError => e
584
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
585
+ end
586
+
587
+ # 此接口 (DeleteSeal) 用于删除指定ID的印章。
588
+
589
+ # 注意:默认印章不支持删除
590
+
591
+ # @param request: Request instance for DeleteSeal.
592
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DeleteSealRequest`
593
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DeleteSealResponse`
594
+ def DeleteSeal(request)
595
+ body = send_request('DeleteSeal', request.serialize)
596
+ response = JSON.parse(body)
597
+ if response['Response'].key?('Error') == false
598
+ model = DeleteSealResponse.new
599
+ model.deserialize(response['Response'])
600
+ model
601
+ else
602
+ code = response['Response']['Error']['Code']
603
+ message = response['Response']['Error']['Message']
604
+ reqid = response['Response']['RequestId']
605
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
606
+ end
607
+ rescue TencentCloud::Common::TencentCloudSDKException => e
608
+ raise e
609
+ rescue StandardError => e
610
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
611
+ end
612
+
613
+ # 第三方应用可通过此接口(DescribeCatalogApprovers)查询指定目录的参与者列表
614
+
615
+ # @param request: Request instance for DescribeCatalogApprovers.
616
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeCatalogApproversRequest`
617
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeCatalogApproversResponse`
618
+ def DescribeCatalogApprovers(request)
619
+ body = send_request('DescribeCatalogApprovers', request.serialize)
620
+ response = JSON.parse(body)
621
+ if response['Response'].key?('Error') == false
622
+ model = DescribeCatalogApproversResponse.new
623
+ model.deserialize(response['Response'])
624
+ model
625
+ else
626
+ code = response['Response']['Error']['Code']
627
+ message = response['Response']['Error']['Message']
628
+ reqid = response['Response']['RequestId']
629
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
630
+ end
631
+ rescue TencentCloud::Common::TencentCloudSDKException => e
632
+ raise e
633
+ rescue StandardError => e
634
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
635
+ end
636
+
637
+ # 第三方应用可通过此接口(DescribeCatalogSignComponents)拉取目录签署区
638
+
639
+ # @param request: Request instance for DescribeCatalogSignComponents.
640
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeCatalogSignComponentsRequest`
641
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeCatalogSignComponentsResponse`
642
+ def DescribeCatalogSignComponents(request)
643
+ body = send_request('DescribeCatalogSignComponents', request.serialize)
644
+ response = JSON.parse(body)
645
+ if response['Response'].key?('Error') == false
646
+ model = DescribeCatalogSignComponentsResponse.new
647
+ model.deserialize(response['Response'])
648
+ model
649
+ else
650
+ code = response['Response']['Error']['Code']
651
+ message = response['Response']['Error']['Message']
652
+ reqid = response['Response']['RequestId']
653
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
654
+ end
655
+ rescue TencentCloud::Common::TencentCloudSDKException => e
656
+ raise e
657
+ rescue StandardError => e
658
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
659
+ end
660
+
661
+ # 此接口(DescribeCustomFlowIds)用于通过自定义流程id来查询对应的电子签流程id
662
+
663
+ # @param request: Request instance for DescribeCustomFlowIds.
664
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeCustomFlowIdsRequest`
665
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeCustomFlowIdsResponse`
666
+ def DescribeCustomFlowIds(request)
667
+ body = send_request('DescribeCustomFlowIds', request.serialize)
668
+ response = JSON.parse(body)
669
+ if response['Response'].key?('Error') == false
670
+ model = DescribeCustomFlowIdsResponse.new
671
+ model.deserialize(response['Response'])
672
+ model
673
+ else
674
+ code = response['Response']['Error']['Code']
675
+ message = response['Response']['Error']['Message']
676
+ reqid = response['Response']['RequestId']
677
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
678
+ end
679
+ rescue TencentCloud::Common::TencentCloudSDKException => e
680
+ raise e
681
+ rescue StandardError => e
682
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
683
+ end
684
+
685
+ # 此接口(DescribeCustomFlowIdsByFlowId)用于根据流程id反查自定义流程id
686
+
687
+ # @param request: Request instance for DescribeCustomFlowIdsByFlowId.
688
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeCustomFlowIdsByFlowIdRequest`
689
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeCustomFlowIdsByFlowIdResponse`
690
+ def DescribeCustomFlowIdsByFlowId(request)
691
+ body = send_request('DescribeCustomFlowIdsByFlowId', request.serialize)
692
+ response = JSON.parse(body)
693
+ if response['Response'].key?('Error') == false
694
+ model = DescribeCustomFlowIdsByFlowIdResponse.new
695
+ model.deserialize(response['Response'])
696
+ model
697
+ else
698
+ code = response['Response']['Error']['Code']
699
+ message = response['Response']['Error']['Message']
700
+ reqid = response['Response']['RequestId']
701
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
702
+ end
703
+ rescue TencentCloud::Common::TencentCloudSDKException => e
704
+ raise e
705
+ rescue StandardError => e
706
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
707
+ end
708
+
709
+ # 该接口为第三方平台向电子签平台获取慧眼人脸核身照片
710
+
711
+ # @param request: Request instance for DescribeFaceIdPhotos.
712
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFaceIdPhotosRequest`
713
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFaceIdPhotosResponse`
714
+ def DescribeFaceIdPhotos(request)
715
+ body = send_request('DescribeFaceIdPhotos', request.serialize)
716
+ response = JSON.parse(body)
717
+ if response['Response'].key?('Error') == false
718
+ model = DescribeFaceIdPhotosResponse.new
719
+ model.deserialize(response['Response'])
720
+ model
721
+ else
722
+ code = response['Response']['Error']['Code']
723
+ message = response['Response']['Error']['Message']
724
+ reqid = response['Response']['RequestId']
725
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
726
+ end
727
+ rescue TencentCloud::Common::TencentCloudSDKException => e
728
+ raise e
729
+ rescue StandardError => e
730
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
731
+ end
732
+
733
+ # 该接口为第三方平台向电子签平台获取慧眼人脸核身结果
734
+
735
+ # @param request: Request instance for DescribeFaceIdResults.
736
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFaceIdResultsRequest`
737
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFaceIdResultsResponse`
738
+ def DescribeFaceIdResults(request)
739
+ body = send_request('DescribeFaceIdResults', request.serialize)
740
+ response = JSON.parse(body)
741
+ if response['Response'].key?('Error') == false
742
+ model = DescribeFaceIdResultsResponse.new
743
+ model.deserialize(response['Response'])
744
+ model
745
+ else
746
+ code = response['Response']['Error']['Code']
747
+ message = response['Response']['Error']['Message']
748
+ reqid = response['Response']['RequestId']
749
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
750
+ end
751
+ rescue TencentCloud::Common::TencentCloudSDKException => e
752
+ raise e
753
+ rescue StandardError => e
754
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
755
+ end
756
+
757
+ # 根据用户自定义id查询文件id
758
+
759
+ # @param request: Request instance for DescribeFileIdsByCustomIds.
760
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFileIdsByCustomIdsRequest`
761
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFileIdsByCustomIdsResponse`
762
+ def DescribeFileIdsByCustomIds(request)
763
+ body = send_request('DescribeFileIdsByCustomIds', request.serialize)
764
+ response = JSON.parse(body)
765
+ if response['Response'].key?('Error') == false
766
+ model = DescribeFileIdsByCustomIdsResponse.new
767
+ model.deserialize(response['Response'])
768
+ model
769
+ else
770
+ code = response['Response']['Error']['Code']
771
+ message = response['Response']['Error']['Message']
772
+ reqid = response['Response']['RequestId']
773
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
774
+ end
775
+ rescue TencentCloud::Common::TencentCloudSDKException => e
776
+ raise e
777
+ rescue StandardError => e
778
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
779
+ end
780
+
781
+ # 此接口(DescribeFileUrls)用于获取签署文件下载的URL。
782
+
783
+ # @param request: Request instance for DescribeFileUrls.
784
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFileUrlsRequest`
785
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFileUrlsResponse`
786
+ def DescribeFileUrls(request)
787
+ body = send_request('DescribeFileUrls', request.serialize)
788
+ response = JSON.parse(body)
789
+ if response['Response'].key?('Error') == false
790
+ model = DescribeFileUrlsResponse.new
791
+ model.deserialize(response['Response'])
792
+ model
793
+ else
794
+ code = response['Response']['Error']['Code']
795
+ message = response['Response']['Error']['Message']
796
+ reqid = response['Response']['RequestId']
797
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
798
+ end
799
+ rescue TencentCloud::Common::TencentCloudSDKException => e
800
+ raise e
801
+ rescue StandardError => e
802
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
803
+ end
804
+
805
+ # 通过此接口(DescribeFlow)可查询签署流程的详细信息。
806
+
807
+ # @param request: Request instance for DescribeFlow.
808
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFlowRequest`
809
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFlowResponse`
810
+ def DescribeFlow(request)
811
+ body = send_request('DescribeFlow', request.serialize)
812
+ response = JSON.parse(body)
813
+ if response['Response'].key?('Error') == false
814
+ model = DescribeFlowResponse.new
815
+ model.deserialize(response['Response'])
816
+ model
817
+ else
818
+ code = response['Response']['Error']['Code']
819
+ message = response['Response']['Error']['Message']
820
+ reqid = response['Response']['RequestId']
821
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
822
+ end
823
+ rescue TencentCloud::Common::TencentCloudSDKException => e
824
+ raise e
825
+ rescue StandardError => e
826
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
827
+ end
828
+
829
+ # 第三方应用可通过此接口(DescribeFlowApprovers)查询流程参与者信息。
830
+
831
+ # @param request: Request instance for DescribeFlowApprovers.
832
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFlowApproversRequest`
833
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFlowApproversResponse`
834
+ def DescribeFlowApprovers(request)
835
+ body = send_request('DescribeFlowApprovers', request.serialize)
836
+ response = JSON.parse(body)
837
+ if response['Response'].key?('Error') == false
838
+ model = DescribeFlowApproversResponse.new
839
+ model.deserialize(response['Response'])
840
+ model
841
+ else
842
+ code = response['Response']['Error']['Code']
843
+ message = response['Response']['Error']['Message']
844
+ reqid = response['Response']['RequestId']
845
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
846
+ end
847
+ rescue TencentCloud::Common::TencentCloudSDKException => e
848
+ raise e
849
+ rescue StandardError => e
850
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
851
+ end
852
+
853
+ # 查询流程文件
854
+
855
+ # @param request: Request instance for DescribeFlowFiles.
856
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeFlowFilesRequest`
857
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeFlowFilesResponse`
858
+ def DescribeFlowFiles(request)
859
+ body = send_request('DescribeFlowFiles', request.serialize)
860
+ response = JSON.parse(body)
861
+ if response['Response'].key?('Error') == false
862
+ model = DescribeFlowFilesResponse.new
863
+ model.deserialize(response['Response'])
864
+ model
865
+ else
866
+ code = response['Response']['Error']['Code']
867
+ message = response['Response']['Error']['Message']
868
+ reqid = response['Response']['RequestId']
869
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
870
+ end
871
+ rescue TencentCloud::Common::TencentCloudSDKException => e
872
+ raise e
873
+ rescue StandardError => e
874
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
875
+ end
876
+
877
+ # 此接口(DescribeSeals)用于查询指定ID的印章信息。
878
+
879
+ # @param request: Request instance for DescribeSeals.
880
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeSealsRequest`
881
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeSealsResponse`
882
+ def DescribeSeals(request)
883
+ body = send_request('DescribeSeals', request.serialize)
884
+ response = JSON.parse(body)
885
+ if response['Response'].key?('Error') == false
886
+ model = DescribeSealsResponse.new
887
+ model.deserialize(response['Response'])
888
+ model
889
+ else
890
+ code = response['Response']['Error']['Code']
891
+ message = response['Response']['Error']['Message']
892
+ reqid = response['Response']['RequestId']
893
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
894
+ end
895
+ rescue TencentCloud::Common::TencentCloudSDKException => e
896
+ raise e
897
+ rescue StandardError => e
898
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
899
+ end
900
+
901
+ # 此接口(DescribeSubOrganizations)用于查询子机构信息。
902
+
903
+ # 注:此接口仅可查询您所属机构应用号创建的子机构信息,不可跨应用/跨机构查询。
904
+
905
+ # @param request: Request instance for DescribeSubOrganizations.
906
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeSubOrganizationsRequest`
907
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeSubOrganizationsResponse`
908
+ def DescribeSubOrganizations(request)
909
+ body = send_request('DescribeSubOrganizations', request.serialize)
910
+ response = JSON.parse(body)
911
+ if response['Response'].key?('Error') == false
912
+ model = DescribeSubOrganizationsResponse.new
913
+ model.deserialize(response['Response'])
914
+ model
915
+ else
916
+ code = response['Response']['Error']['Code']
917
+ message = response['Response']['Error']['Message']
918
+ reqid = response['Response']['RequestId']
919
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
920
+ end
921
+ rescue TencentCloud::Common::TencentCloudSDKException => e
922
+ raise e
923
+ rescue StandardError => e
924
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
925
+ end
926
+
927
+ # 此接口(DescribeUsers)用于查询应用号下的个人用户信息。
928
+
929
+ # 注:此接口仅可查询您所属机构应用号创建的个人用户信息,不可跨应用/跨机构查询。
930
+
931
+ # @param request: Request instance for DescribeUsers.
932
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DescribeUsersRequest`
933
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DescribeUsersResponse`
934
+ def DescribeUsers(request)
935
+ body = send_request('DescribeUsers', request.serialize)
936
+ response = JSON.parse(body)
937
+ if response['Response'].key?('Error') == false
938
+ model = DescribeUsersResponse.new
939
+ model.deserialize(response['Response'])
940
+ model
941
+ else
942
+ code = response['Response']['Error']['Code']
943
+ message = response['Response']['Error']['Message']
944
+ reqid = response['Response']['RequestId']
945
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
946
+ end
947
+ rescue TencentCloud::Common::TencentCloudSDKException => e
948
+ raise e
949
+ rescue StandardError => e
950
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
951
+ end
952
+
953
+ # 通过此接口(DestroyFlowFile)可删除指定流程中的合同文件。
954
+
955
+ # 注:调用此接口前,请确保此流程已属于归档状态。您可通过查询流程信息接口(DescribeFlow)进行查询。
956
+
957
+ # @param request: Request instance for DestroyFlowFile.
958
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::DestroyFlowFileRequest`
959
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::DestroyFlowFileResponse`
960
+ def DestroyFlowFile(request)
961
+ body = send_request('DestroyFlowFile', request.serialize)
962
+ response = JSON.parse(body)
963
+ if response['Response'].key?('Error') == false
964
+ model = DestroyFlowFileResponse.new
965
+ model.deserialize(response['Response'])
966
+ model
967
+ else
968
+ code = response['Response']['Error']['Code']
969
+ message = response['Response']['Error']['Message']
970
+ reqid = response['Response']['RequestId']
971
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
972
+ end
973
+ rescue TencentCloud::Common::TencentCloudSDKException => e
974
+ raise e
975
+ rescue StandardError => e
976
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
977
+ end
978
+
979
+ # 生成企业电子印章
980
+
981
+ # @param request: Request instance for GenerateOrganizationSeal.
982
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::GenerateOrganizationSealRequest`
983
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::GenerateOrganizationSealResponse`
984
+ def GenerateOrganizationSeal(request)
985
+ body = send_request('GenerateOrganizationSeal', request.serialize)
986
+ response = JSON.parse(body)
987
+ if response['Response'].key?('Error') == false
988
+ model = GenerateOrganizationSealResponse.new
989
+ model.deserialize(response['Response'])
990
+ model
991
+ else
992
+ code = response['Response']['Error']['Code']
993
+ message = response['Response']['Error']['Message']
994
+ reqid = response['Response']['RequestId']
995
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
996
+ end
997
+ rescue TencentCloud::Common::TencentCloudSDKException => e
998
+ raise e
999
+ rescue StandardError => e
1000
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1001
+ end
1002
+
1003
+ # 此接口(GenerateUserSeal)用于生成个人签名图片。
1004
+
1005
+ # 注意:
1006
+ # 1. 个人签名由用户注册时预留的姓名信息生成,不支持自定义签名内容。
1007
+ # 2. 个人用户仅支持拥有一个系统生成的电子签名。
1008
+
1009
+ # @param request: Request instance for GenerateUserSeal.
1010
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::GenerateUserSealRequest`
1011
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::GenerateUserSealResponse`
1012
+ def GenerateUserSeal(request)
1013
+ body = send_request('GenerateUserSeal', request.serialize)
1014
+ response = JSON.parse(body)
1015
+ if response['Response'].key?('Error') == false
1016
+ model = GenerateUserSealResponse.new
1017
+ model.deserialize(response['Response'])
1018
+ model
1019
+ else
1020
+ code = response['Response']['Error']['Code']
1021
+ message = response['Response']['Error']['Message']
1022
+ reqid = response['Response']['RequestId']
1023
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1024
+ end
1025
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1026
+ raise e
1027
+ rescue StandardError => e
1028
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1029
+ end
1030
+
1031
+ # 此接口 (ModifyOrganizationDefaultSeal) 用于重新指定企业默认印章。
1032
+
1033
+ # @param request: Request instance for ModifyOrganizationDefaultSeal.
1034
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::ModifyOrganizationDefaultSealRequest`
1035
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::ModifyOrganizationDefaultSealResponse`
1036
+ def ModifyOrganizationDefaultSeal(request)
1037
+ body = send_request('ModifyOrganizationDefaultSeal', request.serialize)
1038
+ response = JSON.parse(body)
1039
+ if response['Response'].key?('Error') == false
1040
+ model = ModifyOrganizationDefaultSealResponse.new
1041
+ model.deserialize(response['Response'])
1042
+ model
1043
+ else
1044
+ code = response['Response']['Error']['Code']
1045
+ message = response['Response']['Error']['Message']
1046
+ reqid = response['Response']['RequestId']
1047
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1048
+ end
1049
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1050
+ raise e
1051
+ rescue StandardError => e
1052
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1053
+ end
1054
+
1055
+ # 此接口(ModifySeal)用于修改指定印章ID的印章图片和名称。
1056
+
1057
+ # 注:印章类型暂不支持修改,如需调整,请联系客服经理或通过创建印章接口(CreateSeal)进行创建新印章。
1058
+
1059
+ # @param request: Request instance for ModifySeal.
1060
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::ModifySealRequest`
1061
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::ModifySealResponse`
1062
+ def ModifySeal(request)
1063
+ body = send_request('ModifySeal', request.serialize)
1064
+ response = JSON.parse(body)
1065
+ if response['Response'].key?('Error') == false
1066
+ model = ModifySealResponse.new
1067
+ model.deserialize(response['Response'])
1068
+ model
1069
+ else
1070
+ code = response['Response']['Error']['Code']
1071
+ message = response['Response']['Error']['Message']
1072
+ reqid = response['Response']['RequestId']
1073
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1074
+ end
1075
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1076
+ raise e
1077
+ rescue StandardError => e
1078
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1079
+ end
1080
+
1081
+ # 此接口(ModifySubOrganizationInfo)用于更新子机构信息。
1082
+
1083
+ # 注:若修改子机构名称或更新机构证件照片,需要重新通过子机构实名接口(VerifySubOrganization)进行重新实名。
1084
+
1085
+ # @param request: Request instance for ModifySubOrganizationInfo.
1086
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::ModifySubOrganizationInfoRequest`
1087
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::ModifySubOrganizationInfoResponse`
1088
+ def ModifySubOrganizationInfo(request)
1089
+ body = send_request('ModifySubOrganizationInfo', request.serialize)
1090
+ response = JSON.parse(body)
1091
+ if response['Response'].key?('Error') == false
1092
+ model = ModifySubOrganizationInfoResponse.new
1093
+ model.deserialize(response['Response'])
1094
+ model
1095
+ else
1096
+ code = response['Response']['Error']['Code']
1097
+ message = response['Response']['Error']['Message']
1098
+ reqid = response['Response']['RequestId']
1099
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1100
+ end
1101
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1102
+ raise e
1103
+ rescue StandardError => e
1104
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1105
+ end
1106
+
1107
+ # 此接口(ModifyUser)用于更新个人用户信息。
1108
+
1109
+ # 注:若修改用户姓名,需要重新通过个人用户实名接口(VerifyUser)进行重新实名。
1110
+
1111
+ # @param request: Request instance for ModifyUser.
1112
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::ModifyUserRequest`
1113
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::ModifyUserResponse`
1114
+ def ModifyUser(request)
1115
+ body = send_request('ModifyUser', request.serialize)
1116
+ response = JSON.parse(body)
1117
+ if response['Response'].key?('Error') == false
1118
+ model = ModifyUserResponse.new
1119
+ model.deserialize(response['Response'])
1120
+ model
1121
+ else
1122
+ code = response['Response']['Error']['Code']
1123
+ message = response['Response']['Error']['Message']
1124
+ reqid = response['Response']['RequestId']
1125
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1126
+ end
1127
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1128
+ raise e
1129
+ rescue StandardError => e
1130
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1131
+ end
1132
+
1133
+ # 此接口 (ModifyUserDefaultSeal) 用于重新指定个人默认印章。
1134
+
1135
+ # @param request: Request instance for ModifyUserDefaultSeal.
1136
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::ModifyUserDefaultSealRequest`
1137
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::ModifyUserDefaultSealResponse`
1138
+ def ModifyUserDefaultSeal(request)
1139
+ body = send_request('ModifyUserDefaultSeal', request.serialize)
1140
+ response = JSON.parse(body)
1141
+ if response['Response'].key?('Error') == false
1142
+ model = ModifyUserDefaultSealResponse.new
1143
+ model.deserialize(response['Response'])
1144
+ model
1145
+ else
1146
+ code = response['Response']['Error']['Code']
1147
+ message = response['Response']['Error']['Message']
1148
+ reqid = response['Response']['RequestId']
1149
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1150
+ end
1151
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1152
+ raise e
1153
+ rescue StandardError => e
1154
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1155
+ end
1156
+
1157
+ # 此接口(RejectFlow)用于用户拒绝签署合同流程。
1158
+
1159
+ # @param request: Request instance for RejectFlow.
1160
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::RejectFlowRequest`
1161
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::RejectFlowResponse`
1162
+ def RejectFlow(request)
1163
+ body = send_request('RejectFlow', request.serialize)
1164
+ response = JSON.parse(body)
1165
+ if response['Response'].key?('Error') == false
1166
+ model = RejectFlowResponse.new
1167
+ model.deserialize(response['Response'])
1168
+ model
1169
+ else
1170
+ code = response['Response']['Error']['Code']
1171
+ message = response['Response']['Error']['Message']
1172
+ reqid = response['Response']['RequestId']
1173
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1174
+ end
1175
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1176
+ raise e
1177
+ rescue StandardError => e
1178
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1179
+ end
1180
+
1181
+ # 此接口(SendFlow)用于指定签署者及签署内容,后续可通过生成签署接口(CreateSignUrl)获取签署url。
1182
+
1183
+ # @param request: Request instance for SendFlow.
1184
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::SendFlowRequest`
1185
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::SendFlowResponse`
1186
+ def SendFlow(request)
1187
+ body = send_request('SendFlow', request.serialize)
1188
+ response = JSON.parse(body)
1189
+ if response['Response'].key?('Error') == false
1190
+ model = SendFlowResponse.new
1191
+ model.deserialize(response['Response'])
1192
+ model
1193
+ else
1194
+ code = response['Response']['Error']['Code']
1195
+ message = response['Response']['Error']['Message']
1196
+ reqid = response['Response']['RequestId']
1197
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1198
+ end
1199
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1200
+ raise e
1201
+ rescue StandardError => e
1202
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1203
+ end
1204
+
1205
+ # 发送流程并获取签署URL
1206
+
1207
+ # @param request: Request instance for SendFlowUrl.
1208
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::SendFlowUrlRequest`
1209
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::SendFlowUrlResponse`
1210
+ def SendFlowUrl(request)
1211
+ body = send_request('SendFlowUrl', request.serialize)
1212
+ response = JSON.parse(body)
1213
+ if response['Response'].key?('Error') == false
1214
+ model = SendFlowUrlResponse.new
1215
+ model.deserialize(response['Response'])
1216
+ model
1217
+ else
1218
+ code = response['Response']['Error']['Code']
1219
+ message = response['Response']['Error']['Message']
1220
+ reqid = response['Response']['RequestId']
1221
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1222
+ end
1223
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1224
+ raise e
1225
+ rescue StandardError => e
1226
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1227
+ end
1228
+
1229
+ # 此接口用于发送签署验证码
1230
+
1231
+ # @param request: Request instance for SendSignInnerVerifyCode.
1232
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::SendSignInnerVerifyCodeRequest`
1233
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::SendSignInnerVerifyCodeResponse`
1234
+ def SendSignInnerVerifyCode(request)
1235
+ body = send_request('SendSignInnerVerifyCode', request.serialize)
1236
+ response = JSON.parse(body)
1237
+ if response['Response'].key?('Error') == false
1238
+ model = SendSignInnerVerifyCodeResponse.new
1239
+ model.deserialize(response['Response'])
1240
+ model
1241
+ else
1242
+ code = response['Response']['Error']['Code']
1243
+ message = response['Response']['Error']['Message']
1244
+ reqid = response['Response']['RequestId']
1245
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1246
+ end
1247
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1248
+ raise e
1249
+ rescue StandardError => e
1250
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1251
+ end
1252
+
1253
+ # 此接口(SignFlow)可用于对流程文件进行签署。
1254
+
1255
+ # @param request: Request instance for SignFlow.
1256
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::SignFlowRequest`
1257
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::SignFlowResponse`
1258
+ def SignFlow(request)
1259
+ body = send_request('SignFlow', request.serialize)
1260
+ response = JSON.parse(body)
1261
+ if response['Response'].key?('Error') == false
1262
+ model = SignFlowResponse.new
1263
+ model.deserialize(response['Response'])
1264
+ model
1265
+ else
1266
+ code = response['Response']['Error']['Code']
1267
+ message = response['Response']['Error']['Message']
1268
+ reqid = response['Response']['RequestId']
1269
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1270
+ end
1271
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1272
+ raise e
1273
+ rescue StandardError => e
1274
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1275
+ end
1276
+
1277
+ # 此接口(UploadFiles)用于文件上传。
1278
+
1279
+ # @param request: Request instance for UploadFiles.
1280
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::UploadFilesRequest`
1281
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::UploadFilesResponse`
1282
+ def UploadFiles(request)
1283
+ body = send_request('UploadFiles', request.serialize)
1284
+ response = JSON.parse(body)
1285
+ if response['Response'].key?('Error') == false
1286
+ model = UploadFilesResponse.new
1287
+ model.deserialize(response['Response'])
1288
+ model
1289
+ else
1290
+ code = response['Response']['Error']['Code']
1291
+ message = response['Response']['Error']['Message']
1292
+ reqid = response['Response']['RequestId']
1293
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1294
+ end
1295
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1296
+ raise e
1297
+ rescue StandardError => e
1298
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1299
+ end
1300
+
1301
+ # 此接口(VerifySubOrganization)用于通过子机构的实名认证。
1302
+
1303
+ # 注:此接口为白名单接口,如您需要使用此能力,请提前与客户经理沟通或邮件至e-contract@tencent.com与我们联系。
1304
+
1305
+ # @param request: Request instance for VerifySubOrganization.
1306
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::VerifySubOrganizationRequest`
1307
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::VerifySubOrganizationResponse`
1308
+ def VerifySubOrganization(request)
1309
+ body = send_request('VerifySubOrganization', request.serialize)
1310
+ response = JSON.parse(body)
1311
+ if response['Response'].key?('Error') == false
1312
+ model = VerifySubOrganizationResponse.new
1313
+ model.deserialize(response['Response'])
1314
+ model
1315
+ else
1316
+ code = response['Response']['Error']['Code']
1317
+ message = response['Response']['Error']['Message']
1318
+ reqid = response['Response']['RequestId']
1319
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1320
+ end
1321
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1322
+ raise e
1323
+ rescue StandardError => e
1324
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1325
+ end
1326
+
1327
+ # 第三方应用可通过此接口(VerifyUser)将腾讯电子签个人用户的实名认证状态设为通过。
1328
+
1329
+ # 注:此接口为白名单接口,如您需要使用此能力,请提前与客户经理沟通或邮件至e-contract@tencent.com与我们联系。
1330
+
1331
+ # @param request: Request instance for VerifyUser.
1332
+ # @type request: :class:`Tencentcloud::essbasic::V20201222::VerifyUserRequest`
1333
+ # @rtype: :class:`Tencentcloud::essbasic::V20201222::VerifyUserResponse`
1334
+ def VerifyUser(request)
1335
+ body = send_request('VerifyUser', request.serialize)
1336
+ response = JSON.parse(body)
1337
+ if response['Response'].key?('Error') == false
1338
+ model = VerifyUserResponse.new
1339
+ model.deserialize(response['Response'])
1340
+ model
1341
+ else
1342
+ code = response['Response']['Error']['Code']
1343
+ message = response['Response']['Error']['Message']
1344
+ reqid = response['Response']['RequestId']
1345
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1346
+ end
1347
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1348
+ raise e
1349
+ rescue StandardError => e
1350
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1351
+ end
1352
+
1353
+
1354
+ end
1355
+ end
1356
+ end
1357
+ end