tencentcloud-sdk-essbasic 3.0.749 → 3.0.750

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1455efcc7e0d8f8502fa9efa3455afb718817d93
4
- data.tar.gz: 5666697a3f15fbecab8a06dadce60cde42a82880
3
+ metadata.gz: d60c787e5756d9efaa7d3e1c9ca5c7793da9ef5a
4
+ data.tar.gz: c8f1c75456a3ca127b7299a4a2215b33e636f84a
5
5
  SHA512:
6
- metadata.gz: c9e966096500259513ade73f9124f877c70cec8cac57f7f8a2a6e816c90854c9a5e814d2540e25fa3453326a71069a7801ab6895eee14417942d461ca85b146d
7
- data.tar.gz: c5e8c35206b4830a0ded065a91e8f4c1c54480a1d770d280283f1a4a0b916b03ade0c36367e1766b253b92b34a2b21ab8b9994b746fd17b4a600b6c1104dffa9
6
+ metadata.gz: f79561ddc56ff7a828722c0033b2c55a9a5556c0afeb16ff06156a5fbe0266fc12f2b037422e40efa526d788e1358d67e9800f1334ba60dabb64a55fbcb2cef1
7
+ data.tar.gz: b503ebbb65ab5015329fb4047c99fbfec4587fa3e21a9c37ddef23ba592e19780fe7a927746d91c4fd8492b38815396127a619667b6ba6faf80ccc135360c246
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.749
1
+ 3.0.750
@@ -708,15 +708,14 @@ module TencentCloud
708
708
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
709
709
  end
710
710
 
711
- # 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
711
+ # 该接口用于发起合同后,生成用户的签署链接 <br/>
712
712
 
713
713
  # **注意**
714
- # 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
715
- # 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
716
- # 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
717
- # 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
714
+ # 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
715
+ # 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
716
+ # 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
718
717
  # 跳转到小程序的实现,参考微信官方文档(分为<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>。
719
- # 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
718
+ # 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
720
719
 
721
720
  # @param request: Request instance for ChannelCreateFlowSignUrl.
722
721
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
@@ -2096,10 +2096,11 @@ module TencentCloud
2096
2096
  # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2097
2097
  # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2098
2098
  # @type FlowId: String
2099
- # @param FlowApproverInfos: 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
2099
+ # @param FlowApproverInfos: 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId,其他可不传。
2100
+
2100
2101
  # 注:
2101
- # `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
2102
- # `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
2102
+ # `1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
2103
+ # `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
2103
2104
  # @type FlowApproverInfos: Array
2104
2105
  # @param Operator: 用户信息,暂未开放
2105
2106
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -2107,21 +2108,29 @@ module TencentCloud
2107
2108
  # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
2108
2109
  # @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
2109
2110
  # @type JumpUrl: String
2111
+ # @param UrlType: 链接类型,支持指定以下类型
2112
+ # <ul><li>0 : 签署链接 (默认值)</li>
2113
+ # <li>1 : 预览链接</li></ul>
2114
+ # 注:
2115
+ # `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
2116
+ # `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
2117
+ # @type UrlType: Integer
2110
2118
 
2111
- attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl
2119
+ attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl, :UrlType
2112
2120
  extend Gem::Deprecate
2113
2121
  deprecate :Operator, :none, 2024, 1
2114
2122
  deprecate :Operator=, :none, 2024, 1
2115
2123
  deprecate :Organization, :none, 2024, 1
2116
2124
  deprecate :Organization=, :none, 2024, 1
2117
2125
 
2118
- def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil)
2126
+ def initialize(agent=nil, flowid=nil, flowapproverinfos=nil, operator=nil, organization=nil, jumpurl=nil, urltype=nil)
2119
2127
  @Agent = agent
2120
2128
  @FlowId = flowid
2121
2129
  @FlowApproverInfos = flowapproverinfos
2122
2130
  @Operator = operator
