tencentcloud-sdk-essbasic 3.0.841 → 3.0.843

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e0d207cb9447fcd0c4581b2527440d1ca7ebc40
-  data.tar.gz: ef763a590ec61e621dfc6a277ceaf5f69f98242f
+  metadata.gz: ad07ec0faa7de948191d19d8dbc1ff395f19830a
+  data.tar.gz: e01624a2eaa71f874b93f20e59a5f88eb335555a
 SHA512:
-  metadata.gz: a707a871f306ae67a3e335263d68f695dcd1dab9991f5e62b79e69ceb0ca12a776440ebbd2380587369b9301acfc8b407f181de10dcb696b50fbda252a984f64
-  data.tar.gz: 0f80411aba4ecb4e59223dbeec598fd0bdb22186ce0bcba770fd09f78dcea9bbeac8f7446883f808d1e252181c21163bb9d356b4c6f30a5deccaab4c820a0427
+  metadata.gz: 69de9f3fb6b00a6d2f87bbc46f43f71c1b673b061abd1cb28cd54c5f931ccc9cf84ae1580c656dbce9738d90d159c470b6c842daa4e8865bd7a36f6306c42b50
+  data.tar.gz: 6d4d61099301c9df297185749630e76f43a1822eeb042acf2daf0c5c55903311f2cb9187cfd830f05f13c793ed95037e03d7d87d313e5b3d5c7c8a52c89f3d7b

data/lib/VERSION

@@ -1 +1 @@
-3.0.841
+3.0.843

data/lib/v20210526/client.rb

@@ -681,11 +681,10 @@ module TencentCloud
         # 该接口用于发起合同后，生成用户的签署链接 <br/>
 
         # **注意**
-        # 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。
-        # 2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
-        # 3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        # 1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
+        # 2. 该接口返回的签署链接适用于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>。
-        # 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        # 3. 因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`
@@ -2561,6 +2560,9 @@ module TencentCloud
         # httpProfile.setEndpoint("file.test.ess.tencent.cn");
         # ```
 
+        # <font color="red">相关视频指引</font> <br>
+        # 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
+
         # @param request: Request instance for UploadFiles.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::UploadFilesRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::UploadFilesResponse`

data/lib/v20210526/models.rb

@@ -1378,19 +1378,22 @@ module TencentCloud
         # </li>
         # </ul>
         # @type UserData: String
+        # @param Option: 个性化参数，用于控制页面展示内容
+        # @type Option: :class:`Tencentcloud::Essbasic.v20210526.models.EmbedUrlOption`
 
-        attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator, :UserData
+        attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator, :UserData, :Option
         extend Gem::Deprecate
         deprecate :Operator, :none, 2024, 6
         deprecate :Operator=, :none, 2024, 6
 
-        def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil, userdata=nil)
+        def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil, userdata=nil, option=nil)
           @Agent = agent
           @EmbedType = embedtype
           @BusinessId = businessid
           @HiddenComponents = hiddencomponents
           @Operator = operator
           @UserData = userdata
+          @Option = option
         end
 
         def deserialize(params)
@@ -1406,6 +1409,10 @@ module TencentCloud
             @Operator.deserialize(params['Operator'])
           end
           @UserData = params['UserData']
+          unless params['Option'].nil?
+            @Option = EmbedUrlOption.new
+            @Option.deserialize(params['Option'])
+          end
         end
       end
 
@@ -2305,7 +2312,12 @@ module TencentCloud
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。
         # @type FlowIds: Array
-        # @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。 - 1. 若OpenId为空，Name和Mobile 必须提供。 - 2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。
+        # @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
+
+        # <ul>
+        # <li>1. 若OpenId为空，Name和Mobile 必须提供。</li>
+        # <li>2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。	</li>
+        # </ul>
         # @type OpenId: String
         # @param Name: 签署方经办人的姓名。
         # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
