tencentcloud-sdk-essbasic 3.0.525 → 3.0.527

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd4cb655e564580e510495164f27857b63753d7a
-  data.tar.gz: b2830d746868939a1a9cf35912b99035451beba2
+  metadata.gz: 75d1f77c792007e5c2a30f7547d90e40696bea27
+  data.tar.gz: 3cef2eeeb8fccd397b77cca5a774dcff643804f1
 SHA512:
-  metadata.gz: 79b8035f33f1e2903543096f6094d56db194bdbb0fb17042846b25cbbd7c49bc01ce5b6125b594dd0aab4c8f3d0b1150bb1c7f058648f6caa00477c697f594b5
-  data.tar.gz: ab031cc8ca48f5aebfbad1671221dd17c81a076e33db73c9780c10850d716c87e5aefdb686d682b9819d42d32859eb1692a3f36156f3c98c210b6b0ad09126ae
+  metadata.gz: 97fad9203f54506e1cb41a0d6b7f671a4c84139342d589e5c1903b9e066182d64a212528269e983e28196c7c3eae6c81c46894e81ccc14c5b5d5694f44c2f57e
+  data.tar.gz: d88d74e1232e3533d46ffa6ec711ef636a62bb22e66963b07f46378cf8d3253490aa2b28843aa2f4c45b9b4fe4778a20378ebd0d4fd837612ac580061dce8e6f

data/lib/VERSION

@@ -1 +1 @@
-3.0.525
+3.0.527

data/lib/v20210526/client.rb

@@ -184,6 +184,8 @@ module TencentCloud
         end
 
         # 本接口（ChannelCreateEmbedWebUrl）用于创建嵌入web的链接
+        # 本接口支持创建：创建印章，创建模版，修改模版，预览模版，预览合同流程的web链接
+        # 进入web连接后与当前控制台操作保持一致
 
         # @param request: Request instance for ChannelCreateEmbedWebUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateEmbedWebUrlRequest`
@@ -207,7 +209,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 接口（ChannelCreateFlowByFiles）用于通过文件创建签署流程。此接口静默签能力不可直接使用，需要运营申请
+        # 接口（ChannelCreateFlowByFiles）用于通过文件创建签署流程。此接口静默签能力不可直接使用，请联系客户经理申请使用
 
         # @param request: Request instance for ChannelCreateFlowByFiles.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowByFilesRequest`
@@ -257,7 +259,7 @@ module TencentCloud
 
         # 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
         # 注意:
-        # 该接口不可直接调用，请联系电子签运营开通后方可调用。
+        # 该接口不可直接调用，请联系客户经理申请使用
 
         # @param request: Request instance for ChannelCreateFlowReminds.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowRemindsRequest`
@@ -308,7 +310,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建签署链接，需要联系运营人员开白后才可使用
+        # 创建签署链接，请联系客户经理申请使用
+        # 该接口用于发起合同后，生成C端签署人的签署链接，点击跳转小程序完成签署
+        # 注意：该接口目前签署人类型仅支持个人签署方（PERSON）
+        # 注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
 
         # @param request: Request instance for ChannelCreateFlowSignUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
@@ -358,6 +363,10 @@ module TencentCloud
         end
 
         # 创建预发起合同
+        # 通过此接口指定：合同，签署人，填写控件信息，生成预创建合同链接，点击后跳转到web页面完成合同创建并发起
+        # 可指定合同信息不可更改，签署人信息不可更改
+        # 合同发起后，填写及签署流程与现有操作流程一致
+        # 注意：目前仅支持模版发起
 
         # @param request: Request instance for ChannelCreatePrepareFlow.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreatePrepareFlowRequest`
@@ -682,9 +691,17 @@ module TencentCloud
         # 跳转小程序的几种方式：主要是设置不同的EndPoint
         # 1. 通过链接Url直接跳转到小程序，不需要返回
         # 设置EndPoint为WEIXINAPP，得到链接打开即可。（与短信提醒用户签署形式一样）。
+
         # 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
         # 设置EndPoint为CHANNEL，指定JumpUrl，得到链接打开即可。
+
         # 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
+        # 跳转到小程序的实现，参考官方文档
+        # https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
+        # 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+        # 使用CreateSignUrls，设置EndPoint为APP，得到path。
+
+        # 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
         # 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
         # 全屏方式：
         # （https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
@@ -692,8 +709,6 @@ module TencentCloud
         # （https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
         # 其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
         # 使用CreateSignUrls，设置EndPoint为APP，得到path。
-        # 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
-        # 实现方式同App跳小程序。
 
         # @param request: Request instance for CreateSignUrls.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSignUrlsRequest`
@@ -1016,6 +1031,7 @@ module TencentCloud
         end
 
         # 此接口（UploadFiles）用于文件上传。
