tencentcloud-sdk-ess 3.0.817 → 3.0.819

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0dcf5afe33c36f84fcb97086e81aaf50a3d9ef8
-  data.tar.gz: b5753758c673051d7681367cc47f1b09a8c8ae36
+  metadata.gz: 31e00ece6eb52e5e1b305661e0c84b3a73e0a035
+  data.tar.gz: 367044d5c26ffc8b05f95b5708753f7ff95723cf
 SHA512:
-  metadata.gz: 5c846efce8ca0a42b099200b895a83e87fd6d2d4d215c30de2d4ac800862a15787b56041d862b52c1a6a3b59470df6fff230dfc8b38e8045a4978564f3502ed9
-  data.tar.gz: 8ff9fd89f0ed4f93d2888bcc8f1a7a4c5123540685c7bb6bce944e281da7e70b74dc77aa31f0e3b642ce7a4919423df87a7e6a1c7a484ee3fdd0d18ff1eb58cc
+  metadata.gz: 9150cfc2684d03e773f3f39bc809a0831a53ffc72bf53da0a9a3498e34a6db10355338c7cc918eb9e04cd761e218d0384342c66565fb84eb6d395d6e33715479
+  data.tar.gz: d7dbdb645c01ec7f880f55712924d97b7ea555d00f4ab203144ae5c6324d8250e45293da75c6bc144c407abff03b74d85b2420c2051b80beb8cf26cd26c18f6c

data/lib/VERSION

@@ -1 +1 @@
-3.0.817
+3.0.819

data/lib/v20201111/client.rb

@@ -882,7 +882,7 @@ module TencentCloud
         # <tr>
         # <td>普通saas员工</td>
         # <td>将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号</td>
-        # <td>发送短信通知员工（短信中带有认证加入企业的链接）   ![image]() </td>
+        # <td>发送短信通知员工（短信中带有认证加入企业的链接）  </td>
         # </tr>
         # <tr>
         # <td>企微员工</td>
@@ -1233,7 +1233,7 @@ module TencentCloud
         # <li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>
         # <li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
         # <li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>
-        # <li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li>
+        # <li>在解除协议签署完毕后，原合同及解除协议均变为已解除状态。</li>
         # <li>非原合同企业参与人发起解除协议时，需要有<code>解除合同的权限</code>。</li>
         # </ul>
 
@@ -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签署界面都会使用此配置进行展示。
 
         # 如果多次调用，会以最后一次的配置为准
@@ -2154,6 +2182,31 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 用于客户企业在调用生成[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口之前判断C端用户是否实名，如果已经实名，就不需要再次调用生成C端链接接口去实名
+        # 注意：此接口仅会返回当前员工是否通过[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)所实名的员工是否实名，并不会返回个人用户自己在电子签进行实名的状况
+
+        # @param request: Request instance for DescribeUserVerifyStatus.
+        # @type request: :class:`Tencentcloud::ess::V20201111::DescribeUserVerifyStatusRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeUserVerifyStatusResponse`
+        def DescribeUserVerifyStatus(request)
+          body = send_request('DescribeUserVerifyStatus', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeUserVerifyStatusResponse.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
+
         # 通过此接口可以关闭个人用户自动签功能。
         # 无需对应的用户刷脸等方式同意即可关闭。
 

data/lib/v20201111/models.rb

@@ -1115,7 +1115,8 @@ module TencentCloud
         # <li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>
 
         # <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式
-        # <ul><li> <b>HANDWRITE</b> : 手写签名</li>
+        # <ul><li> <b>HANDWRITE</b> :  需要实时手写的手写签名</li>
+        # <li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
         # <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
         # <li> <b>ESIGN</b> : 个人印章类型</li>
         # <li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>
@@ -1284,7 +1285,8 @@ module TencentCloud
 
         # 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
 
-        # <ul><li>HANDWRITE : 手写签名</li>
+        # <ul><li>HANDWRITE : 需要实时手写的手写签名</li>
+        # <li>HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
         # <li>OCR_ESIGN : OCR印章（智慧手写签名）</li>
         # <li>ESIGN : 个人印章</li>
         # <li>SYSTEM_ESIGN : 系统印章</li></ul>
@@ -5100,6 +5102,109 @@ 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或者小程序跳转适合此类型
+
+        # 如果不传递，默认值是 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，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回
+        # @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: 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
@@ -7206,6 +7311,54 @@ module TencentCloud
         end
       end
 
+      # DescribeUserVerifyStatus请求参数结构体
+      class DescribeUserVerifyStatusRequest < 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
+
+        attr_accessor :Operator, :Name, :IdCardNumber
+
+        def initialize(operator=nil, name=nil, idcardnumber=nil)
+          @Operator = operator
+          @Name = name
+          @IdCardNumber = idcardnumber
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @Name = params['Name']
+          @IdCardNumber = params['IdCardNumber']
+        end
+      end
+
+      # DescribeUserVerifyStatus返回参数结构体
+      class DescribeUserVerifyStatusResponse < TencentCloud::Common::AbstractModel
+        # @param VerifyStatus: true:表示已实名
+        # false：表示未实名
+        # @type VerifyStatus: Boolean
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :VerifyStatus, :RequestId
+
+        def initialize(verifystatus=nil, requestid=nil)
+          @VerifyStatus = verifystatus
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @VerifyStatus = params['VerifyStatus']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 视频认证结果
       class DetectInfoVideoData < TencentCloud::Common::AbstractModel
         # @param LiveNessVideo: 活体视频的base64编码，mp4格式
@@ -8046,7 +8199,8 @@ module TencentCloud
         # @type Components: Array
         # @param ComponentLimitType: 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
 
-        # <ul><li> <b>HANDWRITE</b> :手写签名。</li>
+        # <ul><li> <b>HANDWRITE</b> :需要实时手写的手写签名。</li>
+        # <li> <b>HANDWRITTEN_ESIGN</b> :长效手写签名， 是使用保存到个人中心的印章列表的手写签名。(并且包含HANDWRITE)</li>
         # <li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
         # <li> <b>ESIGN</b> :个人印章类型。</li>
         # <li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>

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.819
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-12 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: