tencentcloud-sdk-ess 3.0.923 → 3.0.924

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 547009e45c94a8a695bcdc8a1e7cb46146480ff6
-  data.tar.gz: d867bd1dda70214e81518a12d1bd186c5f5dca82
+  metadata.gz: 8aa290efeeac8d3cc3b997dc5f04e7d131090aa2
+  data.tar.gz: 56b60fb2cbce96208bad3a721056f93ee6dc8e7a
 SHA512:
-  metadata.gz: cd6c435de7023f1e16984611b49a17f16151190cef3999a8db1ed52300e1aad222d0bd40aeafce1b83819cb1a2ca46df81ff8cb1ee8c1005a6f2b3df5d1d6fc9
-  data.tar.gz: 33ff3db3e78d61c6b3047fc0122a8bb40e128c40ae155417d67d29438a28fe6a2c40ad93ddd794a289f0d87ad8bde8d82c247f0ad3a600865c388aa740645933
+  metadata.gz: 91307ad36e0cb75f65919172349ba3b274595a1dee64f5b82d6ad65b27faf36694cba45adfcf7bbfd09b4e82680d2a62eac02887a6a21c628d3edd3bb8ae821f
+  data.tar.gz: 556f6e7be3b7e16238d18ec54837e5ae3d0539160483046d0b05067da55424dd50cb2039ca3ec34d02b5a9aac71b531e055e73501232bc99730e92b9375d34ec

data/lib/VERSION

@@ -1 +1 @@
-3.0.923
+3.0.924

data/lib/v20201111/client.rb

@@ -29,7 +29,17 @@ module TencentCloud
         end
 
 
-        # 该接口用于结束动态签署流程，若当前合同还存在签署方未签署，无法结束。
+        # 该接口用于结束动态签署方2.0的合同流程。
+
+
+        # **功能开通**
+        # - 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>，然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
+
+        # **使用条件**
+        # - 此接口只能在<font color="red">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态（例如：过期、拒签、撤销或者调用过此接口成功过），将无法通过此接口结束合同流程。
+
+        # **整体流程**
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/75d323c66e44b05bbc8e949c18664455.png)
 
         # @param request: Request instance for ArchiveDynamicFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::ArchiveDynamicFlowRequest`
@@ -473,8 +483,20 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CreateDynamicFlowApprover）用来补充动态合同的签署人信息。<br/>
-        # 适用场景：使用CreateFlowByFiles指定：OpenDynamicSignFlow=true发起的合同，可以使用该接口补充后续签署人。<br/>
+        # 此接口（CreateDynamicFlowApprover）接口主要用于补充动态签署方2.0合同的签署方信息，包括但不限于名字、手机号和签署区域等信息。
+
+
+        # **功能开通**
+        # 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>，然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
+
+        # **使用条件**
+        # - 在发起合同时，必须将OpenDynamicSignFlow参数设置为true，以确保合同以动态签署方2.0的方式处理，否则默认处理为普通合同。
+        # - 此接口只能在合同处于非终态时调用。一旦合同进入终态（例如：过期、拒签或撤销），将无法通过此接口添加新的签署方。
+
+
+        # 动态签署方2.0合同<font color="red">不会自动结束（整个合同变为签署完成）</font>，需要通过调用<a href="https://qian.tencent.com/developers/companyApis/operateFlows/ArchiveDynamicFlow/" target="_blank">结束动态签署合同</a>来手动结束签署流程。整体的流程如下图
+
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/75d323c66e44b05bbc8e949c18664455.png)
 
         # @param request: Request instance for CreateDynamicFlowApprover.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateDynamicFlowApproverRequest`
@@ -667,7 +689,7 @@ module TencentCloud
 
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/b2715f0236faee807cfc0521f93cf01b.png)
 
-        # <b><font color="red">2. 动态签署人合同</font>: 若未指定具体签署人的信息，则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档    [动态签署人合同](https://qian.tencent.com/developers/company/dynamic_signer/)    。动态签署人在控制台上的展示样式如下：
+        # <b><font color="red">2. 动态签署人合同</font>: 若未指定具体签署人的信息，则合同变成动态签署人合同</b>。需调用此接口补充或添加签署人。可以参考文档    <a href="https://qian.tencent.com/developers/company/dynamic_signer/" target="_blank">动态签署人合同</a>   。动态签署人在控制台上的展示样式如下：
 
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/2729477978e020c3bbb4d2e767bb78eb.png)
 
@@ -2597,8 +2619,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 用于客户企业在调用生成[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口之前判断C端用户是否实名，如果已经实名，就不需要再次调用生成C端链接接口去实名
-        # 注意：此接口仅会返回当前员工是否通过[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)所实名的员工是否实名，并不会返回个人用户自己在电子签进行实名的状况
+        # 检测个人用户是否已经实名。
+
+        # 在调用生成C端用户实名链接（[CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)）接口之前，客户企业应首先调用本接口判断C端用户是否已经完成实名认证。如果用户已经实名，那么无需再次调用（[CreateUserVerifyUrl](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)）生成链接并走实名认证流程。
+
+        # 注意：
+
+        # - 此接口<font color="red">仅用于确认通过本公司生成[C端用户实名链接（CreateUserVerifyUrl）](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口注册认证的用户，不包括其他途径（如主动注册认证、在签署合同中注册认证等）在电子签平台上进行的实名认证</font>。
+
+        # - 调用此接口需要购买单独的实名套餐包。<font color="red">使用前请联系对接的客户经理沟通</font>。
 
         # @param request: Request instance for DescribeUserVerifyStatus.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeUserVerifyStatusRequest`

data/lib/v20201111/models.rb

@@ -433,10 +433,15 @@ module TencentCloud
 
       # 动态签署2.0合同参与人信息
       class ArchiveDynamicApproverData < TencentCloud::Common::AbstractModel
-        # @param SignId: 签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。 注意：不指定该字段时默认为发起方
+        # @param SignId: 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。
+
+        # 可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SignId: String
-        # @param RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。 模板发起合同时，该参数为必填项。 文件发起合同是，该参数无需传值。 如果开发者后序用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
+        # @param RecipientId: 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。
+
+        # 填写控件和签署控件都与特定的角色编号关联。
+
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type RecipientId: String
 
@@ -8420,13 +8425,31 @@ module TencentCloud
 
       # 动态添加签署人的结果信息
       class DynamicFlowApproverResult < TencentCloud::Common::AbstractModel
-        # @param RecipientId: 签署方角色编号
+        # @param RecipientId: 签署方角色编号，签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。
+
+        # 填写控件和签署控件都与特定的角色编号关联。
+
+        # 在进行新增签署方操作时，建议记录下该签署方的角色编号。后续可以拉取流程信息，用来判断该签署方的当前状态。
+
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type RecipientId: String
-        # @param SignId: 签署方唯一编号
+        # @param SignId: 签署方唯一编号，一个全局唯一的标识符，不同的流程不会出现冲突。
+
+        # 可以使用签署方的唯一编号来生成签署链接（也可以通过RecipientId来生成签署链接）。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SignId: String
-        # @param ApproverStatus: 签署方当前状态
+        # @param ApproverStatus: 签署方当前状态，会出现下面的状态
+
+        # 2：待签署
+        # 3：已签署
+        # 4：已拒绝
+        # 5：已过期
+        # 6：已撤销
+        # 8：待填写
+        # 9：因为各种原因（签署人改名等）而终止
+        # 10：填写完成
+        # 15：已解除
+        # 19：转他人处理
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverStatus: Integer
 

metadata

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