tencentcloud-sdk-essbasic 3.0.690 → 3.0.692
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/tencentcloud-sdk-essbasic.rb +3 -3
- data/lib/v20210526/client.rb +102 -42
- data/lib/v20210526/models.rb +368 -123
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b050ac52b1afe4fa59435fc53f5a7e99d2f32b99
|
|
4
|
+
data.tar.gz: c1ab636d1d630d2c343cff9df501e6ea3fea9f65
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9955fddbfca773f02cd38d98701d7f5c2d842368e9db7017d5b343a644144cca6023576eb3306fafcb631eb04b30aa812cab076bdcc6e1270b2fbd25f3e6c783
|
|
7
|
+
data.tar.gz: 1444f8779bf83ee44ed1550703cc87a93b7f446f5a723926f3d6b68f68a9f124684696c933034122bcc6ac14a2febb45b7389c0a711283fd48566c28e1ae1514
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.692
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
require 'tencentcloud-sdk-common'
|
|
4
4
|
|
|
5
|
-
require_relative 'v20210526/client'
|
|
6
|
-
require_relative 'v20210526/models'
|
|
7
|
-
|
|
8
5
|
require_relative 'v20201222/client'
|
|
9
6
|
require_relative 'v20201222/models'
|
|
10
7
|
|
|
8
|
+
require_relative 'v20210526/client'
|
|
9
|
+
require_relative 'v20210526/models'
|
|
10
|
+
|
|
11
11
|
module TencentCloud
|
|
12
12
|
module Essbasic
|
|
13
13
|
end
|
data/lib/v20210526/client.rb
CHANGED
|
@@ -29,22 +29,16 @@ module TencentCloud
|
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
#
|
|
33
|
-
|
|
34
|
-
#
|
|
35
|
-
|
|
36
|
-
# -
|
|
37
|
-
# -
|
|
38
|
-
|
|
39
|
-
# - 已撤回
|
|
40
|
-
# - 拒绝填写
|
|
41
|
-
# - 已解除
|
|
42
|
-
|
|
43
|
-
# <br/>
|
|
44
|
-
# 满足撤销条件的合同会发起异步撤销流程，而不满足撤销条件的合同将返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
|
|
45
|
-
# <br/><br/>
|
|
32
|
+
# 通过合同编号批量撤销合同，单次最多支持撤销100份合同。
|
|
33
|
+
|
|
34
|
+
# 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
|
|
35
|
+
|
|
36
|
+
# - **可撤回合同状态**：未全部签署完成
|
|
37
|
+
# - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
38
|
+
|
|
46
39
|
# 注:
|
|
47
|
-
#
|
|
40
|
+
# - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
|
41
|
+
# - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
48
42
|
|
|
49
43
|
# @param request: Request instance for ChannelBatchCancelFlows.
|
|
50
44
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
|
|
@@ -71,11 +65,13 @@ module TencentCloud
|
|
|
71
65
|
# 撤销签署流程接口
|
|
72
66
|
|
|
73
67
|
# 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
|
|
74
|
-
|
|
75
|
-
#
|
|
68
|
+
|
|
69
|
+
# - **可撤回合同状态**：未全部签署完成
|
|
70
|
+
# - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
71
|
+
|
|
76
72
|
# 注:
|
|
77
|
-
# <
|
|
78
|
-
#
|
|
73
|
+
# - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
|
74
|
+
# - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
79
75
|
|
|
80
76
|
# @param request: Request instance for ChannelCancelFlow.
|
|
81
77
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelFlowRequest`
|
|
@@ -149,15 +145,15 @@ module TencentCloud
|
|
|
149
145
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
150
146
|
end
|
|
151
147
|
|
|
152
|
-
#
|
|
153
|
-
# 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
|
|
154
|
-
# 接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
|
|
148
|
+
# 通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
|
|
155
149
|
|
|
156
|
-
#
|
|
157
|
-
# 不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
150
|
+
# 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
|
|
158
151
|
|
|
159
|
-
#
|
|
160
|
-
#
|
|
152
|
+
# - **可撤回合同状态**：未全部签署完成
|
|
153
|
+
# - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
154
|
+
|
|
155
|
+
# 注:
|
|
156
|
+
# - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
161
157
|
|
|
162
158
|
# @param request: Request instance for ChannelCreateBatchCancelFlowUrl.
|
|
163
159
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchCancelFlowUrlRequest`
|
|
@@ -181,6 +177,37 @@ module TencentCloud
|
|
|
181
177
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
182
178
|
end
|
|
183
179
|
|
|
180
|
+
# 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
|
|
181
|
+
# `注意：`<br/>
|
|
182
|
+
# `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
|
|
183
|
+
# `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
|
|
184
|
+
# `3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。` <br/>
|
|
185
|
+
# `4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。` <br/>
|
|
186
|
+
# `5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`<br/>
|
|
187
|
+
# 跳转到小程序的实现，参考微信官方文档(分为<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>
|
|
188
|
+
|
|
189
|
+
# @param request: Request instance for ChannelCreateBatchQuickSignUrl.
|
|
190
|
+
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlRequest`
|
|
191
|
+
# @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlResponse`
|
|
192
|
+
def ChannelCreateBatchQuickSignUrl(request)
|
|
193
|
+
body = send_request('ChannelCreateBatchQuickSignUrl', request.serialize)
|
|
194
|
+
response = JSON.parse(body)
|
|
195
|
+
if response['Response'].key?('Error') == false
|
|
196
|
+
model = ChannelCreateBatchQuickSignUrlResponse.new
|
|
197
|
+
model.deserialize(response['Response'])
|
|
198
|
+
model
|
|
199
|
+
else
|
|
200
|
+
code = response['Response']['Error']['Code']
|
|
201
|
+
message = response['Response']['Error']['Message']
|
|
202
|
+
reqid = response['Response']['RequestId']
|
|
203
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
|
204
|
+
end
|
|
205
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
|
206
|
+
raise e
|
|
207
|
+
rescue StandardError => e
|
|
208
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
209
|
+
end
|
|
210
|
+
|
|
184
211
|
# 通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。
|
|
185
212
|
# 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
|
|
186
213
|
|
|
@@ -235,7 +262,14 @@ module TencentCloud
|
|
|
235
262
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
236
263
|
end
|
|
237
264
|
|
|
238
|
-
#
|
|
265
|
+
# 此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
|
|
266
|
+
# 前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
|
|
267
|
+
# 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
|
|
268
|
+
# 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
|
|
269
|
+
# 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
270
|
+
# 注:
|
|
271
|
+
# 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
272
|
+
# 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
239
273
|
|
|
240
274
|
# @param request: Request instance for ChannelCreateConvertTaskApi.
|
|
241
275
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateConvertTaskApiRequest`
|
|
@@ -790,8 +824,16 @@ module TencentCloud
|
|
|
790
824
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
791
825
|
end
|
|
792
826
|
|
|
793
|
-
#
|
|
794
|
-
#
|
|
827
|
+
# 发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
|
|
828
|
+
# 解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。
|
|
829
|
+
|
|
830
|
+
# 注意：
|
|
831
|
+
# <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
832
|
+
# <li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>
|
|
833
|
+
# <li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>
|
|
834
|
+
# <li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
|
|
835
|
+
# <li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>
|
|
836
|
+
# <li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>
|
|
795
837
|
|
|
796
838
|
# @param request: Request instance for ChannelCreateReleaseFlow.
|
|
797
839
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateReleaseFlowRequest`
|
|
@@ -867,7 +909,9 @@ module TencentCloud
|
|
|
867
909
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
868
910
|
end
|
|
869
911
|
|
|
870
|
-
#
|
|
912
|
+
# 获取个人用户自动签的开通链接。
|
|
913
|
+
|
|
914
|
+
# 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
871
915
|
|
|
872
916
|
# @param request: Request instance for ChannelCreateUserAutoSignEnableUrl.
|
|
873
917
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserAutoSignEnableUrlRequest`
|
|
@@ -1199,8 +1243,12 @@ module TencentCloud
|
|
|
1199
1243
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1200
1244
|
end
|
|
1201
1245
|
|
|
1202
|
-
#
|
|
1203
|
-
#
|
|
1246
|
+
# 此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
1247
|
+
# 前提条件：已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
|
|
1248
|
+
|
|
1249
|
+
# 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。<br />
|
|
1250
|
+
# 注：
|
|
1251
|
+
# 1. `大文件转换所需的时间可能会比较长`
|
|
1204
1252
|
|
|
1205
1253
|
# @param request: Request instance for ChannelGetTaskResultApi.
|
|
1206
1254
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelGetTaskResultApiRequest`
|
|
@@ -1708,15 +1756,27 @@ module TencentCloud
|
|
|
1708
1756
|
|
|
1709
1757
|
# 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
|
|
1710
1758
|
|
|
1711
|
-
#
|
|
1712
|
-
|
|
1713
|
-
#
|
|
1714
|
-
#
|
|
1715
|
-
#
|
|
1716
|
-
#
|
|
1717
|
-
|
|
1718
|
-
#
|
|
1719
|
-
#
|
|
1759
|
+
# **一个模板通常会包含以下结构信息**
|
|
1760
|
+
|
|
1761
|
+
# - 模板模版ID, 模板名字等基本信息
|
|
1762
|
+
# - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
|
|
1763
|
+
# - 发起方和签署方的填写控件 Components
|
|
1764
|
+
# - 签署方的签署控件 SignComponents
|
|
1765
|
+
|
|
1766
|
+
# **适用场景**
|
|
1767
|
+
# 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口，作为创建合同的前置接口使用。
|
|
1768
|
+
# 通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
|
|
1769
|
+
|
|
1770
|
+
# **模版的来源**
|
|
1771
|
+
# 子客企业的模板有两种途径获取
|
|
1772
|
+
# - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
|
|
1773
|
+
# - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
# **注意**
|
|
1777
|
+
|
|
1778
|
+
# >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
|
|
1779
|
+
# >2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
|
|
1720
1780
|
|
|
1721
1781
|
# @param request: Request instance for DescribeTemplates.
|
|
1722
1782
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeTemplatesRequest`
|
|
@@ -1888,7 +1948,7 @@ module TencentCloud
|
|
|
1888
1948
|
|
|
1889
1949
|
# 该接口 (PrepareFlows) 用于创建待发起文件
|
|
1890
1950
|
# 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
|
|
1891
|
-
# 目前该接口只支持B2C
|
|
1951
|
+
# 目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
|
|
1892
1952
|
|
|
1893
1953
|
# @param request: Request instance for PrepareFlows.
|
|
1894
1954
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::PrepareFlowsRequest`
|
data/lib/v20210526/models.rb
CHANGED
|
@@ -116,6 +116,8 @@ module TencentCloud
|
|
|
116
116
|
|
|
117
117
|
# 签署人个性化能力信息
|
|
118
118
|
class ApproverOption < TencentCloud::Common::AbstractModel
|
|
119
|
+
# @param NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
|
|
120
|
+
# @type NoRefuse: Boolean
|
|
119
121
|
# @param HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏
|
|
120
122
|
# @type HideOneKeySign: Boolean
|
|
121
123
|
# @param FillType: 签署人信息补充类型，默认无需补充。
|
|
@@ -133,15 +135,17 @@ module TencentCloud
|
|
|
133
135
|
# </ul>
|
|
134
136
|
# @type FlowReadLimit: String
|
|
135
137
|
|
|
136
|
-
attr_accessor :HideOneKeySign, :FillType, :FlowReadLimit
|
|
138
|
+
attr_accessor :NoRefuse, :HideOneKeySign, :FillType, :FlowReadLimit
|
|
137
139
|
|
|
138
|
-
def initialize(hideonekeysign=nil, filltype=nil, flowreadlimit=nil)
|
|
140
|
+
def initialize(norefuse=nil, hideonekeysign=nil, filltype=nil, flowreadlimit=nil)
|
|
141
|
+
@NoRefuse = norefuse
|
|
139
142
|
@HideOneKeySign = hideonekeysign
|
|
140
143
|
@FillType = filltype
|
|
141
144
|
@FlowReadLimit = flowreadlimit
|
|
142
145
|
end
|
|
143
146
|
|
|
144
147
|
def deserialize(params)
|
|
148
|
+
@NoRefuse = params['NoRefuse']
|
|
145
149
|
@HideOneKeySign = params['HideOneKeySign']
|
|
146
150
|
@FillType = params['FillType']
|
|
147
151
|
@FlowReadLimit = params['FlowReadLimit']
|
|
@@ -394,25 +398,33 @@ module TencentCloud
|
|
|
394
398
|
|
|
395
399
|
# ChannelBatchCancelFlows请求参数结构体
|
|
396
400
|
class ChannelBatchCancelFlowsRequest < TencentCloud::Common::AbstractModel
|
|
397
|
-
# @param Agent:
|
|
401
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
402
|
+
|
|
403
|
+
# 此接口下面信息必填。
|
|
404
|
+
# <ul>
|
|
405
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
406
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
407
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
408
|
+
# </ul>
|
|
409
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
398
410
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
399
|
-
# @param FlowIds:
|
|
411
|
+
# @param FlowIds: 要撤销的合同流程ID列表，最多100个，超过100不处理
|
|
400
412
|
# @type FlowIds: Array
|
|
401
|
-
# @param CancelMessage:
|
|
413
|
+
# @param CancelMessage: 撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
|
|
414
|
+
|
|
415
|
+
# 备注:`如果不传递撤回原因，那么默认撤回原因是 "自动撤销（通过接口实现）"`
|
|
402
416
|
# @type CancelMessage: String
|
|
403
|
-
# @param CancelMessageFormat:
|
|
404
|
-
|
|
405
|
-
#
|
|
406
|
-
#
|
|
407
|
-
#
|
|
408
|
-
#
|
|
409
|
-
|
|
410
|
-
#
|
|
411
|
-
|
|
412
|
-
#
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
# 备注:`如果不传递撤销理由，那么默认撤销理由是 "自动撤销（通过接口实现）"`
|
|
417
|
+
# @param CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式：
|
|
418
|
+
|
|
419
|
+
# **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
420
|
+
# **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
421
|
+
# **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
422
|
+
# **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
423
|
+
|
|
424
|
+
# 注: `CancelMessage为撤销当前合同的理由`
|
|
425
|
+
|
|
426
|
+
# 
|
|
427
|
+
|
|
416
428
|
# @type CancelMessageFormat: Integer
|
|
417
429
|
# @param Operator: 暂未开放
|
|
418
430
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -447,7 +459,7 @@ module TencentCloud
|
|
|
447
459
|
|
|
448
460
|
# ChannelBatchCancelFlows返回参数结构体
|
|
449
461
|
class ChannelBatchCancelFlowsResponse < TencentCloud::Common::AbstractModel
|
|
450
|
-
# @param FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id
|
|
462
|
+
# @param FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
|
|
451
463
|
# @type FailMessages: Array
|
|
452
464
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
453
465
|
# @type RequestId: String
|
|
@@ -650,9 +662,17 @@ module TencentCloud
|
|
|
650
662
|
|
|
651
663
|
# ChannelCreateBatchCancelFlowUrl请求参数结构体
|
|
652
664
|
class ChannelCreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
|
|
653
|
-
# @param Agent:
|
|
665
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
666
|
+
|
|
667
|
+
# 此接口下面信息必填。
|
|
668
|
+
# <ul>
|
|
669
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
670
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
671
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
672
|
+
# </ul>
|
|
673
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
654
674
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
655
|
-
# @param FlowIds:
|
|
675
|
+
# @param FlowIds: 要撤销的合同流程ID列表，最多100个，超过100不处理
|
|
656
676
|
# @type FlowIds: Array
|
|
657
677
|
# @param Operator: 暂未开放
|
|
658
678
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -683,11 +703,12 @@ module TencentCloud
|
|
|
683
703
|
|
|
684
704
|
# ChannelCreateBatchCancelFlowUrl返回参数结构体
|
|
685
705
|
class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
|
|
686
|
-
# @param BatchCancelFlowUrl:
|
|
706
|
+
# @param BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
|
|
687
707
|
# @type BatchCancelFlowUrl: String
|
|
688
|
-
# @param FailMessages:
|
|
708
|
+
# @param FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
|
|
689
709
|
# @type FailMessages: Array
|
|
690
|
-
# @param UrlExpireOn:
|
|
710
|
+
# @param UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
|
|
711
|
+
|
|
691
712
|
# @type UrlExpireOn: String
|
|
692
713
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
693
714
|
# @type RequestId: String
|
|
@@ -709,6 +730,86 @@ module TencentCloud
|
|
|
709
730
|
end
|
|
710
731
|
end
|
|
711
732
|
|
|
733
|
+
# ChannelCreateBatchQuickSignUrl请求参数结构体
|
|
734
|
+
class ChannelCreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel
|
|
735
|
+
# @param FlowIds: 批量签署的合同流程ID数组。
|
|
736
|
+
# 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
|
|
737
|
+
# @type FlowIds: Array
|
|
738
|
+
# @param FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
|
739
|
+
# 注:
|
|
740
|
+
# `1. ApproverType目前只支持个人类型的签署人。`
|
|
741
|
+
# `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
|
|
742
|
+
# `3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
743
|
+
# @type FlowApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverInfo`
|
|
744
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
745
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
746
|
+
# @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
|
|
747
|
+
# @type JumpUrl: String
|
|
748
|
+
# @param SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：
|
|
749
|
+
# <ul><li>**0**：手写签名(默认)</li>
|
|
750
|
+
# <li>**1**：OCR楷体</li></ul>
|
|
751
|
+
# 注：
|
|
752
|
+
# <ul><li>默认情况下，签名类型为手写签名</li>
|
|
753
|
+
# <li>您可以传递多种值，表示可用多种签名类型。</li></ul>
|
|
754
|
+
# @type SignatureTypes: Array
|
|
755
|
+
# @param ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
|
|
756
|
+
# <ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
|
|
757
|
+
# <li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
758
|
+
# 注：
|
|
759
|
+
# <ul><li>默认情况下，认证校验方式为人脸认证</li>
|
|
760
|
+
# <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
|
|
761
|
+
# @type ApproverSignTypes: Array
|
|
762
|
+
|
|
763
|
+
attr_accessor :FlowIds, :FlowApproverInfo, :Agent, :JumpUrl, :SignatureTypes, :ApproverSignTypes
|
|
764
|
+
|
|
765
|
+
def initialize(flowids=nil, flowapproverinfo=nil, agent=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil)
|
|
766
|
+
@FlowIds = flowids
|
|
767
|
+
@FlowApproverInfo = flowapproverinfo
|
|
768
|
+
@Agent = agent
|
|
769
|
+
@JumpUrl = jumpurl
|
|
770
|
+
@SignatureTypes = signaturetypes
|
|
771
|
+
@ApproverSignTypes = approversigntypes
|
|
772
|
+
end
|
|
773
|
+
|
|
774
|
+
def deserialize(params)
|
|
775
|
+
@FlowIds = params['FlowIds']
|
|
776
|
+
unless params['FlowApproverInfo'].nil?
|
|
777
|
+
@FlowApproverInfo = FlowApproverInfo.new
|
|
778
|
+
@FlowApproverInfo.deserialize(params['FlowApproverInfo'])
|
|
779
|
+
end
|
|
780
|
+
unless params['Agent'].nil?
|
|
781
|
+
@Agent = Agent.new
|
|
782
|
+
@Agent.deserialize(params['Agent'])
|
|
783
|
+
end
|
|
784
|
+
@JumpUrl = params['JumpUrl']
|
|
785
|
+
@SignatureTypes = params['SignatureTypes']
|
|
786
|
+
@ApproverSignTypes = params['ApproverSignTypes']
|
|
787
|
+
end
|
|
788
|
+
end
|
|
789
|
+
|
|
790
|
+
# ChannelCreateBatchQuickSignUrl返回参数结构体
|
|
791
|
+
class ChannelCreateBatchQuickSignUrlResponse < TencentCloud::Common::AbstractModel
|
|
792
|
+
# @param FlowApproverUrlInfo: 签署人签署链接信息
|
|
793
|
+
# @type FlowApproverUrlInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverUrlInfo`
|
|
794
|
+
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
795
|
+
# @type RequestId: String
|
|
796
|
+
|
|
797
|
+
attr_accessor :FlowApproverUrlInfo, :RequestId
|
|
798
|
+
|
|
799
|
+
def initialize(flowapproverurlinfo=nil, requestid=nil)
|
|
800
|
+
@FlowApproverUrlInfo = flowapproverurlinfo
|
|
801
|
+
@RequestId = requestid
|
|
802
|
+
end
|
|
803
|
+
|
|
804
|
+
def deserialize(params)
|
|
805
|
+
unless params['FlowApproverUrlInfo'].nil?
|
|
806
|
+
@FlowApproverUrlInfo = FlowApproverUrlInfo.new
|
|
807
|
+
@FlowApproverUrlInfo.deserialize(params['FlowApproverUrlInfo'])
|
|
808
|
+
end
|
|
809
|
+
@RequestId = params['RequestId']
|
|
810
|
+
end
|
|
811
|
+
end
|
|
812
|
+
|
|
712
813
|
# ChannelCreateBatchSignUrl请求参数结构体
|
|
713
814
|
class ChannelCreateBatchSignUrlRequest < TencentCloud::Common::AbstractModel
|
|
714
815
|
# @param Agent: 关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
@@ -884,13 +985,35 @@ module TencentCloud
|
|
|
884
985
|
|
|
885
986
|
# ChannelCreateConvertTaskApi请求参数结构体
|
|
886
987
|
class ChannelCreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
|
|
887
|
-
# @param Agent:
|
|
988
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
989
|
+
|
|
990
|
+
# 此接口下面信息必填。
|
|
991
|
+
# <ul>
|
|
992
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
993
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
994
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
995
|
+
# </ul>
|
|
996
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
888
997
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
889
|
-
# @param ResourceType:
|
|
998
|
+
# @param ResourceType: 需要进行转换的资源文件类型
|
|
999
|
+
# 支持的文件类型如下：
|
|
1000
|
+
# <ul><li>doc</li>
|
|
1001
|
+
# <li>docx</li>
|
|
1002
|
+
# <li>xls</li>
|
|
1003
|
+
# <li>xlsx</li>
|
|
1004
|
+
# <li>jpg</li>
|
|
1005
|
+
# <li>jpeg</li>
|
|
1006
|
+
# <li>png</li>
|
|
1007
|
+
# <li>bmp</li>
|
|
1008
|
+
# <li>txt</li></ul>
|
|
890
1009
|
# @type ResourceType: String
|
|
891
|
-
# @param ResourceName:
|
|
1010
|
+
# @param ResourceName: 需要进行转换操作的文件资源名称，带资源后缀名。
|
|
1011
|
+
|
|
1012
|
+
# 注: `资源名称长度限制为256个字符`
|
|
892
1013
|
# @type ResourceName: String
|
|
893
|
-
# @param ResourceId:
|
|
1014
|
+
# @param ResourceId: 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
|
1015
|
+
|
|
1016
|
+
# 注: `目前，此接口仅支持单个文件进行转换。`
|
|
894
1017
|
# @type ResourceId: String
|
|
895
1018
|
# @param Operator: 调用方用户信息，不用传
|
|
896
1019
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -934,7 +1057,7 @@ module TencentCloud
|
|
|
934
1057
|
|
|
935
1058
|
# ChannelCreateConvertTaskApi返回参数结构体
|
|
936
1059
|
class ChannelCreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
|
|
937
|
-
# @param TaskId:
|
|
1060
|
+
# @param TaskId: 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
|
|
938
1061
|
# @type TaskId: String
|
|
939
1062
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
940
1063
|
# @type RequestId: String
|
|
@@ -2120,13 +2243,28 @@ module TencentCloud
|
|
|
2120
2243
|
|
|
2121
2244
|
# ChannelCreateReleaseFlow请求参数结构体
|
|
2122
2245
|
class ChannelCreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
|
|
2123
|
-
# @param Agent:
|
|
2246
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2247
|
+
|
|
2248
|
+
# 此接口下面信息必填。
|
|
2249
|
+
# <ul>
|
|
2250
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
2251
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2252
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2253
|
+
# </ul>
|
|
2254
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
2124
2255
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
2125
|
-
# @param NeedRelievedFlowId:
|
|
2256
|
+
# @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
|
|
2126
2257
|
# @type NeedRelievedFlowId: String
|
|
2127
|
-
# @param ReliveInfo:
|
|
2258
|
+
# @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
|
|
2128
2259
|
# @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
|
|
2129
|
-
# @param ReleasedApprovers:
|
|
2260
|
+
# @param ReleasedApprovers: 替换解除协议的签署人， 如不指定替换签署人, 则使用原流程的签署人。 <br/>
|
|
2261
|
+
# 如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
|
2262
|
+
|
|
2263
|
+
# 注意：
|
|
2264
|
+
# <ul>
|
|
2265
|
+
# <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
|
|
2266
|
+
# <li>可以不指定替换签署人, 使用原流程的签署人</li>
|
|
2267
|
+
# </ul>
|
|
2130
2268
|
# @type ReleasedApprovers: Array
|
|
2131
2269
|
# @param CallbackUrl: 签署完回调url，最大长度1000个字符
|
|
2132
2270
|
# @type CallbackUrl: String
|
|
@@ -2134,17 +2272,26 @@ module TencentCloud
|
|
|
2134
2272
|
# @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
|
|
2135
2273
|
# @param Operator: 暂未开放
|
|
2136
2274
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
2137
|
-
# @param Deadline:
|
|
2275
|
+
# @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
|
|
2276
|
+
# 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
|
|
2138
2277
|
# @type Deadline: Integer
|
|
2278
|
+
# @param UserData: 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
|
|
2279
|
+
|
|
2280
|
+
# 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
|
|
2139
2281
|
|
|
2140
|
-
|
|
2282
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
2283
|
+
# @type UserData: String
|
|
2284
|
+
|
|
2285
|
+
attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline, :UserData
|
|
2141
2286
|
extend Gem::Deprecate
|
|
2287
|
+
deprecate :CallbackUrl, :none, 2023, 11
|
|
2288
|
+
deprecate :CallbackUrl=, :none, 2023, 11
|
|
2142
2289
|
deprecate :Organization, :none, 2023, 11
|
|
2143
2290
|
deprecate :Organization=, :none, 2023, 11
|
|
2144
2291
|
deprecate :Operator, :none, 2023, 11
|
|
2145
2292
|
deprecate :Operator=, :none, 2023, 11
|
|
2146
2293
|
|
|
2147
|
-
def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil)
|
|
2294
|
+
def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil, userdata=nil)
|
|
2148
2295
|
@Agent = agent
|
|
2149
2296
|
@NeedRelievedFlowId = needrelievedflowid
|
|
2150
2297
|
@ReliveInfo = reliveinfo
|
|
@@ -2153,6 +2300,7 @@ module TencentCloud
|
|
|
2153
2300
|
@Organization = organization
|
|
2154
2301
|
@Operator = operator
|
|
2155
2302
|
@Deadline = deadline
|
|
2303
|
+
@UserData = userdata
|
|
2156
2304
|
end
|
|
2157
2305
|
|
|
2158
2306
|
def deserialize(params)
|
|
@@ -2183,6 +2331,7 @@ module TencentCloud
|
|
|
2183
2331
|
@Operator.deserialize(params['Operator'])
|
|
2184
2332
|
end
|
|
2185
2333
|
@Deadline = params['Deadline']
|
|
2334
|
+
@UserData = params['UserData']
|
|
2186
2335
|
end
|
|
2187
2336
|
end
|
|
2188
2337
|
|
|
@@ -2334,22 +2483,29 @@ module TencentCloud
|
|
|
2334
2483
|
|
|
2335
2484
|
# ChannelCreateUserAutoSignEnableUrl请求参数结构体
|
|
2336
2485
|
class ChannelCreateUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
|
|
2337
|
-
# @param Agent:
|
|
2486
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2338
2487
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
2339
|
-
# @param SceneKey:
|
|
2340
|
-
# E_PRESCRIPTION_AUTO_SIGN
|
|
2488
|
+
# @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
|
2489
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
2490
|
+
|
|
2491
|
+
# 注: `现在仅支持电子处方场景`
|
|
2341
2492
|
# @type SceneKey: String
|
|
2342
|
-
# @param Operator:
|
|
2493
|
+
# @param Operator: 执行本接口操作的员工信息。
|
|
2494
|
+
# 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
|
2343
2495
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
2344
|
-
# @param AutoSignConfig:
|
|
2496
|
+
# @param AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
|
|
2345
2497
|
# @type AutoSignConfig: :class:`Tencentcloud::Essbasic.v20210526.models.AutoSignConfig`
|
|
2346
|
-
# @param UrlType:
|
|
2498
|
+
# @param UrlType: 生成的链接类型：
|
|
2499
|
+
# <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
|
2500
|
+
# <li> **H5SIGN** : 生成H5端开通链接</li></ul>
|
|
2347
2501
|
# @type UrlType: String
|
|
2348
|
-
# @param NotifyType:
|
|
2502
|
+
# @param NotifyType: 是否通知开通方，通知类型:
|
|
2503
|
+
# <ul><li>默认不设置为不通知开通方</li>
|
|
2504
|
+
# <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
|
|
2349
2505
|
# @type NotifyType: String
|
|
2350
|
-
# @param NotifyAddress:
|
|
2506
|
+
# @param NotifyAddress: 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
|
|
2351
2507
|
# @type NotifyAddress: String
|
|
2352
|
-
# @param ExpiredTime: 链接的过期时间，格式为Unix
|
|
2508
|
+
# @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
|
|
2353
2509
|
# @type ExpiredTime: Integer
|
|
2354
2510
|
|
|
2355
2511
|
attr_accessor :Agent, :SceneKey, :Operator, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress, :ExpiredTime
|
|
@@ -2388,17 +2544,27 @@ module TencentCloud
|
|
|
2388
2544
|
|
|
2389
2545
|
# ChannelCreateUserAutoSignEnableUrl返回参数结构体
|
|
2390
2546
|
class ChannelCreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
|
|
2391
|
-
# @param Url:
|
|
2547
|
+
# @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
|
|
2392
2548
|
# @type Url: String
|
|
2393
|
-
# @param AppId:
|
|
2549
|
+
# @param AppId: 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
2550
|
+
|
|
2551
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
|
2394
2552
|
# @type AppId: String
|
|
2395
|
-
# @param AppOriginalId:
|
|
2553
|
+
# @param AppOriginalId: 腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
2554
|
+
|
|
2555
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
|
2396
2556
|
# @type AppOriginalId: String
|
|
2397
|
-
# @param Path:
|
|
2557
|
+
# @param Path: 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
2558
|
+
|
|
2559
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
|
2398
2560
|
# @type Path: String
|
|
2399
|
-
# @param QrCode: base64
|
|
2561
|
+
# @param QrCode: base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
|
2562
|
+
|
|
2563
|
+
# 注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
|
2400
2564
|
# @type QrCode: String
|
|
2401
|
-
# @param UrlType:
|
|
2565
|
+
# @param UrlType: 返回的链接类型
|
|
2566
|
+
# <ul><li> 空: 默认小程序端链接</li>
|
|
2567
|
+
# <li> **H5SIGN** : h5端链接</li></ul>
|
|
2402
2568
|
# @type UrlType: String
|
|
2403
2569
|
# @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2404
2570
|
# @type RequestId: String
|
|
@@ -3241,9 +3407,17 @@ module TencentCloud
|
|
|
3241
3407
|
|
|
3242
3408
|
# ChannelGetTaskResultApi请求参数结构体
|
|
3243
3409
|
class ChannelGetTaskResultApiRequest < TencentCloud::Common::AbstractModel
|
|
3244
|
-
# @param Agent:
|
|
3410
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3411
|
+
|
|
3412
|
+
# 此接口下面信息必填。
|
|
3413
|
+
# <ul>
|
|
3414
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
3415
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3416
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3417
|
+
# </ul>
|
|
3418
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
3245
3419
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
3246
|
-
# @param TaskId:
|
|
3420
|
+
# @param TaskId: 转换任务Id，通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
|
|
3247
3421
|
# @type TaskId: String
|
|
3248
3422
|
# @param Operator: 操作者的信息，不用传
|
|
3249
3423
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -3286,22 +3460,22 @@ module TencentCloud
|
|
|
3286
3460
|
# @param TaskId: 任务Id
|
|
3287
3461
|
# @type TaskId: String
|
|
3288
3462
|
# @param TaskStatus: 任务状态，需要关注的状态
|
|
3289
|
-
# 0 :NeedTranform -
|
|
3290
|
-
# 4 :Processing -
|
|
3291
|
-
# 8 :TaskEnd -
|
|
3292
|
-
#
|
|
3293
|
-
#
|
|
3294
|
-
#
|
|
3463
|
+
# <ul><li>**0** :NeedTranform - 任务已提交</li>
|
|
3464
|
+
# <li>**4** :Processing - 文档转换中</li>
|
|
3465
|
+
# <li>**8** :TaskEnd - 任务处理完成</li>
|
|
3466
|
+
# <li>**-2** :DownloadFailed - 下载失败</li>
|
|
3467
|
+
# <li>**-6** :ProcessFailed - 转换失败</li>
|
|
3468
|
+
# <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
|
|
3295
3469
|
# @type TaskStatus: Integer
|
|
3296
3470
|
# @param TaskMessage: 状态描述，需要关注的状态
|
|
3297
|
-
# NeedTranform
|
|
3298
|
-
# Processing
|
|
3299
|
-
# TaskEnd
|
|
3300
|
-
# DownloadFailed
|
|
3301
|
-
# ProcessFailed
|
|
3302
|
-
# ProcessTimeout
|
|
3471
|
+
# <ul><li> **NeedTranform** : 任务已提交</li>
|
|
3472
|
+
# <li> **Processing** : 文档转换中</li>
|
|
3473
|
+
# <li> **TaskEnd** : 任务处理完成</li>
|
|
3474
|
+
# <li> **DownloadFailed** : 下载失败</li>
|
|
3475
|
+
# <li> **ProcessFailed** : 转换失败</li>
|
|
3476
|
+
# <li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
3303
3477
|
# @type TaskMessage: String
|
|
3304
|
-
# @param ResourceId: 资源Id，也是FileId
|
|
3478
|
+
# @param ResourceId: 资源Id，也是FileId，用于文件发起时使用
|
|
3305
3479
|
# @type ResourceId: String
|
|
3306
3480
|
# @param PreviewUrl: 预览文件Url，有效期30分钟
|
|
3307
3481
|
# 当前字段返回为空，发起的时候，将ResourceId 放入发起即可
|
|
@@ -5013,55 +5187,88 @@ module TencentCloud
|
|
|
5013
5187
|
|
|
5014
5188
|
# DescribeTemplates请求参数结构体
|
|
5015
5189
|
class DescribeTemplatesRequest < TencentCloud::Common::AbstractModel
|
|
5016
|
-
# @param Agent:
|
|
5017
|
-
|
|
5190
|
+
# @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5191
|
+
|
|
5192
|
+
# 此接口下面信息必填。
|
|
5193
|
+
# <ul>
|
|
5194
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
5195
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5196
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5197
|
+
# </ul>
|
|
5198
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
5018
5199
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
5019
|
-
# @param TemplateId:
|
|
5200
|
+
# @param TemplateId: 合同模板ID，为32位字符串。
|
|
5201
|
+
|
|
5202
|
+
# 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
5020
5203
|
# @type TemplateId: String
|
|
5021
|
-
# @param ContentType:
|
|
5022
|
-
|
|
5023
|
-
#
|
|
5204
|
+
# @param ContentType: 查询模版的内容
|
|
5205
|
+
|
|
5206
|
+
# <ul><li>**0**：（默认）模板列表及详情</li>
|
|
5207
|
+
# <li>**1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
5024
5208
|
# @type ContentType: Integer
|
|
5025
|
-
# @param
|
|
5209
|
+
# @param TemplateIds: 合同模板ID数组，每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
|
|
5210
|
+
|
|
5211
|
+
# 注意:
|
|
5212
|
+
# 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。`
|
|
5213
|
+
# 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。`
|
|
5214
|
+
# 4. `若传递此参数，分页参数(Limit,Offset)无效`
|
|
5215
|
+
# @type TemplateIds: Array
|
|
5216
|
+
# @param Limit: 指定每页返回的数据条数，和Offset参数配合使用。
|
|
5217
|
+
|
|
5218
|
+
# 注：`1.默认值为20，单页做大值为200。`
|
|
5026
5219
|
# @type Limit: Integer
|
|
5027
|
-
# @param Offset:
|
|
5220
|
+
# @param Offset: 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
|
|
5221
|
+
|
|
5222
|
+
# 注：`1.offset从0开始，即第一页为0。`
|
|
5223
|
+
# `2.默认从第一页返回。`
|
|
5028
5224
|
# @type Offset: Integer
|
|
5029
|
-
# @param
|
|
5030
|
-
# 默认false，只返回发起方控件；
|
|
5031
|
-
# true，返回所有签署方控件
|
|
5032
|
-
# @type QueryAllComponents: Boolean
|
|
5033
|
-
# @param TemplateName: 模糊搜索模板名称，最大长度200
|
|
5225
|
+
# @param TemplateName: 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
|
|
5034
5226
|
# @type TemplateName: String
|
|
5035
|
-
# @param
|
|
5036
|
-
#
|
|
5037
|
-
#
|
|
5227
|
+
# @param ChannelTemplateId: 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
|
|
5228
|
+
# @type ChannelTemplateId: String
|
|
5229
|
+
# @param QueryAllComponents: 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
|
5230
|
+
|
|
5231
|
+
# <ul><li>**false**：（默认）只返回发起方控件</li>
|
|
5232
|
+
# <li>**true**：返回所有参与方(包括发起方和签署方)控件</li></ul>
|
|
5233
|
+
# @type QueryAllComponents: Boolean
|
|
5234
|
+
# @param WithPreviewUrl: 是否获取模板预览链接。
|
|
5235
|
+
|
|
5236
|
+
# <ul><li>**false**：不获取（默认）</li>
|
|
5237
|
+
# <li>**true**：获取</li></ul>
|
|
5238
|
+
|
|
5239
|
+
# 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
|
|
5240
|
+
|
|
5241
|
+
# 注: `此功能为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
5038
5242
|
# @type WithPreviewUrl: Boolean
|
|
5039
5243
|
# @param WithPdfUrl: 是否获取模板的PDF文件链接。
|
|
5040
|
-
|
|
5041
|
-
#
|
|
5042
|
-
#
|
|
5244
|
+
|
|
5245
|
+
# <ul><li>**false**：不获取（默认）</li>
|
|
5246
|
+
# <li>**true**：获取</li></ul>
|
|
5247
|
+
|
|
5248
|
+
# 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地
|
|
5249
|
+
|
|
5250
|
+
# 注: `此功能为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
5043
5251
|
# @type WithPdfUrl: Boolean
|
|
5044
|
-
# @param ChannelTemplateId: 对应第三方应用平台企业的模板ID
|
|
5045
|
-
# @type ChannelTemplateId: String
|
|
5046
5252
|
# @param Operator: 操作者的信息
|
|
5047
5253
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
5048
5254
|
|
|
5049
|
-
attr_accessor :Agent, :TemplateId, :ContentType, :Limit, :Offset, :
|
|
5255
|
+
attr_accessor :Agent, :TemplateId, :ContentType, :TemplateIds, :Limit, :Offset, :TemplateName, :ChannelTemplateId, :QueryAllComponents, :WithPreviewUrl, :WithPdfUrl, :Operator
|
|
5050
5256
|
extend Gem::Deprecate
|
|
5051
5257
|
deprecate :Operator, :none, 2023, 11
|
|
5052
5258
|
deprecate :Operator=, :none, 2023, 11
|
|
5053
5259
|
|
|
5054
|
-
def initialize(agent=nil, templateid=nil, contenttype=nil, limit=nil, offset=nil,
|
|
5260
|
+
def initialize(agent=nil, templateid=nil, contenttype=nil, templateids=nil, limit=nil, offset=nil, templatename=nil, channeltemplateid=nil, queryallcomponents=nil, withpreviewurl=nil, withpdfurl=nil, operator=nil)
|
|
5055
5261
|
@Agent = agent
|
|
5056
5262
|
@TemplateId = templateid
|
|
5057
5263
|
@ContentType = contenttype
|
|
5264
|
+
@TemplateIds = templateids
|
|
5058
5265
|
@Limit = limit
|
|
5059
5266
|
@Offset = offset
|
|
5060
|
-
@QueryAllComponents = queryallcomponents
|
|
5061
5267
|
@TemplateName = templatename
|
|
5268
|
+
@ChannelTemplateId = channeltemplateid
|
|
5269
|
+
@QueryAllComponents = queryallcomponents
|
|
5062
5270
|
@WithPreviewUrl = withpreviewurl
|
|
5063
5271
|
@WithPdfUrl = withpdfurl
|
|
5064
|
-
@ChannelTemplateId = channeltemplateid
|
|
5065
5272
|
@Operator = operator
|
|
5066
5273
|
end
|
|
5067
5274
|
|
|
@@ -5072,13 +5279,14 @@ module TencentCloud
|
|
|
5072
5279
|
end
|
|
5073
5280
|
@TemplateId = params['TemplateId']
|
|
5074
5281
|
@ContentType = params['ContentType']
|
|
5282
|
+
@TemplateIds = params['TemplateIds']
|
|
5075
5283
|
@Limit = params['Limit']
|
|
5076
5284
|
@Offset = params['Offset']
|
|
5077
|
-
@QueryAllComponents = params['QueryAllComponents']
|
|
5078
5285
|
@TemplateName = params['TemplateName']
|
|
5286
|
+
@ChannelTemplateId = params['ChannelTemplateId']
|
|
5287
|
+
@QueryAllComponents = params['QueryAllComponents']
|
|
5079
5288
|
@WithPreviewUrl = params['WithPreviewUrl']
|
|
5080
5289
|
@WithPdfUrl = params['WithPdfUrl']
|
|
5081
|
-
@ChannelTemplateId = params['ChannelTemplateId']
|
|
5082
5290
|
unless params['Operator'].nil?
|
|
5083
5291
|
@Operator = UserInfo.new
|
|
5084
5292
|
@Operator.deserialize(params['Operator'])
|
|
@@ -5088,11 +5296,11 @@ module TencentCloud
|
|
|
5088
5296
|
|
|
5089
5297
|
# DescribeTemplates返回参数结构体
|
|
5090
5298
|
class DescribeTemplatesResponse < TencentCloud::Common::AbstractModel
|
|
5091
|
-
# @param Templates:
|
|
5299
|
+
# @param Templates: 模板详情列表数据
|
|
5092
5300
|
# @type Templates: Array
|
|
5093
|
-
# @param TotalCount:
|
|
5301
|
+
# @param TotalCount: 查询到的模板总数
|
|
5094
5302
|
# @type TotalCount: Integer
|
|
5095
|
-
# @param Limit:
|
|
5303
|
+
# @param Limit: 每页返回的数据条数
|
|
5096
5304
|
# @type Limit: Integer
|
|
5097
5305
|
# @param Offset: 查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
|
|
5098
5306
|
# @type Offset: Integer
|
|
@@ -5632,9 +5840,13 @@ module TencentCloud
|
|
|
5632
5840
|
# @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverOption`
|
|
5633
5841
|
# @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批，true 则为需要
|
|
5634
5842
|
# @type ApproverNeedSignReview: Boolean
|
|
5635
|
-
# @param ApproverVerifyTypes:
|
|
5636
|
-
#
|
|
5637
|
-
#
|
|
5843
|
+
# @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
|
|
5844
|
+
# <ul><li> **1** : （默认）人脸识别,人脸识别后才能合同内容</li>
|
|
5845
|
+
# <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
|
|
5846
|
+
# </li></ul>
|
|
5847
|
+
# 注:
|
|
5848
|
+
# <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
|
5849
|
+
# <li>此字段可传多个校验方式</li></ul>
|
|
5638
5850
|
# @type ApproverVerifyTypes: Array
|
|
5639
5851
|
# @param ApproverSignTypes: 签署人签署合同时的认证方式
|
|
5640
5852
|
# <ul><li> **1** :人脸认证</li>
|
|
@@ -5659,7 +5871,9 @@ module TencentCloud
|
|
|
5659
5871
|
|
|
5660
5872
|
# 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
|
|
5661
5873
|
# @type AddSignComponentsLimits: Array
|
|
5662
|
-
# @param ApproverRoleName:
|
|
5874
|
+
# @param ApproverRoleName: 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
|
|
5875
|
+
|
|
5876
|
+
# 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
|
|
5663
5877
|
# @type ApproverRoleName: String
|
|
5664
5878
|
|
|
5665
5879
|
attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType, :AddSignComponentsLimits, :ApproverRoleName
|
|
@@ -6093,36 +6307,67 @@ module TencentCloud
|
|
|
6093
6307
|
# | widthPercent | Integer | 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35 |
|
|
6094
6308
|
# | content | String | 表头单元格内容，字数不超过100 |
|
|
6095
6309
|
class FlowInfo < TencentCloud::Common::AbstractModel
|
|
6096
|
-
# @param FlowName:
|
|
6310
|
+
# @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
|
|
6097
6311
|
# @type FlowName: String
|
|
6098
|
-
# @param Deadline:
|
|
6312
|
+
# @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
|
|
6313
|
+
# 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
|
|
6314
|
+
# 示例值：1604912664
|
|
6099
6315
|
# @type Deadline: Integer
|
|
6100
|
-
# @param TemplateId:
|
|
6316
|
+
# @param TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
|
|
6317
|
+
|
|
6318
|
+
# 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
|
|
6101
6319
|
# @type TemplateId: String
|
|
6102
6320
|
# @param FlowApprovers: 多个签署人信息，最大支持50个签署方
|
|
6103
6321
|
# @type FlowApprovers: Array
|
|
6104
6322
|
# @param FormFields: 表单K-V对列表
|
|
6105
6323
|
# @type FormFields: Array
|
|
6106
|
-
# @param CallbackUrl:
|
|
6324
|
+
# @param CallbackUrl: 合同状态变动结的通知回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性，最大长度1000个字符。
|
|
6325
|
+
|
|
6326
|
+
# 腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
|
|
6327
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块
|
|
6107
6328
|
# @type CallbackUrl: String
|
|
6108
|
-
# @param FlowType:
|
|
6329
|
+
# @param FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
|
|
6109
6330
|
# @type FlowType: String
|
|
6110
|
-
# @param FlowDescription:
|
|
6331
|
+
# @param FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
|
|
6111
6332
|
# @type FlowDescription: String
|
|
6112
|
-
# @param CustomerData:
|
|
6333
|
+
# @param CustomerData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
|
|
6334
|
+
|
|
6335
|
+
# 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
|
|
6113
6336
|
# @type CustomerData: String
|
|
6114
|
-
# @param CustomShowMap:
|
|
6337
|
+
# @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
|
|
6338
|
+
# <ul><li>{合同名称} </li>
|
|
6339
|
+
# <li>{发起方企业} </li>
|
|
6340
|
+
# <li>{发起方姓名} </li>
|
|
6341
|
+
# <li>{签署方N企业}</li>
|
|
6342
|
+
# <li>{签署方N姓名}</li></ul>
|
|
6343
|
+
# 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
|
|
6344
|
+
|
|
6345
|
+
# 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
|
|
6346
|
+
|
|
6347
|
+
# 合同名称：租房合同
|
|
6348
|
+
# 发起方：腾讯公司(张三)
|
|
6349
|
+
# 签署方：李四
|
|
6350
|
+
|
|
6115
6351
|
# @type CustomShowMap: String
|
|
6116
|
-
# @param CcInfos:
|
|
6117
|
-
# @type CcInfos: Array
|
|
6118
|
-
# @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。
|
|
6119
|
-
# 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
|
|
6352
|
+
# @param CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
|
|
6120
6353
|
|
|
6121
|
-
#
|
|
6354
|
+
# 注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
6355
|
+
# @type CcInfos: Array
|
|
6356
|
+
# @param NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
|
|
6357
|
+
# <ul><li> **false**：（默认）不需要审批，直接签署。</li>
|
|
6358
|
+
# <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
|
|
6359
|
+
# 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
6360
|
+
# <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
|
|
6361
|
+
# <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
|
|
6362
|
+
# 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
|
|
6122
6363
|
# @type NeedSignReview: Boolean
|
|
6123
|
-
# @param CcNotifyType:
|
|
6364
|
+
# @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
|
|
6365
|
+
# <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
|
|
6366
|
+
# <li> **1** : 签署完成后通知对方来查看合同</li></ul>
|
|
6124
6367
|
# @type CcNotifyType: Integer
|
|
6125
|
-
# @param AutoSignScene:
|
|
6368
|
+
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
6369
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签） </li></ul>
|
|
6370
|
+
# 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
6126
6371
|
# @type AutoSignScene: String
|
|
6127
6372
|
|
|
6128
6373
|
attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos, :NeedSignReview, :CcNotifyType, :AutoSignScene
|
|
@@ -7104,18 +7349,18 @@ module TencentCloud
|
|
|
7104
7349
|
end
|
|
7105
7350
|
end
|
|
7106
7351
|
|
|
7107
|
-
#
|
|
7352
|
+
# 流程中签署方和填写方(如果有填写控件存证时)的信息
|
|
7108
7353
|
class Recipient < TencentCloud::Common::AbstractModel
|
|
7109
|
-
# @param RecipientId:
|
|
7354
|
+
# @param RecipientId: 合同参与方的角色ID
|
|
7110
7355
|
# @type RecipientId: String
|
|
7111
|
-
# @param RecipientType:
|
|
7112
|
-
# ENTERPRISE
|
|
7113
|
-
# INDIVIDUAL
|
|
7114
|
-
# PROMOTER
|
|
7356
|
+
# @param RecipientType: 参与者类型, 可以选择的类型如下:
|
|
7357
|
+
# <ul><li> **ENTERPRISE** :此角色为企业参与方</li>
|
|
7358
|
+
# <li> **INDIVIDUAL** :此角色为个人参与方</li>
|
|
7359
|
+
# <li> **PROMOTER** :此角色是发起方</li></ul>
|
|
7115
7360
|
# @type RecipientType: String
|
|
7116
|
-
# @param Description:
|
|
7361
|
+
# @param Description: 合同参与方的角色描述，长度不能超过100，只能由中文、字母、数字和下划线组成。
|
|
7117
7362
|
# @type Description: String
|
|
7118
|
-
# @param RoleName:
|
|
7363
|
+
# @param RoleName: 合同参与方的角色名字，长度不能超过20，只能由中文、字母、数字和下划线组成。
|
|
7119
7364
|
# @type RoleName: String
|
|
7120
7365
|
# @param RequireValidation: 是否需要校验，
|
|
7121
7366
|
# true-是，
|
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.692
|
|
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-11-
|
|
11
|
+
date: 2023-11-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|
|
@@ -33,11 +33,11 @@ executables: []
|
|
|
33
33
|
extensions: []
|
|
34
34
|
extra_rdoc_files: []
|
|
35
35
|
files:
|
|
36
|
-
- lib/v20210526/client.rb
|
|
37
|
-
- lib/v20210526/models.rb
|
|
38
|
-
- lib/v20201222/client.rb
|
|
39
36
|
- lib/v20201222/models.rb
|
|
37
|
+
- lib/v20201222/client.rb
|
|
40
38
|
- lib/tencentcloud-sdk-essbasic.rb
|
|
39
|
+
- lib/v20210526/models.rb
|
|
40
|
+
- lib/v20210526/client.rb
|
|
41
41
|
- lib/VERSION
|
|
42
42
|
homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
|
|
43
43
|
licenses:
|