tencentcloud-sdk-ess 3.0.884 → 3.0.886

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a790dfa0826d69a272320c669ba594377702fb61
-  data.tar.gz: b79e3f2bef36407cc3c149feec67f7a4cb3ed76e
+  metadata.gz: 913329bc44ceadcc0dfd63083bde106228a5a782
+  data.tar.gz: f69af4d020aef88bb8ef40c82c5e800a5713452c
 SHA512:
-  metadata.gz: 34c9e8e1d78a6ea3761f2dcb037f16bf1d041794ef093b67d2d8d23ee1b9213b31e447af0289c203f99283e1f7b5354a010f357c3204d96f1cc27e756fa89e7c
-  data.tar.gz: 334b39f2eaf26e261bf3f5fa254949dfb02212e8902197f6942495ab94cb780d58c7c44a00a63af53abd2373a21c345b4f06400cdaf5cb7b96eb8bd035293ab8
+  metadata.gz: 804cdfaecaf96fa862a03c753a05adb370614a28ec5c941bae8178a1ddfa32a7c2e0dbc8395490e9cf1086df45f6c9aeea4c4e0dcb77e543a5f076f0eed409df
+  data.tar.gz: 8ee8895e5a283c315a0b6c752e56aaf7418d74094402b2a8289a5f5ad0fd94d5f9c64c63465d8a8bd5215b3a162491a2e64ddda8fb716b1ef990604022191c91

data/lib/VERSION

@@ -1 +1 @@
-3.0.884
+3.0.886

data/lib/v20201111/client.rb

