tencentcloud-sdk-ess 3.0.784 → 3.0.786

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d15e1ed0087caab1c7065054fe89666639fc7ca7
-  data.tar.gz: 613d99f18dd01a268ddc415c5bd5b118c5235008
+  metadata.gz: 8cde24a76b73e318b60d4baff2fb12ac1cd5c4d5
+  data.tar.gz: 47dd39010a9e293d602f149c003ee36a805fba8b
 SHA512:
-  metadata.gz: 5ba5e56949e702be72b06dddb576969ff547168b3248baf869de8d98c7e0cc788cfda18da1699d039ac0ad1b913d589d1ade6d7e12fcef3cca33f367b3ef220c
-  data.tar.gz: b760962ab5f5e84169f2a60584805c179f7f48ddfbaeb3ca4a3e5f98d61a0cdb1b68069dcfc242025665804defb244b0840fc499cc0d5b28418eb157845d0b09
+  metadata.gz: 1b51decdf418fd55a9f339d555dcdba43ce90c7a9ea59dc31f3e41469d2f63b7315bd780ceec03ad734836ff4e71632ada8cadf1ce9b54ae53e699c9d1e2a0bb
+  data.tar.gz: 9d02a4f2b18644ba76ef9538cdd57592da5a385446c6c851e12d5f67f176217dc70efffd8178bdafff03a0a4ae2ab24a82e20a08df86a3d59acca4943a15288a

data/lib/VERSION

@@ -1 +1 @@
-3.0.784
+3.0.786

data/lib/v20201111/client.rb

@@ -66,7 +66,7 @@ module TencentCloud
         # 2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
 
-        # 3. <font color='red'>撤销合同会返还合同额度</font>
+        # 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
 
         # 4.  撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
 
@@ -153,13 +153,16 @@ module TencentCloud
         # - **可撤回合同状态**：未全部签署完成
         # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
+        # 批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
+
+
         # 注：
         # 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
 
         # 2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
 
-        # 3. <font color='red'>撤销合同会返还合同额度</font>
+        # 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
 
         # @param request: Request instance for CreateBatchCancelFlowUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`
@@ -530,7 +533,7 @@ module TencentCloud
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
 
         # 注：
-        # -  合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
+        # -  合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
         # - **静默（自动）签署不支持合同签署方存在填写**功能
 
         # @param request: Request instance for CreateFlowByFiles.
@@ -1519,6 +1522,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。
+
+        # @param request: Request instance for DescribeCancelFlowsTask.
+        # @type request: :class:`Tencentcloud::ess::V20201111::DescribeCancelFlowsTaskRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeCancelFlowsTaskResponse`
+        def DescribeCancelFlowsTask(request)
+          body = send_request('DescribeCancelFlowsTask', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeCancelFlowsTaskResponse.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
+
         # 查询企业扩展服务的授权详情（列表），当前支持查询以下内容：
         # 1. 企业自动签（本企业授权、集团企业授权、合作企业授权）
         # 2. 批量签署能力
@@ -2252,7 +2279,7 @@ module TencentCloud
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
 
         # 注：
-        # 1.<font color="red">合同发起后就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
+        # 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
 
         # 2.<font color="red">静默（自动）签署不支持合同签署方存在填写</font>功能
 

data/lib/v20201111/models.rb

@@ -140,7 +140,7 @@ module TencentCloud
         # @type ApproverIdCardType: String
         # @param ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type ApproverIdCardNumber: String
         # @param NotifyType: 通知签署方经办人的方式,  有以下途径:
@@ -764,6 +764,26 @@ module TencentCloud
         end
       end
 
+      # 撤销失败的流程信息
+      class CancelFailureFlow < TencentCloud::Common::AbstractModel
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # @type FlowId: String
+        # @param Reason: 撤销失败原因
+        # @type Reason: String
+
+        attr_accessor :FlowId, :Reason
+
+        def initialize(flowid=nil, reason=nil)
+          @FlowId = flowid
+          @Reason = reason
+        end
+
+        def deserialize(params)
+          @FlowId = params['FlowId']
+          @Reason = params['Reason']
+        end
+      end
+
       # CancelFlow请求参数结构体
       class CancelFlowRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -1310,15 +1330,18 @@ module TencentCloud
 
         # 例如:2023-07-28 17:25:59
         # @type UrlExpireOn: String
+        # @param TaskId: 批量撤销任务编号，为32位字符串，可用于[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl) 或关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
+        # @type TaskId: String
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :BatchCancelFlowUrl, :FailMessages, :UrlExpireOn, :RequestId
+        attr_accessor :BatchCancelFlowUrl, :FailMessages, :UrlExpireOn, :TaskId, :RequestId
 
-        def initialize(batchcancelflowurl=nil, failmessages=nil, urlexpireon=nil, requestid=nil)
+        def initialize(batchcancelflowurl=nil, failmessages=nil, urlexpireon=nil, taskid=nil, requestid=nil)
           @BatchCancelFlowUrl = batchcancelflowurl
           @FailMessages = failmessages
           @UrlExpireOn = urlexpireon
+          @TaskId = taskid
           @RequestId = requestid
         end
 
@@ -1326,6 +1349,7 @@ module TencentCloud
           @BatchCancelFlowUrl = params['BatchCancelFlowUrl']
           @FailMessages = params['FailMessages']
           @UrlExpireOn = params['UrlExpireOn']
+          @TaskId = params['TaskId']
           @RequestId = params['RequestId']
         end
       end
@@ -1465,7 +1489,7 @@ module TencentCloud
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
 
         # 注：`请确保和合同中填入的一致`
@@ -3125,24 +3149,26 @@ module TencentCloud
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param InvitationNotifyType: 员工邀请方式可通过以下方式进行设置：
-
-        # **H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。
-        # **SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。
+        # @param InvitationNotifyType: 员工邀请方式
+        # 可通过以下途径进行设置：
+        # <ul><li>**SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。</li></ul>
         # @type InvitationNotifyType: String
         # @param JumpUrl: 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。
 
         # 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
         # @type JumpUrl: String
+        # @param Endpoint: 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月</li></ul>注意：InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型（InvitationNotifyType）</td><td>Endpoint</td></tr><tr><td>SMS（默认）</td><td>不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递，会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL</td></tr></tbody></table>
+        # @type Endpoint: String
 
-        attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl
+        attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl, :Endpoint
 
-        def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil)
+        def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil, endpoint=nil)
           @Operator = operator
           @Employees = employees
           @Agent = agent
           @InvitationNotifyType = invitationnotifytype
           @JumpUrl = jumpurl
