tencentcloud-sdk-ess 3.0.759 → 3.0.760

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb623916af10e08e06ba10cc6d2b77730f0121ad
-  data.tar.gz: 1564fd9a8a75214c1203f66621b4052ad863b9b1
+  metadata.gz: 24834bd7cd0cda391e536f867ecdf2ecd7f665e9
+  data.tar.gz: 4e3b3a8a6cca9debae539b76cbee0ab09d9c8e6a
 SHA512:
-  metadata.gz: 6aae6af504d10a713ecabd550137b03f04a740348464d891ae4c60b5b2c7f32278f0b55f0aa2a49bebc2baab9da3ad5d6b658ee404dd1d981ffb37dfd6a671a6
-  data.tar.gz: 2782c62658472ada8480d3669a46e5d138ac8062d5005ae24d204950a25dec4549786db46a8dcbc4cb650bb0f98cf7199e44ff62b222c9888bf9ed2e0b84a722
+  metadata.gz: 6cbd043a434274b1bb88041cd7d1046511d7599142293c85f6f54b787685ccdd13eb7979a35e8fee7244d379f5bc878a209d40687d34aa284b61c50904321f2a
+  data.tar.gz: 41c59d078e3231ceaca0e929e3f203873597d78f93ec01fc894170a0d1a8396b019f50c23e530781a31c5dc61ca5bef035d7fee2d2572d872cdda3045dd2034e

data/lib/VERSION

@@ -1 +1 @@
-3.0.759
+3.0.760

data/lib/v20201111/client.rb

@@ -55,9 +55,16 @@ module TencentCloud
 
         # 用于撤销合同流程<br/>
         # 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
+        # - **可撤回合同状态**：未全部签署完成
+        # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
         # 注:
-        # `如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+        # 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+
+        # 2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
+
+        # 3. <font color='red'>撤销合同会返还合同额度</font>
 
         # @param request: Request instance for CancelFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
@@ -135,9 +142,20 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 注：此接口将会废弃，请使用撤销单个签署流程（CancelFlow）接口。
-        # 指定需要批量撤回的签署流程Id，获取批量撤销链接。
-        # 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回。
+        # 指定需要批量撤回的签署流程Id，以获取批量撤销链接。
+        # 客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。
+        # 接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。
+
+        # - **可撤回合同状态**：未全部签署完成
+        # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
+        # 注：
+        # 1. 如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+
+        # 2. 有对应合同撤销权限的人:  <font color='red'>合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人</font>
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
+
+        # 3. <font color='red'>撤销合同会返还合同额度</font>
 
         # @param request: Request instance for CreateBatchCancelFlowUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`

data/lib/v20201111/models.rb

@@ -748,9 +748,11 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param FlowId: 合同流程ID, 为32位字符串。
 
-        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # 可登录腾讯电子签控制台，[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         # @type FlowId: String
-        # @param CancelMessage: 撤销此合同流程的原因，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
+        # @param CancelMessage: 撤销此合同流程的**撤销理由**，最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成（不支持表情）。
+
+        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
         # @type CancelMessage: String
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -1243,7 +1245,7 @@ module TencentCloud
         # <br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param FlowIds: 需要执行撤回的流程(合同)的编号列表，最多100个.
-        # <br>列表中的流程(合同)编号不要重复.
+        # 列表中的流程(合同)编号不要重复.
         # @type FlowIds: Array
         # @param Agent: 代理企业和员工的信息。
         # <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -4078,7 +4080,10 @@ module TencentCloud
         # @type PathType: Integer
         # @param AutoJumpBack: 签署完成后是否自动回跳
         # <ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
-        # 注:  ` 该参数只针对"APP" 类型的签署链接有效`
+
+        # 注:
+        # 1. 该参数<font color="red">只针对APP</font> 类型的签署链接有效
+        # 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
         # @type AutoJumpBack: Boolean
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -7773,16 +7778,20 @@ module TencentCloud
       # style String 为字体风格设置 风格支持： font : 目前支持 黑体、宋体; fontSize： 6-72; color：000000-FFFFFF  字符串形如：  "#FFFFFF" 或者 "0xFFFFFF"; bold ： 是否加粗， true ： 加粗 false： 不加粗; align: 对其方式， 支持 LEFT / RIGHT / CENTER
       class FormField < TencentCloud::Common::AbstractModel
         # @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
+        # TEXT ：  文本内容
+        # MULTI_LINE_TEXT ：文本内容
+        # CHECK_BOX ：true/false
+        # FILL_IMAGE、ATTACHMENT ： 附件的FileId，需要通过UploadFiles接口上传获取
+        # SELECTOR ： 选项值
+        # DYNAMIC_TABLE ：传入json格式的表格内容，具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)
         # @type ComponentValue: String
         # @param ComponentId: 控件id，和ComponentName选择一项传入即可
+
+        # <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件ID的方式</a>
         # @type ComponentId: String
         # @param ComponentName: 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
+
+        # <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件名字的方式</a>
         # @type ComponentName: String
 
         attr_accessor :ComponentValue, :ComponentId, :ComponentName

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.759
+  version: 3.0.760
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common