tencentcloud-sdk-ess 1.0.347 → 1.0.348

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8efdcb3993a9f5be87587b9f37a2956a774d8900
-  data.tar.gz: e1c6d9309fe78d6a74e37f7c25b750e7415935a3
+  metadata.gz: 99cc441cb7cfbe513048075bbbb6aff39761c29b
+  data.tar.gz: c1d7a8eeeb692becba7a9d2698cd7a53dd927bf4
 SHA512:
-  metadata.gz: af84d784e36e1a47251450bd4076b3352cb73a37c97a8959d65a385ea72e16679ddd2ad44f1932535efe33b0f2ccdc1f90d50a2f0b21ec82097a9ff2ca27bcc4
-  data.tar.gz: b9e0084a5e0d2b6e4ba3f92573d8780b58a464aa76cb7b18142f83589ada1f2db670bcff04db8a483533eecf02b7d5c6946123609453bd3b9daa3c460c1f7254
+  metadata.gz: 41ffad38fa5906e05216dc01f32325f9c15d4333b5e3b7cddbdeaf277cc9ad338e48742f8c7f0527302fdf94c5f7a8430fcd982a7edf174dde25511d4f7add34
+  data.tar.gz: a91e4b6b56a639cfd66e552718683d5437831a37a50e72f43be106ecc2fdae26f80a95166ddd69a8243298d4b717a09e42ee7f99f7a7d3cc96ca4f6281790b51

data/lib/VERSION

@@ -1 +1 @@
-1.0.347
+1.0.348

data/lib/v20201111/client.rb

@@ -30,6 +30,8 @@ module TencentCloud
 
 
         # 用于撤销签署流程
+        # 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
+        # 注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
 
         # @param request: Request instance for CancelFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
@@ -78,6 +80,8 @@ module TencentCloud
         end
 
         # 创建电子文档
+        # 适用场景：见创建签署流程接口。
+        # 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
 
         # @param request: Request instance for CreateDocument.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateDocumentRequest`
@@ -102,6 +106,8 @@ module TencentCloud
         end
 
         # 创建签署流程
+        # 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
+        # 注：改接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
 
         # @param request: Request instance for CreateFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest`
@@ -125,7 +131,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建签署流程。
+        # 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
+        # 适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
+        # 适用场景2：可通过改接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
+        # 注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
 
         # @param request: Request instance for CreateFlowByFiles.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowByFilesRequest`
@@ -150,6 +159,7 @@ module TencentCloud
         end
 
         # 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+        # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
         # 适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
 
         # @param request: Request instance for CreateMultiFlowSignQRCode.
@@ -176,6 +186,11 @@ module TencentCloud
 
         # 获取小程序跳转链接
 
+        # 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
+
+        # 注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
+
+
         # 跳转到小程序的实现，参考官方文档（分为<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>两种方式）
 
 
@@ -204,6 +219,7 @@ module TencentCloud
         end
 
         # 查询文件下载URL
+        # 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
 
         # @param request: Request instance for DescribeFileUrls.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsRequest`
@@ -228,6 +244,7 @@ module TencentCloud
         end
 
         # 查询流程摘要
+        # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
 
         # @param request: Request instance for DescribeFlowBriefs.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -252,6 +269,7 @@ module TencentCloud
         end
 
         # 二期接口-查询模板
+        # 适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
 
         # @param request: Request instance for DescribeFlowTemplates.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
@@ -300,6 +318,8 @@ module TencentCloud
         end
 
         # 此接口用于发起流程
+        # 适用场景：见创建签署流程接口。
+        # 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
 
         # @param request: Request instance for StartFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
@@ -324,6 +344,7 @@ module TencentCloud
         end
 
         # 此接口（UploadFiles）用于文件上传。
+        # 适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
         # 调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
 
         # @param request: Request instance for UploadFiles.

data/lib/v20201111/models.rb

@@ -1550,35 +1550,32 @@ module TencentCloud
 
       # UploadFiles请求参数结构体
       class UploadFilesRequest < TencentCloud::Common::AbstractModel
-        # @param Caller: 调用方信息
-        # @type Caller: :class:`Tencentcloud::Ess.v20201111.models.Caller`
         # @param BusinessType: 文件对应业务类型，用于区分文件存储路径：
         # 1. TEMPLATE - 模板； 文件类型：.pdf/.html
         # 2. DOCUMENT - 签署过程及签署后的合同文档 文件类型：.pdf/.html
-        # 3. FLOW - 签署过程 文件类型：.pdf/.html
-        # 4. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
-        # 5. BUSINESSLICENSE - 营业执照 文件类型：.jpg/.jpeg/.png
-        # 6. IDCARD - 身份证 文件类型：.jpg/.jpeg/.png
+        # 3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
         # @type BusinessType: String
+        # @param Caller: 调用方信息
+        # @type Caller: :class:`Tencentcloud::Ess.v20201111.models.Caller`
         # @param FileInfos: 上传文件内容数组，最多支持20个文件
         # @type FileInfos: Array
         # @param FileUrls: 上传文件链接数组，最多支持20个URL
         # @type FileUrls: String
-        # @param CoverRect: 是否将pdf灰色矩阵置白
+        # @param CoverRect: 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
         # true--是，处理置白
         # false--否，不处理
         # @type CoverRect: Boolean
-        # @param FileType: 特殊文件类型需要指定文件类型：
-        # HTML-- .html文件
+        # @param FileType: 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
+        # 如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
         # @type FileType: String
         # @param CustomIds: 用户自定义ID数组，与上传文件一一对应
         # @type CustomIds: Array
 
-        attr_accessor :Caller, :BusinessType, :FileInfos, :FileUrls, :CoverRect, :FileType, :CustomIds
+        attr_accessor :BusinessType, :Caller, :FileInfos, :FileUrls, :CoverRect, :FileType, :CustomIds
         
-        def initialize(caller=nil, businesstype=nil, fileinfos=nil, fileurls=nil, coverrect=nil, filetype=nil, customids=nil)
-          @Caller = caller
+        def initialize(businesstype=nil, caller=nil, fileinfos=nil, fileurls=nil, coverrect=nil, filetype=nil, customids=nil)
           @BusinessType = businesstype
+          @Caller = caller
           @FileInfos = fileinfos
           @FileUrls = fileurls
           @CoverRect = coverrect
@@ -1587,11 +1584,11 @@ module TencentCloud
         end
 
         def deserialize(params)
+          @BusinessType = params['BusinessType']
           unless params['Caller'].nil?
             @Caller = Caller.new
             @Caller.deserialize(params['Caller'])
           end
-          @BusinessType = params['BusinessType']
           unless params['FileInfos'].nil?
             @FileInfos = []
             params['FileInfos'].each do |i|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 1.0.347
+  version: 1.0.348
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common