+          @Endpoint = endpoint
         end
 
         def deserialize(params)
@@ -3164,6 +3190,7 @@ module TencentCloud
           end
           @InvitationNotifyType = params['InvitationNotifyType']
           @JumpUrl = params['JumpUrl']
+          @Endpoint = params['Endpoint']
         end
       end
 
@@ -3609,7 +3636,7 @@ module TencentCloud
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
         # @param Agent: 代理企业和员工的信息。
@@ -3876,7 +3903,7 @@ module TencentCloud
         # @type UserName: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
         # @param SealName: 印章名称，长度1-50个字。
@@ -4105,7 +4132,7 @@ module TencentCloud
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母(但“I”、“O”除外)，后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
         # @param EndPoint: 要跳转的链接类型
@@ -5165,6 +5192,80 @@ module TencentCloud
         end
       end
 
+      # DescribeCancelFlowsTask请求参数结构体
+      class DescribeCancelFlowsTaskRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param TaskId: 批量撤销任务编号，为32位字符串，通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
+        # @type TaskId: String
+        # @param Agent: 代理企业和员工的信息。
+        # <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :TaskId, :Agent
+
+        def initialize(operator=nil, taskid=nil, agent=nil)
+          @Operator = operator
+          @TaskId = taskid
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @TaskId = params['TaskId']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # DescribeCancelFlowsTask返回参数结构体
+      class DescribeCancelFlowsTaskResponse < TencentCloud::Common::AbstractModel
+        # @param TaskId: 批量撤销任务编号，为32位字符串，通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
+        # @type TaskId: String
+        # @param TaskStatus: 任务状态，需要关注的状态
+        # <ul><li>**PROCESSING**  - 任务执行中</li>
+        # <li>**END** - 任务处理完成</li>
+        # <li>**TIMEOUT** 任务超时未处理完成，用户未在批量撤销链接有效期内操作</li></ul>
+        # @type TaskStatus: String
+        # @param SuccessFlowIds: 批量撤销成功的签署流程编号
+        # @type SuccessFlowIds: Array
+        # @param FailureFlows: 批量撤销失败的签署流程信息
+        # @type FailureFlows: Array
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :TaskId, :TaskStatus, :SuccessFlowIds, :FailureFlows, :RequestId
+
+        def initialize(taskid=nil, taskstatus=nil, successflowids=nil, failureflows=nil, requestid=nil)
+          @TaskId = taskid
+          @TaskStatus = taskstatus
+          @SuccessFlowIds = successflowids
+          @FailureFlows = failureflows
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+          @TaskStatus = params['TaskStatus']
+          @SuccessFlowIds = params['SuccessFlowIds']
+          unless params['FailureFlows'].nil?
+            @FailureFlows = []
+            params['FailureFlows'].each do |i|
+              cancelfailureflow_tmp = CancelFailureFlow.new
+              cancelfailureflow_tmp.deserialize(i)
+              @FailureFlows << cancelfailureflow_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeExtendedServiceAuthDetail请求参数结构体
       class DescribeExtendedServiceAuthDetailRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -6930,7 +7031,7 @@ module TencentCloud
         # @type ApproverIdCardType: String
         # @param ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
 
         # 注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
@@ -7280,7 +7381,7 @@ module TencentCloud
         # @type ApproverIdCardType: String
         # @param ApproverIdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type ApproverIdCardNumber: String
         # @param RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
@@ -8335,8 +8436,12 @@ module TencentCloud
         # 注: `视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
         # @type IntentionType: Integer
         # @param IntentionQuestions: 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
+
+        # 注：`选择问答模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可语音回复“同意”或“不同意”。`
         # @type IntentionQuestions: Array
         # @param IntentionActions: 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