+        # 其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。
         # 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。
         # 代码示例：
         # HttpProfile httpProfile = new HttpProfile();

data/lib/v20210526/models.rb

@@ -195,15 +195,33 @@ module TencentCloud
       class CcInfo < TencentCloud::Common::AbstractModel
         # @param Mobile: 被抄送人手机号，大陆11位手机号
         # @type Mobile: String
+        # @param Name: 被抄送人姓名
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Name: String
+        # @param CcType: 被抄送人类型
+        # 0--个人. 1--员工
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CcType: Integer
+        # @param CcPermission: 被抄送人权限
+        # 0--可查看
+        # 1--可查看也可下载
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CcPermission: Integer
 
-        attr_accessor :Mobile
+        attr_accessor :Mobile, :Name, :CcType, :CcPermission
         
-        def initialize(mobile=nil)
+        def initialize(mobile=nil, name=nil, cctype=nil, ccpermission=nil)
           @Mobile = mobile
+          @Name = name
+          @CcType = cctype
+          @CcPermission = ccpermission
         end
 
         def deserialize(params)
           @Mobile = params['Mobile']
+          @Name = params['Name']
+          @CcType = params['CcType']
+          @CcPermission = params['CcPermission']
         end
       end
 
@@ -607,7 +625,7 @@ module TencentCloud
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowName: 签署流程名称，长度不超过200个字符
         # @type FlowName: String
-        # @param FlowApprovers: 签署流程签约方列表，最多不超过5个参与方
+        # @param FlowApprovers: 签署流程签约方列表，最多不超过50个参与方
         # @type FlowApprovers: Array
         # @param FileIds: 签署文件资源Id列表，目前仅支持单个文件
         # @type FileIds: Array
@@ -638,10 +656,14 @@ module TencentCloud
         # @type SignBeanTag: Integer
         # @param Operator: 操作者的信息，不用传
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param CcInfos: 被抄送人信息列表
+        # @type CcInfos: Array
+        # @param CcNotifyType: 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
+        # @type CcNotifyType: Integer
 
-        attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :Operator
+        attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :Operator, :CcInfos, :CcNotifyType
         
-        def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, operator=nil)
+        def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, operator=nil, ccinfos=nil, ccnotifytype=nil)
           @Agent = agent
           @FlowName = flowname
           @FlowApprovers = flowapprovers
@@ -658,6 +680,8 @@ module TencentCloud
           @ApproverVerifyType = approververifytype
           @SignBeanTag = signbeantag
           @Operator = operator
+          @CcInfos = ccinfos
+          @CcNotifyType = ccnotifytype
         end
 
         def deserialize(params)
@@ -697,6 +721,15 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          unless params['CcInfos'].nil?
+            @CcInfos = []
+            params['CcInfos'].each do |i|
+              ccinfo_tmp = CcInfo.new
+              ccinfo_tmp.deserialize(i)
+              @CcInfos << ccinfo_tmp
+            end
+          end
+          @CcNotifyType = params['CcNotifyType']
         end
       end
 
@@ -1784,6 +1817,7 @@ module TencentCloud
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverMobile: String
         # @param RecipientId: 签署人Id，使用模版发起是，对应模版配置中的签署人RecipientId
+        # 注意：模版发起时该字段必填
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type RecipientId: String
         # @param PreReadTime: 签署前置条件：阅读时长限制，不传默认10s,最大300s，最小3s
@@ -3516,10 +3550,12 @@ module TencentCloud
 
         # 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
         # @type NeedSignReview: Boolean
+        # @param CcNotifyType: 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
+        # @type CcNotifyType: Integer
 
-        attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos, :NeedSignReview
+        attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos, :NeedSignReview, :CcNotifyType
         
-        def initialize(flowname=nil, deadline=nil, templateid=nil, flowapprovers=nil, formfields=nil, callbackurl=nil, flowtype=nil, flowdescription=nil, customerdata=nil, customshowmap=nil, ccinfos=nil, needsignreview=nil)
+        def initialize(flowname=nil, deadline=nil, templateid=nil, flowapprovers=nil, formfields=nil, callbackurl=nil, flowtype=nil, flowdescription=nil, customerdata=nil, customshowmap=nil, ccinfos=nil, needsignreview=nil, ccnotifytype=nil)
           @FlowName = flowname
           @Deadline = deadline
           @TemplateId = templateid
@@ -3532,6 +3568,7 @@ module TencentCloud
           @CustomShowMap = customshowmap
           @CcInfos = ccinfos
           @NeedSignReview = needsignreview
+          @CcNotifyType = ccnotifytype
         end
 
         def deserialize(params)
@@ -3568,6 +3605,7 @@ module TencentCloud
             end
           end
           @NeedSignReview = params['NeedSignReview']
+          @CcNotifyType = params['CcNotifyType']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.525
+  version: 3.0.527
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common