tencentcloud-sdk-ess 3.0.775 → 3.0.777

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a6048bd98d371b752a1aa5ce0193ffb54200dc6
-  data.tar.gz: 0255c55529936e66bd154a26a07d7f6bc4f94955
+  metadata.gz: eed493dc886ca750e73b56bb62a37a9eb997b451
+  data.tar.gz: 695b8353448d7c00a6b12847b7b858041e7dcd6a
 SHA512:
-  metadata.gz: 6c7fa87ebf8fed76c17439b380971742c121f752ec3e34b404d16bae3b56f05d4e3364b8d130cdd0a11590b8a96814e91939cecdddd58289bf6418c30617735d
-  data.tar.gz: 53c8948d9fe18febc0ccd5458a634ee54d86897dec5a5d320534a91ba6b4cf5760367098c19b7c87234f5d46e3f360fa77e104d57fef6cd1170809ba42ea6cff
+  metadata.gz: c74b1247fa10615de75e1fd1f7aef2492bdd2ad04c046e96a1f388eefdc75ed359cd54bdb2e5e63e7d9c7d2dc51f43e2c399304c173bc8185f21a1aa74988d5d
+  data.tar.gz: b317b9c51680230c35d1341c3aeb35250ae368bf508dedcce43433a5b29734151ce65621b3d4a43dca07a807276b60674acba2d5f6a4e75e74b2492860b0b2d3

data/lib/VERSION

@@ -1 +1 @@
-3.0.775
+3.0.777

data/lib/v20201111/client.rb

