tencentcloud-sdk-essbasic 3.0.595 → 3.0.597

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2c986d0bee0dd2407a63a7a33c9bf3fd8d9a18e
-  data.tar.gz: 3bf06957624d8cd044b9da9fe3378ddb021aff05
+  metadata.gz: 95fa2f8d0c13f9eb05fa518fcbd7102cdaee1ea5
+  data.tar.gz: 37fb5fd26f7356eacb96b41d323598780ce1033f
 SHA512:
-  metadata.gz: ab37f0709ad7050546c91add741f5a017fd2035b5d54ed22b1a87984c4b144d0ac4213e22df961c743cc8fc4cbed475f0d574fbef4a70f3102a01cccf0750b23
-  data.tar.gz: 30fec91751d288d218a2a9038d7f47e68ea967e984da960534560246017f2dfbba3898e7a34ba42d7e03d815a3bb4d0104573332d00ade7a0b688f5c1bc04f1d
+  metadata.gz: 01e5594ac8ee27441ae293334a5f937d7df09e12c30f89e2156e5947c24d81cc74a6ffe4d62cb81d4c9609a23b7f231b2cb47050adc585c9cbe8f09760a02fbd
+  data.tar.gz: 3f97aa4f6707601f522d09617b30391d26f34f98c904638a070f37a0b7f6e1be206b9f325b0cd53abcfd44a65ce9d88db84721820c74900131ebdacd9a8233a1

data/lib/VERSION

@@ -1 +1 @@
-3.0.595
+3.0.597

data/lib/v20210526/client.rb

