RubyGems - tencentcloud-sdk-ess - Versions diffs - 3.0.731 → 3.0.733 - Mend

tencentcloud-sdk-ess 3.0.731 → 3.0.733

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.

Files changed (5) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 584b703e8261178119eeeb6b0f21c182ff78a810
-  data.tar.gz: 3a850b34c552ebb14e7188f8cfcfc57fcfe11cef
+  metadata.gz: 6ab393d84dc375521aec7c5acee6512be4b8e74a
+  data.tar.gz: 8271cc417c36b34b3bd2b8c2deb753198017d207
 SHA512:
-  metadata.gz: 83c06b057fd67fb0585c65e0c34247789508d9125b49cfdbd7f81ef20ff03d9ba870ed403504cb5bb1aa28db15d1a8e2edab4b4750aa6136e7b5046cbaa70003
-  data.tar.gz: 30a73494045269a4b6c679fe754b87864c513a96fcf2cef6797374520792d63148931eb66f38f88705d7ac7ae9c272b3eb664ac893fd957ff71ff4a1e410f760
+  metadata.gz: 6c92fdc8b89e1ef8269f33c55c7dec42d69464c5725d3f1867abfb0ab40f2bba0a158d8925fb5e0fbd7a07682cf5d2a9c94ba40ecd50bd22bae708b51ccf8100
+  data.tar.gz: 5d410fdc3949d328f1181111a910579ce404c217b526bb00487553f7d3a0c6200100de1e5a61f3019aaa9193376d939efb10b52e375ad31d456c42b5fbaf83ac

data/lib/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 3.0.~~731~~
1	+ 3.0.733

data/lib/v20201111/client.rb CHANGED Viewed

@@ -343,6 +343,33 @@ module TencentCloud
         # 通过模板创建签署流程<br/>
         # 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
+        # <table>
+        # 	<thead>
+        # 		<tr>
+        # 			<th>签署人类别</th>
+        # 			<th>需要提前准备的信息</th>
+        # 		</tr>
+        # 	</thead>
+        # 	<tbody>
+        # 		<tr>
+        # 			<td>自己企业的员工签署（未认证加入或已认证加入）</td>
+        # 			<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
+        # 		</tr>
+        # 		<tr>
+        # 			<td>自己企业的员工签署（已认证加入）</td>
+        # 			<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
+        # 		</tr>
+        # 		<tr>
+        # 			<td>其他企业的员工签署</td>
+        # 			<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
+        # 		</tr>
+        # 		<tr>
+        # 			<td>个人（自然人）签署</td>
+        # 			<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
+        # 		</tr>
+        # 	</tbody>
+        # </table>
         # 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
@@ -405,8 +432,38 @@ module TencentCloud
         # 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
         # 适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
+        # <table>
+        # 	<thead>
+        # 		<tr>
+        # 			<th>签署人类别</th>
+        # 			<th>需要提前准备的信息</th>
+        # 		</tr>
+        # 	</thead>
+        # 	<tbody>
+        # 		<tr>
+        # 			<td>自己企业的员工签署（未认证加入或已认证加入）</td>
+        # 			<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
+        # 		</tr>
+        # 		<tr>
+        # 			<td>自己企业的员工签署（已认证加入）</td>
+        # 			<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
+        # 		</tr>
+        # 		<tr>
+        # 			<td>其他企业的员工签署</td>
+        # 			<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
+        # 		</tr>
+        # 		<tr>
+        # 			<td>个人（自然人）签署</td>
+        # 			<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
+        # 		</tr>
+        # 	</tbody>
+        # </table>
         # 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
         # 注：
@@ -528,11 +585,14 @@ module TencentCloud
         # 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
-        # 1. 发起合同时，签署人的NotifyType需设置为sms
-        # 2. 合同中当前状态为“待签署”的签署人是催办的对象
-        # 3. 每个合同只能催办一次
+        # 1. 发起合同时，**签署人的NotifyType需设置为sms**
+        # 2. 合同中当前状态为 **待签署** 的签署人是催办的对象
+        # 3. **每个合同只能催办一次**
+        # **催办的效果**: 对方会收到如下的短信通知
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
-        # 注意：该接口无法直接调用，请联系客户经理申请使用。
+        # 注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
         # @param request: Request instance for CreateFlowReminds.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRemindsRequest`