@@ -3682,16 +3694,19 @@ module TencentCloud
 
         # 注:  `为空时查询所有类型的印章。`
         # @type SealTypes: Array
+        # @param SealStatuses: 查询的印章状态列表。 <ul> <li>空，只查询启用状态的印章；</li> <li>ALL，查询所有状态的印章；</li> <li>CHECKING，查询待审核的印章；</li> <li>SUCCESS，查询启用状态的印章；</li> <li>FAIL，查询印章审核拒绝的印章；</li> <li>DISABLE，查询已停用的印章；</li> <li>STOPPED，查询已终止的印章；</li> <li>VOID，查询已作废的印章；</li> <li>INVALID，查询已失效的印章；</li> </ul>
+        # @type SealStatuses: Array
 
-        attr_accessor :Agent, :Limit, :Offset, :InfoType, :SealId, :SealTypes
+        attr_accessor :Agent, :Limit, :Offset, :InfoType, :SealId, :SealTypes, :SealStatuses
 
-        def initialize(agent=nil, limit=nil, offset=nil, infotype=nil, sealid=nil, sealtypes=nil)
+        def initialize(agent=nil, limit=nil, offset=nil, infotype=nil, sealid=nil, sealtypes=nil, sealstatuses=nil)
           @Agent = agent
           @Limit = limit
           @Offset = offset
           @InfoType = infotype
           @SealId = sealid
           @SealTypes = sealtypes
+          @SealStatuses = sealstatuses
         end
 
         def deserialize(params)
@@ -3704,6 +3719,7 @@ module TencentCloud
           @InfoType = params['InfoType']
           @SealId = params['SealId']
           @SealTypes = params['SealTypes']
+          @SealStatuses = params['SealStatuses']
         end
       end
 
@@ -4811,7 +4827,13 @@ module TencentCloud
         # <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
         # <b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
         # 印章的对应关系参考下图
-        # ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
+        # <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型
+        # <ul><li> <b>OFFICIAL</b> :  企业公章</li>
+        # <li> <b>CONTRACT</b> : 合同专用章</li>
+        # <li> <b>FINANCE</b> : 财务专用章</li>
+        # <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
+        # <b>参考样例</b>：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
 
         # <font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
         # <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"</li>
@@ -4975,7 +4997,14 @@ module TencentCloud
         # @type ComponentType: String
         # @param ComponentValue: 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
 
-        # 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）
+        # 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型
+
+        # <ul><li> <b>OFFICIAL</b> :  企业公章</li>
+        # <li> <b>CONTRACT</b> : 合同专用章</li>
+        # <li> <b>FINANCE</b> : 财务专用章</li>
+        # <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
+
+        # 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
 
         # 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
 
@@ -6987,6 +7016,32 @@ module TencentCloud
         end
       end
 
+      # 创建嵌入式页面url个性化参数
+      class EmbedUrlOption < TencentCloud::Common::AbstractModel
+        # @param ShowFlowDetailComponent: 合同详情页面是否展示合同控件信息
+        # <br/>true:允许在合同详情页展示控件
+        # <br/>false:不允许在合同详情页展示控件
+        # <br/>默认false,在合同详情页不展示控件
+        # @type ShowFlowDetailComponent: Boolean
+        # @param ShowTemplateComponent: 模版预览页面是否展示空间信息
+        # <br/>true:允许在模版预览页展示控件
+        # <br/>false:不允许在模版预览页展示控件
+        # <br/>默认false,在模版预览页不展示控件
+        # @type ShowTemplateComponent: Boolean
+
+        attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent
+
+        def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil)
+          @ShowFlowDetailComponent = showflowdetailcomponent
+          @ShowTemplateComponent = showtemplatecomponent
+        end
+
+        def deserialize(params)
+          @ShowFlowDetailComponent = params['ShowFlowDetailComponent']
+          @ShowTemplateComponent = params['ShowTemplateComponent']
+        end
+      end
+
       # 扩展服务开通和授权的详细信息
       class ExtentServiceAuthInfo < TencentCloud::Common::AbstractModel
         # @param Type: 扩展服务类型
