tencentcloud-sdk-essbasic 3.0.930 → 3.0.932

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: 79766cabe890fe2533277bb255bf3a81f054c006
4
- data.tar.gz: cbd924a1a6b4e32c7a5dcb2c06c046b1a8b7d0a8
3
+ metadata.gz: b31a260e2dfddfa730a18daec31c53e854c597e1
4
+ data.tar.gz: 9ce89f57a46d1cc1bd1841c5a9718c4a599e5388
5
5
  SHA512:
6
- metadata.gz: be19900e30362ce9d2fe3e92ba5f2a7918b081569e2079a437aff923073cd53e856cb3f338a5d365def6261a58c7020cbaad230710c3ae4863c3f0ca6ef23fe1
7
- data.tar.gz: a556cd11c5803c191ae6abb9407719e09a228c627159a0233cb060184744d0cd57992a3f84998d75c0838ea18bd36f74478a30d627c4cdad829e2302cba7b082
6
+ metadata.gz: 621d0d6d062d269532599d7ce8a8c94a518fe9673804000a9bcf95de37f8fe7287cfed91ad84c009eb6922ea4ec75dfd2e3a70e5da1667da77d140d27375d339
7
+ data.tar.gz: 8e058c48f9a6ac704c714da3bd8e2dd634d575c55ba7f1807fd608a976971b8e9cab2f7b2c3aa11dc733527468816e3a17de9e5f1b4f310cd4c3751cdac28dd9
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.930
1
+ 3.0.932
@@ -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
 
@@ -901,7 +916,7 @@ module TencentCloud
901
916
  end
902
917
 
903
918
  # 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
904
- # 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
919
+ # 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/partner/flow_release)。
905
920
 
906
921
  # 注意:
907
922
  # <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
@@ -1445,9 +1460,10 @@ module TencentCloud
1445
1460
  # 此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
1446
1461
  # 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
1447
1462
 
1448
- # 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
1463
+ # 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源ID。<br />
1449
1464
  # 注:
1450
- # 1. `大文件转换所需的时间可能会比较长`
1465
+ # 1. `大文件转换所需的时间可能会比较长。`
1466
+ # 2. `本接口返回的文件资源ID就是PDF资源ID,可以直接用于【用PDF文件创建签署流程】接口发起合同。`
1451
1467
 
1452
1468
  # @param request: Request instance for ChannelGetTaskResultApi.
1453
1469
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelGetTaskResultApiRequest`
@@ -1793,6 +1809,34 @@ module TencentCloud
1793
1809
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1794
1810
  end
1795
1811
 
1812
+ # 创建企业注销链接
1813
+
1814
+ # 系统将返回操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成企业的注销操作。
1815
+
1816
+ # 注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人。`
1817
+
1818
+ # @param request: Request instance for CreateCloseOrganizationUrl.
1819
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateCloseOrganizationUrlRequest`
1820
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateCloseOrganizationUrlResponse`
1821
+ def CreateCloseOrganizationUrl(request)
1822
+ body = send_request('CreateCloseOrganizationUrl', request.serialize)
1823
+ response = JSON.parse(body)
1824
+ if response['Response'].key?('Error') == false
1825
+ model = CreateCloseOrganizationUrlResponse.new
1826
+ model.deserialize(response['Response'])
1827
+ model
1828
+ else
1829
+ code = response['Response']['Error']['Code']
1830
+ message = response['Response']['Error']['Message']
1831
+ reqid = response['Response']['RequestId']
1832
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1833
+ end
1834
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1835
+ raise e
1836
+ rescue StandardError => e
1837
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1838
+ end
1839
+
1796
1840
  # 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
1797
1841
 
1798
1842
  # Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态,进入不同的流程,主要情况分类如下:
@@ -2208,6 +2252,36 @@ module TencentCloud
2208
2252
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2209
2253
  end
2210
2254
 
2255
+ # 批量清理未认证的企业认证流程。
2256
+
2257
+ # 此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。
2258
+ # 为接口[提交子企业批量认证链接创建任务](https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks) 和[查询子企业批量认证链接](https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。
2259
+
2260
+ # 注意:
2261
+ # **这个接口的操作人必须跟生成批量认证链接接口的应用号一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流**
2262
+
2263
+ # @param request: Request instance for DeleteOrganizationAuthorizations.
2264
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::DeleteOrganizationAuthorizationsRequest`
2265
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::DeleteOrganizationAuthorizationsResponse`
2266
+ def DeleteOrganizationAuthorizations(request)
2267
+ body = send_request('DeleteOrganizationAuthorizations', request.serialize)
2268
+ response = JSON.parse(body)
2269
+ if response['Response'].key?('Error') == false
2270
+ model = DeleteOrganizationAuthorizationsResponse.new
2271
+ model.deserialize(response['Response'])
2272
+ model
2273
+ else
2274
+ code = response['Response']['Error']['Code']
2275
+ message = response['Response']['Error']['Message']
2276
+ reqid = response['Response']['RequestId']
2277
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
2278
+ end
2279
+ rescue TencentCloud::Common::TencentCloudSDKException => e
2280
+ raise e
2281
+ rescue StandardError => e
2282
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2283
+ end
2284
+
2211
2285
  # 此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>获取到任务ID,然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。
