tencentcloud-sdk-essbasic 3.0.382 → 3.0.387

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a50feae1d6e2a7fd1edee88c85875445e816c19
-  data.tar.gz: f5c63849f9c440ddf37d51a41f041b0d44c72f3d
+  metadata.gz: 8949d995abe0f55fff29a2e392ecc12b8dab9fe0
+  data.tar.gz: 7f3d5f870514f68c0df8b66cb80f738f7df45431
 SHA512:
-  metadata.gz: 39a955ea4e3c2f9a233d4c6519900f3e09c45bc7473e20ce0001d186f83713e312d3009830c8b467ec75e172c196da22caa8b715c9771f603b88707dc82233d2
-  data.tar.gz: 06ab6d5c9e8f0cce90528b6d4056df3c7d419006483e39d10c88eae4de768214abad9c254c7aeecbf068fe309f6d2a50e143b4ede633ed877cd2bc4c9a7a07e7
+  metadata.gz: 6eaf323976c45a47519f1c03cbaeb1c6afc4095d67549543b149fa427e27eed1a75e4e225c74ec6beb93844d0af89115545a83b8a8472fd11a25c38d997cab9a
+  data.tar.gz: cd6380258ef401e8e47fcfda02043db422b6067714fb45261fa05f323b6787c99f7a24d569971f8bed3bb7bde7d010ed695f8964ca70f4985f7fefe7606d2c71

data/lib/VERSION

@@ -1 +1 @@
-3.0.382
+3.0.387

data/lib/v20210526/client.rb

@@ -53,8 +53,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 指定需要批量撤回的签署流程Id，获取批量撤销链接
-        # 客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
+        # 指定需要批量撤销的签署流程Id，获取批量撤销链接
+        # 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销
 
         # @param request: Request instance for ChannelCreateBatchCancelFlowUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchCancelFlowUrlRequest`
@@ -126,6 +126,33 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 提交企业签署流程审批结果
+
+        # 在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
+        # 若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
+
+        # @param request: Request instance for ChannelCreateFlowSignReview.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignReviewRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignReviewResponse`
+        def ChannelCreateFlowSignReview(request)
+          body = send_request('ChannelCreateFlowSignReview', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateFlowSignReviewResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫签署流程二维码。
         # 适用的模版仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模版，且模版中发起方没有填写控件。
 

data/lib/v20210526/models.rb

@@ -194,11 +194,11 @@ module TencentCloud
 
       # ChannelCreateBatchCancelFlowUrl返回参数结构体
       class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
-        # @param BatchCancelFlowUrl: 批量撤回url
+        # @param BatchCancelFlowUrl: 批量撤销url
         # @type BatchCancelFlowUrl: String
-        # @param FailMessages: 签署流程批量撤回失败原因
+        # @param FailMessages: 签署流程批量撤销失败原因
         # @type FailMessages: Array
-        # @param UrlExpireOn: 签署撤回url过期时间-年月日-时分秒
+        # @param UrlExpireOn: 签署撤销url过期时间-年月日-时分秒
         # @type UrlExpireOn: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -222,28 +222,28 @@ module TencentCloud
 
       # ChannelCreateConvertTaskApi请求参数结构体
       class ChannelCreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 无
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param ResourceId: 资源Id
-        # @type ResourceId: String
         # @param ResourceType: 资源类型 取值范围doc,docx,html之一
         # @type ResourceType: String
-        # @param ResourceName: 资源名称
+        # @param ResourceName: 资源名称，长度限制为256字符
         # @type ResourceName: String
-        # @param Organization: 无
-        # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
-        # @param Operator: 无
+        # @param ResourceId: 资源Id，通过UploadFiles获取
+        # @type ResourceId: String
+        # @param Operator: 操作者信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param Organization: 暂未开放
+        # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
 
-        attr_accessor :Agent, :ResourceId, :ResourceType, :ResourceName, :Organization, :Operator
+        attr_accessor :Agent, :ResourceType, :ResourceName, :ResourceId, :Operator, :Organization
         
-        def initialize(agent=nil, resourceid=nil, resourcetype=nil, resourcename=nil, organization=nil, operator=nil)
+        def initialize(agent=nil, resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, organization=nil)
           @Agent = agent
-          @ResourceId = resourceid
           @ResourceType = resourcetype
           @ResourceName = resourcename
-          @Organization = organization
+          @ResourceId = resourceid
           @Operator = operator
+          @Organization = organization
         end
 
         def deserialize(params)
@@ -251,17 +251,17 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
-          @ResourceId = params['ResourceId']
           @ResourceType = params['ResourceType']
           @ResourceName = params['ResourceName']
-          unless params['Organization'].nil?
-            @Organization = OrganizationInfo.new
-            @Organization.deserialize(params['Organization'])
-          end
+          @ResourceId = params['ResourceId']
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          unless params['Organization'].nil?
+            @Organization = OrganizationInfo.new
+            @Organization.deserialize(params['Organization'])
+          end
         end
       end
 
@@ -287,7 +287,7 @@ module TencentCloud
 
       # ChannelCreateFlowByFiles请求参数结构体
       class ChannelCreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 渠道应用相关信息
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param FlowName: 签署流程名称，长度不超过200个字符
         # @type FlowName: String
@@ -311,12 +311,14 @@ module TencentCloud
         # @type CustomShowMap: String
         # @param CustomerData: 渠道的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
         # @type CustomerData: String
+        # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。  注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+        # @type NeedSignReview: Boolean
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
 
-        attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :Operator
+        attr_accessor :Agent, :FlowName, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :FlowDescription, :CustomShowMap, :CustomerData, :NeedSignReview, :Operator
         
-        def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, operator=nil)
+        def initialize(agent=nil, flowname=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, flowdescription=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, operator=nil)
           @Agent = agent
           @FlowName = flowname
           @FlowApprovers = flowapprovers
