tencentcloud-sdk-ess 3.0.868 → 3.0.870

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 237f95aa36516b3be66214a4cd2fb52ae4c0d51b
-  data.tar.gz: 1a305178f12ad78ed5f9131b3d68a699c541ca0d
+  metadata.gz: 4d59a1c522a7da8d445a8d159aef8ed1d5681837
+  data.tar.gz: 23e26430b99e6dfadd582f9556198e5a96e2292b
 SHA512:
-  metadata.gz: 49815d08445e7e7a8d2a965298d0402e60d092b0988f9c045a7211ef0da4436529bb63273d47fd503cb74045152b477fd84a751d1eefb9c2dcc153f4ac7093cb
-  data.tar.gz: 2ee3d507cc1bf0eae5d2764637052c1bd3a2f763655b9b4f5e7020ec87cc7fcd82ad5b9206ffec9acb881f3fde42e3344d3d502a71bb4f13497aaaebcd0308a9
+  metadata.gz: e4b9a7f79dd2643502aa045526abdeb255072edeb1570faa5241e3428452d90b779c788bac1483030061af8ff4d7ac1521bb1c8d385c2a4c8f8b8b78ea071dcc
+  data.tar.gz: 5c042a792d470e944e3cfaa9f800824b3bf3a41406b1eb2432fbe31dea1c22c238a74b7887e18823c83c63fc7bb06cd106715b1c244d6f11288d57435a9381a5

data/lib/VERSION

@@ -1 +1 @@
-3.0.868
+3.0.870

data/lib/v20201111/client.rb

@@ -388,14 +388,18 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建：
+        # 本接口（CreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建：
         # 1. 创建印章
         # 2. 创建模板
         # 3. 修改模板
         # 4. 预览模板
         # 5. 预览合同流程
 
-        # 用户可以通过这些链接快速将其集成到自己的系统中。
+        # 预览模板的嵌入页面长相如下：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
+
+        # 预览合同流程的嵌入页面长相如下：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
 
         # @param request: Request instance for CreateEmbedWebUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateEmbedWebUrlRequest`
@@ -1182,11 +1186,17 @@ module TencentCloud
         end
 
         # 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。<br/>
-        # 附注：
-        # - 员工必须需作为批量签署合同的签署方，or或签合同的候选人之一。
-        # - 对于本方企业：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
-        # - 若要生成他发企业签署链接：应传RecipientIds，且制定的合同必须是接口调用方发起的。
-        # - 支持待签署、待填写状态的合同生成签署链接。
+
+        # 注：
+        # <ul>
+        # <li>员工必须需作为批量签署合同的签署方，或者是或签合同的候选人之一。</li>
+        # <li><b>本方企业签署链接</b>：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。</li>
+        # <li><b>他方企业签署链接</b>：传RecipientIds，且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。（<b>如果签署人没有加入对方企业则会引导加入；如果对方企业还没有注册认证，会引导企业注册和认证</b>）</li>
+        # <li>只支持待签署、待填写状态的合同生成签署链接。</li>
+        # </ul>
+
+        # 签署的嵌入页面长相如下：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
 
         # @param request: Request instance for CreateOrganizationBatchSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateOrganizationBatchSignUrlRequest`
