tencentcloud-sdk-ess 3.0.931 → 3.0.932

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1bf83c07d982bced462fa118ad66c441efd4701
-  data.tar.gz: 083cb25a12649ae410f4272f0eb55fa82ef678b4
+  metadata.gz: d15c5aba7ed902bc0eb474b31ceb5ab3fba8d9f9
+  data.tar.gz: c59255d3d8829dce82c9aae73ad99a5a073a2f7c
 SHA512:
-  metadata.gz: bfda8f58ed08408792269286a174cda6df6eacb51d13f4961422de0e58fdecc8112fadf545ce40e0d2f2abd1bb80b8afe153458315a1ea372961a0055d6df107
-  data.tar.gz: adfdceaa007d97a49648611e1aa8afc626d30661e3ceb2b419c41669ab0f0114bc60338dacddd718eeda9df81f910519a0320d111f8c40664c41a0416e7602d2
+  metadata.gz: bc83502a8ec4b913f9408eed5c8e70895f18f7b0f6bdbfed042b4e5bcf03c6d85e93b9f4196940a6e95524e818cc86ff02386a93fdc95821ed0344384390b732
+  data.tar.gz: 8ce58e8f68dbd860fd22f3f3f44a1f46a757f219c0e109ccd21bec2a34da86dd554c1a6aaffec19f9feded37d2a2b6e7fd317713bf6b0cafb755651f5ee043b7

data/lib/VERSION

@@ -1 +1 @@
-3.0.931
+3.0.932

data/lib/v20201111/client.rb

@@ -695,6 +695,22 @@ module TencentCloud
 
         # 实际签署人需要通过[获取跳转至腾讯电子签小程序的签署链接](https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl/)生成的链接进入小程序，领取合同并签署。同一签署环节可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。
 
+        # **接口使用说明**：
+
+        # 1.本接口现已支持批量补充签署人
+
+        # 2.当<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中指定需要补充的FlowId时，可以对指定合同补充签署人；可以指定多个相同发起方的不同合同在完成批量补充
+
+        # 3.当<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中指定需要补充的FlowId时，是对指定的合同补充多个指定的签署人
+
+        # 4.如果同时指定了<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId，仅使用<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId作为补充的合同
+
+        # 5.如果部分指定了<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId，又指定了<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId；那么<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>存在指定的FlowId，则使用<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId，不存在则使用<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId作为补充的合同
+
+
+        # 6.如果同时未指定了<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId，则传参错误。
+
+        # 7. 新加入的签署方<font color="red">平台不会发送短信</font>进行签署。请您生成相应的链接，并将其发送给该签署方以便完成签署过程。
 
         # **限制条件**：
 
@@ -1607,7 +1623,7 @@ module TencentCloud
         end
 
         # 发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。
-        # 解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。
+        # 解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。具体用法可以参考文档[合同解除](https://qian.tencent.com/developers/company/flow_release)。
 
         # 注意：
         # <ul>
@@ -1620,6 +1636,7 @@ module TencentCloud
         # <li><strong>非原合同企业参与者的权限：</strong>非原合同的企业参与者发起解除协议时，必须具备相应的解除权限。</li>
         # <li><strong>自动签署：</strong>支持本企业的自动签署，不支持其他企业的自动签署（不能不动神色的把别人参与的合同作废了）</li>
         # </ul>
+
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)
 
         # @param request: Request instance for CreateReleaseFlow.
