tencentcloud-sdk-essbasic 3.0.431 → 3.0.433

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b3a37665b077d5d6e88ffd99fede6b0cc3f7f9
-  data.tar.gz: 91c0457a22d7d0eb7437c593b884c3ebc3bc7663
+  metadata.gz: b178478ea43c21dbde94a8bed6341339528559fa
+  data.tar.gz: 28e4fef563cee69a27be49f549cb48316096819e
 SHA512:
-  metadata.gz: 8c6893ff25805966bfdcbb620df2236160607b788f934656e65f3e85845397f8843096e331253197660a36f9268d7369e748549c006a6356e0c6efa2400f37fd
-  data.tar.gz: de89e2e043dc9b22e48cda044c9eb2414cc50eb00eedfd1e1879166af6d3a9c9fc0a8e8c7b3dbe28d614184f417be532fdc20b87bc70d2917597097a550d318c
+  metadata.gz: 9dbd7b8f159081d0ea37edafac6e901e6d3f11d6c516c01a19d53a86db0f44d9d0ecf8998cc0b75347836055c2d86fd2d8719bd01c8d111783ca0fbbd397fc23
+  data.tar.gz: fa540b373ebd4b9daf9e2bf8861ee9362d91c6abff99719bb718c8bd7c99eed3a9630cadc336ea067f84590c145048f12700374ae1b4cd5d34460841b4b2a06f

data/lib/VERSION

@@ -1 +1 @@
-3.0.431
+3.0.433

data/lib/v20210526/client.rb

@@ -308,6 +308,7 @@ module TencentCloud
         # 若子客企业未激活，会进入企业激活流程,首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）
         # 若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。
         # 若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
+        # 返回的Url仅支持PC端操作。
 
         # @param request: Request instance for CreateConsoleLoginUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlRequest`
@@ -332,6 +333,7 @@ module TencentCloud
         end
 
         # 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
+        # 合同发起人必须在电子签已经进行实名。
 
         # @param request: Request instance for CreateFlowsByTemplates.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateFlowsByTemplatesRequest`
@@ -355,7 +357,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
+        # 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，请联系运营/客服咨询相关流程
 
         # @param request: Request instance for CreateSealByImage.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateSealByImageRequest`
@@ -379,7 +381,23 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
+        # 创建跳转小程序查看或签署的链接。
+
+        # 跳转小程序的几种方式：主要是设置不同的EndPoint
+        # 1. 通过链接Url直接跳转到小程序，不需要返回
+        # 设置EndPoint为WEIXINAPP，得到链接打开即可。（与短信提醒用户签署形式一样）。
+        # 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
+        # 设置EndPoint为CHANNEL，指定JumpUrl，得到链接打开即可。
+        # 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
+        # 跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
+        # 全屏方式：
+        # （https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
+        # 半屏方式：
+        # （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`
@@ -427,7 +445,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
+        # 根据签署流程信息批量获取资源下载链接，可以下载签署中、签署完的合同，需合作企业先进行授权。
+        # 此接口直接返回下载的资源的url，与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
 
         # @param request: Request instance for DescribeResourceUrlsByFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeResourceUrlsByFlowsRequest`
@@ -555,7 +574,7 @@ module TencentCloud
 
         # 该接口 (PrepareFlows) 用于创建待发起文件
         # 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-        # 目前该接口只支持B2C，不建议使用。
+        # 目前该接口只支持B2C，不建议使用，将会废弃。
 
         # @param request: Request instance for PrepareFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::PrepareFlowsRequest`

data/lib/v20210526/models.rb

@@ -576,27 +576,30 @@ module TencentCloud
         # @type FlowEffectiveDay: Integer
         # @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
         # @type QrEffectiveDay: Integer
+        # @param Restrictions: 限制二维码用户条件
+        # @type Restrictions: Array
         # @param CallbackUrl: 回调地址，最大长度1000个字符
         # 不传默认使用渠道应用号配置的回调地址
         # 回调时机:用户通过签署二维码发起合同时，企业额度不足导致失败
         # @type CallbackUrl: String
-        # @param ApproverRestrictions: 限制二维码用户条件
-        # @type ApproverRestrictions: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverRestriction`
         # @param Operator: 用户信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param ApproverRestrictions: 限制二维码用户条件（已弃用）
+        # @type ApproverRestrictions: :class:`Tencentcloud::Essbasic.v20210526.models.ApproverRestriction`
 
-        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :CallbackUrl, :ApproverRestrictions, :Operator
+        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :CallbackUrl, :Operator, :ApproverRestrictions
         
-        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, callbackurl=nil, approverrestrictions=nil, operator=nil)
+        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, callbackurl=nil, operator=nil, approverrestrictions=nil)
           @Agent = agent
           @TemplateId = templateid
           @FlowName = flowname
           @MaxFlowNum = maxflownum
           @FlowEffectiveDay = floweffectiveday
           @QrEffectiveDay = qreffectiveday
+          @Restrictions = restrictions
           @CallbackUrl = callbackurl
-          @ApproverRestrictions = approverrestrictions
           @Operator = operator
+          @ApproverRestrictions = approverrestrictions
         end
 
         def deserialize(params)
@@ -609,15 +612,23 @@ module TencentCloud
           @MaxFlowNum = params['MaxFlowNum']
           @FlowEffectiveDay = params['FlowEffectiveDay']
           @QrEffectiveDay = params['QrEffectiveDay']
