tencentcloud-sdk-essbasic 3.0.931 → 3.0.933

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d31ee36bfd7c132f96c55583549de59cb8749726
4
- data.tar.gz: 5689e5248f5bc07020382bb6c5cc67d093c4f476
3
+ metadata.gz: f661b7f8c4b35ee9f453652909cd34e4a1252029
4
+ data.tar.gz: 141811ab3d492e63edbfacdf6fb8cb9cf5d0d766
5
5
  SHA512:
6
- metadata.gz: 1eb4fb0c58550ac1f48900555d8b2674c81d158eedbca89507dd5713b3a9dd6dc093bc24325f4d51d1ab03fe1393b164e44e3c2798b0fc7571a9c6b4a0bd4949
7
- data.tar.gz: da9d5b1604d2d8140d9827fd6cd4abbd6a755108f2bedd37157c9e3721dfad14bfd7cc2c98941d74130d1dfa04e81865c202715d03f473531b56e2c395348245
6
+ metadata.gz: 3bceed185b2a367d6d5316fb02179d19847cc1e829af5bdf9217ecff4d25cbd657571a90e728daaa384ff0bb72ca3b2a5d8e7ea996d484585022e7ec71d21efe
7
+ data.tar.gz: 7982570bd4f099d82356bce2a927d13d876e789dec6326b119be9d20177a6b1b66e5893ee1b989fd21d9e7c03a6b212bd3e91d4dbaf2743b6f90bb757b9aa5fb
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.931
1
+ 3.0.933
@@ -363,10 +363,25 @@ module TencentCloud
363
363
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
364
364
  end
365
365
 
366
- # 适用场景:
366
+ # **适用场景**:
367
367
  # 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
368
368
 
369
- # 限制条件:
369
+ # **接口使用说明**:
370
+
371
+ # 1.本接口现已支持批量补充签署人
372
+
373
+ # 2.当<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中指定需要补充的FlowId时,可以对指定合同补充签署人;可以指定多个相同发起方的不同合同在完成批量补充
374
+
375
+ # 3.当<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中指定需要补充的FlowId时,是对指定的合同补充多个指定的签署人
376
+
377
+ # 4.如果同时指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,仅使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId作为补充的合同
378
+
379
+ # 5.如果部分指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId,又指定了<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId;那么<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>存在指定的FlowId,则使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId,不存在则使用<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId作为补充的合同
380
+
381
+
382
+ # 6.如果同时未指定了<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,则传参错误
383
+
384
+ # **限制条件**:
370
385
  # 1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
371
386
  # 2. 个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。
372
387
 
@@ -445,19 +460,21 @@ module TencentCloud
445
460
 
446
461
  # 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
447
462
 
448
- # 合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。
463
+ # - 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。
464
+ # - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
465
+ # - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
449
466
 
450
- # 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
467
+ # <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
451
468
 
452
469
 
453
470
 
454
- # **注**:
455
- # <ul>
456
- # <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
457
- # <li>合同组暂不支持抄送功能</li>
458
- # <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。</li>
459
- # </ul>
471
+ # ### 1. 适用场景
460
472
 
473
+ # 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
474
+
475
+ # ### 2. 发起方要求和签署方实名要求
476
+ # - **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。
477
+ # - **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。
461
478
  # **可以作为发起方和签署方的角色列表**
462
479
  # <table>
463
480
  # <thead>
@@ -478,37 +495,35 @@ module TencentCloud
478
495
  # <tr>
479
496
  # <td>场景二</td>
480
497
  # <td>第三方子企业A员工</td>
481
- # <td>第三方子企业B(不指定经办人)</td>
482
- # </tr>
483
-
484
- # <tr>
485
- # <td>场景三</td>
486
- # <td>第三方子企业A员工</td>
487
498
  # <td>第三方子企业B员工</td>
488
499
  # </tr>
489
500
 
490
501
  # <tr>
491
- # <td>场景四</td>
502
+ # <td>场景三</td>
492
503
  # <td>第三方子企业A员工</td>
493
504
  # <td>个人/自然人</td>
494
505
  # </tr>
495
506
 
