tencentcloud-sdk-ess 3.0.734 → 3.0.736

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef316d635ddaebf1d189b1f75681e9252d81eca4
-  data.tar.gz: f410741fc5efb788216b512f67cca873273d635a
+  metadata.gz: 98776e507951c3436ecd4cdf1510e561e253d6b1
+  data.tar.gz: 0995b6e9f24a6892c3d08b71e2f3f8e848f266ba
 SHA512:
-  metadata.gz: 3b118227cdd0565f0cd8a60a0511e96e530ba7979206c8db8c5cec8c646a161e46284ddc411cec24a2a326aa901a47b59961560ae076c63089a70f3d2cfd4601
-  data.tar.gz: 3b3595021255ea72c06738662adc38ef28f6c5430bf4dae149eed1020b39c2559f0a33a4876934509ccb8f8c2eef60c6500e8d7815e7fbf8006d41cfa2bad637
+  metadata.gz: fe3bc0e0f5c85da40bd6b1faf7185f727326dcfb06a936558be2287fe6627a699a75e022924c8150ca0b8804fdd8b63a37cea75c32f775408bb6740a4c6d4540
+  data.tar.gz: 3100a863f6607343680072f431ba56c1c31b5ec0afc69c7915a560c2cd3cce159572097c147b5b284ea19ee22230cbb8df09633534ad5a75e64b6930b11e054e

data/lib/VERSION

@@ -1 +1 @@
-3.0.734
+3.0.736

data/lib/v20201111/client.rb

@@ -164,7 +164,7 @@ module TencentCloud
         # 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
         # **注意：**
         # 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
-        # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**，**不支持填写控件** 。
+        # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。
         # 3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
         # 4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
         # 5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
