tencentcloud-sdk-essbasic 3.0.639 → 3.0.640

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6eabc2c31b1012da68e6b6a784232a5aa92f65d
-  data.tar.gz: 919cfe7f385fe1330174a318c67c0751222d4c52
+  metadata.gz: a0d183e4dd532100e7eee9518906eeb778c0f9de
+  data.tar.gz: 6f8bbb4a28f81d010a852dd5353cf0a32b10b411
 SHA512:
-  metadata.gz: 394ce36713a86a77d4544cd73b723ad64703c281f6b3475cabf8c8c3d35e2a26ea186e7c44e24c3cd9783b88ec3d21e8f663a29b67fa2ef4688f62a53e347b7a
-  data.tar.gz: 4b48994a7ac58ea50e4f85d0faa6ee1ac008df925a2feb2666d41154129eedd3d76a5ccbe574834b6280ee1c0867ebaa6b40a174e3cf8992dfb852c68cd2b9ce
+  metadata.gz: c61372f50ee2736f12d26dd64cfd834ee4f055e03f2986059347ecf690333aee2b4b5aac5cb162c8428c6aadc7fb1e054a8ce8effef871baa8cbdb47236a1bc8
+  data.tar.gz: 191a1f593290c6599a04191b31eb42cdba23237cf76833960a334e8e22dc21778dc61df67e776f918305f5cf48676f3ff5e453b872dd36ce0debcc56d6666d8b

data/lib/VERSION

@@ -1 +1 @@
-3.0.639
+3.0.640

data/lib/v20210526/client.rb

@@ -919,10 +919,16 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
-        # 若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。）
-        # 若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。
-        # 若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
+        # 此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。
+        # 链接访问后，会根据企业的和员工的状态（企业根据ProxyOrganizationOpenId参数，员工根据OpenId参数判断），进入不同的流程，主要情况分类如下：
+        # 1. 若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。
+        # 2. 若子客企业已激活，员工未激活，则会进入经办人激活流程。
+        # 3. 若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。
+
+        # 如果是企业激活流程，需要注意如下情况：
+
+        # 1. 若在激活过程中，更换用户OpenID重新生成链接，之前的认证会被清理。因此不要在认证过程中多人同时操作，导致认证过程互相影响。
+        # 2. 若您认证中发现信息有误需要重新认证，可以通过更换OpenID重新生成链接的方式，来清理掉已有的流程。
 
         # @param request: Request instance for CreateConsoleLoginUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateConsoleLoginUrlRequest`
@@ -1314,7 +1320,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，主要是子客企业的营业执照，便于子客企业开通过程中不用手动上传。若有需要调用此接口，需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
+        # 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称，企业营业执照，企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意：
+        # 1. 需要在子客企业激活前调用该接口，如果您的企业已经提交企业信息或者企业已经激活，同步的企业信息将不会生效。
+        # 2. 如果您同时传递了营业执照信息和企业名称等信息，在认证过程中将以营业执照中的企业信息为准，请注意企业信息需要和营业执照信息对应。
 
         # @param request: Request instance for SyncProxyOrganization.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationRequest`

data/lib/v20210526/models.rb

@@ -3214,38 +3214,76 @@ module TencentCloud
         # 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param ProxyOrganizationName: 子客企业名称，最大长度64个字符
+        # 注意：
+        # 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。
+        # 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
         # @type ProxyOrganizationName: String
+        # @param UniformSocialCreditCode: 子客企业统一社会信用代码，最大长度200个字符
+        # 注意：
+        # 1、如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。
+        # @type UniformSocialCreditCode: String
         # @param ProxyOperatorName: 子客企业经办人的姓名，最大长度50个字符
+        # 注意：
+        # 1、若经办人已经实名，这里修改经办人名字传入将不会生效。
+        # 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
         # @type ProxyOperatorName: String