@@ -1292,6 +1302,37 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 创建他方自动签授权链接，通过该链接可进入小程序进行合作方企业的自动签授权，若当前企业未开通企业自动签，通过该链接会先引导开通本企业自动签。
+        # 该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
+
+
+
+        # 注:
+        # 1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
+        # 2. 已经在授权中或者授权成功的企业，无法重复授权
+
+        # @param request: Request instance for CreatePartnerAutoSignAuthUrl.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreatePartnerAutoSignAuthUrlRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreatePartnerAutoSignAuthUrlResponse`
+        def CreatePartnerAutoSignAuthUrl(request)
+          body = send_request('CreatePartnerAutoSignAuthUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreatePartnerAutoSignAuthUrlResponse.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
+
         # 获取个人用户认证证书图片下载URL
 
         # 个人用户认证证书图片样式如下图
@@ -1326,9 +1367,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建发起流程web页面
-        # <br/>适用场景：通过该接口（CreatePrepareFlow）传入合同文件/模板编号及签署人信息，可获得发起流程的可嵌入页面，在页面完成签署控件等信息的编辑与确认后，快速发起流程。
-        # <br/>注：该接口包含模板/文件发起流程的全部功能，调用接口后不会立即发起，需在可嵌入页面点击按钮进行发起流程。
+        # 创建发起流程Web页面，通过该接口可以获取发起流程的可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中）。在页面上完成签署控件等信息的编辑与确认后，可快速发起流程。
+
+        #  <br/>注意：调用接口后，<font color="red">流程不会立即发起，需在嵌入页面上点击【发起合同】按钮来发起流程</font>。
+
+        # 嵌入页面长相如下:
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
 
         # @param request: Request instance for CreatePrepareFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowRequest`
@@ -2515,17 +2559,20 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
-        # 1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
-        # 2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。
+        # 在已启动的签署流程中，可对签署截止日期进行延期操作，主要分为以下两个层面：
+        # 1. <b> 合同（流程）层面</b>：仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
+        # 2. <b> 签署人层面</b>  ：需提供流程ID和签署人ID。此操作针对特定签署人进行延期，特别是对于有序合同（流程），签署截止时间不得超过后续签署人的流程截止时间。
+
+        # 此接口存在以下限制：
+        # 1. 执行操作的员工须为<font  color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
+        # 2. 延长整个签署流程时，<font  color="red">应至少有一方尚未签署</font>（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
+        # 3. 延长整个签署流程时，新的签署截止日期应晚于已设定的签署截止日期和当前日期。
+        # 4. 延长签署方截止时间时，<font  color="red">签署方不能处于流程完结或已终止状态</font>（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
+        # 5. 延长签署方截止时间时，新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同，还需早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
+        # 6. <font  color="red">不支持操作合同组合同</font>。
 
-        # 此接口有如下限制条件：
-        # 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
-        # 2. 在延长整个签署流程时，签署流程应至少还有一方未签署（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态）。
-        # 3. 在延长整个签署流程时，新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
-        # 4. 在延长签署方的截止时间时，签署方不能处于流程完结或已终止状态（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
-        # 5. 在延长签署方的截止时间时，签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同，还应早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
-        # 6. 不支持操作合同组合同。
+        # 合同（流程）层面 截止时间控制台展示的位置：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/265b130136bf6e8f01f5880438467dfb.png)
 
         # @param request: Request instance for ModifyFlowDeadline.
         # @type request: :class:`Tencentcloud::ess::V20201111::ModifyFlowDeadlineRequest`

data/lib/v20201111/models.rb

@@ -197,7 +197,7 @@ module TencentCloud
         # @param ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式，可传递以下值：
         # <ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li>
         # <li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li>
-        # <li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。</li></ul>
+        # <li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）</li></ul>
 
         # 默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
 
@@ -1930,7 +1930,7 @@ module TencentCloud
       # CreateEmbedWebUrl请求参数结构体
       class CreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
-        # <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
+        # <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param EmbedType: WEB嵌入资源类型，支持以下类型
         # <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
@@ -1956,17 +1956,7 @@ module TencentCloud
         # @type Reviewer: :class:`Tencentcloud::Ess.v20201111.models.ReviewerInfo`
         # @param Option: 个性化参数，用于控制页面展示内容
         # @type Option: :class:`Tencentcloud::Ess.v20201111.models.EmbedUrlOption`
-        # @param UserData: 用户自定义参数
-        # <ul>
-        # <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
-        # <li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li>
-        # <li>支持的格式：json字符串的BASE64编码字符串</li>
-        # <li>示例：<ul>
-        #                  <li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>
-        #                  <li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li>
-        # </ul>
-        # </li>
-        # </ul>
+        # @param UserData: <ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li> <li>支持的格式：json字符串的BASE64编码字符串</li> <li>示例：<ul>                  <li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>                  <li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li> </ul> </li> </ul>
         # @type UserData: String
 
         attr_accessor :Operator, :EmbedType, :BusinessId, :Agent, :Reviewer, :Option, :UserData
@@ -4112,8 +4102,11 @@ module TencentCloud
         # @param UserId: 员工在腾讯电子签平台的独特身份标识，为32位字符串。
         # 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
         # UserId必须是传入合同（FlowId）中的签署人。
-        # - 1. 若UserId为空，Name和Mobile 必须提供。
-        # - 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。
+
+        # <ul>
+        # <li>1. 若UserId为空，Name和Mobile 必须提供。</li>
+        # <li>2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。</li>
+        # </ul>
         # @type UserId: String
         # @param Name: 员工姓名，必须与手机号码一起使用。
         # 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
@@ -4302,6 +4295,68 @@ module TencentCloud
         end
       end
 
+      # CreatePartnerAutoSignAuthUrl请求参数结构体
+      class CreatePartnerAutoSignAuthUrlRequest < TencentCloud::Common::AbstractModel
+        # @param AuthorizedOrganizationId: 被授企业id
+        # @type AuthorizedOrganizationId: String
+        # @param SealTypes: 指定印章类型，指定后只能选择该类型的印章进行授权支持以下印章类型：- OFFICIAL : 企业公章- CONTRACT : 合同专用章- FINANCE : 财务专用章- PERSONNEL : 人事专用章
+        # @type SealTypes: Array
+        # @param Agent: 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param Operator: 执行本接口操作的员工信息。<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+
+        attr_accessor :AuthorizedOrganizationId, :SealTypes, :Agent, :Operator
+
+        def initialize(authorizedorganizationid=nil, sealtypes=nil, agent=nil, operator=nil)
+          @AuthorizedOrganizationId = authorizedorganizationid
+          @SealTypes = sealtypes
+          @Agent = agent
+          @Operator = operator
+        end
+
+        def deserialize(params)
+          @AuthorizedOrganizationId = params['AuthorizedOrganizationId']
+          @SealTypes = params['SealTypes']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+        end
+      end
+
+      # CreatePartnerAutoSignAuthUrl返回参数结构体
+      class CreatePartnerAutoSignAuthUrlResponse < TencentCloud::Common::AbstractModel
+        # @param Url: 授权链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
+        # @type Url: String
+        # @param MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
+        # @type MiniAppPath: String
+        # @param ExpireTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
+        # @type ExpireTime: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :Url, :MiniAppPath, :ExpireTime, :RequestId
+
+        def initialize(url=nil, miniapppath=nil, expiretime=nil, requestid=nil)
+          @Url = url
+          @MiniAppPath = miniapppath
+          @ExpireTime = expiretime
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Url = params['Url']
+          @MiniAppPath = params['MiniAppPath']
+          @ExpireTime = params['ExpireTime']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreatePersonAuthCertificateImage请求参数结构体
       class CreatePersonAuthCertificateImageRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -8682,7 +8737,7 @@ module TencentCloud
         # @param ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式，可传递以下值：
         # <ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li>
         # <li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li>
-        # <li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。</li></ul>
+        # <li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。（如果是港澳台客户，建议不要选择这个）</li></ul>
         # 注：
         # <ul><li>默认情况下，认证校验方式为人脸认证和签署密码两种形式；</li>
         # <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.868
+  version: 3.0.870
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common