tencentcloud-sdk-ess 1.0.347 → 1.0.350

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: 8efdcb3993a9f5be87587b9f37a2956a774d8900
4
- data.tar.gz: e1c6d9309fe78d6a74e37f7c25b750e7415935a3
3
+ metadata.gz: 28ad75e35c4abdcfaeba47232d37f5f9b9374d8b
4
+ data.tar.gz: 4189c655f86074a684730b736efb44e976ddbbd5
5
5
  SHA512:
6
- metadata.gz: af84d784e36e1a47251450bd4076b3352cb73a37c97a8959d65a385ea72e16679ddd2ad44f1932535efe33b0f2ccdc1f90d50a2f0b21ec82097a9ff2ca27bcc4
7
- data.tar.gz: b9e0084a5e0d2b6e4ba3f92573d8780b58a464aa76cb7b18142f83589ada1f2db670bcff04db8a483533eecf02b7d5c6946123609453bd3b9daa3c460c1f7254
6
+ metadata.gz: 58f5e3bbb52152d3d82e2fe6278cbd8857a284b23bf5f22070ea38de3a7b5b47cca99bfc3937590cef022075295831fee3ee00e3209be3b483ec238bf3dfe057
7
+ data.tar.gz: 3eefd4071af6a0fcaf69678cbf49feee24b376bde265a0fb4c37d0b14bfeab10c0ec706dc95b125d2fb6202445596bbcfe7e98d759e1c87222a2d327448f98fe
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.347
1
+ 1.0.350
@@ -30,6 +30,8 @@ module TencentCloud
30
30
 
31
31
 
32
32
  # 用于撤销签署流程
33
+ # 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
34
+ # 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
33
35
 
34
36
  # @param request: Request instance for CancelFlow.
35
37
  # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
@@ -78,6 +80,8 @@ module TencentCloud
78
80
  end
79
81
 
80
82
  # 创建电子文档
83
+ # 适用场景:见创建签署流程接口。
84
+ # 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
81
85
 
82
86
  # @param request: Request instance for CreateDocument.
83
87
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateDocumentRequest`
@@ -102,6 +106,8 @@ module TencentCloud
102
106
  end
103
107
 
104
108
  # 创建签署流程
109
+ # 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
110
+ # 注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
105
111
 
106
112
  # @param request: Request instance for CreateFlow.
107
113
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest`
@@ -125,7 +131,10 @@ module TencentCloud
125
131
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
126
132
  end
127
133
 
128
- # 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建签署流程。
134
+ # 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
135
+ # 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
136
+ # 适用场景2:可通过改接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
137
+ # 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
129
138
 
130
139
  # @param request: Request instance for CreateFlowByFiles.
131
140
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesRequest`
@@ -150,6 +159,7 @@ module TencentCloud
150
159
  end
151
160
 
152
161
  # 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
162
+ # 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
153
163
  # 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
154
164
 
155
165
  # @param request: Request instance for CreateMultiFlowSignQRCode.
@@ -176,6 +186,11 @@ module TencentCloud
176
186
 
177
187
  # 获取小程序跳转链接
178
188
 
189
+ # 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
190
+
191
+ # 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
192
+
193
+
179
194
  # 跳转到小程序的实现,参考官方文档(分为<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>两种方式)
180
195
 
181
196
 
@@ -204,6 +219,7 @@ module TencentCloud
204
219
  end
205
220
 
206
221
  # 查询文件下载URL
222
+ # 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
207
223
 
208
224
  # @param request: Request instance for DescribeFileUrls.
209
225
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsRequest`
@@ -228,6 +244,7 @@ module TencentCloud
228
244
  end
229
245
 
230
246
  # 查询流程摘要
247
+ # 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
231
248
 
232
249
  # @param request: Request instance for DescribeFlowBriefs.
233
250
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -252,6 +269,7 @@ module TencentCloud
252
269
  end
253
270
 
254
271
  # 二期接口-查询模板
272
+ # 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
255
273
 
256
274
  # @param request: Request instance for DescribeFlowTemplates.