@@ -583,6 +583,37 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 提交合同组签署流程审批结果的适用场景包括：
+
+        # 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时，若指定了以下参数 为true，则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
+        #   - [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
+        #   - [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
+
+
+        # 2. 同一合同组，同一签署人可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
+
+        # @param request: Request instance for CreateFlowGroupSignReview.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupSignReviewRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupSignReviewResponse`
+        def CreateFlowGroupSignReview(request)
+          body = send_request('CreateFlowGroupSignReview', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateFlowGroupSignReviewResponse.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
+
         # 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
 
         # 1. 发起合同时，**签署人的NotifyType需设置为sms**
@@ -616,9 +647,36 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 提交签署流程审批结果的适用场景包括：
-        # 1. 在使用模板（CreateFlow）或文件（CreateFlowByFiles）创建签署流程时，若指定了参数NeedSignReview为true，且发起方企业作为签署方参与了流程签署，则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
-        # 2. 若签署流程状态正常，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
+        # 提交企业流程审批结果
+        # **当前存在两种审核操作：**
+        # <ul>
+        # <li>签署审核
+        # <ul>
+        # <li>在通过接口<ul>
+        # <li>CreateFlowByFiles</li>
+        # <li>CreateFlow</li>
+        # <li>CreateFlowGroupByTemplates</li>
+        # <li>CreateFlowGroupByFiles</li>
+        # <li>CreatePrepareFlow</li>
+        # </ul>
+        # 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果</li>
+        # <li>在通过接口
+        # <ul>
+        # <li>CreateFlowByFiles</li>
+        # <li>CreateFlow</li>
+        # <li>CreateFlowGroupByTemplates</li>
+        # <li>CreateFlowGroupByFiles</li>
+        # </ul>
+        # 发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果</li>
+        # </ul>
+        # </li>
+        # <li>发起审核
+        #  <ul>
+        # <li>通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
+        # </li>
+        # </ul>
+        # </li>
+        # </ul>
 
         # @param request: Request instance for CreateFlowSignReview.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignReviewRequest`

data/lib/v20201111/models.rb

@@ -170,7 +170,8 @@ module TencentCloud
         # @type PreReadTime: Integer
         # @param UserId: 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
 
-        # 注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
+        # 注：
+        # 如果传进来的<font color="red">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）
         # @type UserId: String
         # @param ApproverSource: 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
         # @type ApproverSource: String
@@ -1307,7 +1308,9 @@ module TencentCloud
         # <li>**4**：系统签名</li></ul>
         # 注：
         # <ul><li>默认情况下，签名类型为手写签名</li>
-        # <li>您可以传递多种值，表示可用多种签名类型。</li></ul>
+        # <li>您可以传递多种值，表示可用多种签名类型。</li>
+        # <li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li>
+        # </ul>
         # @type SignatureTypes: Array
         # @param ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
         # <ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
@@ -1607,6 +1610,7 @@ module TencentCloud
         # @param FormFields: 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
         # <ul>
         # <li>支持自动签传递印章，可通过指定自动签控件id，指定印章id来完成</li>
+        # <li>附件控件支持传入图片、文件资源id，并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型，图片资源会放置在合同文件的末尾，如果传入的资源有非图片类型资源，会将资源放置在附件控件所在页面的下一页。</li>
         # </ul>
         # 注：只有在控制台编辑模板时，<font color="red">归属给发起方</font>的填写控件（如下图）才能在创建文档的时候进行内容填充。
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
@@ -2409,6 +2413,81 @@ module TencentCloud
         end
       end
 
+      # CreateFlowGroupSignReview请求参数结构体
+      class CreateFlowGroupSignReviewRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param FlowGroupId: 合同(流程)组的合同组Id，为32位字符串，通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。
+        # @type FlowGroupId: String
+        # @param ReviewType: 提交的审核结果，审核结果有下面三种情况
+        # <ul><li><b>PASS</b>: 审核通过，合同流程可以继续执行签署等操作</li>
+        # <li><b>REJECT</b>: 审核拒绝，合同流程不会变动</li>
+        # <li><b>SIGN_REJECT</b>:拒签，合同流程直接结束，合同状态变为**合同拒签**</li></ul>
+        # @type ReviewType: String
+        # @param ApproverInfo: 需要进行签署审核的签署人的个人信息或企业信息，签署方的匹配方式按照以下规则:
+
+        # 个人：二选一（选择其中任意信息组合即可）
+        # <ul><li>姓名+证件类型+证件号</li>
+        # <li>姓名+手机号</li></ul>
+
+        # 企业：二选一  （选择其中任意信息组合即可）
+        # <ul><li>企业名+姓名+证件类型+证件号</li>
+        # <li>企业名+姓名+手机号</li></ul>
+        # @type ApproverInfo: :class:`Tencentcloud::Ess.v20201111.models.NeedReviewApproverInfo`
+        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param ReviewMessage: 审核不通过的原因，该字段的字符串长度不超过200个字符。
+
+        # 注：`当审核类型（ReviewType）为审核拒绝（REJECT）或拒签（SIGN_REJECT）时，审核结果原因字段必须填写`
+        # @type ReviewMessage: String
+
+        attr_accessor :Operator, :FlowGroupId, :ReviewType, :ApproverInfo, :Agent, :ReviewMessage
+
+        def initialize(operator=nil, flowgroupid=nil, reviewtype=nil, approverinfo=nil, agent=nil, reviewmessage=nil)
+          @Operator = operator
+          @FlowGroupId = flowgroupid
+          @ReviewType = reviewtype
+          @ApproverInfo = approverinfo
+          @Agent = agent
+          @ReviewMessage = reviewmessage
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @FlowGroupId = params['FlowGroupId']
+          @ReviewType = params['ReviewType']
+          unless params['ApproverInfo'].nil?
+            @ApproverInfo = NeedReviewApproverInfo.new
+            @ApproverInfo.deserialize(params['ApproverInfo'])
+          end
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @ReviewMessage = params['ReviewMessage']
+        end
+      end
+
+      # CreateFlowGroupSignReview返回参数结构体
+      class CreateFlowGroupSignReviewResponse < 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
+
       # 创建合同个性化参数
       class CreateFlowOption < TencentCloud::Common::AbstractModel
         # @param CanEditFlow: 是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。
@@ -2711,22 +2790,18 @@ module TencentCloud
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param FlowId: 合同流程ID，为32位字符串。
-        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # <ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
+        # <li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
         # @type FlowId: String
-        # @param ReviewType: 企业审核结果
-        # <ul><li>PASS: 通过</li>
-        # <li>REJECT: 拒绝</li></ul>
+        # @param ReviewType: 企业内部审核结果
+        # <ul><li>PASS: 审核通过</li>
+        # <li>REJECT: 审核拒绝</li>
+        # <li>SIGN_REJECT:拒签(流程结束)</li></ul>
         # @type ReviewType: String
-        # @param ReviewMessage: 审核结果原因，
-        # 字符串长度不超过200
-        # 当ReviewType 是拒绝（REJECT） 时此字段必填。
-        # @type ReviewMessage: String
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param RecipientId: 审核签署节点人标识，
-        # 用来标识审核的签署方。
-        # 如果签署审核节点是个人， 此参数必填。
+        # @param RecipientId: 审核节点的签署人标志，用于指定当前审核的签署方
+        # <ul><li>**如果签署审核节点是个人， 此参数必填**。</li></ul>
         # @type RecipientId: String
         # @param OperateType: 操作类型：（接口通过该字段区分不同的操作类型）
 
@@ -2735,17 +2810,23 @@ module TencentCloud
 
         # 如果审核节点是个人，则操作类型只能为SignReview。
         # @type OperateType: String
+        # @param ReviewMessage: 审核结果原因
+        # <ul><li>字符串长度不超过200</li>
+        # <li>当ReviewType 是拒绝（REJECT） 时此字段必填。</li>
+        # <li>当ReviewType 是拒绝（SIGN_REJECT） 时此字段必填。</li></ul>
 
-        attr_accessor :Operator, :FlowId, :ReviewType, :ReviewMessage, :Agent, :RecipientId, :OperateType
+        # @type ReviewMessage: String
+
+        attr_accessor :Operator, :FlowId, :ReviewType, :Agent, :RecipientId, :OperateType, :ReviewMessage
 
-        def initialize(operator=nil, flowid=nil, reviewtype=nil, reviewmessage=nil, agent=nil, recipientid=nil, operatetype=nil)
+        def initialize(operator=nil, flowid=nil, reviewtype=nil, agent=nil, recipientid=nil, operatetype=nil, reviewmessage=nil)
           @Operator = operator
           @FlowId = flowid
           @ReviewType = reviewtype
-          @ReviewMessage = reviewmessage
           @Agent = agent
           @RecipientId = recipientid
           @OperateType = operatetype
+          @ReviewMessage = reviewmessage
         end
 
         def deserialize(params)
@@ -2755,13 +2836,13 @@ module TencentCloud
           end
           @FlowId = params['FlowId']
           @ReviewType = params['ReviewType']
-          @ReviewMessage = params['ReviewMessage']
           unless params['Agent'].nil?
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
           @RecipientId = params['RecipientId']
           @OperateType = params['OperateType']
+          @ReviewMessage = params['ReviewMessage']
         end
       end
 
@@ -7397,7 +7478,8 @@ module TencentCloud
       # }
       # ```
 
-      # 当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue填入附件图片的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
+      # 当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue支持填入附件图片或者文件的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
+      # 支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf
 
       # ```
       # FormField输入示例：
@@ -8158,6 +8240,56 @@ module TencentCloud
         end
       end
 
+      # 需要进行签署审核的签署人信息
+      class NeedReviewApproverInfo < TencentCloud::Common::AbstractModel
+        # @param ApproverType: 签署方经办人的类型，支持以下类型
+        # <ul><li> ORGANIZATION 企业（含企业自动签）</li>
+        # <li>PERSON 个人（含个人自动签）</li></ul>
+        # @type ApproverType: String
+        # @param ApproverName: 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
+        # @type ApproverName: String
+        # @param ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
+        # @type ApproverMobile: String
+        # @param ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
+        # <ul><li>ID_CARD 居民身份证  (默认值)</li>
+        # <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
+        # <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
+        # <li>OTHER_CARD_TYPE 其他证件</li></ul>
+
+        # 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
+        # @type ApproverIdCardType: String
+        # @param ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
+        # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+        # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+        # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
+        # @type ApproverIdCardNumber: String
+        # @param OrganizationName: 组织机构名称。
+        # 请确认该名称与企业营业执照中注册的名称一致。
+        # 如果名称中包含英文括号()，请使用中文括号（）代替。
+        # 如果签署方是企业签署方(approverType = 0 或者 approverType = 3)， 则企业名称必填。
+        # @type OrganizationName: String
+
+        attr_accessor :ApproverType, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :OrganizationName
+
+        def initialize(approvertype=nil, approvername=nil, approvermobile=nil, approveridcardtype=nil, approveridcardnumber=nil, organizationname=nil)
+          @ApproverType = approvertype
+          @ApproverName = approvername
+          @ApproverMobile = approvermobile
+          @ApproverIdCardType = approveridcardtype
+          @ApproverIdCardNumber = approveridcardnumber
+          @OrganizationName = organizationname
+        end
+
+        def deserialize(params)
+          @ApproverType = params['ApproverType']
+          @ApproverName = params['ApproverName']
+          @ApproverMobile = params['ApproverMobile']
+          @ApproverIdCardType = params['ApproverIdCardType']
+          @ApproverIdCardNumber = params['ApproverIdCardNumber']
+          @OrganizationName = params['OrganizationName']
+        end
+      end
+
       # 持有的电子印章信息
       class OccupiedSeal < TencentCloud::Common::AbstractModel
         # @param SealId: 电子印章编号

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.734
+  version: 3.0.736
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-25 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common