tencentcloud-sdk-ess 3.0.885 → 3.0.887

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 191b7c987e9436bb085d0ea72747f479d2dd8b25
4
- data.tar.gz: ca26197102d307a006c0396935b117c9af872ccb
3
+ metadata.gz: 59d5511adb48977d1518b807d14573f2c6c86ec4
4
+ data.tar.gz: ef19e1e8782546bda5ea61dfc6f70531d492719d
5
5
  SHA512:
6
- metadata.gz: 097c70d359220aecc32a4035da4aa5d7f01fb708aff348407f636159b881761da3685cd0b76ed611a30d454b9023f325caac4120ba6db2583892fda1426b7337
7
- data.tar.gz: 127ec8c3709de986f130f879a4d7f9a00fa06c82a87f1abb949c21e0aea176847cadb5fb8067deeaaff605936db189927b78f8a7027dc603c6f195746b0d44a8
6
+ metadata.gz: 352b2e0e16a15d2364efeec19dedfe7e46c265c0e212325710ad87576cafa69f7154da39d7d7a6798377c55785d98cdcb41660be3a8681263ab1372131cb5802
7
+ data.tar.gz: daf50cc7351530e622fcf6b03f7c614d6c76d167b3e8f75f380a89802abf8cab9e3c3fc8eecb0c16bc13ca8e7fe2c4a815f2d64ce59fdc901666f38e625e5a2a
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.885
1
+ 3.0.887
@@ -217,6 +217,35 @@ module TencentCloud
217
217
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
218
218
  end
219
219
 
220
+ # 此接口用于获取企业批量认证链接-单链接包含多条认证流。
221
+
222
+ # 前提条件:已调用 [CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经完成。
223
+
224
+ # 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间。
225
+ # 此链接包含多条认证流程,使用该链接可以批量的对企业进行认证。
226
+
227
+ # @param request: Request instance for CreateBatchOrganizationAuthorizationUrl.
228
+ # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchOrganizationAuthorizationUrlRequest`
229
+ # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchOrganizationAuthorizationUrlResponse`
230
+ def CreateBatchOrganizationAuthorizationUrl(request)
231
+ body = send_request('CreateBatchOrganizationAuthorizationUrl', request.serialize)
232
+ response = JSON.parse(body)
233
+ if response['Response'].key?('Error') == false
234
+ model = CreateBatchOrganizationAuthorizationUrlResponse.new
235
+ model.deserialize(response['Response'])
236
+ model
237
+ else
238
+ code = response['Response']['Error']['Code']
239
+ message = response['Response']['Error']['Message']
240
+ reqid = response['Response']['RequestId']
241
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
242
+ end
243
+ rescue TencentCloud::Common::TencentCloudSDKException => e
244
+ raise e
245
+ rescue StandardError => e
246
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
247
+ end
248
+
220
249
  # 本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接
221
250
  # 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
222
251
 
@@ -1473,6 +1473,97 @@ module TencentCloud
1473
1473
  end
1474
1474
  end
1475
1475
 
