tencentcloud-sdk-ess 3.0.625 → 3.0.627

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51acd12bd64d1deffcf445f8b448969a17af752f
-  data.tar.gz: 53114ff10e2ef6fb361507a5b5b28c5ab0d183fb
+  metadata.gz: ec68f7237db79392c482c127678fc20491fd6d2a
+  data.tar.gz: b7d66b8c83b8e98397112fa5540b808351083a8a
 SHA512:
-  metadata.gz: bb0900bde999a247be7b7e3a274d8e54c020b5bd033851c13e1547c83e1db212c14f09ead42007a43f19646fae725b069fb309d29e065dc4e947d9241fc3537e
-  data.tar.gz: bda863e8a7c3331b96d016ec62ebc510413a8b7cc77da9fe5358be1d392a60313bda19c315dd5ee022a779ad8c974ba9274382fac5656ea05f99ab8518ff2a48
+  metadata.gz: e0b2dd658ea3d9212377be1bdc46f5f18d5c67498593bac6cc794d9ce8ffc08e4df60677447f67ca7c3ab5b1fa15aaa6bca139ccfd79e4441a8aebcb03a1aa56
+  data.tar.gz: 5e5e0cf1af8070cd30db6aa28fb41033804dd996e1dae3e15c7eb756b654738e62eee6d72baf22fadd6b38cd3b258944728cdf9c06f1ae436f33e8c34bec1b33

data/lib/VERSION

@@ -1 +1 @@
-3.0.625
+3.0.627

data/lib/v20201111/client.rb