257
275
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
@@ -300,6 +318,8 @@ module TencentCloud
300
318
  end
301
319
 
302
320
  # 此接口用于发起流程
321
+ # 适用场景:见创建签署流程接口。
322
+ # 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
303
323
 
304
324
  # @param request: Request instance for StartFlow.
305
325
  # @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
@@ -324,6 +344,7 @@ module TencentCloud
324
344
  end
325
345
 
326
346
  # 此接口(UploadFiles)用于文件上传。
347
+ # 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
327
348
  # 调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
328
349
 
329
350
  # @param request: Request instance for UploadFiles.
@@ -1550,35 +1550,32 @@ module TencentCloud
1550
1550
 
1551
1551
  # UploadFiles请求参数结构体
1552
1552
  class UploadFilesRequest < TencentCloud::Common::AbstractModel
1553
- # @param Caller: 调用方信息
1554
- # @type Caller: :class:`Tencentcloud::Ess.v20201111.models.Caller`
1555
1553
  # @param BusinessType: 文件对应业务类型,用于区分文件存储路径:
1556
1554
  # 1. TEMPLATE - 模板; 文件类型:.pdf/.html
1557
1555
  # 2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
1558
- # 3. FLOW - 签署过程 文件类型:.pdf/.html
1559
- # 4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
1560
- # 5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
1561
- # 6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
1556
+ # 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
1562
1557
  # @type BusinessType: String
1558
+ # @param Caller: 调用方信息
1559
+ # @type Caller: :class:`Tencentcloud::Ess.v20201111.models.Caller`
1563
1560
  # @param FileInfos: 上传文件内容数组,最多支持20个文件
1564
1561
  # @type FileInfos: Array
1565
1562
  # @param FileUrls: 上传文件链接数组,最多支持20个URL
1566
1563
  # @type FileUrls: String
1567
- # @param CoverRect: 是否将pdf灰色矩阵置白
1564
+ # @param CoverRect: 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
1568
1565
  # true--是,处理置白
1569
1566
  # false--否,不处理
1570
1567
  # @type CoverRect: Boolean
1571
- # @param FileType: 特殊文件类型需要指定文件类型:
1572
- # HTML-- .html文件
1568
+ # @param FileType: 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
1569
+ # 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
1573
1570
  # @type FileType: String
1574
1571
  # @param CustomIds: 用户自定义ID数组,与上传文件一一对应
1575
1572
  # @type CustomIds: Array
1576
1573
 
1577
- attr_accessor :Caller, :BusinessType, :FileInfos, :FileUrls, :CoverRect, :FileType, :CustomIds
1574
+ attr_accessor :BusinessType, :Caller, :FileInfos, :FileUrls, :CoverRect, :FileType, :CustomIds
1578
1575
 
1579
- def initialize(caller=nil, businesstype=nil, fileinfos=nil, fileurls=nil, coverrect=nil, filetype=nil, customids=nil)
1580
- @Caller = caller
1576
+ def initialize(businesstype=nil, caller=nil, fileinfos=nil, fileurls=nil, coverrect=nil, filetype=nil, customids=nil)
1581
1577
  @BusinessType = businesstype
1578
+ @Caller = caller
1582
1579
  @FileInfos = fileinfos
1583
1580
  @FileUrls = fileurls
1584
1581
  @CoverRect = coverrect
@@ -1587,11 +1584,11 @@ module TencentCloud
1587
1584
  end
1588
1585
 
1589
1586
  def deserialize(params)
1587
+ @BusinessType = params['BusinessType']
1590
1588
  unless params['Caller'].nil?
1591
1589
  @Caller = Caller.new
1592
1590
  @Caller.deserialize(params['Caller'])
1593
1591
  end
1594
- @BusinessType = params['BusinessType']
1595
1592
  unless params['FileInfos'].nil?
1596
1593
  @FileInfos = []
1597
1594
  params['FileInfos'].each do |i|
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: 1.0.347
4
+ version: 1.0.350
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-03 00:00:00.000000000 Z
11
+ date: 2022-07-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common