2123
2131
  @Organization = organization
2124
2132
  @JumpUrl = jumpurl
2133
+ @UrlType = urltype
2125
2134
  end
2126
2135
 
2127
2136
  def deserialize(params)
@@ -2147,6 +2156,7 @@ module TencentCloud
2147
2156
  @Organization.deserialize(params['Organization'])
2148
2157
  end
2149
2158
  @JumpUrl = params['JumpUrl']
2159
+ @UrlType = params['UrlType']
2150
2160
  end
2151
2161
  end
2152
2162
 
@@ -4576,8 +4586,9 @@ module TencentCloud
4576
4586
  # <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
4577
4587
  # <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
4578
4588
 
4579
- # **如果是SignComponent签署控件类型,则可选的字段为**
4580
-
4589
+ # **如果是SignComponent签署控件类型,
4590
+ # 需要根据签署人的类型可选的字段为**
4591
+ # * 企业方
4581
4592
  # <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
4582
4593
  # <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
4583
4594
  # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
@@ -4585,6 +4596,12 @@ module TencentCloud
4585
4596
  # <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
4586
4597
  # <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
4587
4598
  # <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
4599
+
4600
+ # * 个人方
4601
+ # <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
4602
+ # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
4603
+ # <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
4604
+
4588
4605
  # 注:` 表单域的控件不能作为印章和签名控件`
4589
4606
  # @type ComponentType: String
4590
4607
  # @param ComponentName: **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
@@ -4846,7 +4863,9 @@ module TencentCloud
4846
4863
  # <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
4847
4864
  # <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
4848
4865
  # <li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
4849
- # <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
4866
+ # <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
4867
+ # <li>**H5**:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
4868
+ # <li>**SHORT_H5**:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>
4850
4869
  # 示例值:PC
4851
4870
  # @type Endpoint: String
4852
4871
 
@@ -5097,7 +5116,9 @@ module TencentCloud
5097
5116
  # <ul><li>**PC**:(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
5098
5117
  # <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
5099
5118
  # <li>**SHORT_URL**:<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
5100
- # <li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
5119
+ # <li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
5120
+ # <li>**H5**:<font color="red">H5长链接</font>跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
5121
+ # <li>**SHORT_H5**:<font color="red">H5短链</font>跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面</li></ul>
5101
5122
  # @type Endpoint: String
5102
5123
  # @param AutoJumpBackEvent: 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
5103
5124
  # <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
@@ -5114,13 +5135,19 @@ module TencentCloud
5114
5135
  # @type AuthorizationTypes: Array
5115
5136
  # @param Operator: 暂未开放
5116
5137
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
5117
-
5118
- attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator
5138
+ # @param ProxyOperatorIdCardNumber: 子客经办人身份证
5139
+ # 注意:`如果已同步,这里非空会更新同步的经办人身份证号,暂时只支持居民身份证类型`。
5140
+ # @type ProxyOperatorIdCardNumber: String
5141
+ # @param AutoJumpUrl: 认证完成跳转链接
5142
+ # 注意:`只在H5生效,域名需要联系我们开白`。
5143
+ # @type AutoJumpUrl: String
5144
+
5145
+ attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :Operator, :ProxyOperatorIdCardNumber, :AutoJumpUrl
5119
5146
  extend Gem::Deprecate
5120
5147
  deprecate :Operator, :none, 2024, 1
5121
5148
  deprecate :Operator=, :none, 2024, 1
5122
5149
 
5123
- def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, _module=nil, moduleid=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, operator=nil)
5150
+ 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)
5124
5151
  @Agent = agent
5125
5152
  @ProxyOrganizationName = proxyorganizationname
5126
5153
  @UniformSocialCreditCode = uniformsocialcreditcode
@@ -5132,6 +5159,8 @@ module TencentCloud
5132
5159
  @AutoJumpBackEvent = autojumpbackevent
