tencentcloud-sdk-essbasic 3.0.723 → 3.0.725

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bc0936d1d4c74c706303abe9910c69f39b8b155
-  data.tar.gz: 5fce772aa91c87ebc1ea97a8ba0f83aeb2aafa96
+  metadata.gz: 5e443eb8513f210b2625451f42484eada98bdedd
+  data.tar.gz: 2c4b7f77e898d9ad9cd678f1b2ca79cd998023b5
 SHA512:
-  metadata.gz: 9056dc3e244965132fb6664e0ef2b7dc0e8389c216e5d2060167ba8e5914fb7a2c7c55e85c8f69bfefcc7883a4f28393b1bedc1cea047a13dfe01fe7e503dd77
-  data.tar.gz: 98afbe26b923d4b78375aed699ee2dbf4de8e5a5436c0df9a8f9c95e47d61ff85f8cfb5b68cefc69a38393e763ff2d004ff85214800fc0b519c55efe9feed150
+  metadata.gz: 056b1c2a6ecc088ae662b7dd4479e1074cd4777fcc11f4bbacd366654491b1078b95d3400674f12d5feb2bc5521ee7da8522068953bb41ae14df91d4fa2338b4
+  data.tar.gz: 5568793278b81c250a6c73cad18d75ddf94162bff6e886df668bdea02c857c967481071a7ae573ce0203c6f76eec007999092b57c6b0df9f4cbba67f90a044a5

data/lib/VERSION

@@ -1 +1 @@
-3.0.723
+3.0.725

data/lib/v20210526/client.rb

@@ -214,7 +214,7 @@ module TencentCloud
 
         # 注：
         # - 参与人点击链接后需短信验证码才能查看合同内容。
-        # - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。
+        # - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。若为子客企业，请确保员工已经加入企业。
         # - 个人批量签署，签名区`仅支持手写签名`。
 
         # @param request: Request instance for ChannelCreateBatchSignUrl.