2212
2286
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
2213
2287
 
@@ -2440,10 +2514,18 @@ module TencentCloud
2440
2514
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2441
2515
  end
2442
2516
 
2443
- # 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同
2517
+ # 获取合同流程PDF的下载链接,可以下载签署中、签署完的此子企业创建的合同。
2444
2518
 
2445
- # **注意**:
2446
- # 有两种开通权限的途径
2519
+
2520
+
2521
+
2522
+ # ### 1. 确保合同的PDF已经合成后,再调用本接口。
2523
+ # 用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
2524
+
2525
+ # **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
2526
+ # **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。
2527
+
2528
+ # ### 2. 有两种开通下载权限的途径。
2447
2529
 
2448
2530
  # **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。
2449
2531
  # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
@@ -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
  # `使用动态签署人能力前,需登陆腾讯电子签控制台打开服务开关`
@@ -1394,11 +1394,17 @@ module TencentCloud
1394
1394
  # @type EmbedType: String
1395
1395
  # @param BusinessId: WEB嵌入的业务资源ID
1396
1396
 
1397
+ # 当EmbedType取值
1397
1398
  # <ul>
1398
- # <li>当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId</li>
1399
- # <li>当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId</li>
1400
- # <li>当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId</li>
1399
+ # <li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li>
1400
+ # <li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li>
1401
+ # <li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li>
1402
+ # <li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li>
1401
1403
  # </ul>
1404
+
1405
+
1406
+ # 注意:
1407
+ # 1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口[创建文件转换任务](https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi) 来进行转换成PDF资源。
1402
1408
  # @type BusinessId: String
1403
1409
  # @param HiddenComponents: 是否隐藏控件,只有预览模板时生效
1404
1410
  # @type HiddenComponents: Boolean
@@ -1492,7 +1498,10 @@ module TencentCloud
1492
1498
 
1493
1499
  # - 如果不指定,则使用姓名和手机号进行补充。
1494
1500
  # @type Approvers: Array
1495
- # @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指定合同
1496
1505
  # @type FlowId: String
1497
1506
  # @param FillApproverType: 签署人信息补充方式
1498
1507
 
@@ -5484,6 +5493,65 @@ module TencentCloud
5484
5493
  end
5485
5494
  end
5486
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
+
5487
5555
  # CreateConsoleLoginUrl请求参数结构体
5488
5556
  class CreateConsoleLoginUrlRequest < TencentCloud::Common::AbstractModel
5489
5557
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
@@ -5572,7 +5640,14 @@ module TencentCloud
5572
5640
 
5573
5641
  # <a href="https://qcloudimg.tencent-cloud.cn/raw/dd54f333140c711cf6a88e3801bcd178.png" target="_blank">点击查看头顶导航栏位置</a>
5574
5642
  # @type TopNavigationStatus: String
5575
- # @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)
5576
5651
  # @type AutoActive: Boolean
5577
5652
 
5578
5653
  attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :ProxyOperatorMobile, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator, :ProxyOperatorIdCardNumber, :AutoJumpUrl, :TopNavigationStatus, :AutoActive
@@ -6391,7 +6466,10 @@ module TencentCloud
6391
6466
  # 第三方平台子客企业和员工必须已经过实名认证
6392
6467
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
6393
6468
  # @param FlowIds: 合同流程ID数组,最多支持100个。
6394
- # 注: `该参数和合同组编号必须二选一`
6469
+
6470
+ # 注:
6471
+ # 1. 必须选择提供此参数或合同组编号中的一个。
6472
+ # 2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
6395
6473
  # @type FlowIds: Array
6396
6474
  # @param FlowGroupId: 合同组编号
6397
6475
  # 注:`该参数和合同流程ID数组必须二选一`
@@ -6408,17 +6486,14 @@ module TencentCloud
6408
6486
  # @type Endpoint: String
6409
6487
  # @param GenerateType: 签署链接生成类型,可以选择的类型如下
6410
6488
 
6411
- # <ul><li>**ALL**:(默认)全部签署方签署链接,此时不会给自动签署(静默签署)的签署方创建签署链接</li>
6412
- # <li>**CHANNEL**:第三方子企业员工签署方</li>
6413
- # <li>**NOT_CHANNEL**:SaaS平台企业员工签署方</li>
6414
- # <li>**PERSON**:个人/自然人签署方</li>
6415
- # <li>**FOLLOWER**:关注方,目前是合同抄送方</li>
6416
- # <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>
6417
6495
  # @type GenerateType: String