@@ -550,6 +550,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息
+
+        # @param request: Request instance for ChannelDescribeFlowComponents.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeFlowComponentsRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeFlowComponentsResponse`
+        def ChannelDescribeFlowComponents(request)
+          body = send_request('ChannelDescribeFlowComponents', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelDescribeFlowComponentsResponse.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
+
         # 查询子客企业电子印章，需要操作者具有管理印章权限
         # 客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
 

data/lib/v20210526/models.rb

@@ -1708,6 +1708,57 @@ module TencentCloud
         end
       end
 
+      # ChannelDescribeFlowComponents请求参数结构体
+      class ChannelDescribeFlowComponentsRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 应用相关信息
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param FlowId: 电子签流程的Id
+        # @type FlowId: String
+
+        attr_accessor :Agent, :FlowId
+
+        def initialize(agent=nil, flowid=nil)
+          @Agent = agent
+          @FlowId = flowid
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @FlowId = params['FlowId']
+        end
+      end
+
+      # ChannelDescribeFlowComponents返回参数结构体
+      class ChannelDescribeFlowComponentsResponse < TencentCloud::Common::AbstractModel
+        # @param RecipientComponentInfos: 流程关联的填写控件信息
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type RecipientComponentInfos: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RecipientComponentInfos, :RequestId
+
+        def initialize(recipientcomponentinfos=nil, requestid=nil)
+          @RecipientComponentInfos = recipientcomponentinfos
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['RecipientComponentInfos'].nil?
+            @RecipientComponentInfos = []
+            params['RecipientComponentInfos'].each do |i|
+              recipientcomponentinfo_tmp = RecipientComponentInfo.new
+              recipientcomponentinfo_tmp.deserialize(i)
+              @RecipientComponentInfos << recipientcomponentinfo_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelDescribeOrganizationSeals请求参数结构体
       class ChannelDescribeOrganizationSealsRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
@@ -2274,7 +2325,38 @@ module TencentCloud
         # @type ComponentPosX: Float
         # @param ComponentPosY: 参数控件Y位置，单位px
         # @type ComponentPosY: Float
-        # @param ComponentExtra: 参数控件样式，json格式表述
+        # @param ComponentExtra: 扩展参数：
+        # 为JSON格式。
+
+        # ComponentType为FILL_IMAGE时，支持以下参数：
+        # NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中
+        # FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放
+
+        # ComponentType为SIGN_SIGNATURE类型可以控制签署方式
+        # {“ComponentTypeLimit”: [“xxx”]}
+        # xxx可以为：
+        # HANDWRITE – 手写签名
+        # OCR_ESIGN -- AI智能识别手写签名
+        # ESIGN -- 个人印章类型
+        # SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
+        # 如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
+
+        # ComponentType为SIGN_DATE时，支持以下参数：
+        # 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"
+        # 2 FontSize： 数字类型，范围6-72，默认值为12
+        # 3 FontAlign： 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
+        # 4 Format： 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
+        # 5 Gaps:： 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数
+        # 如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
+        # 特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
+        # 参数样例：    "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}"
+
+        # ComponentType为SIGN_SEAL类型时，支持以下参数：
+        # 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）
+        # 参数样例： "ComponentExtra":"{\"PageRanges\":[\"PageRange\":{\"BeginPage\":1,\"EndPage\":-1}]}"
+
+
+        # 参数控件样式，json格式表述
 
         # 不同类型的控件会有部分非通用参数
 
@@ -2306,7 +2388,11 @@ module TencentCloud
         # 5 Gaps:： 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙钟的空格个数
         # 如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期
         # 特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）
-        # 参数样例：    "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}",
+        # 参数样例：    "ComponentExtra": "{\"Format\":“yyyy m d”,\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}"
+
+        # ComponentType为SIGN_SEAL类型时，支持以下参数：
+        # 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）
+        # 参数样例： "ComponentExtra":"{\"PageRanges\":[\"PageRange\":{\"BeginPage\":1,\"EndPage\":-1}]}"
         # @type ComponentExtra: String
         # @param ComponentValue: 控件填充vaule，ComponentType和传入值类型对应关系：
         # TEXT - 文本内容
@@ -3466,6 +3552,43 @@ module TencentCloud
         end
       end
 
+      # 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
+      class FilledComponent < TencentCloud::Common::AbstractModel
+        # @param ComponentId: 控件Id
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ComponentId: String
+        # @param ComponentName: 控件名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ComponentName: String
+        # @param ComponentFillStatus: 控件填写状态；0-未填写；1-已填写
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ComponentFillStatus: String
+        # @param ComponentValue: 控件填写内容
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ComponentValue: String
+        # @param ImageUrl: 图片填充控件下载链接，如果是图片填充控件时，这里返回图片的下载链接。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ImageUrl: String
+
+        attr_accessor :ComponentId, :ComponentName, :ComponentFillStatus, :ComponentValue, :ImageUrl
+
+        def initialize(componentid=nil, componentname=nil, componentfillstatus=nil, componentvalue=nil, imageurl=nil)
+          @ComponentId = componentid
+          @ComponentName = componentname
+          @ComponentFillStatus = componentfillstatus
+          @ComponentValue = componentvalue
+          @ImageUrl = imageurl
+        end
+
+        def deserialize(params)
+          @ComponentId = params['ComponentId']
+          @ComponentName = params['ComponentName']
+          @ComponentFillStatus = params['ComponentFillStatus']
+          @ComponentValue = params['ComponentValue']
+          @ImageUrl = params['ImageUrl']
+        end
+      end
+
       # 此结构体 (Filter) 用于描述查询过滤条件。
       class Filter < TencentCloud::Common::AbstractModel
         # @param Key: 查询过滤条件的Key
@@ -4677,6 +4800,45 @@ module TencentCloud
         end
       end
 
+      # 参与方填写控件信息
+      class RecipientComponentInfo < TencentCloud::Common::AbstractModel
+        # @param RecipientId: 参与方Id
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type RecipientId: String
+        # @param RecipientFillStatus: 参与方填写状态
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type RecipientFillStatus: String
+        # @param IsPromoter: 是否发起方
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type IsPromoter: Boolean
+        # @param Components: 填写控件内容
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Components: Array
+
+        attr_accessor :RecipientId, :RecipientFillStatus, :IsPromoter, :Components
+
+        def initialize(recipientid=nil, recipientfillstatus=nil, ispromoter=nil, components=nil)
+          @RecipientId = recipientid
+          @RecipientFillStatus = recipientfillstatus
+          @IsPromoter = ispromoter
+          @Components = components
+        end
+
+        def deserialize(params)
+          @RecipientId = params['RecipientId']
+          @RecipientFillStatus = params['RecipientFillStatus']
+          @IsPromoter = params['IsPromoter']
+          unless params['Components'].nil?
+            @Components = []
+            params['Components'].each do |i|
+              filledcomponent_tmp = FilledComponent.new
+              filledcomponent_tmp.deserialize(i)
+              @Components << filledcomponent_tmp
+            end
+          end
+        end
+      end
+
       # 解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。
       # 注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该签署人。
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.595
+  version: 3.0.597
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common