@@ -329,6 +331,7 @@ module TencentCloud
           @FlowDescription = flowdescription
           @CustomShowMap = customshowmap
           @CustomerData = customerdata
+          @NeedSignReview = needsignreview
           @Operator = operator
         end
 
@@ -362,6 +365,7 @@ module TencentCloud
           @FlowDescription = params['FlowDescription']
           @CustomShowMap = params['CustomShowMap']
           @CustomerData = params['CustomerData']
+          @NeedSignReview = params['NeedSignReview']
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
@@ -390,6 +394,56 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateFlowSignReview请求参数结构体
+      class ChannelCreateFlowSignReviewRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param FlowId: 签署流程编号
+        # @type FlowId: String
+        # @param ReviewType: 企业内部审核结果
+        # PASS: 通过
+        # REJECT: 拒绝
+        # @type ReviewType: String
+        # @param ReviewMessage: 审核原因
+        # 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
+        # @type ReviewMessage: String
+
+        attr_accessor :Agent, :FlowId, :ReviewType, :ReviewMessage
+        
+        def initialize(agent=nil, flowid=nil, reviewtype=nil, reviewmessage=nil)
+          @Agent = agent
+          @FlowId = flowid
+          @ReviewType = reviewtype
+          @ReviewMessage = reviewmessage
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @FlowId = params['FlowId']
+          @ReviewType = params['ReviewType']
+          @ReviewMessage = params['ReviewMessage']
+        end
+      end
+
+      # ChannelCreateFlowSignReview返回参数结构体
+      class ChannelCreateFlowSignReviewResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+        
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateMultiFlowSignQRCode请求参数结构体
       class ChannelCreateMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 渠道应用相关信息。
@@ -482,22 +536,22 @@ module TencentCloud
 
       # ChannelGetTaskResultApi请求参数结构体
       class ChannelGetTaskResultApiRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 渠道信息
+        # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param TaskId: 任务Id
+        # @param TaskId: 任务Id，通过ChannelCreateConvertTaskApi接口获得
         # @type TaskId: String
-        # @param Organization: 企业信息
-        # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
-        # @param Operator: 操作人信息
+        # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param Organization: 暂未开放
+        # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
 
-        attr_accessor :Agent, :TaskId, :Organization, :Operator
+        attr_accessor :Agent, :TaskId, :Operator, :Organization
         