@@ -7283,7 +7338,7 @@ module TencentCloud
 
       # **各种场景传参说明**:
 
-      # <table>     <thead>     <tr>         <th>场景编号</th>         <th>发起方类型</th>         <th>签署方类型</th>         <th>签署方传参说明</th>     </tr>     </thead>     <tbody>     <tr>         <td>场景一</td>         <td>第三方子企业A员工</td>         <td>第三方子企业A员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（必传）OpenId：企业员工标识</li>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>             </ul>         </td>     </tr>     <tr>         <td>场景二</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B(不指定经办人走领取方式)</td>         <td>             <ul>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）ApproverOption.FillType：需设置为1</li>             </ul>         </td>     </tr>     <tr>         <td>场景三</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B员工</td>         <td>  <ul>             <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>             <li>（必传）Name：签署方的名字</li>             <li>（必传）Mobile：签署方的手机号</li>             <li>（必传）OpenId：企业员工标识</li>             <li>（必传）OrganizationName：子企业名称</li>             <li>（必传）OrganizationOpenId：子企业的标识</li>             <li>（固定）ApproverType：需设置为ORGANIZATION</li>         </ul></td>     </tr>     <tr>         <td>场景四</td>         <td>第三方子企业A员工</td>         <td>个人/自然人</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（固定）ApproverType：需设置为PERSON</li>             </ul>         </td>     </tr>     <tr>         <td>场景五</td>         <td>第三方子企业A员工</td>         <td>SaaS平台企业员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）OrganizationName：SaaS企业的名字</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）NotChannelOrganization：需设置为True</li>             </ul>         </td>     </tr>     </tbody> </table>
+      # <table>     <thead>     <tr>         <th>场景编号</th>         <th>发起方类型</th>         <th>签署方类型</th>         <th>签署方传参说明</th>     </tr>     </thead>     <tbody>     <tr>         <td>场景一</td>         <td>第三方子企业A员工</td>         <td>第三方子企业A员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（必传）OpenId：企业员工标识</li>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>             </ul>         </td>     </tr>     <tr>         <td>场景二</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B(不指定经办人走领取方式)</td>         <td>             <ul>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）ApproverOption.FillType：需设置为1</li>             </ul>         </td>     </tr>     <tr>         <td>场景三</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B员工</td>         <td>  <ul>             <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>             <li>（必传）Name：签署方的名字</li>             <li>（必传）Mobile：签署方的手机号</li>             <li>（必传）OpenId：企业员工标识</li>             <li>（必传）OrganizationName：子企业名称</li>             <li>（必传）OrganizationOpenId：子企业的标识</li>             <li>（固定）ApproverType：需设置为ORGANIZATION</li>         </ul></td>     </tr>     <tr>         <td>场景四</td>         <td>第三方子企业A员工</td>         <td>个人/自然人</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（固定）ApproverType：需设置为PERSON</li>             </ul>         </td>     </tr>     <tr>         <td>场景五</td>         <td>第三方子企业A员工</td>         <td>SaaS平台企业员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）OrganizationName：SaaS企业的名字</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（不传）OrganizationOpenId：子企业的标识</li>    <li>（不传）OpenId：企业员工标识</li>               <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）NotChannelOrganization：需设置为True</li>             </ul>         </td>     </tr>     </tbody> </table>
 
 
       # **注1**: `使用模板发起合同时，RecipientId（模板发起合同时）必传`
@@ -7418,7 +7473,7 @@ module TencentCloud
 
         # 注: `签署方为第三方子客企业时会被置为NONE,   不会发短信通知`
         # @type NotifyType: String
-        # @param AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。
+        # @param AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。
 
         # 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
         # @type AddSignComponentsLimits: Array

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.841
+  version: 3.0.843
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common