@@ -1793,6 +1793,33 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 查询渠道子客企业信息时，可以支持单个子客和整个应用下所有子客的查询。返回的信息包括超管、法人的信息以及当前企业的认证状态等信息。
+
+        # - 对于单个企业的查询，通过**指定子客的唯一标识**来查询该子客的企业信息
+        # - 对于整个应用下所有企业的查询，**不需要指定子客的唯一标识**，直接查询整个应用下所有子客企业的企业信息
+
+        # @param request: Request instance for DescribeChannelOrganizations.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeChannelOrganizationsRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::DescribeChannelOrganizationsResponse`
+        def DescribeChannelOrganizations(request)
+          body = send_request('DescribeChannelOrganizations', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeChannelOrganizationsResponse.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
+
         # 生成渠道子客用印申请审批小程序链接，链接类型（通过H5唤起小程序或通过APP跳转的方式查看）
 
         # @param request: Request instance for DescribeChannelSealPolicyWorkflowUrl.

data/lib/v20210526/models.rb

@@ -938,9 +938,6 @@ module TencentCloud
 
       # ChannelCreateBatchQuickSignUrl请求参数结构体
       class ChannelCreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel
-        # @param FlowIds: 批量签署的合同流程ID数组。
-        # 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
-        # @type FlowIds: Array
         # @param FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
         # 注:
         # `1. ApproverType目前只支持个人类型的签署人。`
@@ -949,6 +946,12 @@ module TencentCloud
         # @type FlowApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverInfo`
         # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param FlowIds: 批量签署的合同流程ID数组。
+        # 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
+        # @type FlowIds: Array
+        # @param FlowGroupId: 合同组编号
+        # 注：`该参数和合同流程ID数组必须二选一`
+        # @type FlowGroupId: String
         # @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
         # @type JumpUrl: String
         # @param SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：
@@ -967,19 +970,19 @@ module TencentCloud
         # <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
         # @type ApproverSignTypes: Array
 
-        attr_accessor :FlowIds, :FlowApproverInfo, :Agent, :JumpUrl, :SignatureTypes, :ApproverSignTypes
+        attr_accessor :FlowApproverInfo, :Agent, :FlowIds, :FlowGroupId, :JumpUrl, :SignatureTypes, :ApproverSignTypes
 
-        def initialize(flowids=nil, flowapproverinfo=nil, agent=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil)
-          @FlowIds = flowids
+        def initialize(flowapproverinfo=nil, agent=nil, flowids=nil, flowgroupid=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil)
           @FlowApproverInfo = flowapproverinfo
           @Agent = agent
+          @FlowIds = flowids
+          @FlowGroupId = flowgroupid
           @JumpUrl = jumpurl
           @SignatureTypes = signaturetypes
           @ApproverSignTypes = approversigntypes
         end
 
         def deserialize(params)
-          @FlowIds = params['FlowIds']
           unless params['FlowApproverInfo'].nil?
             @FlowApproverInfo = FlowApproverInfo.new
             @FlowApproverInfo.deserialize(params['FlowApproverInfo'])
@@ -988,6 +991,8 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
+          @FlowIds = params['FlowIds']
+          @FlowGroupId = params['FlowGroupId']
           @JumpUrl = params['JumpUrl']
           @SignatureTypes = params['SignatureTypes']
           @ApproverSignTypes = params['ApproverSignTypes']
@@ -1064,6 +1069,7 @@ module TencentCloud
         # <li>请确认该名称与企业营业执照中注册的名称一致。</li>
         # <li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>
         # <li>请确保此企业已完成腾讯电子签企业认证。</li>
+        # <li>若为子客企业，请确保员工已经加入企业。</li>
         # </ul>
         # @type OrganizationName: String
         # @param JumpToDetail: 是否直接跳转至合同内容页面进行签署
@@ -2480,10 +2486,12 @@ module TencentCloud
         # @type EnableAutoSign: Boolean
         # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
         # @type LicenseType: Integer
+        # @param SceneKey: <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li><li> **OTHER** :  通用场景</li></ul>
+        # @type SceneKey: String
 
-        attr_accessor :Agent, :UserName, :IdCardNumber, :SealName, :SealImage, :Operator, :IdCardType, :SealImageCompress, :Mobile, :EnableAutoSign, :LicenseType
+        attr_accessor :Agent, :UserName, :IdCardNumber, :SealName, :SealImage, :Operator, :IdCardType, :SealImageCompress, :Mobile, :EnableAutoSign, :LicenseType, :SceneKey
 
-        def initialize(agent=nil, username=nil, idcardnumber=nil, sealname=nil, sealimage=nil, operator=nil, idcardtype=nil, sealimagecompress=nil, mobile=nil, enableautosign=nil, licensetype=nil)
+        def initialize(agent=nil, username=nil, idcardnumber=nil, sealname=nil, sealimage=nil, operator=nil, idcardtype=nil, sealimagecompress=nil, mobile=nil, enableautosign=nil, licensetype=nil, scenekey=nil)
           @Agent = agent
           @UserName = username
           @IdCardNumber = idcardnumber
@@ -2495,6 +2503,7 @@ module TencentCloud
           @Mobile = mobile
           @EnableAutoSign = enableautosign
           @LicenseType = licensetype
+          @SceneKey = scenekey
         end
 
         def deserialize(params)
@@ -2515,6 +2524,7 @@ module TencentCloud
           @Mobile = params['Mobile']
           @EnableAutoSign = params['EnableAutoSign']
           @LicenseType = params['LicenseType']
+          @SceneKey = params['SceneKey']
         end
       end
 
@@ -4023,6 +4033,77 @@ module TencentCloud
         end
       end
 
+      # 渠道企业信息
+      class ChannelOrganizationInfo < TencentCloud::Common::AbstractModel
+        # @param OrganizationId: 电子签平台给企业分配的ID（在不同应用下同一个企业会分配通用的ID）
+        # @type OrganizationId: String
+        # @param OrganizationOpenId: 第三方平台子客企业的唯一标识
+        # @type OrganizationOpenId: String
+        # @param OrganizationName: 第三方平台子客企业名称
+        # @type OrganizationName: String
+        # @param UnifiedSocialCreditCode: 企业的统一社会信用代码
+        # @type UnifiedSocialCreditCode: String
+        # @param LegalName: 企业法定代表人的姓名
+        # @type LegalName: String
+        # @param LegalOpenId: 企业法定代表人作为第三方平台子客企业员工的唯一标识
+        # @type LegalOpenId: String
+        # @param AdminName: 企业超级管理员的姓名
+        # @type AdminName: String
+        # @param AdminOpenId: 企业超级管理员作为第三方平台子客企业员工的唯一标识
+        # @type AdminOpenId: String
+        # @param AdminMobile: 企业超级管理员的手机号码
+        # **注**：`手机号码脱敏（隐藏部分用*替代）`
+        # @type AdminMobile: String
+        # @param AuthorizationStatus: 企业认证状态字段。值如下：
+        # <ul>
+        #   <li>**"UNVERIFIED"**： 未认证的企业</li>
+        #   <li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
+        #   <li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
+        #   <li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
+        #   <li>**"VERIFYING"**： 认证中的企业</li>
+        #   <li>**"VERIFIED"**： 已认证的企业</li>
+        # </ul>
+        # @type AuthorizationStatus: String
+        # @param AuthorizationType: 企业认证方式字段。值如下：
+        # <ul>
+        #   <li>**"AuthorizationInit"**： 暂未选择授权方式</li>
+        #   <li>**"AuthorizationFile"**： 授权书</li>
+        #   <li>**"AuthorizationLegalPerson"**： 法人授权超管</li>
+        #   <li>**"AuthorizationLegalIdentity"**： 法人直接认证</li>
+        # </ul>
+        # @type AuthorizationType: String
+
+        attr_accessor :OrganizationId, :OrganizationOpenId, :OrganizationName, :UnifiedSocialCreditCode, :LegalName, :LegalOpenId, :AdminName, :AdminOpenId, :AdminMobile, :AuthorizationStatus, :AuthorizationType
+
+        def initialize(organizationid=nil, organizationopenid=nil, organizationname=nil, unifiedsocialcreditcode=nil, legalname=nil, legalopenid=nil, adminname=nil, adminopenid=nil, adminmobile=nil, authorizationstatus=nil, authorizationtype=nil)
+          @OrganizationId = organizationid
+          @OrganizationOpenId = organizationopenid
+          @OrganizationName = organizationname
+          @UnifiedSocialCreditCode = unifiedsocialcreditcode
+          @LegalName = legalname
+          @LegalOpenId = legalopenid
+          @AdminName = adminname
+          @AdminOpenId = adminopenid
+          @AdminMobile = adminmobile
+          @AuthorizationStatus = authorizationstatus
+          @AuthorizationType = authorizationtype
+        end
+
+        def deserialize(params)
+          @OrganizationId = params['OrganizationId']
+          @OrganizationOpenId = params['OrganizationOpenId']
+          @OrganizationName = params['OrganizationName']
+          @UnifiedSocialCreditCode = params['UnifiedSocialCreditCode']
+          @LegalName = params['LegalName']
+          @LegalOpenId = params['LegalOpenId']
+          @AdminName = params['AdminName']
+          @AdminOpenId = params['AdminOpenId']
+          @AdminMobile = params['AdminMobile']
+          @AuthorizationStatus = params['AuthorizationStatus']
+          @AuthorizationType = params['AuthorizationType']
+        end
+      end
+
       # 角色信息
       class ChannelRole < TencentCloud::Common::AbstractModel
         # @param RoleId: 角色ID,为32位字符串
@@ -5608,6 +5689,96 @@ module TencentCloud
         end
       end
 
+      # DescribeChannelOrganizations请求参数结构体
+      class DescribeChannelOrganizationsRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+
+        # 渠道应用标识: Agent.AppId
+        # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
+        # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
+
+        # 第三方平台子客企业和员工必须已经经过实名认证
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param Limit: 指定分页每页返回的数据条数，单页最大支持 200。
+        # @type Limit: Integer
+        # @param OrganizationOpenId: 该字段是指第三方平台子客企业的唯一标识，用于查询单独某个子客的企业数据。
+
+        # **注**：`如果需要批量查询本应用下的所有企业的信息，则该字段不需要赋值`
+        # @type OrganizationOpenId: String
+        # @param AuthorizationStatusList: 可以按照当前企业的认证状态进行过滤。可值如下：
+        # <ul><li>**"UNVERIFIED"**： 未认证的企业</li>
+        #   <li>**"VERIFYINGLEGALPENDINGAUTHORIZATION"**： 认证中待法人授权的企业</li>
+        #   <li>**"VERIFYINGAUTHORIZATIONFILEPENDING"**： 认证中授权书审核中的企业</li>
+        #   <li>**"VERIFYINGAUTHORIZATIONFILEREJECT"**： 认证中授权书已驳回的企业</li>
+        #   <li>**"VERIFYING"**： 认证进行中的企业</li>
+        #   <li>**"VERIFIED"**： 已认证完成的企业</li></ul>
+        # @type AuthorizationStatusList: Array
+        # @param Offset: 指定分页返回第几页的数据，如果不传默认返回第一页。 页码从 0 开始，即首页为 0，最大20000。
+        # @type Offset: Integer
+
+        attr_accessor :Agent, :Limit, :OrganizationOpenId, :AuthorizationStatusList, :Offset
+
+        def initialize(agent=nil, limit=nil, organizationopenid=nil, authorizationstatuslist=nil, offset=nil)
+          @Agent = agent
+          @Limit = limit
+          @OrganizationOpenId = organizationopenid
+          @AuthorizationStatusList = authorizationstatuslist
+          @Offset = offset
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @Limit = params['Limit']
+          @OrganizationOpenId = params['OrganizationOpenId']
+          @AuthorizationStatusList = params['AuthorizationStatusList']
+          @Offset = params['Offset']
+        end
+      end
+
+      # DescribeChannelOrganizations返回参数结构体
+      class DescribeChannelOrganizationsResponse < TencentCloud::Common::AbstractModel
+        # @param ChannelOrganizationInfos: 满足查询条件的企业信息列表。
+        # @type ChannelOrganizationInfos: Array
+        # @param Offset: 指定分页返回第几页的数据。页码从 0 开始，即首页为 0，最大20000。
+        # @type Offset: Integer
+        # @param Limit: 指定分页每页返回的数据条数，单页最大支持 200。
+        # @type Limit: Integer
+        # @param Total: 满足查询条件的企业总数量。
+        # @type Total: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :ChannelOrganizationInfos, :Offset, :Limit, :Total, :RequestId
+
+        def initialize(channelorganizationinfos=nil, offset=nil, limit=nil, total=nil, requestid=nil)
+          @ChannelOrganizationInfos = channelorganizationinfos
+          @Offset = offset
+          @Limit = limit
+          @Total = total
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['ChannelOrganizationInfos'].nil?
+            @ChannelOrganizationInfos = []
+            params['ChannelOrganizationInfos'].each do |i|
+              channelorganizationinfo_tmp = ChannelOrganizationInfo.new
+              channelorganizationinfo_tmp.deserialize(i)
+              @ChannelOrganizationInfos << channelorganizationinfo_tmp
+            end
+          end
+          @Offset = params['Offset']
+          @Limit = params['Limit']
+          @Total = params['Total']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeChannelSealPolicyWorkflowUrl请求参数结构体
       class DescribeChannelSealPolicyWorkflowUrlRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -7291,14 +7462,14 @@ module TencentCloud
       # | cells.N.columnStart | Integer | 单元格坐标：列起始index                           |
       # | cells.N.columnEnd   | Integer | 单元格坐标：列结束index                           |
       # | cells.N.content     | String  | 单元格内容，字数不超过100                         |
-      # | cells.N.style         | String  | 单元格字体风格配置 ，风格配置的json字符串  如： {"font":"黑体","fontSize":12,"color":"FFFFFF","bold":true,"align":"CENTER"}      |
+      # | cells.N.style         | String  | 单元格字体风格配置 ，风格配置的json字符串  如： {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"}      |
 
       # 表格参数headers说明
       # widthPercent Integer 表头单元格列占总表头的比例，例如1：30表示 此列占表头的30%，不填写时列宽度平均拆分；例如2：总2列，某一列填写40，剩余列可以为空，按照60计算。；例如3：总3列，某一列填写30，剩余2列可以为空，分别为(100-30)/2=35
 
       # content String 表头单元格内容，字数不超过100
 
-      # style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF  字符串形如：  "FFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
+      # style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF  字符串形如：  "#FFFFFF" 或者 "0xFFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
       class FormField < TencentCloud::Common::AbstractModel
         # @param ComponentValue: 控件填充值，ComponentType和传入值格式对应关系如下：
         # <ul>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.723
+  version: 3.0.725
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common