@@ -1986,6 +2003,36 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 批量清理未认证的企业认证流程。
+
+        # 此接口用来清除企业方认证信息填写错误，批量清理认证中的认证流信息。
+        # 为接口[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 接口的扩展接口。即在批量认证过程中，当发起认证企业发现超管信息错误的时候，可以将当前超管下的所有认证流企业清除。
+
+        # 注意：
+        # **这个接口的操作人必须跟生成批量认证链接接口的操作人一致，才可以调用，否则会返回当前操作人没有认证中的企业认证流**
+
+        # @param request: Request instance for DeleteOrganizationAuthorizations.
+        # @type request: :class:`Tencentcloud::ess::V20201111::DeleteOrganizationAuthorizationsRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteOrganizationAuthorizationsResponse`
+        def DeleteOrganizationAuthorizations(request)
+          body = send_request('DeleteOrganizationAuthorizations', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DeleteOrganizationAuthorizationsResponse.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
+
         # 本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限
 
         # @param request: Request instance for DeleteSealPolicies.
@@ -2185,6 +2232,12 @@ module TencentCloud
         # 本接口（DescribeFileUrls）用于查询文件的下载URL。
         # 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
 
+
+        # **注**：用户创建合同或者提交签署动作后，后台需要1~3秒的时间就进行合同PDF合成或者签名，为了确保您下载的是签署完成的完整合同文件，我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成，然后在调用本接口</b></font>。
+
+        # **第一种**：请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)功能。一旦所有参与方签署完毕，我们的系统将自动向您提供的回调地址发送完成通知。
+        # **第二种**：通过调用我们的[获取合同信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowBriefs)接口来主动检查合同的签署状态。请仅在确认合同状态为“签署完成”后，进行文件的下载操作。
+
         # @param request: Request instance for DescribeFileUrls.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFileUrlsResponse`
@@ -2688,6 +2741,7 @@ module TencentCloud
         # 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。<br />
         # 注：
         # 1. `大文件转换所需的时间可能会比较长`
+        # 2.  `本接口返回的文件资源ID就是PDF资源ID，可以直接用于【用PDF文件创建签署流程】接口发起合同。`
 
         # @param request: Request instance for GetTaskResultApi.
         # @type request: :class:`Tencentcloud::ess::V20201111::GetTaskResultApiRequest`

data/lib/v20201111/models.rb

@@ -369,7 +369,7 @@ module TencentCloud
         # @type CanEditApprover: Boolean
         # @param FillType: 签署人信息补充类型，默认无需补充。
 
-        # <ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
+        # <ul><li> **1** :  动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
 
         # 注：
         # `使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
@@ -2534,8 +2534,9 @@ module TencentCloud
         # 注：` 如果发起方指定的补充签署人是企业微信签署人（ApproverSource=WEWORKAPP），则需要提供企业微信UserId进行补充； 如果不指定，则使用姓名和手机号进行补充。`
         # @type Approvers: Array
         # @param FlowId: 合同流程ID，为32位字符串。
-        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+        # - 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # - <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId来指定需要补充的合同id
         # @type FlowId: String
         # @param FillApproverType: 签署人信息补充方式
 
@@ -5315,8 +5316,7 @@ module TencentCloud
         # @param Operator: 执行本接口操作的员工信息, userId 必填。
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param OrganizationName: 合同流程签署方的组织机构名称。
-        # 如果名称中包含英文括号()，请使用中文括号（）代替。
+        # @param OrganizationName: 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
         # @type OrganizationName: String
         # @param Name: 合同流程里边签署方经办人的姓名。
         # @type Name: String
@@ -6428,6 +6428,112 @@ module TencentCloud
         end
       end
 
+      # 清理的企业认证流信息
+      class DeleteOrganizationAuthorizationInfo < TencentCloud::Common::AbstractModel
+        # @param AuthorizationId: 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
+        # @type AuthorizationId: String
+        # @param OrganizationName: 认证的企业名称
+        # @type OrganizationName: String
+        # @param Errormessage: 清除认证流产生的错误信息
+        # @type Errormessage: String
+
+        attr_accessor :AuthorizationId, :OrganizationName, :Errormessage
+
+        def initialize(authorizationid=nil, organizationname=nil, errormessage=nil)
+          @AuthorizationId = authorizationid
+          @OrganizationName = organizationname
+          @Errormessage = errormessage
+        end
+
+        def deserialize(params)
+          @AuthorizationId = params['AuthorizationId']
+          @OrganizationName = params['OrganizationName']
+          @Errormessage = params['Errormessage']
+        end
+      end
+
+      # DeleteOrganizationAuthorizations请求参数结构体
+      class DeleteOrganizationAuthorizationsRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息, userId 必填。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param AuthorizationIds: 认证流Ids数组
+        # 认证流 Id 是指在企业认证过程中，当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内，一个企业只能有一个认证流程处于成功状态，以确保认证的唯一性和有效性。
+
+
+        # 认证流 Id可以通过回调 [授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%9B%9B-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83) 获取
+
+        # 注意：
+        # 如果传递了认证流Id，则下面的参数 超管二要素不会生效
+        # @type AuthorizationIds: Array
+        # @param AdminName: 认证人姓名，组织机构超管姓名。
+        # 在注册流程中，必须是超管本人进行操作。
+        # @type AdminName: String
+        # @param AdminMobile: 认证人手机号，组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。
+        # @type AdminMobile: String
+        # @param Agent: 代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :AuthorizationIds, :AdminName, :AdminMobile, :Agent
+
+        def initialize(operator=nil, authorizationids=nil, adminname=nil, adminmobile=nil, agent=nil)
+          @Operator = operator
+          @AuthorizationIds = authorizationids
+          @AdminName = adminname
+          @AdminMobile = adminmobile
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @AuthorizationIds = params['AuthorizationIds']
+          @AdminName = params['AdminName']
+          @AdminMobile = params['AdminMobile']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # DeleteOrganizationAuthorizations返回参数结构体
+      class DeleteOrganizationAuthorizationsResponse < TencentCloud::Common::AbstractModel
+        # @param DeleteOrganizationAuthorizationInfos: 清理的认证流的详细信息，其中包括企业名称，认证流唯一 Id 以及清理过程中产生的错误信息
+        # @type DeleteOrganizationAuthorizationInfos: Array
+        # @param Status: 批量清理认证流返回的状态值
+        # 其中包括
+        # - 1 全部成功
+        # - 2 部分成功
+        # - 3 全部失败
+        # @type Status: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :DeleteOrganizationAuthorizationInfos, :Status, :RequestId
+
+        def initialize(deleteorganizationauthorizationinfos=nil, status=nil, requestid=nil)
+          @DeleteOrganizationAuthorizationInfos = deleteorganizationauthorizationinfos
+          @Status = status
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['DeleteOrganizationAuthorizationInfos'].nil?
+            @DeleteOrganizationAuthorizationInfos = []
+            params['DeleteOrganizationAuthorizationInfos'].each do |i|
+              deleteorganizationauthorizationinfo_tmp = DeleteOrganizationAuthorizationInfo.new
+              deleteorganizationauthorizationinfo_tmp.deserialize(i)
+              @DeleteOrganizationAuthorizationInfos << deleteorganizationauthorizationinfo_tmp
+            end
+          end
+          @Status = params['Status']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DeleteSealPolicies请求参数结构体
       class DeleteSealPoliciesRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -8807,7 +8913,9 @@ module TencentCloud
 
         # 注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
         # @type ApproverIdCardNumber: String
-        # @param FlowId: 合同流程ID，补充合同组子合同动态签署人时必传。
+        # @param FlowId: 合同流程ID
+        # - 补充合同组子合同动态签署人时必传。
+        # - 补充普通合同时，请阅读：<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口</a>的接口使用说明
         # @type FlowId: String
 
         attr_accessor :RecipientId, :ApproverSource, :CustomUserId, :ApproverName, :ApproverMobile, :OrganizationName, :ApproverIdCardType, :ApproverIdCardNumber, :FlowId
@@ -8845,17 +8953,22 @@ module TencentCloud
         # @param ErrMessage: 补充失败错误说明
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ErrMessage: String
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowId: String
 
-        attr_accessor :RecipientId, :ErrMessage
+        attr_accessor :RecipientId, :ErrMessage, :FlowId
 
-        def initialize(recipientid=nil, errmessage=nil)
+        def initialize(recipientid=nil, errmessage=nil, flowid=nil)
           @RecipientId = recipientid
           @ErrMessage = errmessage
+          @FlowId = flowid
         end
 
         def deserialize(params)
           @RecipientId = params['RecipientId']
           @ErrMessage = params['ErrMessage']
+          @FlowId = params['FlowId']
         end
       end
 
@@ -11559,6 +11672,8 @@ module TencentCloud
         # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
 
         # 如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
+
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)
         # @type ApproverSignRole: String
         # @param ApproverSignSealId: 印章Id，签署控件类型为印章时，用于指定本企业签署方在解除协议中使用那个印章进行签署
         # @type ApproverSignSealId: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.931
+  version: 3.0.932
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common