tencentcloud-sdk-essbasic 3.0.736 → 3.0.738
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/v20210526/client.rb +20 -21
- data/lib/v20210526/models.rb +42 -23
- 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: 7adc98cd882e4ab742eea1fcd4ed585675a1dbc4
|
4
|
+
data.tar.gz: b2208f4936fee98d094dfa2cdd3d29dfc7777c48
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dd6cfabe73e537620621eb0707ef1b746c36dc4f744a022690b9401f02273b90b0a943f695a8162fdd135bbfc093f18721399994d9958b55613b01420bc88238
|
7
|
+
data.tar.gz: 712a9b65006d35b1a10b832210251ba775a4902a43ce85bdeb6c073272c0d434c4513cdb855eb3758559fca62fcc082178b52ed8302caa59b9502fd8771cc4cd
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.738
|
data/lib/v20210526/client.rb
CHANGED
@@ -1843,8 +1843,8 @@ module TencentCloud
|
|
1843
1843
|
# | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
|
1844
1844
|
# | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
|
1845
1845
|
# | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
|
1846
|
-
# |APP|
|
1847
|
-
# |APP|
|
1846
|
+
# |APP| <font color="red">贵方APP</font>跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
|
1847
|
+
# |APP| <font color="red">贵方小程序</font>跳转腾讯电子签小程序签署场景| 贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
|
1848
1848
|
|
1849
1849
|
# @param request: Request instance for CreateSignUrls.
|
1850
1850
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSignUrlsRequest`
|
@@ -2036,14 +2036,20 @@ module TencentCloud
|
|
2036
2036
|
end
|
2037
2037
|
|
2038
2038
|
# 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
2039
|
-
# 1. 企业自动签
|
2040
|
-
# 2. 企业与港澳台居民签署合同
|
2041
|
-
# 3. 使用手机号验证签署方身份
|
2042
|
-
# 4. 骑缝章
|
2043
|
-
# 5. 拓宽签署方年龄限制
|
2044
|
-
# 6. 下载企业合同/文件
|
2045
2039
|
|
2046
|
-
#
|
2040
|
+
# 1. **企业自动签**
|
2041
|
+
# 2. **企业与港澳台居民签署合同**
|
2042
|
+
# 3. **使用手机号验证签署方身份**
|
2043
|
+
# 4. **骑缝章**
|
2044
|
+
# 5. **拓宽签署方年龄限制**
|
2045
|
+
# 6. **下载企业合同/文件**
|
2046
|
+
# 7. **隐藏合同经办人姓名**
|
2047
|
+
|
2048
|
+
# 对应能力开通页面在子客控制台-企业中心-拓展服务,如下图所示:
|
2049
|
+
|
2050
|
+
# ![image](https://qcloudimg.tencent-cloud.cn/raw/931a1e02955ab36e5cc69a489af10352.jpg)
|
2051
|
+
|
2052
|
+
# 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
|
2047
2053
|
|
2048
2054
|
# @param request: Request instance for DescribeExtendedServiceAuthInfo.
|
2049
2055
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeExtendedServiceAuthInfoRequest`
|
@@ -2239,28 +2245,21 @@ module TencentCloud
|
|
2239
2245
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
2240
2246
|
end
|
2241
2247
|
|
2242
|
-
#
|
2248
|
+
# 管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
|
2243
2249
|
|
2244
2250
|
# 跳转小程序的几种方式:主要是设置不同的EndPoint
|
2245
2251
|
# 1. 通过链接Url直接跳转到小程序,不需要返回
|
2246
2252
|
# 设置EndPoint为WEIXINAPP,得到链接打开即可。
|
2247
2253
|
|
2248
2254
|
# 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
|
2249
|
-
#
|
2250
|
-
# https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
|
2251
|
-
# 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
2255
|
+
# 跳转到小程序的实现,参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
|
2252
2256
|
# 设置EndPoint为APP,得到path。
|
2253
2257
|
|
2254
|
-
#
|
2255
|
-
#
|
2256
|
-
# 全屏方式:
|
2257
|
-
# (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
2258
|
-
# 半屏方式:
|
2259
|
-
# (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
2260
|
-
# 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
2258
|
+
# 3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
|
2259
|
+
# 跳转到小程序的实现,参考官方文档(分为<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>
|
2261
2260
|
# 设置EndPoint为APP,得到path。
|
2262
2261
|
|
2263
|
-
#
|
2262
|
+
# 4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
2264
2263
|
|
2265
2264
|
# | 小程序 | AppID | 原始ID |
|
2266
2265
|
# | ------------ | ------------ | ------------ |
|
data/lib/v20210526/models.rb
CHANGED
@@ -964,6 +964,8 @@ module TencentCloud
|
|
964
964
|
# ChannelCreateBatchCancelFlowUrl返回参数结构体
|
965
965
|
class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
|
966
966
|
# @param BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
|
967
|
+
|
968
|
+
# 注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
967
969
|
# @type BatchCancelFlowUrl: String
|
968
970
|
# @param FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
|
969
971
|
# @type FailMessages: Array
|
@@ -1184,13 +1186,17 @@ module TencentCloud
|
|
1184
1186
|
class ChannelCreateBatchSignUrlResponse < TencentCloud::Common::AbstractModel
|
1185
1187
|
# @param SignUrl: 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
|
1186
1188
|
|
1187
|
-
# 注:
|
1189
|
+
# 注:
|
1190
|
+
# 1. 非小程序和APP集成使用
|
1191
|
+
# 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
1188
1192
|
# @type SignUrl: String
|
1189
1193
|
# @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
|
1190
1194
|
# @type ExpiredTime: Integer
|
1191
1195
|
# @param MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
|
1192
1196
|
|
1193
|
-
# 注:
|
1197
|
+
# 注:
|
1198
|
+
# 1. 小程序和APP集成使用
|
1199
|
+
# 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
1194
1200
|
# @type MiniAppPath: String
|
1195
1201
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1196
1202
|
# @type RequestId: String
|
@@ -5109,10 +5115,10 @@ module TencentCloud
|
|
5109
5115
|
# 注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
|
5110
5116
|
# @type MenuStatus: String
|
5111
5117
|
# @param Endpoint: 生成链接的类型:
|
5112
|
-
# <ul><li>**PC**:(默认)web
|
5118
|
+
# <ul><li>**PC**:(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
|
5113
5119
|
# <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
5114
|
-
# <li>**SHORT_URL
|
5115
|
-
# <li>**APP
|
5120
|
+
# <li>**SHORT_URL**:<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
5121
|
+
# <li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
|
5116
5122
|
# @type Endpoint: String
|
5117
5123
|
# @param AutoJumpBackEvent: 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
|
5118
5124
|
# <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
|
@@ -5174,9 +5180,11 @@ module TencentCloud
|
|
5174
5180
|
class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
|
5175
5181
|
# @param ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
|
5176
5182
|
# <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>
|
5183
|
+
|
5177
5184
|
# 注:
|
5178
|
-
#
|
5179
|
-
#
|
5185
|
+
# 1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
|
5186
|
+
# 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
|
5187
|
+
# 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
5180
5188
|
# @type ConsoleUrl: String
|
5181
5189
|
# @param IsActivated: 子客企业是否已开通腾讯电子签,
|
5182
5190
|
# <ul><li> **true** :已经开通腾讯电子签</li>
|
@@ -6279,10 +6287,11 @@ module TencentCloud
|
|
6279
6287
|
|
6280
6288
|
# 此接口下面信息必填。
|
6281
6289
|
# <ul>
|
6282
|
-
# <li>渠道应用标识: Agent.
|
6283
|
-
# <li>第三方平台子客企业标识: Agent.
|
6284
|
-
# <li>第三方平台子客企业中的员工标识: Agent.
|
6290
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
6291
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
6292
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
6285
6293
|
# </ul>
|
6294
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
6286
6295
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
6287
6296
|
|
6288
6297
|
attr_accessor :Agent
|
@@ -6762,11 +6771,12 @@ module TencentCloud
|
|
6762
6771
|
# @param Type: 扩展服务类型
|
6763
6772
|
# <ul>
|
6764
6773
|
# <li>AUTO_SIGN 企业自动签(自动签署)</li>
|
6765
|
-
# <li> OVERSEA_SIGN
|
6774
|
+
# <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
|
6766
6775
|
# <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
|
6767
6776
|
# <li> PAGING_SEAL 骑缝章</li>
|
6768
6777
|
# <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
|
6769
6778
|
# <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
|
6779
|
+
# <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
|
6770
6780
|
# </ul>
|
6771
6781
|
# @type Type: String
|
6772
6782
|
# @param Name: 扩展服务名称
|
@@ -7325,10 +7335,12 @@ module TencentCloud
|
|
7325
7335
|
|
7326
7336
|
# 签署人签署链接信息。
|
7327
7337
|
class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
|
7328
|
-
# @param SignUrl:
|
7338
|
+
# @param SignUrl: 签署短链接。
|
7339
|
+
|
7329
7340
|
# 注意:
|
7330
|
-
#
|
7331
|
-
#
|
7341
|
+
# 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
7342
|
+
# 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
7343
|
+
# 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
7332
7344
|
# @type SignUrl: String
|
7333
7345
|
# @param ApproverType: 签署人类型。
|
7334
7346
|
# - **PERSON**: 个人
|
@@ -7337,10 +7349,12 @@ module TencentCloud
|
|
7337
7349
|
# @type Name: String
|
7338
7350
|
# @param Mobile: 签署人手机号。
|
7339
7351
|
# @type Mobile: String
|
7340
|
-
# @param LongUrl:
|
7352
|
+
# @param LongUrl: 签署长链接。
|
7353
|
+
|
7341
7354
|
# 注意:
|
7342
|
-
#
|
7343
|
-
#
|
7355
|
+
# 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
7356
|
+
# 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
7357
|
+
# 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
7344
7358
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7345
7359
|
# @type LongUrl: String
|
7346
7360
|
|
@@ -8111,16 +8125,19 @@ module TencentCloud
|
|
8111
8125
|
# @param ServiceType: 扩展服务类型
|
8112
8126
|
# <ul>
|
8113
8127
|
# <li>AUTO_SIGN 企业自动签(自动签署)</li>
|
8114
|
-
# <li> OVERSEA_SIGN
|
8128
|
+
# <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
|
8115
8129
|
# <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
|
8116
8130
|
# <li> PAGING_SEAL 骑缝章</li>
|
8117
8131
|
# <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
|
8118
8132
|
# <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
|
8133
|
+
# <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
|
8119
8134
|
# </ul>
|
8120
8135
|
# @type ServiceType: String
|
8121
8136
|
# @param Operate: 操作类型
|
8122
|
-
#
|
8123
|
-
#
|
8137
|
+
# <ul>
|
8138
|
+
# <li>OPEN : 开通</li>
|
8139
|
+
# <li>CLOSE : 关闭</li>
|
8140
|
+
# </ul>
|
8124
8141
|
# @type Operate: String
|
8125
8142
|
# @param Endpoint: 链接跳转类型,支持以下类型
|
8126
8143
|
# <ul>
|
@@ -8154,8 +8171,8 @@ module TencentCloud
|
|
8154
8171
|
# @param OperateUrl: 操作跳转链接,有效期24小时
|
8155
8172
|
# 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
|
8156
8173
|
|
8157
|
-
# 当操作类型是 OPEN 且 扩展服务类型是
|
8158
|
-
#
|
8174
|
+
# 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
|
8175
|
+
# 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作
|
8159
8176
|
# @type OperateUrl: String
|
8160
8177
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
8161
8178
|
# @type RequestId: String
|
@@ -9183,6 +9200,8 @@ module TencentCloud
|
|
9183
9200
|
# 签署链接内容
|
9184
9201
|
class SignUrlInfo < TencentCloud::Common::AbstractModel
|
9185
9202
|
# @param SignUrl: 签署链接,过期时间为90天
|
9203
|
+
|
9204
|
+
# 注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
9186
9205
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
9187
9206
|
# @type SignUrl: String
|
9188
9207
|
# @param Deadline: 合同过期时间戳,单位秒
|
@@ -9597,7 +9616,7 @@ module TencentCloud
|
|
9597
9616
|
# @type Components: Array
|
9598
9617
|
# @param Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
|
9599
9618
|
# @type Recipients: Array
|
9600
|
-
# @param SignComponents:
|
9619
|
+
# @param SignComponents: 此模板中的签署控件列表
|
9601
9620
|
# @type SignComponents: Array
|
9602
9621
|
# @param TemplateType: 模板类型:1-静默签;3-普通模板
|
9603
9622
|
# @type TemplateType: Integer
|
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.
|
4
|
+
version: 3.0.738
|
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-12-
|
11
|
+
date: 2023-12-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|