1476
+ # CreateBatchOrganizationAuthorizationUrl请求参数结构体
1477
+ class CreateBatchOrganizationAuthorizationUrlRequest < TencentCloud::Common::AbstractModel
1478
+ # @param Operator: 执行本接口操作的员工信息。
1479
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1480
+ # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1481
+ # @param AdminName: 组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。
1482
+ # 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
1483
+ # @type AdminName: String
1484
+ # @param AdminMobile: 组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。
1485
+ # @type AdminMobile: String
1486
+ # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1487
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1488
+ # @param SubTaskIds: 企业批量认证链接的子任务 SubTaskId,该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素(AdminName,AdminMobile,AdminIdCardNumber)配合使用。若 SubTaskId 不属于传入的超级管理员,将进行筛选。
1489
+ # @type SubTaskIds: Array
1490
+ # @param AdminIdCardType: 组织机构超管证件类型支持以下类型
1491
+ # - ID_CARD : 居民身份证 (默认值)
1492
+ # - HONGKONG_AND_MACAO : 港澳居民来往内地通行证
1493
+ # - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
1494
+ # 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
1495
+ # @type AdminIdCardType: String
1496
+ # @param AdminIdCardNumber: 组织机构超管证件号。 在注册流程中,必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
1497
+ # @type AdminIdCardNumber: String
1498
+ # @param Endpoint: 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**QR_CODE**: 跳转电子签小程序的http_url的二维码形式, 可以在页面展示适合此类型</li></ul>
1499
+ # @type Endpoint: String
1500
+
1501
+ attr_accessor :Operator, :AdminName, :AdminMobile, :Agent, :SubTaskIds, :AdminIdCardType, :AdminIdCardNumber, :Endpoint
1502
+
1503
+ def initialize(operator=nil, adminname=nil, adminmobile=nil, agent=nil, subtaskids=nil, adminidcardtype=nil, adminidcardnumber=nil, endpoint=nil)
1504
+ @Operator = operator
1505
+ @AdminName = adminname
1506
+ @AdminMobile = adminmobile
1507
+ @Agent = agent
1508
+ @SubTaskIds = subtaskids
1509
+ @AdminIdCardType = adminidcardtype
1510
+ @AdminIdCardNumber = adminidcardnumber
1511
+ @Endpoint = endpoint
1512
+ end
1513
+
1514
+ def deserialize(params)
1515
+ unless params['Operator'].nil?
1516
+ @Operator = UserInfo.new
1517
+ @Operator.deserialize(params['Operator'])
1518
+ end
1519
+ @AdminName = params['AdminName']
1520
+ @AdminMobile = params['AdminMobile']
1521
+ unless params['Agent'].nil?
1522
+ @Agent = Agent.new
1523
+ @Agent.deserialize(params['Agent'])
1524
+ end
1525
+ @SubTaskIds = params['SubTaskIds']
1526
+ @AdminIdCardType = params['AdminIdCardType']
1527
+ @AdminIdCardNumber = params['AdminIdCardNumber']
1528
+ @Endpoint = params['Endpoint']
1529
+ end
1530
+ end
1531
+
1532
+ # CreateBatchOrganizationAuthorizationUrl返回参数结构体
1533
+ class CreateBatchOrganizationAuthorizationUrlResponse < TencentCloud::Common::AbstractModel
1534
+ # @param AuthUrl: 批量企业注册链接-单链接包含多条认证流,根据Endpoint的不同设置,返回不同的链接地址。失效时间:7天
1535
+ # 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
1536
+ # <table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead> <tbody>
1537
+ # <tr> <td>HTTP</td> <td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa</td> <td>7天</td> </tr>
1538
+ # <tr> <td>HTTP_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr>
1539
+ # <tr> <td>APP</td> <td>pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde</td> <td>7天</td> </tr><tr> <td>QR_CODE</td> <td>https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png</td> <td>7天</td> </tr> </tbody> </table>
1540
+ # 注:
1541
+ # `1.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`
1542
+ # @type AuthUrl: String
1543
+ # @param ErrorMessages: 认证流认证失败信息
1544
+ # @type ErrorMessages: Array
1545
+ # @param ExpireTime: 链接过期时间,为 7 天后,创建时间,格式为Unix标准时间戳(秒)。
1546
+ # @type ExpireTime: Integer
1547
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1548
+ # @type RequestId: String
1549
+
1550
+ attr_accessor :AuthUrl, :ErrorMessages, :ExpireTime, :RequestId
1551
+
1552
+ def initialize(authurl=nil, errormessages=nil, expiretime=nil, requestid=nil)
1553
+ @AuthUrl = authurl
1554
+ @ErrorMessages = errormessages
1555
+ @ExpireTime = expiretime
1556
+ @RequestId = requestid
1557
+ end
1558
+
1559
+ def deserialize(params)
1560
+ @AuthUrl = params['AuthUrl']
1561
+ @ErrorMessages = params['ErrorMessages']
1562
+ @ExpireTime = params['ExpireTime']
1563
+ @RequestId = params['RequestId']
1564
+ end
1565
+ end
1566
+
1476
1567
  # CreateBatchOrganizationRegistrationTasks请求参数结构体
1477
1568
  class CreateBatchOrganizationRegistrationTasksRequest < TencentCloud::Common::AbstractModel
1478
1569
  # @param Operator: 执行本接口操作的员工信息。
@@ -10815,10 +10906,15 @@ module TencentCloud
10815
10906
  # <li> 5 :设备指纹识别</li>
10816
10907
  # <li> 6 :设备面容识别</li></ul>
10817
10908
  # @type ApproverSignTypes: Array
10909
+ # @param NoTransfer: 签署方是否可以转他人处理
10910
+
10911
+ # <ul><li> **false** : ( 默认)可以转他人处理</li>
10912
+ # <li> **true** :不可以转他人处理</li></ul>
10913
+ # @type NoTransfer: Boolean
10818
10914
 
10819
- attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra, :ApproverVerifyTypes, :ApproverSignTypes
10915
+ attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra, :ApproverVerifyTypes, :ApproverSignTypes, :NoTransfer
10820
10916
 
10821
- def initialize(recipientid=nil, recipienttype=nil, description=nil, rolename=nil, requirevalidation=nil, requiresign=nil, routingorder=nil, requiredelivery=nil, email=nil, mobile=nil, userid=nil, deliverymethod=nil, recipientextra=nil, approververifytypes=nil, approversigntypes=nil)
10917
+ def initialize(recipientid=nil, recipienttype=nil, description=nil, rolename=nil, requirevalidation=nil, requiresign=nil, routingorder=nil, requiredelivery=nil, email=nil, mobile=nil, userid=nil, deliverymethod=nil, recipientextra=nil, approververifytypes=nil, approversigntypes=nil, notransfer=nil)
10822
10918
  @RecipientId = recipientid
10823
10919
  @RecipientType = recipienttype
10824
10920
  @Description = description
@@ -10834,6 +10930,7 @@ module TencentCloud
10834
10930
  @RecipientExtra = recipientextra
10835
10931
  @ApproverVerifyTypes = approververifytypes
10836
10932
  @ApproverSignTypes = approversigntypes
10933
+ @NoTransfer = notransfer
10837
10934
  end
10838
10935
 
10839
10936
  def deserialize(params)
@@ -10852,6 +10949,7 @@ module TencentCloud
10852
10949
  @RecipientExtra = params['RecipientExtra']
10853
10950
  @ApproverVerifyTypes = params['ApproverVerifyTypes']
10854
10951
  @ApproverSignTypes = params['ApproverSignTypes']
10952
+ @NoTransfer = params['NoTransfer']
10855
10953
  end
10856
10954
  end
10857
10955
 
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.885
4
+ version: 3.0.887
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-08-14 00:00:00.000000000 Z
11
+ date: 2024-08-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common