tencentcloud-sdk-essbasic 3.0.622 → 3.0.624

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 197ea1ec27fdb20b8dba13f30afeacad124f02a0
-  data.tar.gz: 9430c3102c4182a594f8db353697f3de864a4242
+  metadata.gz: 60ae778805b9af9a72199376a67a877c9e140f09
+  data.tar.gz: 60a0fa05a54935669e66caf4af2ac67a06ba3c15
 SHA512:
-  metadata.gz: 7b381d31d2025cee50bc2848872a337564340939cf924c5fb67b3c97932d19278d5f6d9b3aed7792aae8dbb052c3e195183e5fc25133475ccee2944d52e256f9
-  data.tar.gz: d9224e4dd43de809eae7826d7190a99d18e282a68d4d7737483a99dd4d138d69d87543b7aabdc205dab05d4f8cd977be8ba6f7480c9eddbd8d634e64dea3bbbe
+  metadata.gz: 35656a85d1f89ede6e13c7bdceca30920d0c481f940f5b9aede3d86e03372558133488a673d40dabdeb280ac749bc5e728852abcdbb27da687cdc4d483ab873e
+  data.tar.gz: 65435d5f84f49cf51c305fbfda94e371012f88f5b759fc113d4972304ed8144ccb7421d2fb667ef626ad0ec499a7aeb77a8c0f91150386632dd1a6bf15b3cccf

data/lib/VERSION

@@ -1 +1 @@
-3.0.622
+3.0.624

data/lib/v20210526/client.rb

@@ -32,6 +32,9 @@ module TencentCloud
         # 指定需要批量撤销的签署流程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)**
@@ -114,7 +117,10 @@ module TencentCloud
         # 指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows
         # 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
         # 接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
-        # 可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。
+
+        # 可以撤回：未全部签署完成
+        #  不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
         # 注意:
         # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
 

data/lib/v20210526/models.rb

@@ -140,24 +140,32 @@ module TencentCloud
         # @param FlowName: 合同流程名称
         # @type FlowName: String
         # @param FlowType: 合同流程类型
+        # <br/>客户自定义，用于合同分类展示
         # @type FlowType: String
         # @param FlowDescription: 合同流程描述信息
         # @type FlowDescription: String
         # @param Deadline: 合同流程截止时间，unix时间戳，单位秒
         # @type Deadline: Integer
         # @param Unordered: 是否顺序签署(true:无序签,false:顺序签)
+        # <br/>默认false，有序签署合同
         # @type Unordered: Boolean
         # @param IntelligentStatus: 是否打开智能添加填写区(默认开启，打开:"OPEN" 关闭："CLOSE")
         # @type IntelligentStatus: String
         # @param FormFields: 填写控件内容
         # @type FormFields: Array
-        # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批，true：开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
+        # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批
+        # <br/>true：开启发起方签署审批
+        # <br/>false：不开启发起方签署审批
+        # <br/>开启后，使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
         # @type NeedSignReview: Boolean
         # @param UserData: 用户流程自定义数据参数
         # @type UserData: String
         # @param CcInfos: 抄送人信息
         # @type CcInfos: Array
-        # @param NeedCreateReview: 是否需要发起前审核，当指定NeedCreateReview=true，则发起后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
+        # @param NeedCreateReview: 是否需要开启发起方发起前审核
+        # <br/>true：开启发起方发起前审核
+        # <br/>false：不开启发起方发起前审核
+        # <br/>当指定NeedCreateReview=true，则提交审核后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
         # @type NeedCreateReview: Boolean
 
         attr_accessor :FlowName, :FlowType, :FlowDescription, :Deadline, :Unordered, :IntelligentStatus, :FormFields, :NeedSignReview, :UserData, :CcInfos, :NeedCreateReview
@@ -245,10 +253,11 @@ module TencentCloud
         # @param CancelMessage: 撤销理由,不超过200个字符
         # @type CancelMessage: String
         # @param CancelMessageFormat: 撤销理由自定义格式；选项：