@@ -186,6 +186,66 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 支持企业进行批量初始化操作：
+
+        # 此接口存在以下限制：
+        # 1. 若批量操作中包含<font  color="red">加入集团企业</font>操作,则调用此接口的员工须有<font  color="red">集团企业管理权限</font>。
+        # 2. 批量操作的企业需要已经完成电子签的认证流程。
+        # 3. 通过此接口生成的链接在小程序端进行操作时，操作人需要是<font  color="red">所有企业的超管或法人</font>。
+        # 4. 批量操作的企业，需要是<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">通过平台方引导认证</a>的企业。
+        # 5. <font  color="red">操作链接过期时间默认为生成链接后7天。</font>
+
+        # @param request: Request instance for CreateBatchInitOrganizationUrl.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchInitOrganizationUrlRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchInitOrganizationUrlResponse`
+        def CreateBatchInitOrganizationUrl(request)
+          body = send_request('CreateBatchInitOrganizationUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateBatchInitOrganizationUrlResponse.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
+
+        # 此接口用于获取企业批量认证链接-单链接包含多条认证流。
+
+        # 前提条件：已调用 [CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks) 和[查询企业批量认证链接DescribeBatchOrganizationRegistrationUrls](https://qian.tencent.com/developers/companyApis/organizations/DescribeBatchOrganizationRegistrationUrls) 确保认证任务已经完成。
+
+        # 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间。
+        # 此链接包含多条认证流程，使用该链接可以批量的对企业进行认证。
+
+        # @param request: Request instance for CreateBatchOrganizationAuthorizationUrl.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchOrganizationAuthorizationUrlRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchOrganizationAuthorizationUrlResponse`
+        def CreateBatchOrganizationAuthorizationUrl(request)
+          body = send_request('CreateBatchOrganizationAuthorizationUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateBatchOrganizationAuthorizationUrlResponse.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
+
         # 本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
         # 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
 

data/lib/v20201111/models.rb

@@ -1403,6 +1403,167 @@ module TencentCloud
         end
       end
 
+      # CreateBatchInitOrganizationUrl请求参数结构体
+      class CreateBatchInitOrganizationUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param OperateTypes: 初始化操作类型
+        # <ul><li>CREATE_SEAL : 创建印章</li>
+        # <li>AUTH_JOIN_ORGANIZATION_GROUP : 加入集团企业</li>
+        # <li>OPEN_AUTO_SIGN :开通企业自动签署</li></ul>
+        # @type OperateTypes: Array
+        # @param OrganizationIds: 批量操作的企业Id列表，最大支持50个
+        # @type OrganizationIds: Array
+        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :OperateTypes, :OrganizationIds, :Agent
+
+        def initialize(operator=nil, operatetypes=nil, organizationids=nil, agent=nil)
+          @Operator = operator
+          @OperateTypes = operatetypes
+          @OrganizationIds = organizationids
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @OperateTypes = params['OperateTypes']
+          @OrganizationIds = params['OrganizationIds']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # CreateBatchInitOrganizationUrl返回参数结构体
+      class CreateBatchInitOrganizationUrlResponse < TencentCloud::Common::AbstractModel
+        # @param MiniAppPath: 小程序路径
+        # @type MiniAppPath: String
+        # @param OperateLongUrl: 操作长链
+        # @type OperateLongUrl: String
+        # @param OperateShortUrl: 操作短链
+        # @type OperateShortUrl: String
+        # @param QRCodeUrl: 操作二维码
+        # @type QRCodeUrl: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :MiniAppPath, :OperateLongUrl, :OperateShortUrl, :QRCodeUrl, :RequestId
+
+        def initialize(miniapppath=nil, operatelongurl=nil, operateshorturl=nil, qrcodeurl=nil, requestid=nil)
+          @MiniAppPath = miniapppath
+          @OperateLongUrl = operatelongurl
+          @OperateShortUrl = operateshorturl
+          @QRCodeUrl = qrcodeurl
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @MiniAppPath = params['MiniAppPath']
+          @OperateLongUrl = params['OperateLongUrl']
+          @OperateShortUrl = params['OperateShortUrl']
+          @QRCodeUrl = params['QRCodeUrl']
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # CreateBatchOrganizationAuthorizationUrl请求参数结构体
+      class CreateBatchOrganizationAuthorizationUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param AdminName: 组织机构超管姓名。 在注册流程中，必须是超管本人进行操作。
+        # 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminName 保持一致。
+        # @type AdminName: String
+        # @param AdminMobile: 组织机构超管手机号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 Admin Mobile保持一致。
+        # @type AdminMobile: String
+        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param SubTaskIds: 企业批量认证链接的子任务 SubTaskId，该 SubTaskId 是通过接口 查询企业批量认证链接 DescribeBatchOrganizationRegistrationUrls 获得。此参数需与超管个人三要素（AdminName，AdminMobile，AdminIdCardNumber）配合使用。若 SubTaskId 不属于传入的超级管理员，将进行筛选。
+        # @type SubTaskIds: Array
+        # @param AdminIdCardType: 组织机构超管证件类型支持以下类型
+        # - ID_CARD : 居民身份证 (默认值)
+        # -  HONGKONG_AND_MACAO : 港澳居民来往内地通行证
+        # - HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
+        # 此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardType保持一致。
+        # @type AdminIdCardType: String
+        # @param AdminIdCardNumber: 组织机构超管证件号。 在注册流程中，必须是超管本人进行操作。此参数需要跟[创建企业批量认证链接](https://qian.tencent.com/developers/companyApis/organizations/CreateBatchOrganizationRegistrationTasks)中 AdminIdCardNumber保持一致。
+        # @type AdminIdCardNumber: 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>**QR_CODE**： 跳转电子签小程序的http_url的二维码形式,  可以在页面展示适合此类型</li></ul>
+        # @type Endpoint: String
+
+        attr_accessor :Operator, :AdminName, :AdminMobile, :Agent, :SubTaskIds, :AdminIdCardType, :AdminIdCardNumber, :Endpoint
+
+        def initialize(operator=nil, adminname=nil, adminmobile=nil, agent=nil, subtaskids=nil, adminidcardtype=nil, adminidcardnumber=nil, endpoint=nil)
+          @Operator = operator
+          @AdminName = adminname
+          @AdminMobile = adminmobile
+          @Agent = agent
+          @SubTaskIds = subtaskids
+          @AdminIdCardType = adminidcardtype
+          @AdminIdCardNumber = adminidcardnumber
+          @Endpoint = endpoint
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @AdminName = params['AdminName']
+          @AdminMobile = params['AdminMobile']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @SubTaskIds = params['SubTaskIds']
+          @AdminIdCardType = params['AdminIdCardType']
+          @AdminIdCardNumber = params['AdminIdCardNumber']
+          @Endpoint = params['Endpoint']
+        end
+      end
+
+      # CreateBatchOrganizationAuthorizationUrl返回参数结构体
+      class CreateBatchOrganizationAuthorizationUrlResponse < TencentCloud::Common::AbstractModel
+        # @param AuthUrl: 批量企业注册链接-单链接包含多条认证流，根据Endpoint的不同设置，返回不同的链接地址。失效时间：7天
+        # 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
+        # <table> <thead> <tr> <th>Endpoint</th> <th>示例</th> <th>链接有效期限</th> </tr> </thead>  <tbody>
+        #  <tr> <td>HTTP</td> <td>https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHHURDfBxSB2rj2Bfa</td> <td>7天</td> </tr>
+        # <tr> <td>HTTP_SHORT_URL</td> <td>https://test.essurl.cn/8gDKUBAWK8</td> <td>7天</td> </tr>
+        # <tr> <td>APP</td> <td>pages/guide/index?to=AUTHORIZATION_ENTERPRISE_FOR_BATCH_SUBMIT&shortKey=yDCHpURDfR6iEkdpsDde</td> <td>7天</td> </tr><tr> <td>QR_CODE</td> <td>https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/authorization_enterprise_for_batch_submit/yDCHHUUckpbdauq9UEjnoFDCCumAMmv1.png</td> <td>7天</td> </tr> </tbody> </table>
+        # 注：
+        # `1.创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义`
+        # @type AuthUrl: String
+        # @param ErrorMessages: 认证流认证失败信息
+        # @type ErrorMessages: Array
+        # @param ExpireTime: 链接过期时间，为 7 天后，创建时间，格式为Unix标准时间戳（秒）。
+        # @type ExpireTime: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :AuthUrl, :ErrorMessages, :ExpireTime, :RequestId
+
+        def initialize(authurl=nil, errormessages=nil, expiretime=nil, requestid=nil)
+          @AuthUrl = authurl
+          @ErrorMessages = errormessages
+          @ExpireTime = expiretime
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @AuthUrl = params['AuthUrl']
+          @ErrorMessages = params['ErrorMessages']
+          @ExpireTime = params['ExpireTime']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateBatchOrganizationRegistrationTasks请求参数结构体
       class CreateBatchOrganizationRegistrationTasksRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -10745,10 +10906,15 @@ module TencentCloud
         # <li> 5 :设备指纹识别</li>
         # <li> 6 :设备面容识别</li></ul>
         # @type ApproverSignTypes: Array
+        # @param NoTransfer: 签署方是否可以转他人处理
 
-        attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra, :ApproverVerifyTypes, :ApproverSignTypes
+        # <ul><li> **false** : ( 默认)可以转他人处理</li>
+        # <li> **true** :不可以转他人处理</li></ul>
+        # @type NoTransfer: Boolean
 
-        def initialize(recipientid=nil, recipienttype=nil, description=nil, rolename=nil, requirevalidation=nil, requiresign=nil, routingorder=nil, requiredelivery=nil, email=nil, mobile=nil, userid=nil, deliverymethod=nil, recipientextra=nil, approververifytypes=nil, approversigntypes=nil)
+        attr_accessor :RecipientId, :RecipientType, :Description, :RoleName, :RequireValidation, :RequireSign, :RoutingOrder, :RequireDelivery, :Email, :Mobile, :UserId, :DeliveryMethod, :RecipientExtra, :ApproverVerifyTypes, :ApproverSignTypes, :NoTransfer
+
+        def initialize(recipientid=nil, recipienttype=nil, description=nil, rolename=nil, requirevalidation=nil, requiresign=nil, routingorder=nil, requiredelivery=nil, email=nil, mobile=nil, userid=nil, deliverymethod=nil, recipientextra=nil, approververifytypes=nil, approversigntypes=nil, notransfer=nil)
           @RecipientId = recipientid
           @RecipientType = recipienttype
           @Description = description
@@ -10764,6 +10930,7 @@ module TencentCloud
           @RecipientExtra = recipientextra
           @ApproverVerifyTypes = approververifytypes
           @ApproverSignTypes = approversigntypes
+          @NoTransfer = notransfer
         end
 
         def deserialize(params)
@@ -10782,6 +10949,7 @@ module TencentCloud
           @RecipientExtra = params['RecipientExtra']
           @ApproverVerifyTypes = params['ApproverVerifyTypes']
           @ApproverSignTypes = params['ApproverSignTypes']
+          @NoTransfer = params['NoTransfer']
         end
       end
 

metadata

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