5133
5160
  @AuthorizationTypes = authorizationtypes
5134
5161
  @Operator = operator
5162
+ @ProxyOperatorIdCardNumber = proxyoperatoridcardnumber
5163
+ @AutoJumpUrl = autojumpurl
5135
5164
  end
5136
5165
 
5137
5166
  def deserialize(params)
@@ -5152,13 +5181,16 @@ module TencentCloud
5152
5181
  @Operator = UserInfo.new
5153
5182
  @Operator.deserialize(params['Operator'])
5154
5183
  end
5184
+ @ProxyOperatorIdCardNumber = params['ProxyOperatorIdCardNumber']
5185
+ @AutoJumpUrl = params['AutoJumpUrl']
5155
5186
  end
5156
5187
  end
5157
5188
 
5158
5189
  # CreateConsoleLoginUrl返回参数结构体
5159
5190
  class CreateConsoleLoginUrlResponse < TencentCloud::Common::AbstractModel
5160
5191
  # @param ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
5161
- # <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>
5192
+ # <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th>
5193
+ # <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>
5162
5194
 
5163
5195
  # 注:
5164
5196
  # 1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
@@ -8932,10 +8964,17 @@ module TencentCloud
8932
8964
  # `1. 当前仅支持一种认证方式`
8933
8965
  # `2. 如果当前的企业类型是政府/事业单位, 则只支持上传授权书+对公打款`
8934
8966
  # @type AuthorizationTypes: Array
8967
+ # @param AdminIdCardType: 经办人的证件类型,支持以下类型
8968
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
8969
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
8970
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
8971
+ # @type AdminIdCardType: String
8972
+ # @param AdminIdCardNumber: 经办人的证件号
8973
+ # @type AdminIdCardNumber: String
8935
8974
 
8936
- attr_accessor :OrganizationName, :OrganizationOpenId, :OpenId, :UniformSocialCreditCode, :LegalName, :Address, :AdminName, :AdminMobile, :AuthorizationTypes
8975
+ attr_accessor :OrganizationName, :OrganizationOpenId, :OpenId, :UniformSocialCreditCode, :LegalName, :Address, :AdminName, :AdminMobile, :AuthorizationTypes, :AdminIdCardType, :AdminIdCardNumber
8937
8976
 
8938
- def initialize(organizationname=nil, organizationopenid=nil, openid=nil, uniformsocialcreditcode=nil, legalname=nil, address=nil, adminname=nil, adminmobile=nil, authorizationtypes=nil)
8977
+ def initialize(organizationname=nil, organizationopenid=nil, openid=nil, uniformsocialcreditcode=nil, legalname=nil, address=nil, adminname=nil, adminmobile=nil, authorizationtypes=nil, adminidcardtype=nil, adminidcardnumber=nil)
8939
8978
  @OrganizationName = organizationname
8940
8979
  @OrganizationOpenId = organizationopenid
8941
8980
  @OpenId = openid
@@ -8945,6 +8984,8 @@ module TencentCloud
8945
8984
  @AdminName = adminname
8946
8985
  @AdminMobile = adminmobile
8947
8986
  @AuthorizationTypes = authorizationtypes
8987
+ @AdminIdCardType = adminidcardtype
8988
+ @AdminIdCardNumber = adminidcardnumber
8948
8989
  end
8949
8990
 
8950
8991
  def deserialize(params)
@@ -8957,6 +8998,8 @@ module TencentCloud
8957
8998
  @AdminName = params['AdminName']
8958
8999
  @AdminMobile = params['AdminMobile']
8959
9000
  @AuthorizationTypes = params['AuthorizationTypes']
9001
+ @AdminIdCardType = params['AdminIdCardType']
9002
+ @AdminIdCardNumber = params['AdminIdCardNumber']
8960
9003
  end
8961
9004
  end
8962
9005
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.749
4
+ version: 3.0.750
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud