tencentcloud-sdk-essbasic 3.0.749 → 3.0.751

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1455efcc7e0d8f8502fa9efa3455afb718817d93
-  data.tar.gz: 5666697a3f15fbecab8a06dadce60cde42a82880
+  metadata.gz: d45fa8fe7943833b307782c23848be60dadd31a7
+  data.tar.gz: ce10d388e2aff703cc0cc02db6d409abe3ce3848
 SHA512:
-  metadata.gz: c9e966096500259513ade73f9124f877c70cec8cac57f7f8a2a6e816c90854c9a5e814d2540e25fa3453326a71069a7801ab6895eee14417942d461ca85b146d
-  data.tar.gz: c5e8c35206b4830a0ded065a91e8f4c1c54480a1d770d280283f1a4a0b916b03ade0c36367e1766b253b92b34a2b21ab8b9994b746fd17b4a600b6c1104dffa9
+  metadata.gz: 8c0e53aee4b2ef7c77db732e721b8687fa6d9fcbe8844b9bd5e8b04433335fb70f6bb54a1abca293caef4e3de99ca6938c0670d7b05fc11822b0491a16e8ecd5
+  data.tar.gz: 53e8b5d9c0d54b7961c0994eea6636496cfdd87bc239e6ac6894efd286cbb3c94f56024170672785a2875f1164f1df62050bdd9c75735049531ceee57d61a09d

data/lib/VERSION

@@ -1 +1 @@
-3.0.749
+3.0.751

data/lib/v20210526/client.rb

@@ -708,15 +708,14 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
+        # 该接口用于发起合同后，生成用户的签署链接 <br/>
 
         # **注意**
-        # 1. 该接口目前**仅支持签署人类型是个人签署方**的场景（PERSON）。
-        # 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，**不支持填写控件** 。
-        # 3. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
-        # 4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        # 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。
+        # 2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
+        # 3. 该接口返回的签署链接适用于APP集成的场景，支持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>。
-        # 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        # 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
 
         # @param request: Request instance for ChannelCreateFlowSignUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`

data/lib/v20210526/models.rb

@@ -2096,10 +2096,11 @@ module TencentCloud
         # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
         # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         # @type FlowId: String
-        # @param FlowApproverInfos: 流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，其他可不传。
+        # @param FlowApproverInfos: 流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId，其他可不传。
+
         # 注:
-        # `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
-        # `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+        # `1. 签署人只能有手写签名、时间类型和印章类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+        # `2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
         # @type FlowApproverInfos: Array
         # @param Operator: 用户信息，暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -2107,21 +2108,29 @@ module TencentCloud
         # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
         # @param JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
         # @type JumpUrl: String
+        # @param UrlType: 链接类型，支持指定以下类型
+        # <ul><li>0 : 签署链接 (默认值)</li>
+        # <li>1 : 预览链接</li></ul>
+        # 注:
+        # `1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
+        # `2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
+        # @type UrlType: Integer
 
-        attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl
+        attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl, :UrlType
         extend Gem::Deprecate
         deprecate :Operator, :none, 2024, 1
         deprecate :Operator=, :none, 2024, 1
         deprecate :Organization, :none, 2024, 1
         deprecate :Organization=, :none, 2024, 1
 
-        def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil)
+        def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil, urltype=nil)
           @Agent = agent
           @FlowId = flowid
           @FlowApproverInfos = flowapproverinfos
           @Operator = operator
           @Organization = organization
           @JumpUrl = jumpurl
+          @UrlType = urltype
         end
 
         def deserialize(params)
@@ -2147,6 +2156,7 @@ module TencentCloud
             @Organization.deserialize(params['Organization'])
           end
           @JumpUrl = params['JumpUrl']
+          @UrlType = params['UrlType']
         end
       end
 
@@ -4576,8 +4586,9 @@ module TencentCloud
         # <li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
         # <li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
 
-        # **如果是SignComponent签署控件类型，则可选的字段为**
-
+        # **如果是SignComponent签署控件类型，
+        # 需要根据签署人的类型可选的字段为**
+        # * 企业方
         # <ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
         # <li> <b>SIGN_DATE</b> : 签署日期控件；</li>
         # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
@@ -4585,6 +4596,12 @@ module TencentCloud
         # <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
         # <li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
         # <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
+
+        # * 个人方
+        # <ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
+        # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
+        # <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li></ul>
+
         # 注：` 表单域的控件不能作为印章和签名控件`
         # @type ComponentType: String
         # @param ComponentName: **在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
@@ -4846,7 +4863,9 @@ module TencentCloud
         # <ul><li>**PC**：(默认)web控制台链接, 需要在PC浏览器中打开</li>
         # <li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
         # <li>**SHORT_URL**：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
-        # <li>**APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li></ul>
+        # <li>**APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li>
+        # <li>**H5**：第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来,  打开后进入腾讯电子签H5页面</li>
+        # <li>**SHORT_H5**：第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来,  打开后进入腾讯电子签H5页面</li></ul>
         # 示例值：PC
         # @type Endpoint: String
 