data/lib/v20201111/models.rb CHANGED Viewed

@@ -941,213 +941,179 @@ module TencentCloud
       # 可以参考官网说明
       # https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
       class Component < TencentCloud::Common::AbstractModel
-        # @param ComponentType: 如果是Component填写控件类型，则可选的字段为：
-        # TEXT - 普通文本控件，输入文本字符串；
-        # MULTI_LINE_TEXT - 多行文本控件，输入文本字符串；
-        # CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
-        # FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID；
-        # DYNAMIC_TABLE - 动态表格控件；
-        # ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
-        # SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容；
-        # DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串；
-        # DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
-        # 如果是SignComponent签署控件类型，则可选的字段为
-        # SIGN_SEAL - 签署印章控件；
-        # SIGN_DATE - 签署日期控件；
-        # SIGN_SIGNATURE - 用户签名控件；
-        # SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；
-        # SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
-        # SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
-        # SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
-        # 表单域的控件不能作为印章和签名控件
+        # @param ComponentType: **如果是Component填写控件类型，则可选的字段为**：
+        # <ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>
+        # <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>
+        # <li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>
+        # <li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>
+        # <li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>
+        # <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>
+        # <li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>
+        # <li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
+        # <li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
+        # **如果是SignComponent签署控件类型，则可选的字段为**
+        # <ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
+        # <li> <b>SIGN_DATE</b> : 签署日期控件；</li>
+        # <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
+        # <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li>
+        # <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>
+        # 注：` 表单域的控件不能作为印章和签名控件`
         # @type ComponentType: String
-        # @param FileIndex: 控件所属文件的序号（取值为：0-N）。
-        # 目前单文件的情况下，值是0
+        # @param FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0
         # @type FileIndex: Integer
-        # @param ComponentHeight: 参数控件高度，单位pt
+        # @param ComponentHeight: **在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。
         # @type ComponentHeight: Float
-        # @param ComponentWidth: 参数控件宽度，单位pt
+        # @param ComponentWidth: **在绝对定位方式和关键字定位方式下**，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。
         # @type ComponentWidth: Float
-        # @param ComponentPage: 参数控件所在页码，取值为：1-N
+        # @param ComponentPage: **在绝对定位方式方式下**，指定控件所在PDF文件上的页码
+        # 注：
+        # 1. 页码编号是从<font color="red">1</font>开始编号的。
+        # 2.  <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。
         # @type ComponentPage: Integer
-        # @param ComponentPosX: 参数控件X位置，单位pt
+        # @param ComponentPosX: **在绝对定位方式和关键字定位方式下**，可以指定控件横向位置的位置，单位为pt（点）。
         # @type ComponentPosX: Float
-        # @param ComponentPosY: 参数控件Y位置，单位pt
+        # @param ComponentPosY: **在绝对定位方式和关键字定位方式下**，可以指定控件纵向位置的位置，单位为pt（点）。
         # @type ComponentPosY: Float
         # @param ComponentId: 控件唯一ID。
-        # 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
+        # **在绝对定位方式方式下**，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
+        # **在关键字定位方式下**，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
+        # 例：
+        # - 如传入的关键字<font color="red">"^甲方签署^"</font >，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符</font >）进行对应操作。
+        # - 如传入的关键字为<font color="red">"甲方签署</font >"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符</font >）都会执行相应操作。
+        # - 如传入的关键字为<font color="red">"^甲方签署</font >"，则PDF文件中每个出现关键字的位置（<font color="red">前面不能有其他字符</font >）都会执行相应操作。
+        # - 如传入的关键字为<font color="red">"甲方签署^</font >"，则PDF文件中每个出现关键字的位置（<font color="red">后面不能有其他字符</font >）都会执行相应操作。
+        # 注：`控件ID可以在一个PDF中不可重复`
         # @type ComponentId: String