496
507
  # <tr>
497
- # <td>场景五</td>
508
+ # <td>场景四</td>
498
509
  # <td>第三方子企业A员工</td>
499
510
  # <td>SaaS平台企业员工</td>
500
511
  # </tr>
501
512
  # </tbody>
502
513
  # </table>
503
514
 
504
- # **注**:
505
- # `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
515
+ # ### 3. 签署方参数差异
516
+ # - 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。
506
517
 
507
- # `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
518
+ # ### 4. 合同额度的扣减与返还
519
+ # - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
520
+ # - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
521
+ # - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
508
522
 
509
- # `3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
523
+ # ### 5. 静默(自动)签署的限制
524
+ # - 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color="red">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。
510
525
 
511
- # `4. 静默(自动)签署不支持合同签署方存在填写功能`
526
+ # ### 6.合同组暂不支持抄送功能
512
527
 
513
528
  # @param request: Request instance for ChannelCreateFlowGroupByFiles.
514
529
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByFilesRequest`
@@ -534,16 +549,21 @@ module TencentCloud
534
549
 
535
550
  # 接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。
536
551
 
537
- # 合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。
552
+ # - 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。
553
+ # - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
554
+ # - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
538
555
 
539
- # 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
556
+ # <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
540
557
 
541
- # **注**:
542
- # <ul>
543
- # <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
544
- # <li>合同组暂不支持抄送功能</li>
545
- # </ul>
546
558
 
559
+
560
+ # ### 1. 适用场景
561
+
562
+ # 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
563
+
564
+ # ### 2. 发起方要求和签署方实名要求
565
+ # - **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。
566
+ # - **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。
547
567
  # **可以作为发起方和签署方的角色列表**
548
568
  # <table>
549
569
  # <thead>
@@ -560,41 +580,38 @@ module TencentCloud
560
580
  # <td>第三方子企业A员工</td>
561
581
  # <td>第三方子企业A员工</td>
562
582
  # </tr>
563
-
564
583
  # <tr>
565
584
  # <td>场景二</td>
566
585
  # <td>第三方子企业A员工</td>
567
- # <td>第三方子企业B(不指定经办人)</td>
568
- # </tr>
569
-
570
- # <tr>
571
- # <td>场景三</td>
572
- # <td>第三方子企业A员工</td>
573
586
  # <td>第三方子企业B员工</td>
574
587
  # </tr>
575
588
 
576
589
  # <tr>
577
- # <td>场景四</td>
590
+ # <td>场景三</td>
578
591
  # <td>第三方子企业A员工</td>
579
592
  # <td>个人/自然人</td>
580
593
  # </tr>
581
594
 
582
595
  # <tr>
583
- # <td>场景五</td>
596
+ # <td>场景四</td>
584
597
  # <td>第三方子企业A员工</td>
585
598
  # <td>SaaS平台企业员工</td>
586
599
  # </tr>
587
600
  # </tbody>
588
601
  # </table>
589
602
 
590
- # **注**:
591
- # `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
603
+ # ### 3. 签署方参数差异
604
+ # - 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。
592
605
 
593
- # `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
606
+ # ### 4. 合同额度的扣减与返还
607
+ # - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
608
+ # - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
609
+ # - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
594
610
 
595
- # `3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
611
+ # ### 5. 静默(自动)签署的限制
612
+ # - 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color="red">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。
596
613
 
597
- # `4. 静默(自动)签署不支持合同签署方存在填写功能`
614
+ # ### 6.合同组暂不支持抄送功能
598
615
 
599
616
  # @param request: Request instance for ChannelCreateFlowGroupByTemplates.
600
617
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowGroupByTemplatesRequest`
@@ -901,7 +918,7 @@ module TencentCloud
901
918
  end
902
919
 
903
920
  # 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
904
- # 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
921
+ # 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/partner/flow_release)。
905
922
 
906
923
  # 注意:
907
924
  # <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
@@ -1445,9 +1462,10 @@ module TencentCloud
1445
1462
  # 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
1446
1463
  # 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
1447
1464
 
1448
- # 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
1465
+ # 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
1449
1466
  # 注:
1450
- # 1. `大文件转换所需的时间可能会比较长`
1467
+ # 1. `大文件转换所需的时间可能会比较长。`
1468
+ # 2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
1451
1469
 
1452
1470
  # @param request: Request instance for ChannelGetTaskResultApi.
1453
1471
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelGetTaskResultApiRequest`
@@ -1793,6 +1811,34 @@ module TencentCloud
1793
1811
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1794
1812
  end