@@ -5097,7 +5116,9 @@ module TencentCloud
         # <ul><li>**PC**：(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
         # <li>**CHANNEL**：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
         # <li>**SHORT_URL**：<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
-        # <li>**APP**：<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li></ul>
+        # <li>**APP**：<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li>
+        # <li>**H5**：<font color="red">H5长链接</font>跳转H5链接, 一般用于贵方H5跳转过来,  打开后进入腾讯电子签H5页面</li>
+        # <li>**SHORT_H5**：<font color="red">H5短链</font>跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面</li></ul>
         # @type Endpoint: String
         # @param AutoJumpBackEvent: 触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括：
         # <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
@@ -5114,13 +5135,19 @@ module TencentCloud
         # @type AuthorizationTypes: Array
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-
-        attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
+        # @param ProxyOperatorIdCardNumber: 子客经办人身份证
+        # 注意：`如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持居民身份证类型`。
+        # @type ProxyOperatorIdCardNumber: String
+        # @param AutoJumpUrl: 认证完成跳转链接
+        # 注意：`只在H5生效，域名需要联系我们开白`。
+        # @type AutoJumpUrl: String
+
+        attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator, :ProxyOperatorIdCardNumber, :AutoJumpUrl
         extend Gem::Deprecate
         deprecate :Operator, :none, 2024, 1
         deprecate :Operator=, :none, 2024, 1
 
-        def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, _module=nil, moduleid=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, proxyoperatoridcardnumber=nil, autojumpurl=nil)
           @Agent = agent
           @ProxyOrganizationName = proxyorganizationname
           @UniformSocialCreditCode = uniformsocialcreditcode
@@ -5132,6 +5159,8 @@ module TencentCloud
           @AutoJumpBackEvent = autojumpbackevent
           @AuthorizationTypes = authorizationtypes
           @Operator = operator
+          @ProxyOperatorIdCardNumber = proxyoperatoridcardnumber
+          @AutoJumpUrl = autojumpurl
         end
 
         def deserialize(params)
@@ -5152,13 +5181,16 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          @ProxyOperatorIdCardNumber = params['ProxyOperatorIdCardNumber']
+          @AutoJumpUrl = params['AutoJumpUrl']
         end
       end
 
       # CreateConsoleLoginUrl返回参数结构体
       class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
         # @param ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
-        # <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead>  <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td>  </tr>  <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td>  </tr>  <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td>  </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td>  </tr> </tbody> </table>
+        # <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th>
+        # <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead>  <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td>  </tr>  <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td>  </tr>  <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td>  </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td>  </tr>  <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP/H5/SHORT_H5</td> <td>30天</td>  </tr> </tbody> </table>
 
         # 注：
         # 1. <font color="red">链接仅单次有效</font>，每次登录需要需要重新创建新的链接
@@ -8932,10 +8964,17 @@ module TencentCloud
         # `1. 当前仅支持一种认证方式`
         # `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
         # @type AuthorizationTypes: Array
+        # @param AdminIdCardType: 经办人的证件类型，支持以下类型
+        # <ul><li>ID_CARD : 居民身份证  (默认值)</li>
+        # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+        # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
+        # @type AdminIdCardType: String
+        # @param AdminIdCardNumber: 经办人的证件号
+        # @type AdminIdCardNumber: String
 
-        attr_accessor :OrganizationName, :OrganizationOpenId, :OpenId, :UniformSocialCreditCode, :LegalName, :Address, :AdminName, :AdminMobile, :AuthorizationTypes
+        attr_accessor :OrganizationName, :OrganizationOpenId, :OpenId, :UniformSocialCreditCode, :LegalName, :Address, :AdminName, :AdminMobile, :AuthorizationTypes, :AdminIdCardType, :AdminIdCardNumber
 
-        def initialize(organizationname=nil, organizationopenid=nil, openid=nil, uniformsocialcreditcode=nil, legalname=nil, address=nil, adminname=nil, adminmobile=nil, authorizationtypes=nil)
+        def initialize(organizationname=nil, organizationopenid=nil, openid=nil, uniformsocialcreditcode=nil, legalname=nil, address=nil, adminname=nil, adminmobile=nil, authorizationtypes=nil, adminidcardtype=nil, adminidcardnumber=nil)
           @OrganizationName = organizationname
           @OrganizationOpenId = organizationopenid
           @OpenId = openid
@@ -8945,6 +8984,8 @@ module TencentCloud
           @AdminName = adminname
           @AdminMobile = adminmobile
           @AuthorizationTypes = authorizationtypes
+          @AdminIdCardType = adminidcardtype
+          @AdminIdCardNumber = adminidcardnumber
         end
 
         def deserialize(params)
@@ -8957,6 +8998,8 @@ module TencentCloud
           @AdminName = params['AdminName']
           @AdminMobile = params['AdminMobile']
           @AuthorizationTypes = params['AuthorizationTypes']
+          @AdminIdCardType = params['AdminIdCardType']
+          @AdminIdCardNumber = params['AdminIdCardNumber']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.749
+  version: 3.0.751
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common