-        # @param ComponentName: 控件名。
-        # 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
+        # @param ComponentName: **在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
+        # **在表单域定位方式下**，ComponentName不仅为控件名，也是表单域名称。
+        # 注：`控件名可以在一个PDF中可以重复`
         # @type ComponentName: String
-        # @param ComponentRequired: 是否必选，默认为false-非必选
+        # @param ComponentRequired: 如果是<b>填写控件</b>，ComponentRequired表示在填写页面此控件是否必填
+        # <ul><li>false（默认）：可以不填写</li>
+        # <li>true ：必须填写此填写控件</li></ul>
+        # 如果是<b>签署控件</b>，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响
         # @type ComponentRequired: Boolean
-        # @param ComponentRecipientId: 控件关联的参与方ID，对应Recipient结构体中的RecipientId
+        # @param ComponentRecipientId: **在通过接口拉取控件信息场景下**，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），**发起合同时候不要填写此字段留空即可**
         # @type ComponentRecipientId: String
-        # @param ComponentExtra: 扩展参数：
-        # 为JSON格式。
-        # 不同类型的控件会有部分非通用参数
-        # ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：
-        # 1 Font：目前只支持黑体、宋体
-        # 2 FontSize： 范围12-72
-        # 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐
-        # 4 FontColor：字符串类型，格式为RGB颜色数字
-        # 参数样例：{\"FontColor\":\"255,0,0\",\"FontSize\":12}
-        # ComponentType为FILL_IMAGE时，支持以下参数：
-        # NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中
-        # FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放
-        # ComponentType为SIGN_SIGNATURE类型可以控制签署方式
-        # {“ComponentTypeLimit”: [“xxx”]}
-        # xxx可以为：
-        # HANDWRITE – 手写签名
-        # OCR_ESIGN -- AI智能识别手写签名
-        # ESIGN -- 个人印章类型
-        # SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
-        # 如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
-        # ComponentType为SIGN_DATE时，支持以下参数：
-        # 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"
-        # 2 FontSize： 数字类型，范围6-72，默认值为12
-        # 3 FontAlign： 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
-        # 4 Format： 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
-        # 5 Gaps:： 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数
+        # @param ComponentExtra: **在所有的定位方式下**，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。
+        # <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：
+        # <ul><li> <b>Font</b>：目前只支持黑体、宋体</li>
+        # <li> <b>FontSize</b>： 范围12 :72</li>
+        # <li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>
+        # <li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>
+        # <b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
+        # <font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：
+        # <ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>
+        # <li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>
+        # <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式
+        # <ul><li> <b>HANDWRITE</b> : 手写签名</li>
+        # <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
+        # <li> <b>ESIGN</b> : 个人印章类型</li>
+        # <li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>
+        # <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
+        # <b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
+        # 印章的对应关系参考下图
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
+        # <font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
+        # <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"</li>
+        # <li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>
+        # <li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>
+        # <li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>
+        # <li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
         # 如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
         # 特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
-        # 参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
+        # <b>参数样例</b>： ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
-        # ComponentType为SIGN_SEAL类型时，支持以下参数：
-        # 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）
-        # 参数样例： "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
+        # <font color="red">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：
+        # <ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
+        # <b>参数样例</b>：` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
         # @type ComponentExtra: String
-        # @param IsFormType: 是否是表单域类型，默认false-不是
+        # @param IsFormType: **在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type IsFormType: Boolean
         # @param ComponentValue: 控件填充vaule，ComponentType和传入值类型对应关系：