-        # @param Module: PC控制台指定模块，文件/合同管理:"DOCUMENT"，模板管理:"TEMPLATE"，印章管理:"SEAL"，组织架构/人员:"OPERATOR"，空字符串："账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
+        # @param Module: PC控制台登录后进入该参数指定的模块，如果不传递，将默认进入控制台首页。支持的模块包括：
+        # 1、DOCUMENT:合同管理模块，
+        # 2、TEMPLATE:企业模板管理模块，
+        # 3、SEAL:印章管理模块，
+        # 4、OPERATOR:组织管理模块，
+        # 默认将进入企业中心模块
+        # 注意：
+        # 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块
+        # 2、该参数仅在企业和员工激活完成，登录控制台场景才生效。
         # @type Module: String
-        # @param ModuleId: 控制台指定模块Id
+        # @param ModuleId: 该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。
+        # 根据Module参数的不同所代表的含义不同。当前支持：
+        # 1、如果Module="SEAL"，ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。
+        # 2、如果Module="TEMPLATE"，ModuleId代表模版Id，登录链接将直接查看指定模版的详情。
+        # 3、如果Module="1、DOCUMENT"，ModuleId代表合同Id，登录链接将直接查看指定合同的详情。
+        # 注意：
+        # 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。
+        # 2、ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到。
         # @type ModuleId: String
-        # @param UniformSocialCreditCode: 子客企业统一社会信用代码，最大长度200个字符
-        # @type UniformSocialCreditCode: String
-        # @param MenuStatus: 是否展示左侧菜单栏 是：ENABLE（默认） 否：DISABLE
+        # @param MenuStatus: 是否展示左侧菜单栏
+        # "ENABLE": 是，展示
+        # “DISABLE”: 否，不展示
+        # 默认值为ENABLE
+        # 注意：
+        # 1、该参数仅在企业和员工激活完成，登录控制台场景才生效。
         # @type MenuStatus: String
-        # @param Endpoint: 链接跳转类型："PC"-PC控制台，“CHANNEL”-H5跳转到电子签小程序；“APP”-第三方APP或小程序跳转电子签小程序，默认为PC控制台
+        # @param Endpoint: 生成链接的类型：
+        # "PC"：PC控制台链接
+        # "CHANNEL"：H5跳转到电子签小程序链接
+        # "APP"：第三方APP或小程序跳转电子签小程序链接
+        # 默认将生成PC控制台链接
         # @type Endpoint: String
-        # @param AutoJumpBackEvent: 触发自动跳转事件，仅对App类型有效，"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
+        # @param AutoJumpBackEvent: 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：
+        # "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
         # @type AutoJumpBackEvent: String
-        # @param AuthorizationTypes: 支持的授权方式,授权方式: "1" - 上传授权书认证  "2" - 法定代表人认证
+        # @param AuthorizationTypes: 可选的企业授权方式:
+        # 1：上传授权书
+        # 2：转法定代表人授权
+        # 4：企业实名认证（信任第三方认证源）（此项仅支持单选）
+        # 未选择信任第三方认证源时，如果是法人进行企业激活，仅支持法人扫脸直接授权，该配置不生效；选择信任第三方认证源时，请先通过“同步企业信息”接口同步信息。
+        # 该参数仅在企业激活场景生效
         # @type AuthorizationTypes: Array
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :Agent, :ProxyOrganizationName, :ProxyOperatorName, :Module, :ModuleId, :UniformSocialCreditCode, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
+        attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
         extend Gem::Deprecate
         deprecate :Operator, :none, 2023, 8
         deprecate :Operator=, :none, 2023, 8
 
-        def initialize(agent=nil, proxyorganizationname=nil, proxyoperatorname=nil, _module=nil, moduleid=nil, uniformsocialcreditcode=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, operator=nil)
+        def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, _module=nil, moduleid=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, operator=nil)
           @Agent = agent
           @ProxyOrganizationName = proxyorganizationname
+          @UniformSocialCreditCode = uniformsocialcreditcode
           @ProxyOperatorName = proxyoperatorname
           @Module = _module
           @ModuleId = moduleid