1795
1813
 
1814
+ # 创建企业注销链接
1815
+
1816
+ # 系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成企业的注销操作。
1817
+
1818
+ # 注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人。`
1819
+
1820
+ # @param request: Request instance for CreateCloseOrganizationUrl.
1821
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateCloseOrganizationUrlRequest`
1822
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateCloseOrganizationUrlResponse`
1823
+ def CreateCloseOrganizationUrl(request)
1824
+ body = send_request('CreateCloseOrganizationUrl', request.serialize)
1825
+ response = JSON.parse(body)
1826
+ if response['Response'].key?('Error') == false
1827
+ model = CreateCloseOrganizationUrlResponse.new
1828
+ model.deserialize(response['Response'])
1829
+ model
1830
+ else
1831
+ code = response['Response']['Error']['Code']
1832
+ message = response['Response']['Error']['Message']
1833
+ reqid = response['Response']['RequestId']
1834
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1835
+ end
1836
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1837
+ raise e
1838
+ rescue StandardError => e
1839
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1840
+ end
1841
+
1796
1842
  # 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
1797
1843
 
1798
1844
  # Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:
@@ -2208,6 +2254,36 @@ module TencentCloud
2208
2254
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2209
2255
  end
2210
2256
 
2257
+ # 批量清理未认证的企业认证流程。
2258
+
2259
+ # 此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。
2260
+ # 为接口[提交子企业批量认证链接创建任务](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。
2261
+
2262
+ # 注意:
2263
+ # **这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**
2264
+
2265
+ # @param request: Request instance for DeleteOrganizationAuthorizations.
2266
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::DeleteOrganizationAuthorizationsRequest`
2267
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::DeleteOrganizationAuthorizationsResponse`
2268
+ def DeleteOrganizationAuthorizations(request)
2269
+ body = send_request('DeleteOrganizationAuthorizations', request.serialize)
2270
+ response = JSON.parse(body)
2271
+ if response['Response'].key?('Error') == false
2272
+ model = DeleteOrganizationAuthorizationsResponse.new
2273
+ model.deserialize(response['Response'])
2274
+ model
2275
+ else
2276
+ code = response['Response']['Error']['Code']
2277
+ message = response['Response']['Error']['Message']
2278
+ reqid = response['Response']['RequestId']
2279
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
2280
+ end
2281
+ rescue TencentCloud::Common::TencentCloudSDKException => e
2282
+ raise e
2283
+ rescue StandardError => e
2284
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2285
+ end
2286
+
2211
2287
  # 此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>获取到任务ID,然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。
2212
2288
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
2213
2289
 
@@ -2440,10 +2516,19 @@ module TencentCloud
2440
2516
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2441
2517
  end
2442
2518
 
2443
- # 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
2519
+ # 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。
2520
+
2521
+
2444
2522
 
2445
- # **注意**:
2446
- # 有两种开通权限的途径
2523
+
2524
+ # ### 1. 确保合同的PDF已经合成后,再调用本接口。
2525
+ # 用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
2526
+
2527
+ # **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
2528
+
2529
+ # **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。
2530
+
2531
+ # ### 2. 有两种开通下载权限的途径。
2447
2532
 
2448
2533
  # **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。
2449
2534
  # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
@@ -2453,6 +2538,7 @@ module TencentCloud
2453
2538
  # **第二种**: 渠道方企业在**企业应用管理**的配置界面打开需要配置的应用,点击**应用扩展服务**开通此功能,需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
2454
2539
  # 注:
2455
2540
  # 1. `请注意如果第三方应用的子客主动关闭了渠道端下载渠道子客合同功能开关,那么渠道方开通了此功能也无法下载子客的合同文件`