-        # TEXT - 文本内容
-        # MULTI_LINE_TEXT - 文本内容
-        # CHECK_BOX - true/false
-        # FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
-        # SELECTOR - 选项值
-        # DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
-        # DATE - 默认是格式化为xxxx年xx月xx日
-        # SIGN_SEAL - 印章ID，于控制台查询获取
-        # SIGN_PAGING_SEAL - 可以指定印章ID，于控制台查询获取
-        # 控件值约束说明：
-        # 企业全称控件：
-        #   约束：企业名称中文字符中文括号
-        #   检查正则表达式：/^[\u3400-\u4dbf\u4e00-\u9fa5（）]+$/
-        # 统一社会信用代码控件：
-        #   检查正则表达式：/^[A-Z0-9]{1,18}$/
-        # 法人名称控件：
-        #   约束：最大50个字符，2到25个汉字或者1到50个字母
-        #   检查正则表达式：/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
-        # 签署意见控件：
-        #   约束：签署意见最大长度为50字符
-        # 签署人手机号控件：
-        #   约束：国内手机号 13,14,15,16,17,18,19号段长度11位
-        # 签署人身份证控件：
-        #   约束：合法的身份证号码检查
-        # 控件名称：
-        #   约束：控件名称最大长度为20字符
-        # 单行文本控件：
-        #   约束：只允许输入中文，英文，数字，中英文标点符号
-        # 多行文本控件：
-        #   约束：只允许输入中文，英文，数字，中英文标点符号
-        # 勾选框控件：
-        #   约束：选择填字符串true，不选填字符串false
-        # 选择器控件：
-        #   约束：同单行文本控件约束，填写选择值中的字符串
-        # 数字控件：
-        #   约束：请输入有效的数字(可带小数点)
-        #   检查正则表达式：/^(-|\+)?\d+(\.\d+)?$/
-        # 日期控件：
-        #   约束：格式：yyyy年mm月dd日
-        # 附件控件：
-        #   约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件
-        # 图片控件：
-        #   约束：JPG或PNG图片，填写上传的图片资源ID
-        # 邮箱控件：
-        #   约束：请输入有效的邮箱地址, w3c标准
-        #   检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
-        #   参考：https://emailregex.com/
-        # 地址控件：
-        #   同单行文本控件约束
-        # 省市区控件：
-        #   同单行文本控件约束
-        # 性别控件：
-        #   同单行文本控件约束，填写选择值中的字符串
-        # 学历控件：
-        #   同单行文本控件约束，填写选择值中的字符串
+        # <ul><li> <b>TEXT</b> : 文本内容</li>
+        # <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
+        # <li> <b>CHECK_BOX</b> : true/false</li>
+        # <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
+        # <li> <b>SELECTOR</b> : 选项值</li>
+        # <li> <b>DYNAMIC_TABLE</b>  - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
+        # <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
+        # <li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取</li>
+        # <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取</li></ul>
+        # <b>控件值约束说明</b>：
+        # <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: 控件生成的方式：
-        # NORMAL - 普通控件
-        # FIELD - 表单域
-        # KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）
+        # <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
+        # <li> <b>FIELD</b> : 表单域</li>
+        # <li> <b>KEYWORD</b> : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）</li></ul>
         # @type GenerateMode: String
-        # @param ComponentDateFontSize: 日期签署控件的字号，默认为 12
+        # @param ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号，默认为 12
         # @type ComponentDateFontSize: Integer
-        # @param ChannelComponentId: 第三方应用集成平台模板控件 ID 标识
+        # @param ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
         # @type ChannelComponentId: String
-        # @param OffsetX: 指定关键字时横坐标偏移量，单位pt
+        # @param OffsetX: **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
+        # 注意： `向左调整设置为负数， 向右调整设置成正数`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OffsetX: Float
-        # @param OffsetY: 指定关键字时纵坐标偏移量，单位pt
+        # @param OffsetY: **如果控件是关键字定位方式**，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
+        # 注意： `向上调整设置为负数， 向下调整设置成正数`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OffsetY: Float
-        # @param ChannelComponentSource: 第三方应用集成中子客企业控件来源。
-        # 0-平台指定；
-        # 1-用户自定义
+        # @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-倒序。
-        # 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。
-        # 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
+        # @param KeywordOrder: **如果控件是关键字定位方式**，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。
+        # <ul><li> <b>Positive</b> :表示正序，即根据关键字在PDF文件内的顺序进行排列</li>
+        # <li> <b>Reverse</b> :表示倒序，即根据关键字在PDF文件内的反序进行排列</li></ul>
+        # 在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。
         # @type KeywordOrder: String
