tencentcloud-sdk-essbasic 3.0.764 → 3.0.766

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: 097c3da0915c213f481ed5de22ce3da11879abc1
4
- data.tar.gz: 6b38598b8ce585f6a4ce19f9edede10b6e99052b
3
+ metadata.gz: d7d715c99bb1237bf191fca11d254f32fb4ddb5b
4
+ data.tar.gz: fbf794317e43ddf3dff3320ddc230c404f7371c2
5
5
  SHA512:
6
- metadata.gz: 898cf335cc42b6a87e6ae509bdf3fcde475d73a2babdabb1fe2002a8b707bccd4078c6d379b560a0342cb48a5f66d84628cbcb3e345b8c686b76367ee6827404
7
- data.tar.gz: 5b327c9961e8bfb6032aa99343d6e56093fd1ad218ab9e16f1206e5ab1b92568064b926fcc88fe2c48ea74dc9ca32ff3feb5f6fa583544fac8415f8d17581549
6
+ metadata.gz: daeb7084aea45ee02ec272ee709e4f3a22727413c566b49e03ebaa99f3f74e95a10ae9c11df25e099cff4dd8096b618e2013bcc2d48ab46f5d3296d25308adc2
7
+ data.tar.gz: b6871bc7669fd52bdcc29aa7d08c53bf54c5a627fe325d04a1367f5493c414baa378ae69b5bd6acf32d9c4c36c02999da7f47ffcb99f51ef1dcbd0b5e631388f
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.764
1
+ 3.0.766
@@ -1789,8 +1789,8 @@ module TencentCloud
1789
1789
  # </tbody>
1790
1790
  # </table>
1791
1791
 
1792
- # ### 三. 填充模版中定义的填写控件
1793
- # 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
1792
+ # ### 三. 填充模板中定义的填写控件
1793
+ # 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
1794
1794
 
1795
1795
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
1796
1796
  # 填充的传参示例如下
@@ -1924,7 +1924,7 @@ module TencentCloud
1924
1924
  # | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
1925
1925
  # | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
1926
1926
 
1927
- # **主要使用场景可以更加EndPoint分类如下**
1927
+ # **主要使用场景EndPoint分类**
1928
1928
 
1929
1929
  # |EndPoint| 场景| 说明和示例|
1930
1930
  # | ---- | ---- | --- |
@@ -1984,32 +1984,6 @@ module TencentCloud
1984
1984
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1985
1985
  end
1986
1986
 
1987
- # 废弃接口
1988
-
1989
- # 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1990
-
1991
- # @param request: Request instance for DescribeBillUsageDetail.
1992
- # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeBillUsageDetailRequest`
1993
- # @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeBillUsageDetailResponse`
1994
- def DescribeBillUsageDetail(request)
1995
- body = send_request('DescribeBillUsageDetail', request.serialize)
1996
- response = JSON.parse(body)
1997
- if response['Response'].key?('Error') == false
1998
- model = DescribeBillUsageDetailResponse.new
1999
- model.deserialize(response['Response'])
2000
- model
2001
- else
2002
- code = response['Response']['Error']['Code']
2003
- message = response['Response']['Error']['Message']
2004
- reqid = response['Response']['RequestId']
2005
- raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
2006
- end
2007
- rescue TencentCloud::Common::TencentCloudSDKException => e
2008
- raise e
2009
- rescue StandardError => e
2010
- raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2011
- end
2012
-
2013
1987
  # 获取出证报告任务执行结果,返回报告 URL。
2014
1988
 
2015
1989
  # 注意:
@@ -2514,11 +2488,12 @@ module TencentCloud
2514
2488
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2515
2489
  end
2516
2490
 
2517
- # 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
2491
+ # 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。
2492
+ # 子客Web控制台的组织架构管理,依赖于第三方应用平台的,无法在页面针对员工做新增/更新/离职等操作, 必须通过 API 来操作。
2518
2493
 
2519
- # - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
2494
+ # - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
2520
2495
 
2521
- # - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
2496
+ # - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
2522
2497
 
2523
2498
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
2524
2499
 
@@ -435,104 +435,6 @@ module TencentCloud
435
435
  end
436
436
  end
437
437
 