+
+        # 注：`选择点头模式时，此字段可不传，不传则使用默认语音文本：请问，您是否同意签署本协议？可点头同意。`
         # @type IntentionActions: Array
 
         attr_accessor :IntentionType, :IntentionQuestions, :IntentionActions
@@ -8834,7 +8939,7 @@ module TencentCloud
         # @type ApproverIdCardType: String
         # @param ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type ApproverIdCardNumber: String
         # @param OrganizationName: 组织机构名称。
@@ -9771,8 +9876,8 @@ module TencentCloud
         end
       end
 
-      # 创建员工成功返回的信息
-      # 支持saas/企微/H5端进行加入。
+      # 创建/修改员工成功返回的信息
+      # 现在支持saas/企微/H5端进行加入。
       class SuccessCreateStaffData < TencentCloud::Common::AbstractModel
         # @param DisplayName: 员工名
         # @type DisplayName: String
@@ -9785,9 +9890,7 @@ module TencentCloud
         # @type Note: String
         # @param WeworkOpenId: 传入的企微账号id
         # @type WeworkOpenId: String
-        # @param Url: H5端员工加入\实名链接
-
-        # 只有入参 InvitationNotifyType = H5的时候才会进行返回。
+        # @param Url: 员工邀请返回链接 根据入参的 InvitationNotifyType 和 Endpoint 返回链接 <table><tbody><tr><td>链接类型</td><td>有效期</td><td>示例</td></tr><tr><td>HTTP_SHORT_URL（短链）</td><td>一天</td><td>https://test.essurl.cn/fvG7UBEd0F</td></tr><tr><td>HTTP（长链）</td><td>一天</td><td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=USER_VERIFY&verifyToken=yDCVbUUckpwocmfpUySko7IS83LTV0u0&expireTime=1710840183</td></tr><tr><td>H5</td><td>30 天</td><td>https://quick.test.qian.tencent.cn/guide?Code=yDCVbUUckpwtvxqoUbTw4VBBjLbfAtW7&CodeType=QUICK&shortKey=yDCVbUY7lhqV7mZlCL2d</td></tr><tr><td>APP</td><td>一天</td><td>/pages/guide/index?to=USER_VERIFY&verifyToken=yDCVbUUckpwocm96UySko7ISvEIZH7Yz&expireTime=1710840455 </td></tr></tbody></table>
         # @type Url: String
 
         attr_accessor :DisplayName, :Mobile, :UserId, :Note, :WeworkOpenId, :Url
@@ -10157,24 +10260,22 @@ module TencentCloud
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param InvitationNotifyType: 员工邀请方式可通过以下方式进行设置：
-
-        # **H5**：会生成H5的链接，点击链接进入H5的认证加入企业的逻辑。
-        # **SMS（默认）**：会通过短信或企业微信消息进行邀请。如果非企业微信场景，则是企业微信消息。其他场景则是短信通知，短信中包含链接，点击后进入微信小程序进行认证加入企业的逻辑。
+        # @param InvitationNotifyType: 员工邀请方式可通过以下途径进行设置：<ul><li>**SMS（默认）**：邀请将通过短信或企业微信消息发送。若场景非企业微信，则采用企业微信消息；其他情境下则使用短信通知。短信内含链接，点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**：将生成H5链接，用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**：系统会根据Endpoint生成签署链接，业务方需获取链接并通知客户。</li></ul>
         # @type InvitationNotifyType: String
-        # @param JumpUrl: 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。
-
-        # 注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
+        # @param JumpUrl: 回跳地址，为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。注：`只有在员工邀请方式（InvitationNotifyType参数）为H5场景下才生效， 其他方式下设置无效。`
         # @type JumpUrl: String
+        # @param Endpoint: 要跳转的链接类型<ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li><li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li><li>**H5**： 第三方移动端浏览器进行嵌入，不支持小程序嵌入，过期时间一个月</li></ul>注意：InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型（InvitationNotifyType）</td><td>Endpoint</td></tr><tr><td>SMS（默认）</td><td>不需要传递，会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递，会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持（HTTP_URL/HTTP_SHORT_URL/H5/APP）默认为HTTP_SHORT_URL</td></tr></tbody></table>
+        # @type Endpoint: String
 
-        attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl
+        attr_accessor :Operator, :Employees, :Agent, :InvitationNotifyType, :JumpUrl, :Endpoint
 
-        def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil)
+        def initialize(operator=nil, employees=nil, agent=nil, invitationnotifytype=nil, jumpurl=nil, endpoint=nil)
           @Operator = operator
           @Employees = employees
           @Agent = agent
           @InvitationNotifyType = invitationnotifytype
           @JumpUrl = jumpurl
+          @Endpoint = endpoint
         end
 
         def deserialize(params)
@@ -10196,6 +10297,7 @@ module TencentCloud
           end
           @InvitationNotifyType = params['InvitationNotifyType']
           @JumpUrl = params['JumpUrl']
+          @Endpoint = params['Endpoint']
         end
       end
 
@@ -10444,7 +10546,7 @@ module TencentCloud
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
-        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.784
+  version: 3.0.786
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common