tencentcloud-sdk-essbasic 3.0.687 → 3.0.688

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f19ca4be959390c27cb7865d7993e8c56b732c59
-  data.tar.gz: 1105b9dc5c70f8b11c7ef04871be58d21effa257
+  metadata.gz: e9034e10361d2d7499e49ae40f635c00ae096d1b
+  data.tar.gz: 092c64090f84480a7038f8ee2111bbd8912efd90
 SHA512:
-  metadata.gz: 032848a8e2d5ed00a8a122c5cb3234ce270619eabc7664c134b5013d4517986b41e2a93aa51a548de02d7b10f3daa2f0b62b9666fabcc29219e58819df50d077
-  data.tar.gz: b184c65ec380a4a9d9295b39168156a90e3d87f484bd11410e2e812f965d5f5602f1e4147973a1ca05ab1f8a217a93c720668794c1ea65eb41b8ab0e9de476b4
+  metadata.gz: d1dd687cb98ba736b92bebdd5bf0aa05389853935f012ce33596e1848401bc36df106bc588b0fe35b05250b47c3923a03d4f3a28c82506a79402bc915a3dfcbb
+  data.tar.gz: beef8ac476ecf0f8f885a6fcb9a28839cec5f6e313374cf5c4bf4731fe7dba64787f86a101a93056059aa5e0f611087cb84b0d4d4822e86b59fd5b9ecb6aa418

data/lib/VERSION

@@ -1 +1 @@
-3.0.687
+3.0.688

data/lib/v20210526/client.rb

@@ -29,18 +29,22 @@ module TencentCloud
         end
 
 
-        # 指定需要批量撤销的签署流程Id，批量撤销合同
-        # 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
-
-        # 可以撤回：未全部签署完成
-        #  不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
-
-        # **满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。**
-
-        # **合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
-
-        # **注意:
-        # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**
+        # 用于批量撤销合同流程<br/>
+        # 适用场景：
+        # 如果某些合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
+        # 通过签署流程编号批量撤销合同，单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是，若合同处于以下已终止状态，则不可撤销：<br/>
+        # - 已全部签署完成
+        # - 已拒签
+        # - 已过期
+        # - 已撤回
+        # - 拒绝填写
+        # - 已解除
+
+        # <br/>
+        # 满足撤销条件的合同会发起异步撤销流程，而不满足撤销条件的合同将返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
+        # <br/><br/>
+        # 注:
+        # `如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
 
         # @param request: Request instance for ChannelBatchCancelFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
@@ -615,7 +619,6 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建个人签署H5签署链接，请联系客户经理申请使用<br/>
         # 该接口用于发起合同后，生成C端签署人的签署链接<br/>
         # 注意：该接口目前签署人类型仅支持个人签署方（PERSON）<br/>
         # 注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
@@ -1140,7 +1143,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 企业方可以通过此接口查询个人用户自动签开启状态
+        # 通过此接口获取个人用户自动签的开通状态。
+
+        # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
 
         # @param request: Request instance for ChannelDescribeUserAutoSignStatus.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeUserAutoSignStatusRequest`
@@ -1164,7 +1169,13 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 企业方可以通过此接口关闭个人的自动签功能
+        # 通过此接口可以关闭个人用户自动签功能。
+        # 无需对应的用户刷脸等方式同意即可关闭。
+
+        # 注意:
+
+        # <ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
+        # <li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
 
         # @param request: Request instance for ChannelDisableUserAutoSign.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDisableUserAutoSignRequest`

data/lib/v20210526/models.rb

@@ -385,12 +385,19 @@ module TencentCloud
         # @type FlowIds: Array
         # @param CancelMessage: 撤销理由,不超过200个字符
         # @type CancelMessage: String
