tencentcloud-sdk-ess 3.0.802 → 3.0.803

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ada0c8cb04b3804a4aebec5d899e87a4b439acb
-  data.tar.gz: 9e109824ed822065d8dcf1c2632d55e4c3dc059c
+  metadata.gz: f5a1e43f5af306665de1f96ee4b455c61d6f635e
+  data.tar.gz: fdb4479cc87658837ef7cd3f1c5fd6e029a17ea7
 SHA512:
-  metadata.gz: 8853919331a2914faa169331cd53fd37e8a203319f0e054850ff57db60dd231745a39c067f32f522e30260839a6c89123a3e49d27679406871bf797560f6fe46
-  data.tar.gz: 23705d4cd9b7cb2e0f5f5cfade0a26b685229c3074a6b46a9204e9f011d1885088425220562dd68a21f553176140b4071da86ca038b7df91bc1483a528ec4248
+  metadata.gz: f23b587671e39cdf101dab083004a5c228c8ac86466db960c1c5368b7483cc8b316aab94eabec4d183c4e79e1072d9b7dce95ff4cad0b21a21dae11e83b27500
+  data.tar.gz: 4fb6240f71eb7728741d596b6b3b35c818c224c139bb7374e4bbff3f8d57e07470f3c26db0ca05280bb0e6bb842e4ad566c6dc621639bc2bdc3ba1e354f223cc

data/lib/VERSION

@@ -1 +1 @@
-3.0.802
+3.0.803

data/lib/v20201111/client.rb