@@ -630,6 +630,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 本接口（CreatePersonAuthCertificateImage）用于创建个人用户证书证明图片
+
+        # @param request: Request instance for CreatePersonAuthCertificateImage.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreatePersonAuthCertificateImageResponse`
+        def CreatePersonAuthCertificateImage(request)
+          body = send_request('CreatePersonAuthCertificateImage', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreatePersonAuthCertificateImageResponse.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
+
         # 创建快速发起流程
         # <br/>适用场景：用户通过API 合同文件及签署信息，并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认，快速发起合同.
         # <br/>注：该接口文件的resourceId 是通过上传文件之后获取的。
@@ -981,7 +1005,7 @@ module TencentCloud
 
         # 查询流程基础信息
         # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
-        # 每个企业限制日调用量限制：10W,  当当日超过此限制后再调用接口返回错误
+        # 每个企业限制日调用量限制：10W，当日超过此限制后再调用接口返回错误
 
         # @param request: Request instance for DescribeFlowBriefs.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`
@@ -1029,7 +1053,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询出证报告，返回报告 URL。
+        # 查询出证报告，返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
 
         # @param request: Request instance for DescribeFlowEvidenceReport.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest`

data/lib/v20201111/models.rb

@@ -251,7 +251,7 @@ module TencentCloud
         # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
         # @param CallbackUrl: 接受回调URL地址。支持http://或者https://协议
 
-        # Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
+        # Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
         # @type CallbackUrl: String
         # @param CertInfoCallback: 是否回调证书信息
         # false-不需要 (默认值)
@@ -264,7 +264,7 @@ module TencentCloud
         # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
 
         # false-不需要(默认)
-        # true-需要(
+        # true-需要
         # @type SealImgCallback: Boolean
         # @param VerifyChannels: 开通时候的验证方式, 分布为
 
@@ -1134,15 +1134,20 @@ module TencentCloud
         # @param Operator: 操作者信息
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param EmbedType: WEB嵌入资源类型。
-        # <br/>CREATE_SEAL: 创建印章
-        # <br/>PREVIEW_SEAL_LIST：预览印章列表
-        # <br/>PREVIEW_SEAL_DETAIL：预览印章详情
-        # <br/>EXTEND_SERVICE：拓展服务
-        # <br/>PREVIEW_FLOW：预览合同
-        # <br/>PREVIEW_FLOW_DETAIL：查看合同详情
+        # <br/>CREATE_SEAL: 生成创建印章的嵌入页面
+        # <br/>CREATE_TEMPLATE：生成创建模板的嵌入页面
+        # <br/>MODIFY_TEMPLATE：生成编辑模板的嵌入页面
+        # <br/>PREVIEW_TEMPLATE：生成预览模板的嵌入页面
+        # <br/>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
+        # <br/>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
+        # <br/>EXTEND_SERVICE：生成拓展服务的嵌入页面
+        # <br/>PREVIEW_FLOW：生成预览合同的嵌入页面
+        # <br/>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
         # @type EmbedType: String
         # @param BusinessId: WEB嵌入的业务资源ID
         # <br/>PREVIEW_SEAL_DETAIL，必填，取值为印章id
+        # <br/>MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模版id
+        # <br/>PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
         # @type BusinessId: String
         # @param Agent: 代理相关应用信息，如集团主企业代子企业操作
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -1648,10 +1653,10 @@ module TencentCloud
         # @param CanEditFlow: 是否允许修改发起合同时确认弹窗的合同信息（合同名称、合同类型、签署截止时间），若不允许编辑，则表单字段将被禁止输入。
         # <br/>true：允许编辑（默认），<br/>false：不允许编辑<br/>默认：false：不允许编辑
         # @type CanEditFlow: Boolean
-        # @param CanEditFormField: 是否允许编辑模版控件
-        # <br/>true:允许编辑模版控件信息
-        # <br/>false:不允许编辑模版控件信息
-        # <br/>默认false:不允许编辑模版控件信息
+        # @param CanEditFormField: 是否允许编辑模板控件
+        # <br/>true:允许编辑模板控件信息
+        # <br/>false:不允许编辑模板控件信息
+        # <br/>默认false:不允许编辑模板控件信息
         # @type CanEditFormField: Boolean
         # @param HideShowFlowName: 发起页面隐藏合同名称展示
         # <br/>true:发起页面隐藏合同名称展示
@@ -1777,6 +1782,7 @@ module TencentCloud
         # @param FlowName: 签署流程名称,最大长度200个字符
         # @type FlowName: String
         # @param Approvers: 签署流程参与者信息，最大限制50方
+        # 注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
         # @type Approvers: Array
         # @param FlowType: 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
         # @type FlowType: String
@@ -2251,19 +2257,22 @@ module TencentCloud
         # @param FlowName: 签署流程名称，最大长度不超过200字符
         # @type FlowName: String
         # @param MaxFlowNum: 最大可发起签署流程份数，默认5份
-        # 发起流程数量超过此上限后二维码自动失效
+        # <br/>发起流程数量超过此上限后二维码自动失效
         # @type MaxFlowNum: Integer
-        # @param FlowEffectiveDay: 签署流程有效天数 默认7天 最高设置不超过30天
+        # @param FlowEffectiveDay: 签署流程有效天数
+        # <br/>默认7天
+        # <br/>最高设置不超过30天
         # @type FlowEffectiveDay: Integer
         # @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
         # @type QrEffectiveDay: Integer
-        # @param Restrictions: 限制二维码用户条件
+        # @param Restrictions: 指定的签署人信息
+        # <br/>指定后，则只允许指定的签署人扫码签署
         # @type Restrictions: Array
-        # @param UserData: 用户自定义字段，回调的时候会进行透传，长度需要小于20480
+        # @param UserData: 用户自定义字段
+        # <br/>回调的时候会进行透传，长度需要小于20480
         # @type UserData: String
         # @param CallbackUrl: 回调地址,最大长度1000字符串
-        # 回调时机：
-        # 用户通过签署二维码发起签署流程时，企业额度不足导致失败
+        # <br/>回调时机：用户通过签署二维码发起签署流程时，企业额度不足导致失败
         # @type CallbackUrl: String
         # @param Agent: 应用信息
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -2418,6 +2427,62 @@ module TencentCloud
         end
       end
 
+      # CreatePersonAuthCertificateImage请求参数结构体
+      class CreatePersonAuthCertificateImageRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 操作人信息
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param UserName: 个人用户名称
+        # @type UserName: String
+        # @param IdCardType: 身份证件类型取值：
+        # ID_CARD 身居民身份证
+        # PASSPORT 护照
+        # HONGKONG_AND_MACAO 港澳居民来往内地通行证
+        # FOREIGN_ID_CARD 外国人永久居留身份证
+        # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+        # @type IdCardType: String
+        # @param IdCardNumber: 身份证件号码
+        # @type IdCardNumber: String
+
+        attr_accessor :Operator, :UserName, :IdCardType, :IdCardNumber
+
+        def initialize(operator=nil, username=nil, idcardtype=nil, idcardnumber=nil)
+          @Operator = operator
+          @UserName = username
+          @IdCardType = idcardtype
+          @IdCardNumber = idcardnumber
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @UserName = params['UserName']
+          @IdCardType = params['IdCardType']
+          @IdCardNumber = params['IdCardNumber']
+        end
+      end
+
+      # CreatePersonAuthCertificateImage返回参数结构体
+      class CreatePersonAuthCertificateImageResponse < TencentCloud::Common::AbstractModel
+        # @param AuthCertUrl: 个人用户证明证书的下载链接
+        # @type AuthCertUrl: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :AuthCertUrl, :RequestId
+
+        def initialize(authcerturl=nil, requestid=nil)
+          @AuthCertUrl = authcerturl
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @AuthCertUrl = params['AuthCertUrl']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreatePrepareFlow请求参数结构体
       class CreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 调用方用户信息，userId 必填
@@ -3780,7 +3845,7 @@ module TencentCloud
 
         # EvidenceStatusExecuting  出证任务在执行中
         # EvidenceStatusSuccess  出证任务执行成功
-        # EvidenceStatusFailed  出征任务执行失败
+        # EvidenceStatusFailed  出证任务执行失败
         # @type Status: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -4314,7 +4379,7 @@ module TencentCloud
         # @param JoinedTotal: 已授权待激活的企业数量
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type JoinedTotal: Integer
-        # @param ActivedTotal: 已加入的企业数量
+        # @param ActivedTotal: 已加入的企业数量(废弃,请使用ActivatedTotal)
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ActivedTotal: Integer
         # @param ExportUrl: 导出文件的url
@@ -4323,17 +4388,24 @@ module TencentCloud
         # @param List: 成员企业信息列表
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type List: Array
+        # @param ActivatedTotal: 已加入的企业数量
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ActivatedTotal: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :Total, :JoinedTotal, :ActivedTotal, :ExportUrl, :List, :RequestId
+        attr_accessor :Total, :JoinedTotal, :ActivedTotal, :ExportUrl, :List, :ActivatedTotal, :RequestId
+        extend Gem::Deprecate
+        deprecate :ActivedTotal, :none, 2023, 8
+        deprecate :ActivedTotal=, :none, 2023, 8
 
-        def initialize(total=nil, joinedtotal=nil, activedtotal=nil, exporturl=nil, list=nil, requestid=nil)
+        def initialize(total=nil, joinedtotal=nil, activedtotal=nil, exporturl=nil, list=nil, activatedtotal=nil, requestid=nil)
           @Total = total
           @JoinedTotal = joinedtotal
           @ActivedTotal = activedtotal
           @ExportUrl = exporturl
           @List = list
+          @ActivatedTotal = activatedtotal
           @RequestId = requestid
         end
 
@@ -4350,6 +4422,7 @@ module TencentCloud
               @List << grouporganization_tmp
             end
           end
+          @ActivatedTotal = params['ActivatedTotal']
           @RequestId = params['RequestId']
         end
       end
@@ -4617,10 +4690,10 @@ module TencentCloud
         # <br/>false：不允许在合同详情页展示控件
         # <br/>默认false，合同详情页不展示控件
         # @type ShowFlowDetailComponent: Boolean
-        # @param ShowTemplateComponent: 模版预览，允许展示模版控件信息
-        # <br/>true：允许在模版预览页展示控件
-        # <br/>false：不允许在模版预览页展示控件
-        # <br/>默认false，模版预览页不展示控件
+        # @param ShowTemplateComponent: 模板预览，允许展示模板控件信息
+        # <br/>true：允许在模板预览页展示控件
+        # <br/>false：不允许在模板预览页展示控件
+        # <br/>默认false，模板预览页不展示控件
         # @type ShowTemplateComponent: Boolean
 
         attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent
@@ -5139,8 +5212,11 @@ module TencentCloud
         # @param ApproverType: 参与者类型：
         # 0：企业
         # 1：个人
-        # 3：企业静默签署
-        # 注：类型为3（企业静默签署）时，会默认完成该签署方的签署。静默签署仅进行盖章操作，不能是手写签名。
+        # 3：企业自动签署
+        # 注：类型为3（企业自动签署）时，会自动完成该签署方的签署。
+        # 自动签署仅进行盖章操作，不能是手写签名。
+        # 本方企业自动签署的签署人会默认是当前的发起人
+        # 他方企业自动签署的签署人是自动签模板的他方企业授权人
         # @type ApproverType: Integer
         # @param OrganizationName: 签署人企业名称
         # <br/>当approverType=1 或 approverType=3时，必须指定
@@ -5159,7 +5235,7 @@ module TencentCloud
         # @param ApproverIdCardNumber: 签署方经办人证件号码
         # @type ApproverIdCardNumber: String
         # @param RecipientId: 签署方经办人在模板中的参与方ID
-        # <br/>模版发起合同时，该参数为必填项
+        # <br/>模板发起合同时，该参数为必填项
         # <br/>文件发起合同是，该参数无序传值
         # @type RecipientId: String
         # @param VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
@@ -5492,8 +5568,72 @@ module TencentCloud
 
       # 电子文档的控件填充信息。按照控件类型进行相应的填充。
 
+      # 当控件的 ComponentType='TEXT'时，FormField.ComponentValue填入文本内容
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "文本内容"
+      # }
+      # ```
+      # 当控件的 ComponentType='MULTI_LINE_TEXT'时，FormField.ComponentValue填入文本内容，支持自动换行。
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "多行文本内容"
+      # }
+      # ```
+      # 当控件的 ComponentType='CHECK_BOX'时，FormField.ComponentValue填入true或false文本
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "true"
+      # }
+      # ```
+      # 当控件的 ComponentType='FILL_IMAGE'时，FormField.ComponentValue填入图片的资源ID
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      # }
+      # ```
+      # 当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue填入附件图片的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
+      # }
+      # ```
+      # 当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容；
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "选择的内容"
+      # }
+      # ```
+      # 当控件的 ComponentType='DATE'时，FormField.ComponentValue填入日期内容；
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "2023年01月01日"
+      # }
+      # ```
+      # 当控件的 ComponentType='DISTRICT'时，FormField.ComponentValue填入省市区内容；
+      # ```
+      # FormFiled输入示例：
+      # {
+      #     "ComponentId": "componentId1",
+      #     "ComponentValue": "广东省深圳市福田区"
+      # }
+      # ```
       # 【数据表格传参说明】
-      # 当模板的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
+      # 当控件的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
       # 输入示例1：
 
       # ```
@@ -6355,7 +6495,7 @@ module TencentCloud
         # - SIGN_SEAL-默认为印章控件类型
         # - SIGN_SIGNATURE-手写签名控件类型
         # @type ApproverSignComponentType: String
-        # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推.  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
+        # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
         # @type ApproverSignRole: String
 
         attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.625
+  version: 3.0.627
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common