-        def initialize(agent=nil, taskid=nil, organization=nil, operator=nil)
+        def initialize(agent=nil, taskid=nil, operator=nil, organization=nil)
           @Agent = agent
           @TaskId = taskid
-          @Organization = organization
           @Operator = operator
+          @Organization = organization
         end
 
         def deserialize(params)
@@ -506,14 +560,14 @@ module TencentCloud
             @Agent.deserialize(params['Agent'])
           end
           @TaskId = params['TaskId']
-          unless params['Organization'].nil?
-            @Organization = OrganizationInfo.new
-            @Organization.deserialize(params['Organization'])
-          end
           unless params['Operator'].nil?
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          unless params['Organization'].nil?
+            @Organization = OrganizationInfo.new
+            @Organization.deserialize(params['Organization'])
+          end
         end
       end
 
@@ -521,11 +575,23 @@ module TencentCloud
       class ChannelGetTaskResultApiResponse < TencentCloud::Common::AbstractModel
         # @param TaskId: 任务Id
         # @type TaskId: String
-        # @param TaskStatus: 任务状态
+        # @param TaskStatus: 任务状态，需要关注的状态
+        # 0  :NeedTranform   - 任务已提交
+        # 4  :Processing     - 文档转换中
+        # 8  :TaskEnd        - 任务处理完成
+        # -2 :DownloadFailed - 下载失败
+        # -6 :ProcessFailed  - 转换失败
+        # -13:ProcessTimeout - 转换文件超时
         # @type TaskStatus: Integer
-        # @param TaskMessage: 状态描述
+        # @param TaskMessage: 状态描述，需要关注的状态
+        # NeedTranform   - 任务已提交
+        # Processing     - 文档转换中
+        # TaskEnd        - 任务处理完成
+        # DownloadFailed - 下载失败
+        # ProcessFailed  - 转换失败
+        # ProcessTimeout - 转换文件超时
         # @type TaskMessage: String
-        # @param ResourceId: 资源Id
+        # @param ResourceId: 资源Id，也是FileId，用于文件发起使用
         # @type ResourceId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -1582,10 +1648,15 @@ module TencentCloud
         # @type CustomShowMap: String
         # @param CcInfos: 被抄送人的信息列表，抄送功能暂不开放
         # @type CcInfos: Array
+        # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。
+        # 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+        # 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+        # @type NeedSignReview: Boolean
 
-        attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos
+        attr_accessor :FlowName, :Deadline, :TemplateId, :FlowApprovers, :FormFields, :CallbackUrl, :FlowType, :FlowDescription, :CustomerData, :CustomShowMap, :CcInfos, :NeedSignReview
         
-        def initialize(flowname=nil, deadline=nil, templateid=nil, flowapprovers=nil, formfields=nil, callbackurl=nil, flowtype=nil, flowdescription=nil, customerdata=nil, customshowmap=nil, ccinfos=nil)
+        def initialize(flowname=nil, deadline=nil, templateid=nil, flowapprovers=nil, formfields=nil, callbackurl=nil, flowtype=nil, flowdescription=nil, customerdata=nil, customshowmap=nil, ccinfos=nil, needsignreview=nil)
           @FlowName = flowname
           @Deadline = deadline
           @TemplateId = templateid
@@ -1597,6 +1668,7 @@ module TencentCloud
           @CustomerData = customerdata
           @CustomShowMap = customshowmap
           @CcInfos = ccinfos
+          @NeedSignReview = needsignreview
         end
 
         def deserialize(params)
@@ -1632,6 +1704,7 @@ module TencentCloud
               @CcInfos << ccinfo_tmp
             end
           end
+          @NeedSignReview = params['NeedSignReview']
         end
       end
 
@@ -2424,7 +2497,7 @@ module TencentCloud
         # @param Agent: 应用相关信息，若是渠道版调用 appid 和proxyappid 必填
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param BusinessType: 文件对应业务类型，用于区分文件存储路径：
-        # 1. TEMPLATE - 模板； 文件类型：.pdf
+        # 1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
         # 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
         # @type BusinessType: String
         # @param FileInfos: 上传文件内容数组，最多支持20个文件

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.382
+  version: 3.0.387
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common