6418
- # @param OrganizationName: SaaS平台企业员工签署方的企业名称
6419
- # 如果名称中包含英文括号(),请使用中文括号()代替。
6420
-
6421
- # 注: `GenerateType为"NOT_CHANNEL"时必填`
6496
+ # @param OrganizationName: SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
6422
6497
  # @type OrganizationName: String
6423
6498
  # @param Name: 合同流程里边参与方的姓名。
6424
6499
  # 注: `GenerateType为"PERSON"(即个人签署方)时必填`
@@ -6560,6 +6635,97 @@ module TencentCloud
6560
6635
  end
6561
6636
  end
6562
6637
 
6638
+ # 清理的企业认证流信息
6639
+ class DeleteOrganizationAuthorizationInfo < TencentCloud::Common::AbstractModel
6640
+ # @param AuthorizationId: 认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。
6641
+ # @type AuthorizationId: String
6642
+ # @param OrganizationName: 认证的企业名称
6643
+ # @type OrganizationName: String
6644
+ # @param OrganizationOpenId: 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
6645
+ # @type OrganizationOpenId: String
6646
+ # @param Errormessage: 清除认证流产生的错误信息
6647
+ # @type Errormessage: String
6648
+
6649
+ attr_accessor :AuthorizationId, :OrganizationName, :OrganizationOpenId, :Errormessage
6650
+
6651
+ def initialize(authorizationid=nil, organizationname=nil, organizationopenid=nil, errormessage=nil)
6652
+ @AuthorizationId = authorizationid
6653
+ @OrganizationName = organizationname
6654
+ @OrganizationOpenId = organizationopenid
6655
+ @Errormessage = errormessage
6656
+ end
6657
+
6658
+ def deserialize(params)
6659
+ @AuthorizationId = params['AuthorizationId']
6660
+ @OrganizationName = params['OrganizationName']
6661
+ @OrganizationOpenId = params['OrganizationOpenId']
6662
+ @Errormessage = params['Errormessage']
6663
+ end
6664
+ end
6665
+
6666
+ # DeleteOrganizationAuthorizations请求参数结构体
6667
+ class DeleteOrganizationAuthorizationsRequest < TencentCloud::Common::AbstractModel
6668
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6669
+
6670
+ # 此接口下面信息必填。
6671
+ # <ul>
6672
+ # <li>渠道应用标识: Agent.AppId</li>
6673
+ # </ul>
6674
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
6675
+ # @param AdminName: 认证人姓名,组织机构超管姓名。 在注册流程中,必须是超管本人进行操作。
6676
+ # @type AdminName: String
6677
+ # @param AdminMobile: 认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。
6678
+ # @type AdminMobile: String
6679
+
6680
+ attr_accessor :Agent, :AdminName, :AdminMobile
6681
+
6682
+ def initialize(agent=nil, adminname=nil, adminmobile=nil)
6683
+ @Agent = agent
6684
+ @AdminName = adminname
6685
+ @AdminMobile = adminmobile
6686
+ end
6687
+
6688
+ def deserialize(params)
6689
+ unless params['Agent'].nil?
6690
+ @Agent = Agent.new
6691
+ @Agent.deserialize(params['Agent'])
6692
+ end
6693
+ @AdminName = params['AdminName']
6694
+ @AdminMobile = params['AdminMobile']
6695
+ end
6696
+ end
6697
+
6698
+ # DeleteOrganizationAuthorizations返回参数结构体
6699
+ class DeleteOrganizationAuthorizationsResponse < TencentCloud::Common::AbstractModel
6700
+ # @param DeleteOrganizationAuthorizationInfos: 清理认证流的详细信息,包括企业名称、认证流唯一 ID 以及清理认证流过程中产生的错误信息。
6701
+ # @type DeleteOrganizationAuthorizationInfos: Array
6702
+ # @param Status: 批量清理认证流返回的状态值其中包括- 1 全部成功- 2 部分成功- 3 全部失败
6703
+ # @type Status: Integer
6704
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6705
+ # @type RequestId: String
6706
+
6707
+ attr_accessor :DeleteOrganizationAuthorizationInfos, :Status, :RequestId
6708
+
6709
+ def initialize(deleteorganizationauthorizationinfos=nil, status=nil, requestid=nil)
6710
+ @DeleteOrganizationAuthorizationInfos = deleteorganizationauthorizationinfos
6711
+ @Status = status
6712
+ @RequestId = requestid
6713
+ end
6714
+
6715
+ def deserialize(params)
6716
+ unless params['DeleteOrganizationAuthorizationInfos'].nil?
6717
+ @DeleteOrganizationAuthorizationInfos = []
6718
+ params['DeleteOrganizationAuthorizationInfos'].each do |i|
6719
+ deleteorganizationauthorizationinfo_tmp = DeleteOrganizationAuthorizationInfo.new
6720
+ deleteorganizationauthorizationinfo_tmp.deserialize(i)
6721
+ @DeleteOrganizationAuthorizationInfos << deleteorganizationauthorizationinfo_tmp
6722
+ end
6723
+ end
6724
+ @Status = params['Status']
6725
+ @RequestId = params['RequestId']
6726
+ end
6727
+ end
6728
+
6563
6729
  # 第三方应用集成员工部门信息