2541
+
2456
2542
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
2457
2543
 
2458
2544
  # @param request: Request instance for DescribeResourceUrlsByFlows.
@@ -2596,7 +2682,6 @@ module TencentCloud
2596
2682
  # - **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。
2597
2683
  # - **AUTO_SIGN(企业自动签)**
2598
2684
  # - **DOWNLOAD_FLOW(授权渠道下载合同)**
2599
- # - **OVERSEA_SIGN(企业与港澳台居民签署合同)**
2600
2685
 
2601
2686
  # 注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人`
2602
2687
 
@@ -129,7 +129,7 @@ module TencentCloud
129
129
  # @type HideOneKeySign: Boolean
130
130
  # @param FillType: 签署人信息补充类型,默认无需补充。
131
131
 
132
- # <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>
132
+ # <ul><li> **1** : 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li></ul>
133
133
 
134
134
  # 注:
135
135
  # `使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`
@@ -1498,7 +1498,10 @@ module TencentCloud
1498
1498
 
1499
1499
  # - 如果不指定,则使用姓名和手机号进行补充。
1500
1500
  # @type Approvers: Array
1501
- # @param FlowId: 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1501
+ # @param FlowId: 合同流程ID,为32位字符串。
1502
+ # - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1503
+ # - 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1504
+ # - <font color="red">不建议继续使用</font>,请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
1502
1505
  # @type FlowId: String
1503
1506
  # @param FillApproverType: 签署人信息补充方式
1504
1507
 
@@ -5490,6 +5493,65 @@ module TencentCloud
5490
5493
  end
5491
5494
  end
5492
5495
 
5496
+ # CreateCloseOrganizationUrl请求参数结构体
5497
+ class CreateCloseOrganizationUrlRequest < TencentCloud::Common::AbstractModel
5498
+ # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5499
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
5500
+
5501
+ attr_accessor :Agent
5502
+
5503
+ def initialize(agent=nil)
5504
+ @Agent = agent
5505
+ end
5506
+
5507
+ def deserialize(params)
5508
+ unless params['Agent'].nil?
5509
+ @Agent = Agent.new
5510
+ @Agent.deserialize(params['Agent'])
5511
+ end
5512
+ end
5513
+ end
5514
+
5515
+ # CreateCloseOrganizationUrl返回参数结构体
5516
+ class CreateCloseOrganizationUrlResponse < TencentCloud::Common::AbstractModel
5517
+ # @param ExpiredOn: 链接有效期,unix时间戳,精确到秒
5518
+ # @type ExpiredOn: Integer
5519
+ # @param LongUrl: H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
5520
+ # @type LongUrl: String
5521
+ # @param ShortUrl: H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序
5522
+ # @type ShortUrl: String
5523
+ # @param MiniAppPath: APP或小程序跳转电子签小程序链接, 一般用于客户小程序或者APP跳转过来, 打开后进入腾讯电子签小程序
5524
+ # @type MiniAppPath: String
5525
+ # @param QrcodeUrl: 二维码链接
5526
+ # @type QrcodeUrl: String
5527
+ # @param WeixinQrcodeUrl: 直接跳转至电子签小程序的二维码链接,无需通过中转页。您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。
5528
+ # @type WeixinQrcodeUrl: String
5529
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5530
+ # @type RequestId: String
5531
+
5532
+ attr_accessor :ExpiredOn, :LongUrl, :ShortUrl, :MiniAppPath, :QrcodeUrl, :WeixinQrcodeUrl, :RequestId
5533
+
5534
+ def initialize(expiredon=nil, longurl=nil, shorturl=nil, miniapppath=nil, qrcodeurl=nil, weixinqrcodeurl=nil, requestid=nil)
5535
+ @ExpiredOn = expiredon
5536
+ @LongUrl = longurl
5537
+ @ShortUrl = shorturl
5538
+ @MiniAppPath = miniapppath
5539
+ @QrcodeUrl = qrcodeurl
5540
+ @WeixinQrcodeUrl = weixinqrcodeurl
5541
+ @RequestId = requestid
5542
+ end
5543
+
5544
+ def deserialize(params)
5545
+ @ExpiredOn = params['ExpiredOn']
5546
+ @LongUrl = params['LongUrl']
5547
+ @ShortUrl = params['ShortUrl']
5548
+ @MiniAppPath = params['MiniAppPath']
5549
+ @QrcodeUrl = params['QrcodeUrl']
5550
+ @WeixinQrcodeUrl = params['WeixinQrcodeUrl']
5551
+ @RequestId = params['RequestId']
5552
+ end
5553
+ end
5554
+
5493
5555
  # CreateConsoleLoginUrl请求参数结构体
