tencentcloud-sdk-ess 3.0.817 → 3.0.818

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0dcf5afe33c36f84fcb97086e81aaf50a3d9ef8
-  data.tar.gz: b5753758c673051d7681367cc47f1b09a8c8ae36
+  metadata.gz: 3684302491352dd15997ea3cafa3c3b9c152ca81
+  data.tar.gz: 65572d9edf7bfb6537f5cb140beba28933c092fa
 SHA512:
-  metadata.gz: 5c846efce8ca0a42b099200b895a83e87fd6d2d4d215c30de2d4ac800862a15787b56041d862b52c1a6a3b59470df6fff230dfc8b38e8045a4978564f3502ed9
-  data.tar.gz: 8ff9fd89f0ed4f93d2888bcc8f1a7a4c5123540685c7bb6bce944e281da7e70b74dc77aa31f0e3b642ce7a4919423df87a7e6a1c7a484ee3fdd0d18ff1eb58cc
+  metadata.gz: 7ea684ab52a52bce0b6e9373b00a5bf0dd4b1dfdb5fd08d2aaea0199bef4217a86a196c726705c9a12ddf1baf2c09fdb13f8e602d36010d3139ea3d65fd0c316
+  data.tar.gz: ce8af88323e754a47d2222c952630e030ce856ba197afdc86aca99e383114b564d5ca2246010722037023ec15f5776d8c4ad04866c2c8daca46442269b962d5d

data/lib/VERSION

@@ -1 +1 @@
-3.0.817
+3.0.818

data/lib/v20201111/client.rb

@@ -1410,6 +1410,34 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 客户可以主动调用生成实名链接去做C端用户实名，会对实名的用户进行打标记为调用链接客户的用户
+        # 使用场景：
+        # 用户集成场景
+        # 使用限制：
+        # 此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估
+
+        # @param request: Request instance for CreateUserVerifyUrl.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateUserVerifyUrlRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateUserVerifyUrlResponse`
+        def CreateUserVerifyUrl(request)
+          body = send_request('CreateUserVerifyUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateUserVerifyUrlResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。
 
         # 如果多次调用，会以最后一次的配置为准

data/lib/v20201111/models.rb

@@ -5100,6 +5100,107 @@ module TencentCloud
         end
       end
 
+      # CreateUserVerifyUrl请求参数结构体
+      class CreateUserVerifyUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 操作人信息
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param Name: 要实名的姓名
+        # @type Name: String
+        # @param IdCardNumber: 要实名的身份证号码，
+        # 身份证号码如果有x的话，统一传大写X
+        # @type IdCardNumber: String
+        # @param IdCardType: 证件类型，目前只支持身份证类型：ID_CARD
+        # @type IdCardType: String
+        # @param Mobile: 要实名的手机号，兼容带+86的格式
+        # @type Mobile: String
+        # @param Endpoint: 要跳转的链接类型
+
+        # - HTTP：
+        # 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型)
+
+        # - HTTP_SHORT_URL：
+        # 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链
+
+        # - APP：
+        # 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
+        # @type Endpoint: String
+        # @param AutoJumpBack: 签署完成后是否自动回跳
+        # <ul><li>false：否, 实名完成不会自动跳转回来(默认)</li><li>true：是, 实名完成会自动跳转回来</li></ul>
+
+        # 注:
+        # 1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的实名链接有效
+        # 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
+        # 3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font>
+        # @type AutoJumpBack: Boolean
+
+        attr_accessor :Operator, :Name, :IdCardNumber, :IdCardType, :Mobile, :Endpoint, :AutoJumpBack
+
+        def initialize(operator=nil, name=nil, idcardnumber=nil, idcardtype=nil, mobile=nil, endpoint=nil, autojumpback=nil)
+          @Operator = operator
+          @Name = name
+          @IdCardNumber = idcardnumber
+          @IdCardType = idcardtype
+          @Mobile = mobile
+          @Endpoint = endpoint
+          @AutoJumpBack = autojumpback
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @Name = params['Name']
+          @IdCardNumber = params['IdCardNumber']
+          @IdCardType = params['IdCardType']
+          @Mobile = params['Mobile']
+          @Endpoint = params['Endpoint']
+          @AutoJumpBack = params['AutoJumpBack']
+        end
+      end
+
+      # CreateUserVerifyUrl返回参数结构体
+      class CreateUserVerifyUrlResponse < TencentCloud::Common::AbstractModel
+        # @param UserVerifyUrl: 腾讯电子签小程序的实名认证链接。
+        # 如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。
+
+        # - 如果EndPoint是APP，
+        # 得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参加接口描述中的"跳转到小程序的实现"
+
+        # - 如果EndPoint是HTTP，
+        # 得到的链接类似于https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d，点击后会跳转到腾讯电子签小程序进行签署
+
+        # - 如果EndPoint是HTTP_SHORT_URL，
+        # 得到的链接类似于https://essurl.cn/2n**42Nd，点击后会跳转到腾讯电子签小程序进行签署
+
+
+        # 注： 生成的链路后面不能再增加参数
+        # 示例值：https://essurl.cn/2n**42Nd
+        # @type UserVerifyUrl: String
+        # @param ExpireTime: 链接过期时间
+        # @type ExpireTime: Integer
+        # @param MiniAppId: 小程序appid，用于半屏拉起电子签小程序
+        # @type MiniAppId: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :UserVerifyUrl, :ExpireTime, :MiniAppId, :RequestId
+
+        def initialize(userverifyurl=nil, expiretime=nil, miniappid=nil, requestid=nil)
+          @UserVerifyUrl = userverifyurl
+          @ExpireTime = expiretime
+          @MiniAppId = miniappid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @UserVerifyUrl = params['UserVerifyUrl']
+          @ExpireTime = params['ExpireTime']
+          @MiniAppId = params['MiniAppId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateWebThemeConfig请求参数结构体
       class CreateWebThemeConfigRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.817
+  version: 3.0.818
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
@@ -33,9 +33,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tencentcloud-sdk-ess.rb
-- lib/v20201111/models.rb
 - lib/v20201111/client.rb
+- lib/v20201111/models.rb
+- lib/tencentcloud-sdk-ess.rb
 - lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
 licenses: