tencentcloud-sdk-ess 3.0.652 → 3.0.653
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +25 -13
- data/lib/v20201111/models.rb +142 -108
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f16eb3b5eeb13b67e62d57e989b56cd406ab7f11
|
4
|
+
data.tar.gz: 0461dadb9b6bf8779fd38ec36f235c9494a3db61
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 000b663298d001cacf6c24ab46f2719eb00991931c710f8e93c99b2fa7f448ce5927a9d7cb869f397d1d0204fc036914ccca8a0fab726ae5ad598a2cc5891612
|
7
|
+
data.tar.gz: f2becf9075c48f2a57720a3bc50268e7c65edbe6081b981d7961fb27140da1b0785d96860d28be1677aa97c0bf02e93938e8e886796aa97089c776fd6dc1b09e
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.653
|
data/lib/v20201111/client.rb
CHANGED
@@ -611,7 +611,8 @@ module TencentCloud
|
|
611
611
|
end
|
612
612
|
|
613
613
|
# 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
614
|
-
# 适用场景:无需填写签署人信息,可通过模板id
|
614
|
+
# 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
|
615
|
+
# 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
615
616
|
|
616
617
|
# **本接口适用于发起方没有填写控件的 B2C或者单C模板**
|
617
618
|
|
@@ -769,17 +770,22 @@ module TencentCloud
|
|
769
770
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
770
771
|
end
|
771
772
|
|
772
|
-
#
|
773
|
+
# 获取跳转至腾讯电子签小程序的签署链接
|
773
774
|
|
774
775
|
# 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
775
776
|
|
776
|
-
#
|
777
|
+
# 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
777
778
|
|
779
|
+
# 注:
|
780
|
+
# `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
|
781
|
+
# `2. 签署链接的有效期为90天,超过有效期链接不可用`
|
778
782
|
|
779
|
-
#
|
783
|
+
# 其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
780
784
|
|
781
|
-
|
782
|
-
#
|
785
|
+
# | 小程序 | AppID | 原始ID |
|
786
|
+
# | ------------ | ------------ | ------------ |
|
787
|
+
# | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
788
|
+
# | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
783
789
|
|
784
790
|
# @param request: Request instance for CreateSchemeUrl.
|
785
791
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlRequest`
|
@@ -998,7 +1004,12 @@ module TencentCloud
|
|
998
1004
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
999
1005
|
end
|
1000
1006
|
|
1001
|
-
#
|
1007
|
+
# 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
1008
|
+
# 1. 企业静默签
|
1009
|
+
# 2. 企业与港澳台居民签署合同
|
1010
|
+
# 3. 使用手机号验证签署方身份
|
1011
|
+
# 4. 骑缝章
|
1012
|
+
# 5. 批量签署能力
|
1002
1013
|
|
1003
1014
|
# @param request: Request instance for DescribeExtendedServiceAuthInfos.
|
1004
1015
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthInfosRequest`
|
@@ -1426,9 +1437,10 @@ module TencentCloud
|
|
1426
1437
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1427
1438
|
end
|
1428
1439
|
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
#
|
1440
|
+
# 新增/删除企业应用集成中的回调配置。
|
1441
|
+
# 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
|
1442
|
+
# 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
1443
|
+
# 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
1432
1444
|
|
1433
1445
|
# @param request: Request instance for ModifyApplicationCallbackInfo.
|
1434
1446
|
# @type request: :class:`Tencentcloud::ess::V20201111::ModifyApplicationCallbackInfoRequest`
|
@@ -1509,9 +1521,9 @@ module TencentCloud
|
|
1509
1521
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1510
1522
|
end
|
1511
1523
|
|
1512
|
-
#
|
1513
|
-
#
|
1514
|
-
#
|
1524
|
+
# 此接口用于启动流程。它是模板发起合同的最后一步。
|
1525
|
+
# 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
|
1526
|
+
# 流程激活后,将生成一份待签署的电子合同。
|
1515
1527
|
|
1516
1528
|
# @param request: Request instance for StartFlow.
|
1517
1529
|
# @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
|
data/lib/v20201111/models.rb
CHANGED
@@ -415,15 +415,15 @@ module TencentCloud
|
|
415
415
|
end
|
416
416
|
end
|
417
417
|
|
418
|
-
#
|
418
|
+
# 企业应用回调信息
|
419
419
|
class CallbackInfo < TencentCloud::Common::AbstractModel
|
420
|
-
# @param CallbackUrl: 回调url
|
420
|
+
# @param CallbackUrl: 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
421
421
|
# @type CallbackUrl: String
|
422
422
|
# @param Token: 回调加密key,已废弃
|
423
423
|
# @type Token: String
|
424
|
-
# @param CallbackKey: 回调加密key
|
424
|
+
# @param CallbackKey: 回调加密key,用于回调消息加解密。
|
425
425
|
# @type CallbackKey: String
|
426
|
-
# @param CallbackToken: 回调验签token
|
426
|
+
# @param CallbackToken: 回调验签token,用于回调通知校验。
|
427
427
|
# @type CallbackToken: String
|
428
428
|
|
429
429
|
attr_accessor :CallbackUrl, :Token, :CallbackKey, :CallbackToken
|
@@ -2460,50 +2460,56 @@ module TencentCloud
|
|
2460
2460
|
|
2461
2461
|
# CreateMultiFlowSignQRCode请求参数结构体
|
2462
2462
|
class CreateMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
|
2463
|
-
# @param Operator:
|
2463
|
+
# @param Operator: 执行本接口操作的员工信息。
|
2464
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2464
2465
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2465
|
-
# @param TemplateId:
|
2466
|
+
# @param TemplateId: 合同模板ID,为32位字符串。
|
2467
|
+
# 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
2466
2468
|
# @type TemplateId: String
|
2467
|
-
# @param FlowName:
|
2469
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
2470
|
+
# 该名称还将用于合同签署完成后的下载文件名。
|
2468
2471
|
# @type FlowName: String
|
2469
|
-
# @param MaxFlowNum:
|
2470
|
-
#
|
2472
|
+
# @param MaxFlowNum: 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
|
2473
|
+
# 一旦发起流程数超越该限制,该二维码将自动失效。
|
2471
2474
|
# @type MaxFlowNum: Integer
|
2472
|
-
# @param
|
2473
|
-
#
|
2474
|
-
# <br/>最高设置不超过30天
|
2475
|
-
# @type FlowEffectiveDay: Integer
|
2476
|
-
# @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
|
2475
|
+
# @param QrEffectiveDay: 二维码的有效期限,默认为7天,最高设定不得超过90天。
|
2476
|
+
# 一旦超过二维码的有效期限,该二维码将自动失效。
|
2477
2477
|
# @type QrEffectiveDay: Integer
|
2478
|
-
# @param
|
2479
|
-
#
|
2478
|
+
# @param FlowEffectiveDay: 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
|
2479
|
+
# 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
|
2480
|
+
# 最长设定期限不得超过30天。
|
2481
|
+
# @type FlowEffectiveDay: Integer
|
2482
|
+
# @param Restrictions: 指定签署人信息。
|
2483
|
+
# 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
|
2480
2484
|
# @type Restrictions: Array
|
2481
|
-
# @param UserData:
|
2482
|
-
#
|
2485
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
|
2486
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
2487
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
2483
2488
|
# @type UserData: String
|
2484
2489
|
# @param CallbackUrl: 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
|
2485
2490
|
# <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
|
2486
2491
|
# <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
|
2487
2492
|
# @type CallbackUrl: String
|
2488
|
-
# @param Agent:
|
2493
|
+
# @param Agent: 代理企业和员工的信息。
|
2494
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
2489
2495
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2490
2496
|
# @param ApproverRestrictions: 限制二维码用户条件(已弃用)
|
2491
2497
|
# @type ApproverRestrictions: :class:`Tencentcloud::Ess.v20201111.models.ApproverRestriction`
|
2492
2498
|
|
2493
|
-
attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :
|
2499
|
+
attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :QrEffectiveDay, :FlowEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
|
2494
2500
|
extend Gem::Deprecate
|
2495
2501
|
deprecate :CallbackUrl, :none, 2023, 9
|
2496
2502
|
deprecate :CallbackUrl=, :none, 2023, 9
|
2497
2503
|
deprecate :ApproverRestrictions, :none, 2023, 9
|
2498
2504
|
deprecate :ApproverRestrictions=, :none, 2023, 9
|
2499
2505
|
|
2500
|
-
def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil,
|
2506
|
+
def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil, qreffectiveday=nil, floweffectiveday=nil, restrictions=nil, userdata=nil, callbackurl=nil, agent=nil, approverrestrictions=nil)
|
2501
2507
|
@Operator = operator
|
2502
2508
|
@TemplateId = templateid
|
2503
2509
|
@FlowName = flowname
|
2504
2510
|
@MaxFlowNum = maxflownum
|
2505
|
-
@FlowEffectiveDay = floweffectiveday
|
2506
2511
|
@QrEffectiveDay = qreffectiveday
|
2512
|
+
@FlowEffectiveDay = floweffectiveday
|
2507
2513
|
@Restrictions = restrictions
|
2508
2514
|
@UserData = userdata
|
2509
2515
|
@CallbackUrl = callbackurl
|
@@ -2519,8 +2525,8 @@ module TencentCloud
|
|
2519
2525
|
@TemplateId = params['TemplateId']
|
2520
2526
|
@FlowName = params['FlowName']
|
2521
2527
|
@MaxFlowNum = params['MaxFlowNum']
|
2522
|
-
@FlowEffectiveDay = params['FlowEffectiveDay']
|
2523
2528
|
@QrEffectiveDay = params['QrEffectiveDay']
|
2529
|
+
@FlowEffectiveDay = params['FlowEffectiveDay']
|
2524
2530
|
unless params['Restrictions'].nil?
|
2525
2531
|
@Restrictions = []
|
2526
2532
|
params['Restrictions'].each do |i|
|
@@ -2544,9 +2550,9 @@ module TencentCloud
|
|
2544
2550
|
|
2545
2551
|
# CreateMultiFlowSignQRCode返回参数结构体
|
2546
2552
|
class CreateMultiFlowSignQRCodeResponse < TencentCloud::Common::AbstractModel
|
2547
|
-
# @param QrCode:
|
2553
|
+
# @param QrCode: 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
|
2548
2554
|
# @type QrCode: :class:`Tencentcloud::Ess.v20201111.models.SignQrCode`
|
2549
|
-
# @param SignUrls:
|
2555
|
+
# @param SignUrls: 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
|
2550
2556
|
# @type SignUrls: :class:`Tencentcloud::Ess.v20201111.models.SignUrl`
|
2551
2557
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
2552
2558
|
# @type RequestId: String
|
@@ -3053,43 +3059,48 @@ module TencentCloud
|
|
3053
3059
|
|
3054
3060
|
# CreateSchemeUrl请求参数结构体
|
3055
3061
|
class CreateSchemeUrlRequest < TencentCloud::Common::AbstractModel
|
3056
|
-
# @param Operator:
|
3062
|
+
# @param Operator: 执行本接口操作的员工信息, userId 必填。
|
3063
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3057
3064
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3058
|
-
# @param OrganizationName:
|
3065
|
+
# @param OrganizationName: 合同流程签署方的组织机构名称。
|
3066
|
+
# 如果名称中包含英文括号(),请使用中文括号()代替。
|
3059
3067
|
# @type OrganizationName: String
|
3060
|
-
# @param Name:
|
3068
|
+
# @param Name: 合同流程里边签署方经办人的姓名。
|
3061
3069
|
# @type Name: String
|
3062
|
-
# @param Mobile:
|
3070
|
+
# @param Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
3063
3071
|
# @type Mobile: String
|
3064
3072
|
# @param EndPoint: 要跳转的链接类型
|
3065
3073
|
|
3066
|
-
#
|
3067
|
-
#
|
3068
|
-
#
|
3074
|
+
# <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
|
3075
|
+
# <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
|
3076
|
+
# <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
|
3069
3077
|
# @type EndPoint: String
|
3070
|
-
# @param FlowId:
|
3078
|
+
# @param FlowId: 合同流程ID
|
3079
|
+
# 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
|
3071
3080
|
# @type FlowId: String
|
3072
|
-
# @param FlowGroupId:
|
3081
|
+
# @param FlowGroupId: 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
|
3073
3082
|
# @type FlowGroupId: String
|
3074
3083
|
# @param PathType: 要跳转到的页面类型
|
3075
3084
|
|
3076
|
-
#
|
3077
|
-
#
|
3078
|
-
#
|
3085
|
+
# <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
|
3086
|
+
# <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
|
3087
|
+
# <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
|
3079
3088
|
# @type PathType: Integer
|
3080
|
-
# @param AutoJumpBack:
|
3081
|
-
# true
|
3082
|
-
#
|
3083
|
-
# 该参数只针对"APP" 类型的签署链接有效
|
3089
|
+
# @param AutoJumpBack: 签署完成后是否自动回跳
|
3090
|
+
# <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
|
3091
|
+
# 注: ` 该参数只针对"APP" 类型的签署链接有效`
|
3084
3092
|
# @type AutoJumpBack: Boolean
|
3085
|
-
# @param Agent:
|
3093
|
+
# @param Agent: 代理企业和员工的信息。
|
3094
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3086
3095
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3087
|
-
# @param Hides:
|
3096
|
+
# @param Hides: 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
|
3097
|
+
|
3098
|
+
# <ul><li> **0** :合同签署页面更多操作按钮</li>
|
3099
|
+
# <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
|
3100
|
+
# <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
|
3101
|
+
# <li> **3** :签署成功页的查看详情按钮</li></ul>
|
3088
3102
|
|
3089
|
-
#
|
3090
|
-
# - 1:合同签署页面更多操作的拒绝签署按钮
|
3091
|
-
# - 2:合同签署页面更多操作的转他人处理按钮
|
3092
|
-
# - 3:签署成功页的查看详情按钮
|
3103
|
+
# 注: `字段为数组, 可以传值隐藏多个按钮`
|
3093
3104
|
# @type Hides: Array
|
3094
3105
|
|
3095
3106
|
attr_accessor :Operator, :OrganizationName, :Name, :Mobile, :EndPoint, :FlowId, :FlowGroupId, :PathType, :AutoJumpBack, :Agent, :Hides
|
@@ -3131,7 +3142,11 @@ module TencentCloud
|
|
3131
3142
|
|
3132
3143
|
# CreateSchemeUrl返回参数结构体
|
3133
3144
|
class CreateSchemeUrlResponse < TencentCloud::Common::AbstractModel
|
3134
|
-
# @param SchemeUrl:
|
3145
|
+
# @param SchemeUrl: 腾讯电子签小程序的签署链接。
|
3146
|
+
|
3147
|
+
# <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
|
3148
|
+
# <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
|
3149
|
+
# <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
|
3135
3150
|
# @type SchemeUrl: String
|
3136
3151
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3137
3152
|
# @type RequestId: String
|
@@ -3819,24 +3834,28 @@ module TencentCloud
|
|
3819
3834
|
|
3820
3835
|
# DescribeExtendedServiceAuthInfos请求参数结构体
|
3821
3836
|
class DescribeExtendedServiceAuthInfosRequest < TencentCloud::Common::AbstractModel
|
3822
|
-
# @param Operator:
|
3837
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3838
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3823
3839
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3824
|
-
# @param
|
3825
|
-
#
|
3826
|
-
#
|
3827
|
-
# OPEN_SERVER_SIGN
|
3828
|
-
# OVERSEA_SIGN
|
3829
|
-
# MOBILE_CHECK_APPROVER
|
3830
|
-
# PAGING_SEAL
|
3831
|
-
# BATCH_SIGN
|
3840
|
+
# @param ExtendServiceType: 要查询的扩展服务类型。
|
3841
|
+
# 默认为空,即查询当前支持的所有扩展服务信息。
|
3842
|
+
# 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
|
3843
|
+
# <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
|
3844
|
+
# <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
|
3845
|
+
# <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
|
3846
|
+
# <li>PAGING_SEAL:骑缝章</li>
|
3847
|
+
# <li>BATCH_SIGN:批量签署</li></ul>
|
3832
3848
|
# @type ExtendServiceType: String
|
3849
|
+
# @param Agent: 代理企业和员工的信息。
|
3850
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3851
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3833
3852
|
|
3834
|
-
attr_accessor :Operator, :
|
3853
|
+
attr_accessor :Operator, :ExtendServiceType, :Agent
|
3835
3854
|
|
3836
|
-
def initialize(operator=nil,
|
3855
|
+
def initialize(operator=nil, extendservicetype=nil, agent=nil)
|
3837
3856
|
@Operator = operator
|
3838
|
-
@Agent = agent
|
3839
3857
|
@ExtendServiceType = extendservicetype
|
3858
|
+
@Agent = agent
|
3840
3859
|
end
|
3841
3860
|
|
3842
3861
|
def deserialize(params)
|
@@ -3844,17 +3863,17 @@ module TencentCloud
|
|
3844
3863
|
@Operator = UserInfo.new
|
3845
3864
|
@Operator.deserialize(params['Operator'])
|
3846
3865
|
end
|
3866
|
+
@ExtendServiceType = params['ExtendServiceType']
|
3847
3867
|
unless params['Agent'].nil?
|
3848
3868
|
@Agent = Agent.new
|
3849
3869
|
@Agent.deserialize(params['Agent'])
|
3850
3870
|
end
|
3851
|
-
@ExtendServiceType = params['ExtendServiceType']
|
3852
3871
|
end
|
3853
3872
|
end
|
3854
3873
|
|
3855
3874
|
# DescribeExtendedServiceAuthInfos返回参数结构体
|
3856
3875
|
class DescribeExtendedServiceAuthInfosResponse < TencentCloud::Common::AbstractModel
|
3857
|
-
# @param AuthInfoList:
|
3876
|
+
# @param AuthInfoList: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
|
3858
3877
|
# @type AuthInfoList: Array
|
3859
3878
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3860
3879
|
# @type RequestId: String
|
@@ -5031,27 +5050,28 @@ module TencentCloud
|
|
5031
5050
|
end
|
5032
5051
|
end
|
5033
5052
|
|
5034
|
-
#
|
5053
|
+
# 扩展服务开通和授权的详细信息
|
5035
5054
|
class ExtendAuthInfo < TencentCloud::Common::AbstractModel
|
5036
|
-
# @param Type:
|
5037
|
-
# OPEN_SERVER_SIGN
|
5038
|
-
# OVERSEA_SIGN
|
5039
|
-
# MOBILE_CHECK_APPROVER
|
5040
|
-
# PAGING_SEAL
|
5041
|
-
# BATCH_SIGN
|
5055
|
+
# @param Type: 扩展服务的类型,可能是以下值:
|
5056
|
+
# <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
|
5057
|
+
# <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
|
5058
|
+
# <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
|
5059
|
+
# <li>PAGING_SEAL:骑缝章</li>
|
5060
|
+
# <li>BATCH_SIGN:批量签署</li></ul>
|
5042
5061
|
# @type Type: String
|
5043
|
-
# @param Name:
|
5062
|
+
# @param Name: 扩展服务的名称
|
5044
5063
|
# @type Name: String
|
5045
|
-
# @param Status:
|
5064
|
+
# @param Status: 扩展服务的开通状态:
|
5065
|
+
# ENABLE:开通
|
5046
5066
|
# DISABLE:未开通
|
5047
5067
|
# @type Status: String
|
5048
|
-
# @param OperatorUserId:
|
5068
|
+
# @param OperatorUserId: 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
5049
5069
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5050
5070
|
# @type OperatorUserId: String
|
5051
|
-
# @param OperateOn:
|
5071
|
+
# @param OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
|
5052
5072
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5053
5073
|
# @type OperateOn: Integer
|
5054
|
-
# @param HasAuthUserList:
|
5074
|
+
# @param HasAuthUserList: 该扩展服务若可以授权,此参数对应授权人员的列表
|
5055
5075
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5056
5076
|
# @type HasAuthUserList: Array
|
5057
5077
|
|
@@ -5388,10 +5408,13 @@ module TencentCloud
|
|
5388
5408
|
# @param OrganizationName: 签署方企业名称
|
5389
5409
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5390
5410
|
# @type OrganizationName: String
|
5411
|
+
# @param SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
|
5412
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
5413
|
+
# @type SignId: String
|
5391
5414
|
|
5392
|
-
attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName
|
5415
|
+
attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName, :SignId
|
5393
5416
|
|
5394
|
-
def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil)
|
5417
|
+
def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil, signid=nil)
|
5395
5418
|
@ApproveMessage = approvemessage
|
5396
5419
|
@ApproveName = approvename
|
5397
5420
|
@ApproveStatus = approvestatus
|
@@ -5405,6 +5428,7 @@ module TencentCloud
|
|
5405
5428
|
@CustomApproverTag = customapprovertag
|
5406
5429
|
@OrganizationId = organizationid
|
5407
5430
|
@OrganizationName = organizationname
|
5431
|
+
@SignId = signid
|
5408
5432
|
end
|
5409
5433
|
|
5410
5434
|
def deserialize(params)
|
@@ -5421,6 +5445,7 @@ module TencentCloud
|
|
5421
5445
|
@CustomApproverTag = params['CustomApproverTag']
|
5422
5446
|
@OrganizationId = params['OrganizationId']
|
5423
5447
|
@OrganizationName = params['OrganizationName']
|
5448
|
+
@SignId = params['SignId']
|
5424
5449
|
end
|
5425
5450
|
end
|
5426
5451
|
|
@@ -6259,14 +6284,14 @@ module TencentCloud
|
|
6259
6284
|
end
|
6260
6285
|
end
|
6261
6286
|
|
6262
|
-
#
|
6287
|
+
# 被授权的用户信息
|
6263
6288
|
class HasAuthUser < TencentCloud::Common::AbstractModel
|
6264
|
-
# @param UserId:
|
6289
|
+
# @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
6265
6290
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6266
6291
|
# @type UserId: String
|
6267
|
-
# @param BelongTo:
|
6268
|
-
# MainOrg
|
6269
|
-
# CurrentOrg
|
6292
|
+
# @param BelongTo: 当前员工的归属情况,可能值是:
|
6293
|
+
# MainOrg:在集团企业的场景下,返回此值代表是归属主企业
|
6294
|
+
# CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
|
6270
6295
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6271
6296
|
# @type BelongTo: String
|
6272
6297
|
|
@@ -6398,13 +6423,17 @@ module TencentCloud
|
|
6398
6423
|
|
6399
6424
|
# ModifyApplicationCallbackInfo请求参数结构体
|
6400
6425
|
class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
|
6401
|
-
# @param Operator:
|
6426
|
+
# @param Operator: 执行本接口操作的员工信息。
|
6427
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
6402
6428
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
6403
|
-
# @param OperateType: 操作类型:
|
6429
|
+
# @param OperateType: 操作类型:
|
6430
|
+
# 1-新增
|
6431
|
+
# 2-删除
|
6404
6432
|
# @type OperateType: Integer
|
6405
|
-
# @param CallbackInfo:
|
6433
|
+
# @param CallbackInfo: 企业应用回调信息
|
6406
6434
|
# @type CallbackInfo: :class:`Tencentcloud::Ess.v20201111.models.CallbackInfo`
|
6407
|
-
# @param Agent:
|
6435
|
+
# @param Agent: 代理企业和员工的信息。
|
6436
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
6408
6437
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
6409
6438
|
|
6410
6439
|
attr_accessor :Operator, :OperateType, :CallbackInfo, :Agent
|
@@ -7168,13 +7197,14 @@ module TencentCloud
|
|
7168
7197
|
end
|
7169
7198
|
end
|
7170
7199
|
|
7171
|
-
#
|
7200
|
+
# 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
|
7172
7201
|
class SignQrCode < TencentCloud::Common::AbstractModel
|
7173
|
-
# @param QrCodeId: 二维码
|
7202
|
+
# @param QrCodeId: 二维码ID,为32位字符串。
|
7174
7203
|
# @type QrCodeId: String
|
7175
|
-
# @param QrCodeUrl: 二维码
|
7204
|
+
# @param QrCodeUrl: 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
|
7176
7205
|
# @type QrCodeUrl: String
|
7177
|
-
# @param ExpiredTime:
|
7206
|
+
# @param ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒)。
|
7207
|
+
# 一旦超过二维码的有效期限,该二维码将自动失效。
|
7178
7208
|
# @type ExpiredTime: Integer
|
7179
7209
|
|
7180
7210
|
attr_accessor :QrCodeId, :QrCodeUrl, :ExpiredTime
|
@@ -7192,13 +7222,16 @@ module TencentCloud
|
|
7192
7222
|
end
|
7193
7223
|
end
|
7194
7224
|
|
7195
|
-
#
|
7225
|
+
# 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
|
7226
|
+
# 通过链接,用户可直接访问电子签名小程序并签署合同。
|
7196
7227
|
class SignUrl < TencentCloud::Common::AbstractModel
|
7197
|
-
# @param AppSignUrl:
|
7228
|
+
# @param AppSignUrl: 跳转至电子签名小程序签署的链接地址。
|
7229
|
+
# 适用于客户端APP及小程序直接唤起电子签名小程序。
|
7198
7230
|
# @type AppSignUrl: String
|
7199
|
-
# @param EffectiveTime:
|
7231
|
+
# @param EffectiveTime: 签署链接有效时间,格式类似"2022-08-05 15:55:01"
|
7200
7232
|
# @type EffectiveTime: String
|
7201
|
-
# @param HttpSignUrl:
|
7233
|
+
# @param HttpSignUrl: 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
|
7234
|
+
# 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
|
7202
7235
|
# @type HttpSignUrl: String
|
7203
7236
|
|
7204
7237
|
attr_accessor :AppSignUrl, :EffectiveTime, :HttpSignUrl
|
@@ -7334,22 +7367,26 @@ module TencentCloud
|
|
7334
7367
|
|
7335
7368
|
# StartFlow请求参数结构体
|
7336
7369
|
class StartFlowRequest < TencentCloud::Common::AbstractModel
|
7337
|
-
# @param Operator:
|
7370
|
+
# @param Operator: 执行本接口操作的员工信息。
|
7371
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
7338
7372
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
7339
|
-
# @param FlowId:
|
7373
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
7374
|
+
# 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
|
7340
7375
|
# @type FlowId: String
|
7341
7376
|
# @param ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
|
7342
7377
|
# @type ClientToken: String
|
7343
|
-
# @param Agent:
|
7378
|
+
# @param Agent: 代理企业和员工的信息。
|
7379
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
7344
7380
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
7345
|
-
# @param CcNotifyType:
|
7346
|
-
|
7347
|
-
#
|
7348
|
-
|
7349
|
-
# 1-签署完成后通知
|
7381
|
+
# @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
|
7382
|
+
# 0 - 合同发起时通知(默认)
|
7383
|
+
# 1 - 签署完成后通知
|
7350
7384
|
# @type CcNotifyType: Integer
|
7351
7385
|
|
7352
7386
|
attr_accessor :Operator, :FlowId, :ClientToken, :Agent, :CcNotifyType
|
7387
|
+
extend Gem::Deprecate
|
7388
|
+
deprecate :ClientToken, :none, 2023, 9
|
7389
|
+
deprecate :ClientToken=, :none, 2023, 9
|
7353
7390
|
|
7354
7391
|
def initialize(operator=nil, flowid=nil, clienttoken=nil, agent=nil, ccnotifytype=nil)
|
7355
7392
|
@Operator = operator
|
@@ -7376,13 +7413,10 @@ module TencentCloud
|
|
7376
7413
|
|
7377
7414
|
# StartFlow返回参数结构体
|
7378
7415
|
class StartFlowResponse < TencentCloud::Common::AbstractModel
|
7379
|
-
# @param Status:
|
7380
|
-
|
7381
|
-
#
|
7382
|
-
|
7383
|
-
# REVIEW-提交审核成功,
|
7384
|
-
|
7385
|
-
# EXECUTING-已提交发起任务
|
7416
|
+
# @param Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
|
7417
|
+
# START - 发起成功
|
7418
|
+
# REVIEW - 提交审核成功
|
7419
|
+
# EXECUTING - 已提交发起任务
|
7386
7420
|
# @type Status: String
|
7387
7421
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
7388
7422
|
# @type RequestId: String
|
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.
|
4
|
+
version: 3.0.653
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-09-
|
11
|
+
date: 2023-09-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|