5494
5556
  class CreateConsoleLoginUrlRequest < TencentCloud::Common::AbstractModel
5495
5557
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
@@ -5578,7 +5640,14 @@ module TencentCloud
5578
5640
 
5579
5641
  # <a href="https://qcloudimg.tencent-cloud.cn/raw/dd54f333140c711cf6a88e3801bcd178.png" target="_blank">点击查看头顶导航栏位置</a>
5580
5642
  # @type TopNavigationStatus: String
5581
- # @param AutoActive: 是否自动激活子客
5643
+ # @param AutoActive: 是否自动激活子客企业,有下面两种选项:
5644
+
5645
+ # **false(默认设置)**:不自动激活子客户。您需要通过控制台或调用[激活或者续期子企业](https://qian.tencent.com/developers/partnerApis/accounts/CreateChannelSubOrganizationActive)接口手动完成激活过程。
5646
+
5647
+ # **true**:若持有的许可证充足,子客户企业注册完成后将自动激活,无需手动操作或访问控制台。
5648
+
5649
+ # <b>注</b>:如果<b>应用扩展服务</b>中的<b>自动激活子客企业</b>为打开态, 则忽略本接口的AutoActive这个参数(若持有的许可证充足,子客户企业注册完成后将自动激活),具体位置参考下图:
5650
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/c3639b05503d3735bac483d17aa6b0a3.png)
5582
5651
  # @type AutoActive: Boolean
5583
5652
 
5584
5653
  attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :ProxyOperatorMobile, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator, :ProxyOperatorIdCardNumber, :AutoJumpUrl, :TopNavigationStatus, :AutoActive
@@ -6397,7 +6466,10 @@ module TencentCloud
6397
6466
  # 第三方平台子客企业和员工必须已经过实名认证
6398
6467
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
6399
6468
  # @param FlowIds: 合同流程ID数组,最多支持100个。
6400
- # 注: `该参数和合同组编号必须二选一`
6469
+
6470
+ # 注:
6471
+ # 1. 必须选择提供此参数或合同组编号中的一个。
6472
+ # 2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
6401
6473
  # @type FlowIds: Array
6402
6474
  # @param FlowGroupId: 合同组编号
6403
6475
  # 注:`该参数和合同流程ID数组必须二选一`
@@ -6414,17 +6486,14 @@ module TencentCloud
6414
6486
  # @type Endpoint: String
6415
6487
  # @param GenerateType: 签署链接生成类型,可以选择的类型如下
6416
6488
 
6417
- # <ul><li>**ALL**:(默认)全部签署方签署链接,此时不会给自动签署(静默签署)的签署方创建签署链接</li>
6418
- # <li>**CHANNEL**:第三方子企业员工签署方</li>
6419
- # <li>**NOT_CHANNEL**:SaaS平台企业员工签署方</li>
6420
- # <li>**PERSON**:个人/自然人签署方</li>
6421
- # <li>**FOLLOWER**:关注方,目前是合同抄送方</li>
6422
- # <li>**RECIPIENT**:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接</li></ul>
6489
+ # <ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>
6490
+ # <li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>
6491
+ # <li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>
6492
+ # <li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>
6493
+ # <li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>
6494
+ # <li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
6423
6495
  # @type GenerateType: String
6424
- # @param OrganizationName: SaaS平台企业员工签署方的企业名称
6425
- # 如果名称中包含英文括号(),请使用中文括号()代替。
6426
-
6427
- # 注: `GenerateType为"NOT_CHANNEL"时必填`
6496
+ # @param OrganizationName: SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
6428
6497
  # @type OrganizationName: String