-        # @param KeywordPage: 指定关键字页码。
-        # 指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
+        # @param KeywordPage: **如果控件是关键字定位方式**，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
         # @type KeywordPage: Integer
-        # @param RelativeLocation: 关键字位置模式，
-        # Middle-居中，
-        # Below-正下方，
-        # Right-正右方，
-        # LowerRight-右上角，
-        # UpperRight-右下角。
+        # @param RelativeLocation: **如果控件是关键字定位方式**，关键字生成的区域的对齐方式， 可以设置下面的值
+        # <ul><li> <b>Middle</b> :居中</li>
+        # <li> <b>Below</b> :正下方</li>
+        # <li> <b>Right</b> :正右方</li>
+        # <li> <b>LowerRight</b> :右上角</li>
+        # <li> <b>UpperRight</b> :右下角。</li></ul>
         # 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
         # @type RelativeLocation: String
-        # @param KeywordIndexes: 关键字索引。
-        # 如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。
-        # 示例：[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
+        # @param KeywordIndexes: **如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
+        # 注意：关键字索引是从0开始计数的
         # @type KeywordIndexes: Array
-        # @param LockComponentValue: 是否锁定控件值不允许编辑（嵌入式发起使用）
-        # <br/>默认false：不锁定控件值，允许在页面编辑控件值
+        # @param LockComponentValue: **web嵌入发起合同场景下**， 是否锁定填写和签署控件值不允许嵌入页面进行编辑
+        # <ul><li>false（默认）：不锁定控件值，允许在页面编辑控件值</li>
+        # <li>true：锁定控件值，在页面编辑控件值</li></ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LockComponentValue: Boolean
-        # @param ForbidMoveAndDelete: 是否禁止移动和删除控件
-        # <br/>默认false，不禁止移动和删除控件
+        # @param ForbidMoveAndDelete: **web嵌入发起合同场景下**，是否禁止移动和删除填写和签署控件
+        # <ul><li> <b>false（默认）</b> :不禁止移动和删除控件</li>
+        # <li> <b>true</b> : 可以移动和删除控件</li></ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ForbidMoveAndDelete: Boolean
@@ -1335,7 +1301,10 @@ module TencentCloud
         # @type JumpUrl: String
         # @param SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：
         # <ul><li>**0**：手写签名(默认)</li>
-        # <li>**1**：OCR楷体</li></ul>
+        # <li>**1**：OCR楷体</li>
+        # <li>**2**：姓名印章</li>
+        # <li>**3**：图片印章</li>
+        # <li>**4**：系统签名</li></ul>
         # 注：
         # <ul><li>默认情况下，签名类型为手写签名</li>
         # <li>您可以传递多种值，表示可用多种签名类型。</li></ul>
@@ -2033,14 +2002,26 @@ module TencentCloud
         # @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
         # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
         # @type Deadline: Integer
-        # @param RemindedOn: 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
-        # 到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
-        # @type RemindedOn: Integer
         # @param Unordered: 合同流程的签署顺序类型：
         # <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
         # <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
         # @type Unordered: Boolean
+        # @param UserData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
+        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
+        # @type UserData: String
+        # @param RemindedOn: 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
+        # 到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
+        # @type RemindedOn: Integer
+        # @param ApproverVerifyType: 指定个人签署方查看合同的校验方式
+        # <ul><li>   **VerifyCheck**  :（默认）人脸识别,人脸识别后才能合同内容 </li>
+        # <li>   **MobileCheck**  :  手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul>
+        # @type ApproverVerifyType: String
+        # @param SignBeanTag: 签署方签署控件（印章/签名等）的生成方式：
+        # <ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
+        # <li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
+        # @type SignBeanTag: Integer
         # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
         # <ul><li>{合同名称}   </li>
         # <li>{发起方企业} </li>
@@ -2056,6 +2037,13 @@ module TencentCloud
         # 签署方：李四
         # @type CustomShowMap: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
+        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）  </li><li> **OTHER** :  通用场景</li></ul>
+        # 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
+        # @type AutoSignScene: String
         # @param NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
         # <ul><li> **false**：（默认）不需要审批，直接签署。</li>
         # <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