438
- # 用户计费使用情况详情
439
- class BillUsageDetail < TencentCloud::Common::AbstractModel
440
- # @param FlowId: 合同流程ID,为32位字符串。
441
- # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
442
- # 注意:此字段可能返回 null,表示取不到有效值。
443
- # @type FlowId: String
444
- # @param OperatorName: 合同经办人名称
445
- # 如果有多个经办人用分号隔开。
446
- # 注意:此字段可能返回 null,表示取不到有效值。
447
- # @type OperatorName: String
448
- # @param CreateOrganizationName: 发起方组织机构名称
449
- # 注意:此字段可能返回 null,表示取不到有效值。
450
- # @type CreateOrganizationName: String
451
- # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
452
- # 该名称还将用于合同签署完成后的下载文件名。
453
- # 注意:此字段可能返回 null,表示取不到有效值。
454
- # @type FlowName: String
455
- # @param Status: 当前合同状态,如下是状态码对应的状态。
456
- # 0-还没有发起
457
- # 1-等待签署
458
- # 2-部分签署
459
- # 3-拒签
460
- # 4-已签署
461
- # 5-已过期
462
- # 6-已撤销
463
- # 7-还没有预发起
464
- # 8-等待填写
465
- # 9-部分填写
466
- # 10-拒填
467
- # 11-已解除
468
- # 注意:此字段可能返回 null,表示取不到有效值。
469
- # @type Status: Integer
470
- # @param QuotaType: 套餐类型
471
- # 对应关系如下
472
- # CloudEnterprise-企业版合同
473
- # SingleSignature-单方签章
474
- # CloudProve-签署报告
475
- # CloudOnlineSign-腾讯会议在线签约
476
- # ChannelWeCard-微工卡
477
- # SignFlow-合同套餐
478
- # SignFace-签署意愿(人脸识别)
479
- # SignPassword-签署意愿(密码)
480
- # SignSMS-签署意愿(短信)
481
- # PersonalEssAuth-签署人实名(腾讯电子签认证)
482
- # PersonalThirdAuth-签署人实名(信任第三方认证)
483
- # OrgEssAuth-签署企业实名
484
- # FlowNotify-短信通知
485
- # AuthService-企业工商信息查询
486
- # 注意:此字段可能返回 null,表示取不到有效值。
487
- # @type QuotaType: String
488
- # @param UseCount: 合同使用量
489
- # 注意:此字段可能返回 null,表示取不到有效值。
490
- # @type UseCount: Integer
491
- # @param CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。
492
- # 注意:此字段可能返回 null,表示取不到有效值。
493
- # @type CostTime: Integer
494
- # @param QuotaName: 消耗的套餐名称
495
- # 注意:此字段可能返回 null,表示取不到有效值。
496
- # @type QuotaName: String
497
- # @param CostType: 消耗类型
498
- # 1.扣费 2.撤销返还
499
- # 注意:此字段可能返回 null,表示取不到有效值。
500
- # @type CostType: Integer
501
- # @param Remark: 备注
502
- # 注意:此字段可能返回 null,表示取不到有效值。
503
- # @type Remark: String
504
-
505
- attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
506
-
507
- def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, status=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil)
508
- @FlowId = flowid
509
- @OperatorName = operatorname
510
- @CreateOrganizationName = createorganizationname
511
- @FlowName = flowname
512
- @Status = status
513
- @QuotaType = quotatype
514
- @UseCount = usecount
515
- @CostTime = costtime
516
- @QuotaName = quotaname
517
- @CostType = costtype
518
- @Remark = remark
519
- end
520
-
521
- def deserialize(params)
522
- @FlowId = params['FlowId']
523
- @OperatorName = params['OperatorName']
524
- @CreateOrganizationName = params['CreateOrganizationName']
525
- @FlowName = params['FlowName']
526
- @Status = params['Status']
527
- @QuotaType = params['QuotaType']
528
- @UseCount = params['UseCount']
529
- @CostTime = params['CostTime']
530
- @QuotaName = params['QuotaName']
531
- @CostType = params['CostType']
532
- @Remark = params['Remark']
533
- end
534
- end
535
-
536
438
  # 抄送信息
537
439
  class CcInfo < TencentCloud::Common::AbstractModel
538
440
  # @param Mobile: 被抄送人手机号,大陆11位手机号
@@ -1746,7 +1648,7 @@ module TencentCloud
1746
1648
  # @param FlowId: 合同流程ID,为32位字符串。
1747
1649
  # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1748
1650
 
1749
- # [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
1651
+ # [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
1750
1652
  # 注意:此字段可能返回 null,表示取不到有效值。
1751
1653
  # @type FlowId: String
1752
1654
  # @param Approvers: 签署方信息,如角色ID、角色名称等
@@ -2670,7 +2572,7 @@ module TencentCloud
2670
2572
  # @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
2671
2573
 
2672
2574
 
2673
- # [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2575
+ # [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2674
2576
  # @type NeedRelievedFlowId: String
2675
2577
  # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
2676
2578
  # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
@@ -3188,7 +3090,11 @@ module TencentCloud
3188
3090
  # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3189
3091
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3190
3092
  # @param ThemeType: 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
3191
- # <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
3093
+ # <ul>
3094
+ # <li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
3095
+ # <li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
3096
+ # 目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
3097
+ # </ul>
3192
3098
  # @type ThemeType: String
3193
3099
  # @param WebThemeConfig: 主题配置