6429
6498
  # @param Name: 合同流程里边参与方的姓名。
6430
6499
  # 注: `GenerateType为"PERSON"(即个人签署方)时必填`
@@ -6442,8 +6511,7 @@ module TencentCloud
6442
6511
  # <li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。</li>
6443
6512
  # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
6444
6513
  # @type IdCardNumber: String
6445
- # @param OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId
6446
- # 注: `GenerateType为"CHANNEL"时必填`
6514
+ # @param OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
6447
6515
  # @type OrganizationOpenId: String
6448
6516
  # @param OpenId: 第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
6449
6517
 
@@ -6566,6 +6634,97 @@ module TencentCloud
6566
6634
  end
6567
6635
  end
6568
6636
 
6637
+ # 清理的企业认证流信息
6638
+ class DeleteOrganizationAuthorizationInfo < TencentCloud::Common::AbstractModel
6639
+ # @param AuthorizationId: 认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。
6640
+ # @type AuthorizationId: String
6641
+ # @param OrganizationName: 认证的企业名称
6642
+ # @type OrganizationName: String
6643
+ # @param OrganizationOpenId: 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
6644
+ # @type OrganizationOpenId: String
6645
+ # @param Errormessage: 清除认证流产生的错误信息
6646
+ # @type Errormessage: String
6647
+
6648
+ attr_accessor :AuthorizationId, :OrganizationName, :OrganizationOpenId, :Errormessage
6649
+
6650
+ def initialize(authorizationid=nil, organizationname=nil, organizationopenid=nil, errormessage=nil)
6651
+ @AuthorizationId = authorizationid
6652
+ @OrganizationName = organizationname
6653
+ @OrganizationOpenId = organizationopenid
6654
+ @Errormessage = errormessage
6655
+ end
6656
+
6657
+ def deserialize(params)
6658
+ @AuthorizationId = params['AuthorizationId']
6659
+ @OrganizationName = params['OrganizationName']
6660
+ @OrganizationOpenId = params['OrganizationOpenId']
6661
+ @Errormessage = params['Errormessage']
6662
+ end
6663
+ end
6664
+
6665
+ # DeleteOrganizationAuthorizations请求参数结构体
6666
+ class DeleteOrganizationAuthorizationsRequest < TencentCloud::Common::AbstractModel
6667
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6668
+
6669
+ # 此接口下面信息必填。
6670
+ # <ul>
6671
+ # <li>渠道应用标识: Agent.AppId</li>
6672
+ # </ul>
6673
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
6674
+ # @param AdminName: 认证人姓名,组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。
6675
+ # @type AdminName: String
6676
+ # @param AdminMobile: 认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。
6677
+ # @type AdminMobile: String
6678
+
6679
+ attr_accessor :Agent, :AdminName, :AdminMobile
6680
+
6681
+ def initialize(agent=nil, adminname=nil, adminmobile=nil)
6682
+ @Agent = agent
6683
+ @AdminName = adminname
6684
+ @AdminMobile = adminmobile
6685
+ end
6686
+
6687
+ def deserialize(params)
6688
+ unless params['Agent'].nil?
6689
+ @Agent = Agent.new
6690
+ @Agent.deserialize(params['Agent'])
6691
+ end
6692
+ @AdminName = params['AdminName']
6693
+ @AdminMobile = params['AdminMobile']
6694
+ end
6695
+ end
6696
+
6697
+ # DeleteOrganizationAuthorizations返回参数结构体
6698
+ class DeleteOrganizationAuthorizationsResponse < TencentCloud::Common::AbstractModel
6699
+ # @param DeleteOrganizationAuthorizationInfos: 清理认证流的详细信息,包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。
6700
+ # @type DeleteOrganizationAuthorizationInfos: Array
6701
+ # @param Status: 批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败
6702
+ # @type Status: Integer
6703
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6704
+ # @type RequestId: String
6705
+
6706
+ attr_accessor :DeleteOrganizationAuthorizationInfos, :Status, :RequestId
6707
+
6708
+ def initialize(deleteorganizationauthorizationinfos=nil, status=nil, requestid=nil)
6709
+ @DeleteOrganizationAuthorizationInfos = deleteorganizationauthorizationinfos
6710
+ @Status = status
6711
+ @RequestId = requestid
6712
+ end
6713
+
6714
+ def deserialize(params)
6715
+ unless params['DeleteOrganizationAuthorizationInfos'].nil?
6716
+ @DeleteOrganizationAuthorizationInfos = []
6717
+ params['DeleteOrganizationAuthorizationInfos'].each do |i|
6718
+ deleteorganizationauthorizationinfo_tmp = DeleteOrganizationAuthorizationInfo.new
6719
+ deleteorganizationauthorizationinfo_tmp.deserialize(i)
6720
+ @DeleteOrganizationAuthorizationInfos << deleteorganizationauthorizationinfo_tmp
6721
+ end
6722
+ end
6723
+ @Status = params['Status']
6724
+ @RequestId = params['RequestId']
6725
+ end
6726
+ end
6727
+
6569
6728
  # 第三方应用集成员工部门信息