-        # @param CancelMessageFormat: 撤销理由自定义格式；选项：
-
-        # - 0 默认格式
-        # - 1 只保留身份信息：展示为【发起方】
-        # - 2 保留身份信息+企业名称：展示为【发起方xxx公司】
-        # - 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+        # @param CancelMessageFormat: 撤销理由自定义格式，支持以下格式
+        # <ul><li>0 : 默认值</li>
+        # <li>1 : 只保留身份信息</li>
+        # <li>2 : 保留身份信息+企业名称</li>
+        # <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
+        # 例如,假设合同的发起方是典子谦示例企业的经办人张三，撤销理由是"合同内容错误，需要修正",合同撤销后，各签署方看到的撤销理由是会是
+
+        # 0: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同
+        # 1: 发起方以"合同内容错误，需要修正"的理由撤销当前合同
+        # 2: 发起方-典子谦示例企业以"合同内容错误，需要修正"的理由撤销当前合同
+        # 3: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同</br>
+
+        # 备注:`如果不传递撤销理由，那么默认撤销理由是 "自动撤销（通过接口实现）"`
         # @type CancelMessageFormat: Integer
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1371,7 +1378,7 @@ module TencentCloud
         # @param FlowIds: 合同组中每个合同流程ID，每个ID均为32位字符串。
 
         # 注:
-        # `此数组的顺序和入参中的FlowGroupInfos顺序回不一致`
+        # `此数组的顺序和入参中的FlowGroupInfos顺序一致`
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowIds: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1442,7 +1449,7 @@ module TencentCloud
         # @param FlowIds: 合同组中每个合同流程ID，每个ID均为32位字符串。
 
         # 注:
-        # `此数组的顺序和入参中的FlowInfos顺序回不一致`
+        # `此数组的顺序和入参中的FlowInfos顺序一致`
         # @type FlowIds: Array
         # @param TaskInfos: 复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
         # 如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
@@ -3074,14 +3081,17 @@ module TencentCloud
 
       # ChannelDescribeUserAutoSignStatus请求参数结构体
       class ChannelDescribeUserAutoSignStatusRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 渠道应用相关信息
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param SceneKey: 自动签场景:
-        # E_PRESCRIPTION_AUTO_SIGN 电子处方
+        # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
+        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
+
+        # 注: `现在仅支持电子处方场景`
         # @type SceneKey: String
-        # @param UserInfo: 查询开启状态的用户信息
+        # @param UserInfo: 要查询状态的用户信息, 包括名字,身份证等
         # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
-        # @param Operator: 操作人信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
         attr_accessor :Agent, :SceneKey, :UserInfo, :Operator
@@ -3112,13 +3122,19 @@ module TencentCloud
 
       # ChannelDescribeUserAutoSignStatus返回参数结构体
       class ChannelDescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
-        # @param IsOpen: 是否开通
+        # @param IsOpen: 查询用户是否已开通自动签
         # @type IsOpen: Boolean
-        # @param LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
+        # @param LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
+
+        # 值为unix时间戳,单位为秒。
         # @type LicenseFrom: Integer
-        # @param LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
+        # @param LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
+
+        # 值为unix时间戳,单位为秒。
         # @type LicenseTo: Integer
-        # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
+        # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
+
+        # <ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li></ul>
         # @type LicenseType: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3144,14 +3160,15 @@ module TencentCloud
 
       # ChannelDisableUserAutoSign请求参数结构体
       class ChannelDisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 渠道应用相关信息
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param SceneKey: 自动签场景:
-        # E_PRESCRIPTION_AUTO_SIGN 电子处方
+        # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
+        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
         # @type SceneKey: String
-        # @param UserInfo: 关闭自动签的个人的三要素
+        # @param UserInfo: 需要关闭自动签的个人的信息，如姓名，证件信息等。
         # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
-        # @param Operator: 操作人信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
         attr_accessor :Agent, :SceneKey, :UserInfo, :Operator
@@ -8041,14 +8058,18 @@ module TencentCloud
 
       # 用户的三要素：姓名，证件号，证件类型
       class UserThreeFactor < TencentCloud::Common::AbstractModel
-        # @param Name: 姓名
+        # @param Name: 签署方经办人的姓名。
+        # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
         # @type Name: String
-        # @param IdCardType: 证件类型:
-        # ID_CARD 身份证
-        # HONGKONG_AND_MACAO 港澳居民来往内地通行证
-        # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+        # @param IdCardType: 证件类型，支持以下类型
+        # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
+        # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+        # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
         # @type IdCardType: String
-        # @param IdCardNumber: 证件号，如果有 X 请大写
+        # @param IdCardNumber: 证件号码，应符合以下规则
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         # @type IdCardNumber: String
 
         attr_accessor :Name, :IdCardType, :IdCardNumber

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.687
+  version: 3.0.688
 platform: ruby
 authors:
 - Tencent Cloud