-          @CallbackUrl = params['CallbackUrl']
-          unless params['ApproverRestrictions'].nil?
-            @ApproverRestrictions = ApproverRestriction.new
-            @ApproverRestrictions.deserialize(params['ApproverRestrictions'])
+          unless params['Restrictions'].nil?
+            @Restrictions = []
+            params['Restrictions'].each do |i|
+              approverrestriction_tmp = ApproverRestriction.new
+              approverrestriction_tmp.deserialize(i)
+              @Restrictions << approverrestriction_tmp
+            end
           end
+          @CallbackUrl = params['CallbackUrl']
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          unless params['ApproverRestrictions'].nil?
+            @ApproverRestrictions = ApproverRestriction.new
+            @ApproverRestrictions.deserialize(params['ApproverRestrictions'])
+          end
         end
       end
 
@@ -886,6 +897,13 @@ module TencentCloud
       end
 
       # 此结构体 (Component) 用于描述控件属性。
+
+      # 在通过文件发起合同时，对应的component有三种定位方式
+      # 1. 绝对定位方式
+      # 2. 表单域(FIELD)定位方式
+      # 3. 关键字(KEYWORD)定位方式
+      # 可以参考官网说明
+      # https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
       class Component < TencentCloud::Common::AbstractModel
         # @param ComponentId: 控件编号
 
@@ -942,7 +960,10 @@ module TencentCloud
         # @type ComponentPosY: Float
         # @param ComponentExtra: 参数控件样式，json格式表述
         # 不同类型的控件会有部分非通用参数
-        # TEXT控件可以指定字体
+        # TEXT/MULTI_LINE_TEXT控件可以指定
+        # 1 Font：目前只支持黑体、宋体
+        # 2 FontSize： 范围12-72
+        # 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐
         # 例如：{"FontSize":12}
         # @type ComponentExtra: String
         # @param ComponentValue: 控件填充vaule，ComponentType和传入值类型对应关系：
@@ -1066,9 +1087,11 @@ module TencentCloud
 
       # CreateConsoleLoginUrl返回参数结构体
       class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
-        # @param ConsoleUrl: 子客Web控制台url，此链接5分钟内有效，且只能访问一次
+        # @param ConsoleUrl: 子客Web控制台url，此链接5分钟内有效，且只能访问一次。同时需要注意：
+        # 1. 此链接仅单次有效，使用后需要再次创建新的链接（部分聊天软件，如企业微信默认会对链接进行解析，此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接）；
+        # 2. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
         # @type ConsoleUrl: String
-        # @param IsActivated: 渠道子客企业是否已开通腾讯电子签。
+        # @param IsActivated: 渠道子客企业是否已开通腾讯电子签
         # @type IsActivated: Boolean
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -1094,7 +1117,7 @@ module TencentCloud
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowInfos: 多个合同（签署流程）信息，最多支持20个
         # @type FlowInfos: Array
-        # @param NeedPreview: 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，则返回PreviewUrls；
+        # @param NeedPreview: 是否为预览模式；默认为false，即非预览模式，此时发起合同并返回FlowIds；若为预览模式，不会发起合同，会返回PreviewUrls（此Url返回的是PDF文件流 ）；
         # 预览链接有效期300秒；
         # @type NeedPreview: Boolean
         # @param Operator: 操作者的信息
@@ -1239,7 +1262,7 @@ module TencentCloud
         # @param Endpoint: 签署链接类型：“WEIXINAPP”-短链直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；"LONGURL2WEIXINAPP"-长链接跳转小程序；默认“WEIXINAPP”类型，即跳转至小程序；
         # @type Endpoint: String
         # @param GenerateType: 签署链接生成类型，默认是 "ALL"；
-        # "ALL"：全部签署方签署链接；
+        # "ALL"：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接；
         # "CHANNEL"：渠道合作企业；
         # "NOT_CHANNEL"：非渠道合作企业；
         # "PERSON"：个人；
@@ -1443,7 +1466,7 @@ module TencentCloud
         # @param Agent: 渠道应用相关信息。
         # 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowIds: 查询资源所对应的签署流程Id，最多支持50个。
+        # @param FlowIds: 查询资源所对应的签署流程Id，最多支持50个
         # @type FlowIds: Array
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1772,7 +1795,17 @@ module TencentCloud
         end
       end
 
-      # 创建签署流程签署人入参
+      # 创建签署流程签署人入参。
+
+      # 其中签署方FlowApproverInfo需要传递的参数
+      # 非单C、单B、B2C合同，ApproverType、RecipientId（模版发起合同时）必传，建议都传。其他身份标识
+      # 1-个人：Name、Mobile必传
+      # 2-渠道子客企业指定经办人：OpenId必传，OrgName必传、OrgOpenId必传；
+      # 3-渠道合作企业不指定经办人：（暂不支持）
+      # 4-非渠道合作企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。
+
+      # RecipientId参数：
+      # 从DescribeTemplates接口中，可以得到模版下的签署方Recipient列表，根据模版自定义的Rolename在此结构体中确定其RecipientId
       class FlowApproverInfo < TencentCloud::Common::AbstractModel
         # @param Name: 签署人姓名，最大长度50个字符
         # @type Name: String
@@ -2659,10 +2692,10 @@ module TencentCloud
 
       # 签署链接内容
       class SignUrlInfo < TencentCloud::Common::AbstractModel
-        # @param SignUrl: 签署链接
+        # @param SignUrl: 签署链接，过期时间为30天
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SignUrl: String
-        # @param Deadline: 链接失效时间,默认30分钟
+        # @param Deadline: 合同过期时间
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Deadline: Integer
         # @param SignOrder: 当流程为顺序签署此参数有效时，数字越小优先级越高，暂不支持并行签署 可选

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.431
+  version: 3.0.433
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common