6570
6729
  class Department < TencentCloud::Common::AbstractModel
6571
6730
  # @param DepartmentId: 部门id
@@ -7648,7 +7807,9 @@ module TencentCloud
7648
7807
 
7649
7808
  # 注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
7650
7809
  # @type ApproverIdCardNumber: String
7651
- # @param FlowId: 合同流程ID,补充合同组子合同动态签署人时必传。
7810
+ # @param FlowId: 合同流程ID
7811
+ # - 补充合同组子合同动态签署人时必传。
7812
+ # - 补充正常合同,请阅读:<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口</a>接口使用说明
7652
7813
  # @type FlowId: String
7653
7814
 
7654
7815
  attr_accessor :RecipientId, :OpenId, :ApproverName, :ApproverMobile, :OrganizationName, :OrganizationOpenId, :NotChannelOrganization, :ApproverIdCardType, :ApproverIdCardNumber, :FlowId
@@ -7688,17 +7849,22 @@ module TencentCloud
7688
7849
  # @param ErrMessage: 补充失败错误说明
7689
7850
  # 注意:此字段可能返回 null,表示取不到有效值。
7690
7851
  # @type ErrMessage: String
7852
+ # @param FlowId: 合同流程ID,为32位字符串。
7853
+ # 注意:此字段可能返回 null,表示取不到有效值。
7854
+ # @type FlowId: String
7691
7855
 
7692
- attr_accessor :RecipientId, :ErrMessage
7856
+ attr_accessor :RecipientId, :ErrMessage, :FlowId
7693
7857
 
7694
- def initialize(recipientid=nil, errmessage=nil)
7858
+ def initialize(recipientid=nil, errmessage=nil, flowid=nil)
7695
7859
  @RecipientId = recipientid
7696
7860
  @ErrMessage = errmessage
7861
+ @FlowId = flowid
7697
7862
  end
7698
7863
 
7699
7864
  def deserialize(params)
7700
7865
  @RecipientId = params['RecipientId']
7701
7866
  @ErrMessage = params['ErrMessage']
7867
+ @FlowId = params['FlowId']
7702
7868
  end
7703
7869
  end
7704
7870
 
@@ -9276,7 +9442,7 @@ module TencentCloud
9276
9442
  # @param OperateUrl: 操作跳转链接
9277
9443
  # <ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>
9278
9444
  # <li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>
9279
- # <li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>或<b>OVERSEA_SIGN(企业与港澳台居民签署合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color="red"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>
9445
+ # <li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color="red"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>
9280
9446
  # </ul>
9281
9447
 
9282
9448
  # @type OperateUrl: String
@@ -10237,6 +10403,8 @@ module TencentCloud
10237
10403
  # @type ApproverSignComponentType: String
10238
10404
  # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
10239
10405
  # 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
10406
+
10407
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)
10240
10408
  # @type ApproverSignRole: String
10241
10409
  # @param ApproverSignSealId: 印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署
10242
10410
  # @type ApproverSignSealId: String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.931
4
+ version: 3.0.933
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-10-23 00:00:00.000000000 Z
11
+ date: 2024-10-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common