3194
3100
  # @type WebThemeConfig: :class:`Tencentcloud::Essbasic.v20210526.models.WebThemeConfig`
@@ -5736,7 +5642,7 @@ module TencentCloud
5736
5642
 
5737
5643
  # **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
5738
5644
 
5739
- # 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
5645
+ # 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
5740
5646
  # @type Endpoint: String
5741
5647
  # @param GenerateType: 签署链接生成类型,可以选择的类型如下
5742
5648
 
@@ -5959,91 +5865,6 @@ module TencentCloud
5959
5865
  end
5960
5866
  end
5961
5867
 
5962
- # DescribeBillUsageDetail请求参数结构体
5963
- class DescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
5964
- # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5965
- # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
5966
- # @param StartTime: 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
5967
- # @type StartTime: String
5968
- # @param EndTime: 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
5969
- # @type EndTime: String
5970
- # @param QuotaType: 查询的套餐类型 (选填 )不传则查询所有套餐;
5971
- # 对应关系如下
5972
- # CloudEnterprise-企业版合同
5973
- # SingleSignature-单方签章
5974
- # CloudProve-签署报告
5975
- # CloudOnlineSign-腾讯会议在线签约
5976
- # ChannelWeCard-微工卡
5977
- # SignFlow-合同套餐
5978
- # SignFace-签署意愿(人脸识别)
5979
- # SignPassword-签署意愿(密码)
5980
- # SignSMS-签署意愿(短信)
5981
- # PersonalEssAuth-签署人实名(腾讯电子签认证)
5982
- # PersonalThirdAuth-签署人实名(信任第三方认证)
5983
- # OrgEssAuth-签署企业实名
5984
- # FlowNotify-短信通知
5985
- # AuthService-企业工商信息查询
5986
- # @type QuotaType: String
5987
- # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
5988
- # @type Offset: Integer
5989
- # @param Limit: 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
5990
- # @type Limit: Integer
5991
-
5992
- attr_accessor :Agent, :StartTime, :EndTime, :QuotaType, :Offset, :Limit
5993
-
5994
- def initialize(agent=nil, starttime=nil, endtime=nil, quotatype=nil, offset=nil, limit=nil)
5995
- @Agent = agent
5996
- @StartTime = starttime
5997
- @EndTime = endtime
5998
- @QuotaType = quotatype
5999
- @Offset = offset
6000
- @Limit = limit
6001
- end
6002
-
6003
- def deserialize(params)
6004
- unless params['Agent'].nil?
6005
- @Agent = Agent.new
6006
- @Agent.deserialize(params['Agent'])
6007
- end
6008
- @StartTime = params['StartTime']
6009
- @EndTime = params['EndTime']
6010
- @QuotaType = params['QuotaType']
6011
- @Offset = params['Offset']
6012
- @Limit = params['Limit']
6013
- end
6014
- end
6015
-
6016
- # DescribeBillUsageDetail返回参数结构体
6017
- class DescribeBillUsageDetailResponse < TencentCloud::Common::AbstractModel
6018
- # @param Total: 返回查询记录总数
6019
- # @type Total: Integer
6020
- # @param Details: 消耗记录详情
6021
- # @type Details: Array
6022
- # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6023
- # @type RequestId: String
6024
-
6025
- attr_accessor :Total, :Details, :RequestId
6026
-
6027
- def initialize(total=nil, details=nil, requestid=nil)
6028
- @Total = total
6029
- @Details = details
6030
- @RequestId = requestid
6031
- end
6032
-
6033
- def deserialize(params)
6034
- @Total = params['Total']
6035
- unless params['Details'].nil?
6036
- @Details = []
6037
- params['Details'].each do |i|
6038
- billusagedetail_tmp = BillUsageDetail.new
6039
- billusagedetail_tmp.deserialize(i)
6040
- @Details << billusagedetail_tmp
6041
- end
6042
- end
6043
- @RequestId = params['RequestId']
6044
- end
6045
- end
6046
-
6047
5868
  # DescribeChannelFlowEvidenceReport请求参数结构体
6048
5869
  class DescribeChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
6049
5870
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -6574,7 +6395,7 @@ module TencentCloud
6574
6395
 
6575
6396
  # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
6576
6397
 
6577
- # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6398
+ # [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6578
6399
  # @type TemplateId: String
6579
6400
  # @param ContentType: 查询模板的内容
6580
6401
 
@@ -6589,7 +6410,7 @@ module TencentCloud
6589
6410
  # 4. `若传递此参数,分页参数(Limit,Offset)无效`
6590
6411
 
6591
6412
 
6592
- # [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6413
+ # [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6593
6414
  # @type TemplateIds: Array
6594
6415
  # @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
6595
6416
 
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.764
4
+ version: 3.0.766
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-02-05 00:00:00.000000000 Z
11
+ date: 2024-02-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common