-        # 0 默认格式
-        # 1 只保留身份信息：展示为【发起方】
-        # 2 保留身份信息+企业名称：展示为【发起方xxx公司】
-        # 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+
+        # - 0 默认格式
+        # - 1 只保留身份信息：展示为【发起方】
+        # - 2 保留身份信息+企业名称：展示为【发起方xxx公司】
+        # - 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
         # @type CancelMessageFormat: Integer
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -596,21 +605,23 @@ module TencentCloud
       class ChannelCreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param EmbedType: WEB嵌入资源类型。
-        # CREATE_SEAL: 创建印章
-        # CREATE_TEMPLATE：创建模板
-        # MODIFY_TEMPLATE：修改模板
-        # PREVIEW_TEMPLATE：预览模板
-        # PREVIEW_FLOW：预览合同文档
-        # PREVIEW_FLOW_DETAIL：预览合同详情
-        # PREVIEW_SEAL_LIST：预览印章列表
-        # PREVIEW_SEAL_DETAIL：预览印章详情
-        # EXTEND_SERVICE：扩展服务
+        # @param EmbedType: 要生成WEB嵌入界面的类型, 可以选择的值如下:
+
+        # - CREATE_SEAL: 生成创建印章的嵌入页面
+        # - CREATE_TEMPLATE：生成创建模板的嵌入页面
+        # - MODIFY_TEMPLATE：生成修改模板的嵌入页面
+        # - PREVIEW_TEMPLATE：生成预览模板的嵌入页面
+        # - PREVIEW_FLOW：生成预览合同文档的嵌入页面
+        # - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面
+        # - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
+        # - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
+        # - EXTEND_SERVICE：生成扩展服务的嵌入页面
         # @type EmbedType: String
         # @param BusinessId: WEB嵌入的业务资源ID
-        # EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时必填，取值为模板id
-        # PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时必填，取值为合同id
-        # PREVIEW_SEAL_DETAIL，必填，取值为印章id
+
+        # - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
+        # - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
+        # - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
         # @type BusinessId: String
         # @param HiddenComponents: 是否隐藏控件，只有预览模板时生效
         # @type HiddenComponents: Boolean
@@ -1024,7 +1035,7 @@ module TencentCloud
         # 注：接口通过该字段区分操作类型
         # 该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程
         # 若想使用发起审核，请指定该字段为：CreateReview
-        # 若发起个人审核，则指定该字段为：SignReview（注意，给个人审核时，需联系客户经理开白使用）
+        # 若发起个人审核，则指定该字段为：SignReview
         # @type OperateType: String
 
         attr_accessor :Agent, :FlowId, :ReviewType, :ReviewMessage, :RecipientId, :OperateType
@@ -1308,12 +1319,12 @@ module TencentCloud
         # @type ResourceType: Integer
         # @param FlowInfo: 合同流程基础信息
         # @type FlowInfo: :class:`Tencentcloud::Essbasic.v20210526.models.BaseFlowInfo`
-        # @param FlowApproverList: 合同签署人信息
-        # @type FlowApproverList: Array
         # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowOption: 合同流程配置信息，用于配置发起合同时定制化
         # @type FlowOption: :class:`Tencentcloud::Essbasic.v20210526.models.CreateFlowOption`
+        # @param FlowApproverList: 合同签署人信息
+        # @type FlowApproverList: Array
         # @param FlowId: 通过flowid快速获得之前成功通过页面发起的合同生成链接
         # @type FlowId: String
         # @param NeedPreview: 该参数不可用，请通过获取 web 可嵌入接口获取合同流程预览 URL
@@ -1323,7 +1334,7 @@ module TencentCloud
         # @param Operator: 操作人（用户）信息，不用传
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :ResourceId, :ResourceType, :FlowInfo, :FlowApproverList, :Agent, :FlowOption, :FlowId, :NeedPreview, :Organization, :Operator
+        attr_accessor :ResourceId, :ResourceType, :FlowInfo, :Agent, :FlowOption, :FlowApproverList, :FlowId, :NeedPreview, :Organization, :Operator
         extend Gem::Deprecate
         deprecate :NeedPreview, :none, 2023, 7
         deprecate :NeedPreview=, :none, 2023, 7