@@ -1888,6 +1888,36 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
+
+        # 1. 该接口**仅适用于在H5端签署**的合同，**在通过视频认证后**获取人脸图片。
+        # 2. 该接口**不支持小程序端**的签署人脸图片获取。
+        # 3. 请在**签署完成后的三天内**获取人脸图片，**过期后将无法获取**。
+
+        # **注意：该接口需要开通白名单，请联系客户经理开通后使用。**
+
+        # @param request: Request instance for DescribeSignFaceVideo.
+        # @type request: :class:`Tencentcloud::ess::V20201111::DescribeSignFaceVideoRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeSignFaceVideoResponse`
+        def DescribeSignFaceVideo(request)
+          body = send_request('DescribeSignFaceVideo', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeSignFaceVideoResponse.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
+
         # 通过AuthCode查询个人用户是否实名
 
 

data/lib/v20201111/models.rb

@@ -2038,6 +2038,8 @@ module TencentCloud
         # @param FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
         # @type FlowDescription: String
         # @param FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
+        # 如果用户已经在控制台创建了自定义合同类型，可以将这里的类型名称传入。 如果没有创建，我们会自动给发起方公司创建此自定义合同类型。
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
         # @type FlowType: String
         # @param Components: 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
         # <ul><li> 单行文本控件      </li>
@@ -2706,6 +2708,7 @@ module TencentCloud
         # @param FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
         # @type FlowDescription: String
         # @param FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
+        # 此合同类型需要跟模板配置的合同类型保持一致。
         # @type FlowType: String
         # @param ClientToken: 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
         # @type ClientToken: String
@@ -6354,6 +6357,81 @@ module TencentCloud
         end
       end
 
+      # DescribeSignFaceVideo请求参数结构体
+      class DescribeSignFaceVideoRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # @type FlowId: String
+        # @param SignId: 签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
+        # @type SignId: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :FlowId, :SignId, :Agent
+
+        def initialize(operator=nil, flowid=nil, signid=nil, agent=nil)
+          @Operator = operator
+          @FlowId = flowid
+          @SignId = signid
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @FlowId = params['FlowId']
+          @SignId = params['SignId']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # DescribeSignFaceVideo返回参数结构体
+      class DescribeSignFaceVideoResponse < TencentCloud::Common::AbstractModel
+        # @param VideoData: 核身视频结果。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type VideoData: :class:`Tencentcloud::Ess.v20201111.models.DetectInfoVideoData`
+        # @param IntentionQuestionResult: 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type IntentionQuestionResult: :class:`Tencentcloud::Ess.v20201111.models.IntentionQuestionResult`
+        # @param IntentionActionResult: 意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type IntentionActionResult: :class:`Tencentcloud::Ess.v20201111.models.IntentionActionResult`
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :VideoData, :IntentionQuestionResult, :IntentionActionResult, :RequestId
+
+        def initialize(videodata=nil, intentionquestionresult=nil, intentionactionresult=nil, requestid=nil)
+          @VideoData = videodata
+          @IntentionQuestionResult = intentionquestionresult
+          @IntentionActionResult = intentionactionresult
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['VideoData'].nil?
+            @VideoData = DetectInfoVideoData.new
+            @VideoData.deserialize(params['VideoData'])
+          end
+          unless params['IntentionQuestionResult'].nil?
+            @IntentionQuestionResult = IntentionQuestionResult.new
+            @IntentionQuestionResult.deserialize(params['IntentionQuestionResult'])
+          end
+          unless params['IntentionActionResult'].nil?
+            @IntentionActionResult = IntentionActionResult.new
+            @IntentionActionResult.deserialize(params['IntentionActionResult'])
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeThirdPartyAuthCode请求参数结构体
       class DescribeThirdPartyAuthCodeRequest < TencentCloud::Common::AbstractModel
         # @param AuthCode: 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。
@@ -6487,6 +6565,25 @@ module TencentCloud
         end
       end
 
+      # 视频认证结果
+      class DetectInfoVideoData < TencentCloud::Common::AbstractModel
+        # @param LiveNessVideo: 活体视频的base64编码，mp4格式
+
+        # 注:`需进行base64解码获取活体视频文件`
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type LiveNessVideo: String
+
+        attr_accessor :LiveNessVideo
+
+        def initialize(livenessvideo=nil)
+          @LiveNessVideo = livenessvideo
+        end
+
+        def deserialize(params)
+          @LiveNessVideo = params['LiveNessVideo']
+        end
+      end
+
       # DisableUserAutoSign请求参数结构体
       class DisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -7267,13 +7364,19 @@ module TencentCloud
 
         # 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
         # @type Deadline: Integer
+        # @param Intention: 视频核身意图配置，可指定问答模式或者点头模式的语音文本。
+
+        # 注:
+        #  `1.视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
+        # `2.使用视频认证必须指定签署认证方式为人脸（即ApproverSignTypes）。`
+        # @type Intention: :class:`Tencentcloud::Ess.v20201111.models.Intention`
 
-        attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes, :SignTypeSelector, :Deadline
+        attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes, :SignTypeSelector, :Deadline, :Intention
         extend Gem::Deprecate
         deprecate :JumpUrl, :none, 2024, 3
         deprecate :JumpUrl=, :none, 2024, 3
 
-        def initialize(approvertype=nil, organizationname=nil, approvername=nil, approvermobile=nil, approveridcardtype=nil, approveridcardnumber=nil, recipientid=nil, verifychannel=nil, notifytype=nil, isfulltext=nil, prereadtime=nil, userid=nil, required=nil, approversource=nil, customapprovertag=nil, registerinfo=nil, approveroption=nil, jumpurl=nil, signid=nil, approverneedsignreview=nil, signcomponents=nil, components=nil, componentlimittype=nil, approververifytypes=nil, approversigntypes=nil, signtypeselector=nil, deadline=nil)
+        def initialize(approvertype=nil, organizationname=nil, approvername=nil, approvermobile=nil, approveridcardtype=nil, approveridcardnumber=nil, recipientid=nil, verifychannel=nil, notifytype=nil, isfulltext=nil, prereadtime=nil, userid=nil, required=nil, approversource=nil, customapprovertag=nil, registerinfo=nil, approveroption=nil, jumpurl=nil, signid=nil, approverneedsignreview=nil, signcomponents=nil, components=nil, componentlimittype=nil, approververifytypes=nil, approversigntypes=nil, signtypeselector=nil, deadline=nil, intention=nil)
           @ApproverType = approvertype
           @OrganizationName = organizationname
           @ApproverName = approvername
@@ -7301,6 +7404,7 @@ module TencentCloud
           @ApproverSignTypes = approversigntypes
           @SignTypeSelector = signtypeselector
           @Deadline = deadline
+          @Intention = intention
         end
 
         def deserialize(params)
@@ -7351,6 +7455,10 @@ module TencentCloud
           @ApproverSignTypes = params['ApproverSignTypes']
           @SignTypeSelector = params['SignTypeSelector']
           @Deadline = params['Deadline']
+          unless params['Intention'].nil?
+            @Intention = Intention.new
+            @Intention.deserialize(params['Intention'])
+          end
         end
       end
 
@@ -8185,6 +8293,156 @@ module TencentCloud
         end
       end
 
+      # 视频核身意图配置，可指定问答模式或者点头模式的语音文本。
+
+      # 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
+      class Intention < TencentCloud::Common::AbstractModel
+        # @param IntentionType: 视频认证类型，支持以下类型
+        # <ul><li>1 : 问答模式</li>
+        # <li>2 : 点头模式</li></ul>
+
+        # 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
+        # @type IntentionType: Integer
+        # @param IntentionQuestions: 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
+        # @type IntentionQuestions: Array
+        # @param IntentionActions: 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+        # @type IntentionActions: Array
+
+        attr_accessor :IntentionType, :IntentionQuestions, :IntentionActions
+
+        def initialize(intentiontype=nil, intentionquestions=nil, intentionactions=nil)
+          @IntentionType = intentiontype
+          @IntentionQuestions = intentionquestions
+          @IntentionActions = intentionactions
+        end
+
+        def deserialize(params)
+          @IntentionType = params['IntentionType']
+          unless params['IntentionQuestions'].nil?
+            @IntentionQuestions = []
+            params['IntentionQuestions'].each do |i|
+              intentionquestion_tmp = IntentionQuestion.new
+              intentionquestion_tmp.deserialize(i)
+              @IntentionQuestions << intentionquestion_tmp
+            end
+          end
+          unless params['IntentionActions'].nil?
+            @IntentionActions = []
+            params['IntentionActions'].each do |i|
+              intentionaction_tmp = IntentionAction.new
+              intentionaction_tmp.deserialize(i)
+              @IntentionActions << intentionaction_tmp
+            end
+          end
+        end
+      end
+
+      # 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+      class IntentionAction < TencentCloud::Common::AbstractModel
+        # @param Text: 点头确认模式下，系统语音播报使用的问题文本，问题最大长度为150个字符。
+        # @type Text: String
+
+        attr_accessor :Text
+
+        def initialize(text=nil)
+          @Text = text
+        end
+
+        def deserialize(params)
+          @Text = params['Text']
+        end
+      end
+
+      # 意愿核身点头确认模式结果
+      class IntentionActionResult < TencentCloud::Common::AbstractModel
+        # @param Details: 意愿核身结果详细数据，与每段点头确认过程一一对应
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Details: Array
+
+        attr_accessor :Details
+
+        def initialize(details=nil)
+          @Details = details
+        end
+
+        def deserialize(params)
+          unless params['Details'].nil?
+            @Details = []
+            params['Details'].each do |i|
+              intentionactionresultdetail_tmp = IntentionActionResultDetail.new
+              intentionactionresultdetail_tmp.deserialize(i)
+              @Details << intentionactionresultdetail_tmp
+            end
+          end
+        end
+      end
+
+      # 意愿核身点头确认模式结果详细数据
+      class IntentionActionResultDetail < TencentCloud::Common::AbstractModel
+        # @param Video: 视频base64编码（其中包含全程提示文本和点头音频，mp4格式）
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Video: String
+
+        attr_accessor :Video
+
+        def initialize(video=nil)
+          @Video = video
+        end
+
+        def deserialize(params)
+          @Video = params['Video']
+        end
+      end
+
+      # 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
+      class IntentionQuestion < TencentCloud::Common::AbstractModel
+        # @param Question: 当选择语音问答模式时，系统自动播报的问题文本，最大长度为150个字符。
+        # @type Question: String
+        # @param Answers:  当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表，传入后可自动判断用户回答文本是否在标准文本列表中。
+        # @type Answers: Array
+
+        attr_accessor :Question, :Answers
+
+        def initialize(question=nil, answers=nil)
+          @Question = question
+          @Answers = answers
+        end
+
+        def deserialize(params)
+          @Question = params['Question']
+          @Answers = params['Answers']
+        end
+      end
+
+      # 意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。
+      class IntentionQuestionResult < TencentCloud::Common::AbstractModel
+        # @param Video: 视频base64（其中包含全程问题和回答音频，mp4格式）
+
+        # 注：`需进行base64解码获取视频文件`
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Video: String
+        # @param ResultCode:  和答案匹配结果列表
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ResultCode: Array
+        # @param AsrResult: 回答问题语音识别结果列表
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type AsrResult: Array
+
+        attr_accessor :Video, :ResultCode, :AsrResult
+
+        def initialize(video=nil, resultcode=nil, asrresult=nil)
+          @Video = video
+          @ResultCode = resultcode
+          @AsrResult = asrresult
+        end
+
+        def deserialize(params)
+          @Video = params['Video']
+          @ResultCode = params['ResultCode']
+          @AsrResult = params['AsrResult']
+        end
+      end
+
       # ModifyApplicationCallbackInfo请求参数结构体
       class ModifyApplicationCallbackInfoRequest < 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.775
+  version: 3.0.777
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common