@@ -2064,29 +2052,10 @@ module TencentCloud
         # <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
         # 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
         # @type NeedSignReview: Boolean
-        # @param UserData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
-        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
-        # @type UserData: String
-        # @param ApproverVerifyType: 指定个人签署方查看合同的校验方式
-        # <ul><li>   **VerifyCheck**  :（默认）人脸识别,人脸识别后才能合同内容 </li>
-        # <li>   **MobileCheck**  :  手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul>
-        # @type ApproverVerifyType: String
-        # @param SignBeanTag: 签署方签署控件（印章/签名等）的生成方式：
-        # <ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
-        # <li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
-        # @type SignBeanTag: Integer
-        # @param Agent: 代理企业和员工的信息。
-        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
-        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
-        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签）  </li><li> **OTHER** :  通用场景</li></ul>
-        # 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
-        # @type AutoSignScene: String
-        attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowDescription, :FlowType, :Components, :CcInfos, :CcNotifyType, :NeedPreview, :PreviewType, :Deadline, :RemindedOn, :Unordered, :CustomShowMap, :NeedSignReview, :UserData, :ApproverVerifyType, :SignBeanTag, :Agent, :AutoSignScene
+        attr_accessor :Operator, :FlowName, :Approvers, :FileIds, :FlowDescription, :FlowType, :Components, :CcInfos, :CcNotifyType, :NeedPreview, :PreviewType, :Deadline, :Unordered, :UserData, :RemindedOn, :ApproverVerifyType, :SignBeanTag, :CustomShowMap, :Agent, :AutoSignScene, :NeedSignReview
-        def initialize(operator=nil, flowname=nil, approvers=nil, fileids=nil, flowdescription=nil, flowtype=nil, components=nil, ccinfos=nil, ccnotifytype=nil, needpreview=nil, previewtype=nil, deadline=nil, remindedon=nil, unordered=nil, customshowmap=nil, needsignreview=nil, userdata=nil, approververifytype=nil, signbeantag=nil, agent=nil, autosignscene=nil)
+        def initialize(operator=nil, flowname=nil, approvers=nil, fileids=nil, flowdescription=nil, flowtype=nil, components=nil, ccinfos=nil, ccnotifytype=nil, needpreview=nil, previewtype=nil, deadline=nil, unordered=nil, userdata=nil, remindedon=nil, approververifytype=nil, signbeantag=nil, customshowmap=nil, agent=nil, autosignscene=nil, needsignreview=nil)
           @Operator = operator
           @FlowName = flowname
           @Approvers = approvers
@@ -2099,15 +2068,15 @@ module TencentCloud
           @NeedPreview = needpreview
           @PreviewType = previewtype
           @Deadline = deadline
-          @RemindedOn = remindedon
           @Unordered = unordered
-          @CustomShowMap = customshowmap
-          @NeedSignReview = needsignreview
           @UserData = userdata
+          @RemindedOn = remindedon
           @ApproverVerifyType = approververifytype
           @SignBeanTag = signbeantag
+          @CustomShowMap = customshowmap
           @Agent = agent
           @AutoSignScene = autosignscene
+          @NeedSignReview = needsignreview
         end
         def deserialize(params)
@@ -2147,18 +2116,18 @@ module TencentCloud
           @NeedPreview = params['NeedPreview']
           @PreviewType = params['PreviewType']
           @Deadline = params['Deadline']
-          @RemindedOn = params['RemindedOn']
           @Unordered = params['Unordered']
-          @CustomShowMap = params['CustomShowMap']
-          @NeedSignReview = params['NeedSignReview']
           @UserData = params['UserData']
+          @RemindedOn = params['RemindedOn']
           @ApproverVerifyType = params['ApproverVerifyType']
           @SignBeanTag = params['SignBeanTag']
+          @CustomShowMap = params['CustomShowMap']
           unless params['Agent'].nil?
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
           @AutoSignScene = params['AutoSignScene']
+          @NeedSignReview = params['NeedSignReview']
         end
       end

metadata CHANGED Viewed

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