@@ -1332,13 +1343,13 @@ module TencentCloud
         deprecate :Operator, :none, 2023, 7
         deprecate :Operator=, :none, 2023, 7
 
-        def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, flowapproverlist=nil, agent=nil, flowoption=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil)
+        def initialize(resourceid=nil, resourcetype=nil, flowinfo=nil, agent=nil, flowoption=nil, flowapproverlist=nil, flowid=nil, needpreview=nil, organization=nil, operator=nil)
           @ResourceId = resourceid
           @ResourceType = resourcetype
           @FlowInfo = flowinfo
-          @FlowApproverList = flowapproverlist
           @Agent = agent
           @FlowOption = flowoption
+          @FlowApproverList = flowapproverlist
           @FlowId = flowid
           @NeedPreview = needpreview
           @Organization = organization
@@ -1352,14 +1363,6 @@ module TencentCloud
             @FlowInfo = BaseFlowInfo.new
             @FlowInfo.deserialize(params['FlowInfo'])
           end
-          unless params['FlowApproverList'].nil?
-            @FlowApproverList = []
-            params['FlowApproverList'].each do |i|
-              commonflowapprover_tmp = CommonFlowApprover.new
-              commonflowapprover_tmp.deserialize(i)
-              @FlowApproverList << commonflowapprover_tmp
-            end
-          end
           unless params['Agent'].nil?
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
@@ -1368,6 +1371,14 @@ module TencentCloud
             @FlowOption = CreateFlowOption.new
             @FlowOption.deserialize(params['FlowOption'])
           end
+          unless params['FlowApproverList'].nil?
+            @FlowApproverList = []
+            params['FlowApproverList'].each do |i|
+              commonflowapprover_tmp = CommonFlowApprover.new
+              commonflowapprover_tmp.deserialize(i)
+              @FlowApproverList << commonflowapprover_tmp
+            end
+          end
           @FlowId = params['FlowId']
           @NeedPreview = params['NeedPreview']
           unless params['Organization'].nil?
@@ -2747,12 +2758,15 @@ module TencentCloud
 
       # CreateChannelFlowEvidenceReport返回参数结构体
       class CreateChannelFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
-        # @param ReportId: 出证报告 ID，用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
+        # @param ReportId: 出证报告 ID，可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
+
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReportId: String
-        # @param Status: 执行中：EvidenceStatusExecuting
-        # 成功：EvidenceStatusSuccess
-        # 失败：EvidenceStatusFailed
+        # @param Status: 出征任务的执行状态,状态列表如下
+
+        # - EvidenceStatusExecuting : 出征任务正在执行中
+        # - EvidenceStatusSuccess : 出征任务执行成功
+        # - EvidenceStatusFailed : 出征任务执行失败
         # @type Status: String
         # @param ReportUrl: 废除，字段无效
         # 注意：此字段可能返回 null，表示取不到有效值。
@@ -3240,12 +3254,14 @@ module TencentCloud
 
       # DescribeChannelFlowEvidenceReport返回参数结构体
       class DescribeChannelFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
-        # @param ReportUrl: 出证报告 URL
+        # @param ReportUrl: 出证报告下载 URL
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReportUrl: String
-        # @param Status: 执行中：EvidenceStatusExecuting
-        # 成功：EvidenceStatusSuccess
-        # 失败：EvidenceStatusFailed
+        # @param Status: 出征任务的执行状态,状态列表如下
+
+        # - EvidenceStatusExecuting : 出征任务正在执行中
+        # - EvidenceStatusSuccess : 出征任务执行成功
+        # - EvidenceStatusFailed : 出征任务执行失败
         # @type Status: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3319,7 +3335,7 @@ module TencentCloud
         # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowIds: 合同(流程)编号数组，最多支持100个。
-        # （备注：该参数和合同组编号必须二选一）
+        # （备注：该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参）
         # @type FlowIds: Array
         # @param FlowGroupId: 合同组编号（备注：该参数和合同(流程)编号数组必须二选一）
         # @type FlowGroupId: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.622
+  version: 3.0.624
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common