6564
6730
  class Department < TencentCloud::Common::AbstractModel
6565
6731
  # @param DepartmentId: 部门id
@@ -7519,17 +7685,26 @@ module TencentCloud
7519
7685
  # <ul><li> <b>true</b> :允许在模板预览页展示控件</li>
7520
7686
  # <li> <b>false</b> :(默认)不允许在模板预览页展示控件</li></ul>
7521
7687
  # @type ShowTemplateComponent: Boolean
7688
+ # @param SkipUploadFile: 跳过上传文件,默认为false(展示上传文件页)![image](https://qcloudimg.tencent-cloud.cn/raw/8ca33745cf772e79831dbe5a70e82400.png)
7689
+ # - false: 展示上传文件页
7690
+ # - true: 不展示上传文件页
7691
+
7522
7692
 
7523
- attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent
7693
+ # 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**,
7694
+ # @type SkipUploadFile: String
7524
7695
 
7525
- def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil)
7696
+ attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent, :SkipUploadFile
7697
+
7698
+ def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil, skipuploadfile=nil)
7526
7699
  @ShowFlowDetailComponent = showflowdetailcomponent
7527
7700
  @ShowTemplateComponent = showtemplatecomponent
7701
+ @SkipUploadFile = skipuploadfile
7528
7702
  end
7529
7703
 
7530
7704
  def deserialize(params)
7531
7705
  @ShowFlowDetailComponent = params['ShowFlowDetailComponent']
7532
7706
  @ShowTemplateComponent = params['ShowTemplateComponent']
7707
+ @SkipUploadFile = params['SkipUploadFile']
7533
7708
  end
7534
7709
  end
7535
7710
 
@@ -7633,7 +7808,9 @@ module TencentCloud
7633
7808
 
7634
7809
  # 注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
7635
7810
  # @type ApproverIdCardNumber: String
7636
- # @param FlowId: 合同流程ID,补充合同组子合同动态签署人时必传。
7811
+ # @param FlowId: 合同流程ID
7812
+ # - 补充合同组子合同动态签署人时必传。
7813
+ # - 补充正常合同,请阅读:<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelCreateFlowApprovers/" target="_blank">补充签署人接口</a>接口使用说明
7637
7814
  # @type FlowId: String
7638
7815
 
7639
7816
  attr_accessor :RecipientId, :OpenId, :ApproverName, :ApproverMobile, :OrganizationName, :OrganizationOpenId, :NotChannelOrganization, :ApproverIdCardType, :ApproverIdCardNumber, :FlowId
@@ -7673,17 +7850,22 @@ module TencentCloud
7673
7850
  # @param ErrMessage: 补充失败错误说明
7674
7851
  # 注意:此字段可能返回 null,表示取不到有效值。
7675
7852
  # @type ErrMessage: String
7853
+ # @param FlowId: 合同流程ID,为32位字符串。
7854
+ # 注意:此字段可能返回 null,表示取不到有效值。
7855
+ # @type FlowId: String
7676
7856
 
7677
- attr_accessor :RecipientId, :ErrMessage
7857
+ attr_accessor :RecipientId, :ErrMessage, :FlowId
7678
7858
 
7679
- def initialize(recipientid=nil, errmessage=nil)
7859
+ def initialize(recipientid=nil, errmessage=nil, flowid=nil)
7680
7860
  @RecipientId = recipientid
7681
7861
  @ErrMessage = errmessage
7862
+ @FlowId = flowid
7682
7863
  end
7683
7864
 
7684
7865
  def deserialize(params)
7685
7866
  @RecipientId = params['RecipientId']
7686
7867
  @ErrMessage = params['ErrMessage']
7868
+ @FlowId = params['FlowId']
7687
7869
  end
7688
7870
  end
7689
7871
 
@@ -10222,6 +10404,8 @@ module TencentCloud
10222
10404
  # @type ApproverSignComponentType: String
10223
10405
  # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
10224
10406
  # 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
10407
+
10408
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)
10225
10409
  # @type ApproverSignRole: String
10226
10410
  # @param ApproverSignSealId: 印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署
10227
10411
  # @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.930
4
+ version: 3.0.932
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-22 00:00:00.000000000 Z
11
+ date: 2024-10-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common