tencentcloud-sdk-ess 3.0.733 → 3.0.735

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ab393d84dc375521aec7c5acee6512be4b8e74a
-  data.tar.gz: 8271cc417c36b34b3bd2b8c2deb753198017d207
+  metadata.gz: 6eaf0022dbcc157c526a1eb642749fd4d60f094f
+  data.tar.gz: 363e570ccfa8125a7cc0c8addf6cf6f7f479f3d0
 SHA512:
-  metadata.gz: 6c92fdc8b89e1ef8269f33c55c7dec42d69464c5725d3f1867abfb0ab40f2bba0a158d8925fb5e0fbd7a07682cf5d2a9c94ba40ecd50bd22bae708b51ccf8100
-  data.tar.gz: 5d410fdc3949d328f1181111a910579ce404c217b526bb00487553f7d3a0c6200100de1e5a61f3019aaa9193376d939efb10b52e375ad31d456c42b5fbaf83ac
+  metadata.gz: 0499dc117f4f71e7ff5a480aa8adbee5708c64512fb37965089108310f8895bce54165ab64cfe0d672e6793797032af3e8c3f5853010af6d6ba211d67556dfe0
+  data.tar.gz: 00e5255caa216efcee141a0f26a9e9a30d02697445ec502be5badb86b0930c14be938402b75170d698cf6f76a71feb81f30cbd2aff9d26097372980cec278eda

data/lib/VERSION

@@ -1 +1 @@
-3.0.733
+3.0.735

data/lib/v20201111/client.rb

@@ -164,7 +164,7 @@ module TencentCloud
         # 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
         # **注意：**
         # 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
-        # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**，**不支持填写控件** 。
+        # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。
         # 3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
         # 4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
         # 5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。

data/lib/v20201111/models.rb

@@ -170,7 +170,8 @@ module TencentCloud
         # @type PreReadTime: Integer
         # @param UserId: 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
 
-        # 注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
+        # 注：
+        # 如果传进来的<font color="red">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）
         # @type UserId: String
         # @param ApproverSource: 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
         # @type ApproverSource: String
@@ -964,8 +965,6 @@ module TencentCloud
         # <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
         # 注：` 表单域的控件不能作为印章和签名控件`
         # @type ComponentType: String
-        # @param FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0
-        # @type FileIndex: Integer
         # @param ComponentHeight: **在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。
         # @type ComponentHeight: Float
         # @param ComponentWidth: **在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。
@@ -980,6 +979,13 @@ module TencentCloud
         # @type ComponentPosX: Float
         # @param ComponentPosY: **在绝对定位方式和关键字定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。
         # @type ComponentPosY: Float
+        # @param FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0
+        # @type FileIndex: Integer
+        # @param GenerateMode: 控件生成的方式：
+        # <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
+        # <li> <b>FIELD</b> : 表单域</li>
+        # <li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
+        # @type GenerateMode: String
         # @param ComponentId: 控件唯一ID。
 
         # **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
@@ -1065,15 +1071,6 @@ module TencentCloud
         # <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
         # 注：   `部分特殊控件需要在控制台配置模板形式创建`
         # @type ComponentValue: String
-        # @param GenerateMode: 控件生成的方式：
-        # <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
-        # <li> <b>FIELD</b> : 表单域</li>
-        # <li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
-        # @type GenerateMode: String
-        # @param ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12
-        # @type ComponentDateFontSize: Integer
-        # @param ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
-        # @type ChannelComponentId: String
         # @param OffsetX: **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
         # 注意： `向左调整设置为负数， 向右调整设置成正数`
         # 注意：此字段可能返回 null，表示取不到有效值。
@@ -1082,10 +1079,6 @@ module TencentCloud
         # 注意： `向上调整设置为负数， 向下调整设置成正数`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OffsetY: Float
-        # @param ChannelComponentSource: <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
-        # <ul><li> <b>0</b> :平台指定；</li>
-        # <li> <b>1</b> :用户自定义</li></ul>
-        # @type ChannelComponentSource: Integer
         # @param KeywordOrder: **如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。
         # <ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li>
         # <li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul>
@@ -1116,17 +1109,26 @@ module TencentCloud
         # <li> <b>true</b> : 可以移动和删除控件</li></ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ForbidMoveAndDelete: Boolean
+        # @param ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12
+        # @type ComponentDateFontSize: Integer
+        # @param ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
+        # @type ChannelComponentId: String
+        # @param ChannelComponentSource: <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
+        # <ul><li> <b>0</b> :平台指定；</li>
+        # <li> <b>1</b> :用户自定义</li></ul>
+        # @type ChannelComponentSource: Integer
 
-        attr_accessor :ComponentType, :FileIndex, :ComponentHeight, :ComponentWidth, :ComponentPage, :ComponentPosX, :ComponentPosY, :ComponentId, :ComponentName, :ComponentRequired, :ComponentRecipientId, :ComponentExtra, :IsFormType, :ComponentValue, :GenerateMode, :ComponentDateFontSize, :ChannelComponentId, :OffsetX, :OffsetY, :ChannelComponentSource, :KeywordOrder, :KeywordPage, :RelativeLocation, :KeywordIndexes, :LockComponentValue, :ForbidMoveAndDelete
+        attr_accessor :ComponentType, :ComponentHeight, :ComponentWidth, :ComponentPage, :ComponentPosX, :ComponentPosY, :FileIndex, :GenerateMode, :ComponentId, :ComponentName, :ComponentRequired, :ComponentRecipientId, :ComponentExtra, :IsFormType, :ComponentValue, :OffsetX, :OffsetY, :KeywordOrder, :KeywordPage, :RelativeLocation, :KeywordIndexes, :LockComponentValue, :ForbidMoveAndDelete, :ComponentDateFontSize, :ChannelComponentId, :ChannelComponentSource
 