-          @UniformSocialCreditCode = uniformsocialcreditcode
           @MenuStatus = menustatus
           @Endpoint = endpoint
           @AutoJumpBackEvent = autojumpbackevent
@@ -3259,10 +3297,10 @@ module TencentCloud
             @Agent.deserialize(params['Agent'])
           end
           @ProxyOrganizationName = params['ProxyOrganizationName']
+          @UniformSocialCreditCode = params['UniformSocialCreditCode']
           @ProxyOperatorName = params['ProxyOperatorName']
           @Module = params['Module']
           @ModuleId = params['ModuleId']
-          @UniformSocialCreditCode = params['UniformSocialCreditCode']
           @MenuStatus = params['MenuStatus']
           @Endpoint = params['Endpoint']
           @AutoJumpBackEvent = params['AutoJumpBackEvent']
@@ -3278,14 +3316,18 @@ module TencentCloud
       class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
         # @param ConsoleUrl: 子客企业Web控制台url注意事项：
         # 1. 所有类型的链接在企业未认证/员工未认证完成时，只要在有效期内（一年）都可以访问
-        # 2. 若企业认证完成且员工认证完成后，重新获取pc端的链接5分钟之内有效，且只能访问一次
-        # 3. 若企业认证完成且员工认证完成后，重新获取H5/APP的链接只要在有效期内（一年）都可以访问
-        # 4. 此链接仅单次有效，使用后需要再次创建新的链接（部分聊天软件，如企业微信默认会对链接进行解析，此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接）
+        # 2. 若企业认证完成且员工认证完成后，重新获取pc端的链接在5分钟之内有效，且只能访问一次
+        # 3. 若企业认证完成且员工认证完成后，重新获取CHANNEL/APP的链接只要在有效期内（一年）都可以访问
+        # 4. 此链接仅单次有效，每次登录需要需要重新创建新的链接，尽量不要做链接存储，多次使用。
         # 5. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
         # @type ConsoleUrl: String
         # @param IsActivated: 子客企业是否已开通腾讯电子签，true-是，false-否
+        # 注意：
+        # 1、企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断，非企业名称或者社会信用代码
         # @type IsActivated: Boolean
-        # @param ProxyOperatorIsVerified: 当前经办人是否已认证（false:未认证 true:已认证）
+        # @param ProxyOperatorIsVerified: 当前经办人是否已认证，true-是，false-否
+        # 注意：
+        # 1、经办人是否实名是根据Agent.ProxyOperator.OpenId判断，非经办人姓名
         # @type ProxyOperatorIsVerified: Boolean
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -6042,19 +6084,25 @@ module TencentCloud
         # @type ProxyLegalName: String
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param ProxyLegalIdCardType: 第三方平台子客企业法人/负责人证件类型，默认居民身份证（ID_CARD）类型，暂不支持其他类型
+        # @type ProxyLegalIdCardType: String
+        # @param ProxyLegalIdCardNumber: 第三方平台子客企业法人/负责人证件号
+        # @type ProxyLegalIdCardNumber: String
 
-        attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator
+        attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator, :ProxyLegalIdCardType, :ProxyLegalIdCardNumber
         extend Gem::Deprecate
         deprecate :Operator, :none, 2023, 8
         deprecate :Operator=, :none, 2023, 8
 
-        def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil)
+        def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil, proxylegalidcardtype=nil, proxylegalidcardnumber=nil)
           @Agent = agent
           @ProxyOrganizationName = proxyorganizationname
           @BusinessLicense = businesslicense
           @UniformSocialCreditCode = uniformsocialcreditcode
           @ProxyLegalName = proxylegalname
           @Operator = operator
+          @ProxyLegalIdCardType = proxylegalidcardtype
+          @ProxyLegalIdCardNumber = proxylegalidcardnumber
         end
 
         def deserialize(params)
@@ -6070,6 +6118,8 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          @ProxyLegalIdCardType = params['ProxyLegalIdCardType']
+          @ProxyLegalIdCardNumber = params['ProxyLegalIdCardNumber']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.639
+  version: 3.0.640
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common