@@ -186,6 +186,52 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
+        # 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
+
+        # 批量创建链接有以下限制：
+
+        # 1. 单次最多创建10个企业。
+        # 2. 一天同一家企业最多创建8000家企业。
+        # 3. 同一批创建的企业不能重复 其中包括 企业名称，企业统一信用代码
+        # 4. 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置
+
+        # 注：
+
+        # 1. **此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估**
+
+        # 2. 如果生成的链接是APP链接，跳转到小程序的实现，参考微信官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式），如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
+
+
+        # **腾讯电子签小程序的AppID 和 原始Id如下:**
+
+        # | 小程序 | AppID | 原始ID |
+        # | --- | --- | --- |
+        # | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
+        # | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
+
+        # @param request: Request instance for CreateBatchOrganizationRegistrationTasks.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchOrganizationRegistrationTasksRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchOrganizationRegistrationTasksResponse`
+        def CreateBatchOrganizationRegistrationTasks(request)
+          body = send_request('CreateBatchOrganizationRegistrationTasks', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateBatchOrganizationRegistrationTasksResponse.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. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
@@ -981,11 +1027,39 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 本接口（CreateOrganizationAuthUrl）用于生成创建企业认证链接。
+        # 用于业务方系统自己生成认证链接进行跳转.而不用电子签自带的生成链接
+
+        # 注： **此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估**
+
+        # @param request: Request instance for CreateOrganizationAuthUrl.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateOrganizationAuthUrlRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateOrganizationAuthUrlResponse`
+        def CreateOrganizationAuthUrl(request)
+          body = send_request('CreateOrganizationAuthUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateOrganizationAuthUrlResponse.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
+
         # 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。<br/>
         # 附注：
-        # - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。
-        # - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
-        # - 仅支持待签署状态的合同生成签署链接。
+        # - 员工必须需作为批量签署合同的签署方，or或签合同的候选人之一。
+        # - 对于本方企业：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
+        # - 若要生成他发企业签署链接：应传RecipientIds，且制定的合同必须是接口调用方发起的。
+        # - 支持待签署、待填写状态的合同生成签署链接。
 
         # @param request: Request instance for CreateOrganizationBatchSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateOrganizationBatchSignUrlRequest`

data/lib/v20201111/models.rb

@@ -146,10 +146,9 @@ module TencentCloud
         # @param NotifyType: 通知签署方经办人的方式,  有以下途径:
         # <ul><li>  **sms**  :  (默认)短信</li>
         # <li>   **none**   : 不通知</li></ul>
-        # ```
+
         # 注意：
-        # 如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信
-        # ```
+        # `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`
         # @type NotifyType: String
         # @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下****类型****:
         # <ul><li> **1**  :收款人</li>
@@ -536,7 +535,7 @@ module TencentCloud
         # <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
 
         # 成功结果返回：
-        # 若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
+        # 若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
         # @type JumpUrl: String
 
         attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType, :JumpUrl
@@ -1374,6 +1373,86 @@ module TencentCloud
         end
       end
 
+      # CreateBatchOrganizationRegistrationTasks请求参数结构体
+      class CreateBatchOrganizationRegistrationTasksRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param RegistrationOrganizations: 组织机构注册信息。
+        # 一次最多支持10条认证流
+        # @type RegistrationOrganizations: Array
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param Endpoint: 要生成链接的类型, 可以选择的值如下:
+
+        # <ul>
+        # <li>(默认)PC: 生成PC端的链接</li>
+        # <li>SHORT_URL: H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
+        # <li>APP：生成小程序跳转链接</li>
+        # <li>H5：生成H5跳转长链接</li>
+        # <li>SHORT_H5：生成H5跳转短链</li>
+        # </ul>
+        # @type Endpoint: String
+
+        attr_accessor :Operator, :RegistrationOrganizations, :Agent, :Endpoint
+
+        def initialize(operator=nil, registrationorganizations=nil, agent=nil, endpoint=nil)
+          @Operator = operator
+          @RegistrationOrganizations = registrationorganizations
+          @Agent = agent
+          @Endpoint = endpoint
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          unless params['RegistrationOrganizations'].nil?
+            @RegistrationOrganizations = []
+            params['RegistrationOrganizations'].each do |i|
+              registrationorganizationinfo_tmp = RegistrationOrganizationInfo.new
+              registrationorganizationinfo_tmp.deserialize(i)
+              @RegistrationOrganizations << registrationorganizationinfo_tmp
+            end
+          end
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @Endpoint = params['Endpoint']
+        end
+      end
+
+      # CreateBatchOrganizationRegistrationTasks返回参数结构体
+      class CreateBatchOrganizationRegistrationTasksResponse < TencentCloud::Common::AbstractModel
+        # @param TaskId: 生成注册链接的任务Id，
+        # 根据这个id， 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接，进入认证流程
+        # @type TaskId: String
+        # @param ErrorMessages: 批量生成企业认证链接的详细错误信息，
+        # 顺序与输入参数保持一致。
+        # 若企业认证均成功生成，则不返回错误信息；
+        # 若存在任何错误，则返回具体的错误描述。
+        # @type ErrorMessages: Array
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :TaskId, :ErrorMessages, :RequestId
+
+        def initialize(taskid=nil, errormessages=nil, requestid=nil)
+          @TaskId = taskid
+          @ErrorMessages = errormessages
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+          @ErrorMessages = params['ErrorMessages']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateBatchQuickSignUrl请求参数结构体
       class CreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel
         # @param FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
@@ -3612,6 +3691,33 @@ module TencentCloud
         end
       end
 
+      # CreateOrganizationAuthUrl请求参数结构体
+      class CreateOrganizationAuthUrlRequest < TencentCloud::Common::AbstractModel
+
+
+        def initialize()
+        end
+
+        def deserialize(params)
+        end
+      end
+
+      # CreateOrganizationAuthUrl返回参数结构体
+      class CreateOrganizationAuthUrlResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateOrganizationBatchSignUrl请求参数结构体
       class CreateOrganizationBatchSignUrlRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。
@@ -3638,16 +3744,21 @@ module TencentCloud
         # @param Mobile: 员工手机号，必须与姓名一起使用。
         #  如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
         # @type Mobile: String
+        # @param RecipientIds: 为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。
+        # 您可以通过查询合同接口（DescribeFlowInfo）查询此参数。
+        # 若传了此参数，则可以不传 UserId, Name, Mobile等参数
+        # @type RecipientIds: Array
 
-        attr_accessor :Operator, :FlowIds, :Agent, :UserId, :Name, :Mobile
+        attr_accessor :Operator, :FlowIds, :Agent, :UserId, :Name, :Mobile, :RecipientIds
 
-        def initialize(operator=nil, flowids=nil, agent=nil, userid=nil, name=nil, mobile=nil)
+        def initialize(operator=nil, flowids=nil, agent=nil, userid=nil, name=nil, mobile=nil, recipientids=nil)
           @Operator = operator
           @FlowIds = flowids
           @Agent = agent
           @UserId = userid
           @Name = name
           @Mobile = mobile
+          @RecipientIds = recipientids
         end
 
         def deserialize(params)
@@ -3663,6 +3774,7 @@ module TencentCloud
           @UserId = params['UserId']
           @Name = params['Name']
           @Mobile = params['Mobile']
+          @RecipientIds = params['RecipientIds']
         end
       end
 
@@ -7551,7 +7663,7 @@ module TencentCloud
         # @type ApproverIdCardNumber: String
         # @param RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
 
-        # <b>模板发起合同时，该参数为必填项，可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
+        # <b>模板发起合同时，该参数为必填项，可以通过[查询模板信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
         # <b>文件发起合同时，该参数无需传值。</b>
 
         # 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
@@ -9676,6 +9788,79 @@ module TencentCloud
         end
       end
 
+      # 企业认证信息参数， 需要保证这些参数跟营业执照中的信息一致。
+      class RegistrationOrganizationInfo < TencentCloud::Common::AbstractModel
+        # @param OrganizationName: 组织机构名称。
+        # 请确认该名称与企业营业执照中注册的名称一致。
+        # 如果名称中包含英文括号()，请使用中文括号（）代替。
+        # @type OrganizationName: String
+        # @param UniformSocialCreditCode: 组织机构企业统一社会信用代码。
+        # 请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
+        # @type UniformSocialCreditCode: String
+        # @param LegalName: 组织机构法人的姓名。
+        # 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
+        # @type LegalName: String
+        # @param Address: 组织机构企业注册地址。
+        # 请确认该企业注册地址与企业营业执照中注册的地址一致。
+        # @type Address: String
+        # @param AdminName: 组织机构超管姓名。
+        # 在注册流程中，必须是超管本人进行操作。
+        # 如果法人做为超管管理组织机构,超管姓名就是法人姓名
+        # @type AdminName: String
+        # @param AdminMobile: 组织机构超管姓名。
+        # 在注册流程中，这个手机号必须跟操作人在电子签注册的个人手机号一致。
+        # @type AdminMobile: String
+        # @param AuthorizationTypes: 可选的此企业允许的授权方式, 可以设置的方式有:
+        # 1：上传授权书
+        # 2：法人授权超管
+        # 5：授权书+对公打款
+
+
+        # 注:
+        # `1. 当前仅支持一种认证方式`
+        # `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
+        # `3. 如果当前操作人是法人,则是法人认证`
+        # @type AuthorizationTypes: Array
+        # @param AdminIdCardNumber: 认证人身份证号
+        # @type AdminIdCardNumber: String
+        # @param AdminIdCardType: 认证人证件类型
+        # 支持以下类型
+        # <ul><li>ID_CARD : 居民身份证  (默认值)</li>
+        # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+        # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
+        # @type AdminIdCardType: String
+        # @param BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
+        # @type BusinessLicense: String
+
+        attr_accessor :OrganizationName, :UniformSocialCreditCode, :LegalName, :Address, :AdminName, :AdminMobile, :AuthorizationTypes, :AdminIdCardNumber, :AdminIdCardType, :BusinessLicense
+
+        def initialize(organizationname=nil, uniformsocialcreditcode=nil, legalname=nil, address=nil, adminname=nil, adminmobile=nil, authorizationtypes=nil, adminidcardnumber=nil, adminidcardtype=nil, businesslicense=nil)
+          @OrganizationName = organizationname
+          @UniformSocialCreditCode = uniformsocialcreditcode
+          @LegalName = legalname
+          @Address = address
+          @AdminName = adminname
+          @AdminMobile = adminmobile
+          @AuthorizationTypes = authorizationtypes
+          @AdminIdCardNumber = adminidcardnumber
+          @AdminIdCardType = adminidcardtype
+          @BusinessLicense = businesslicense
+        end
+
+        def deserialize(params)
+          @OrganizationName = params['OrganizationName']
+          @UniformSocialCreditCode = params['UniformSocialCreditCode']
+          @LegalName = params['LegalName']
+          @Address = params['Address']
+          @AdminName = params['AdminName']
+          @AdminMobile = params['AdminMobile']
+          @AuthorizationTypes = params['AuthorizationTypes']
+          @AdminIdCardNumber = params['AdminIdCardNumber']
+          @AdminIdCardType = params['AdminIdCardType']
+          @BusinessLicense = params['BusinessLicense']
+        end
+      end
+
       # 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
       # `注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
       # `注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.802
+  version: 3.0.803
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common