-        def initialize(componenttype=nil, fileindex=nil, componentheight=nil, componentwidth=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentid=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, componentextra=nil, isformtype=nil, componentvalue=nil, generatemode=nil, componentdatefontsize=nil, channelcomponentid=nil, offsetx=nil, offsety=nil, channelcomponentsource=nil, keywordorder=nil, keywordpage=nil, relativelocation=nil, keywordindexes=nil, lockcomponentvalue=nil, forbidmoveanddelete=nil)
+        def initialize(componenttype=nil, componentheight=nil, componentwidth=nil, componentpage=nil, componentposx=nil, componentposy=nil, fileindex=nil, generatemode=nil, componentid=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, componentextra=nil, isformtype=nil, componentvalue=nil, offsetx=nil, offsety=nil, keywordorder=nil, keywordpage=nil, relativelocation=nil, keywordindexes=nil, lockcomponentvalue=nil, forbidmoveanddelete=nil, componentdatefontsize=nil, channelcomponentid=nil, channelcomponentsource=nil)
           @ComponentType = componenttype
-          @FileIndex = fileindex
           @ComponentHeight = componentheight
           @ComponentWidth = componentwidth
           @ComponentPage = componentpage
           @ComponentPosX = componentposx
           @ComponentPosY = componentposy
+          @FileIndex = fileindex
+          @GenerateMode = generatemode
           @ComponentId = componentid
           @ComponentName = componentname
           @ComponentRequired = componentrequired
@@ -1134,28 +1136,28 @@ module TencentCloud
           @ComponentExtra = componentextra
           @IsFormType = isformtype
           @ComponentValue = componentvalue
-          @GenerateMode = generatemode
-          @ComponentDateFontSize = componentdatefontsize
-          @ChannelComponentId = channelcomponentid
           @OffsetX = offsetx
           @OffsetY = offsety
-          @ChannelComponentSource = channelcomponentsource
           @KeywordOrder = keywordorder
           @KeywordPage = keywordpage
           @RelativeLocation = relativelocation
           @KeywordIndexes = keywordindexes
           @LockComponentValue = lockcomponentvalue
           @ForbidMoveAndDelete = forbidmoveanddelete
+          @ComponentDateFontSize = componentdatefontsize
+          @ChannelComponentId = channelcomponentid
+          @ChannelComponentSource = channelcomponentsource
         end
 
         def deserialize(params)
           @ComponentType = params['ComponentType']
-          @FileIndex = params['FileIndex']
           @ComponentHeight = params['ComponentHeight']
           @ComponentWidth = params['ComponentWidth']
           @ComponentPage = params['ComponentPage']
           @ComponentPosX = params['ComponentPosX']
           @ComponentPosY = params['ComponentPosY']
+          @FileIndex = params['FileIndex']
+          @GenerateMode = params['GenerateMode']
           @ComponentId = params['ComponentId']
           @ComponentName = params['ComponentName']
           @ComponentRequired = params['ComponentRequired']
@@ -1163,18 +1165,17 @@ module TencentCloud
           @ComponentExtra = params['ComponentExtra']
           @IsFormType = params['IsFormType']
           @ComponentValue = params['ComponentValue']
-          @GenerateMode = params['GenerateMode']
-          @ComponentDateFontSize = params['ComponentDateFontSize']
-          @ChannelComponentId = params['ChannelComponentId']
           @OffsetX = params['OffsetX']
           @OffsetY = params['OffsetY']
-          @ChannelComponentSource = params['ChannelComponentSource']
           @KeywordOrder = params['KeywordOrder']
           @KeywordPage = params['KeywordPage']
           @RelativeLocation = params['RelativeLocation']
           @KeywordIndexes = params['KeywordIndexes']
           @LockComponentValue = params['LockComponentValue']
           @ForbidMoveAndDelete = params['ForbidMoveAndDelete']
+          @ComponentDateFontSize = params['ComponentDateFontSize']
+          @ChannelComponentId = params['ChannelComponentId']
+          @ChannelComponentSource = params['ChannelComponentSource']
         end
       end
 
@@ -1307,7 +1308,9 @@ module TencentCloud
         # <li>**4**：系统签名</li></ul>
         # 注：
         # <ul><li>默认情况下，签名类型为手写签名</li>
-        # <li>您可以传递多种值，表示可用多种签名类型。</li></ul>
+        # <li>您可以传递多种值，表示可用多种签名类型。</li>
+        # <li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li>
+        # </ul>
         # @type SignatureTypes: Array
         # @param ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
         # <ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
@@ -1607,7 +1610,10 @@ module TencentCloud
         # @param FormFields: 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
         # <ul>
         # <li>支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成</li>
+        # <li>附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。</li>
         # </ul>
+        # 注：只有在控制台编辑模板时，<font color="red">归属给发起方</font>的填写控件（如下图）才能在创建文档的时候进行内容填充。
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
         # @type FormFields: Array
         # @param NeedPreview: 是否为预览模式，取值如下：
         # <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
@@ -1722,8 +1728,8 @@ module TencentCloud
         # <li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
         # <li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
         # <li>EXTEND_SERVICE：生成拓展服务的嵌入页面</li>
-        # <li>PREVIEW_FLOW：生成预览合同的嵌入页面</li>
-        # <li>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面</li></ul>
+        # <li>PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）</li>
+        # <li>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）</li></ul>
         # @type EmbedType: String
         # @param BusinessId: WEB嵌入的业务资源ID
         # <ul><li>PREVIEW_SEAL_DETAIL，必填，取值为印章id</li>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.733
+  version: 3.0.735
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common