tencentcloud-sdk-ess 3.0.381 → 3.0.384

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb48cf61b1eef4181ec568bf98bf1443869b3f7c
-  data.tar.gz: 1d3257a19620f056e2d55c53493c152ecb013208
+  metadata.gz: a4334c59112619aed2b085442c9a5b26ea118d19
+  data.tar.gz: 0b68715c351cccacc6039b102c79605e977293ba
 SHA512:
-  metadata.gz: fa2bbbf11a5a0e633f585094988aa7e54e94a8b8eec0760096a29cb7ea2d87329decc3768bbb29b0fa61dc28acc6f79567687cd1665b1f4a182b7d81e3dc5896
-  data.tar.gz: 0dff7cc4a4f8166ad6fa9a45ce63cd0e650b77aec37ee874d68a4282515a3a508a862746b29f3ea72f009b60e916fe30f8d323c4db0ce20dacf3303955ff203a
+  metadata.gz: de5ee88b9f85ff9a1da282c9d000813b9d28f3ff37ae2742ae27e0796a718a12ade8ba7067c855d98fec87e4836b213e1aa6ea18d079e0674f26545395030957
+  data.tar.gz: bfeaa2fe268ad6a0452cc1fc4ba4293dc82c115d04b88909330825a7bc4a84b84a98c560447bb00bd83f6cc231156ea79d65ce1d27b21ea23aea6346e52047c1

data/lib/VERSION

@@ -1 +1 @@
-3.0.381
+3.0.384

data/lib/v20201111/client.rb

@@ -295,6 +295,7 @@ module TencentCloud
 
         # 查询流程摘要
         # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
+        # 日调用量默认10W
 
         # @param request: Request instance for DescribeFlowBriefs.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowBriefsRequest`

data/lib/v20201111/models.rb

@@ -268,16 +268,22 @@ module TencentCloud
 
       # 模板控件信息
       class Component < TencentCloud::Common::AbstractModel
-        # @param ComponentType: 如果是 Component 控件类型，则可选类型为：
-        # TEXT - 单行文本
-        # MULTI_LINE_TEXT - 多行文本
-        # CHECK_BOX - 勾选框
-        # ATTACHMENT - 附件
-        # SELECTOR - 选择器
-        # 如果是 SignComponent 控件类型，则可选类型为：
-        # SIGN_SEAL - 签署印章控件，静默签署时需要传入印章id作为ComponentValue
-        # SIGN_DATE - 签署日期控件
-        # SIGN_SIGNATURE - 手写签名控件，静默签署时不能使用
+        # @param ComponentType: 如果是Component控件类型，则可选的字段为：
+        # TEXT - 普通文本控件；
+        # MULTI_LINE_TEXT - 多行文本控件；
+        # CHECK_BOX - 勾选框控件；
+        # FILL_IMAGE - 图片控件；
+        # DYNAMIC_TABLE - 动态表格控件；
+        # ATTACHMENT - 附件控件；
+        # SELECTOR - 选择器控件；
+
+        # 如果是SignComponent控件类型，则可选的字段为
+        # SIGN_SEAL - 签署印章控件；
+        # SIGN_DATE - 签署日期控件；
+        # SIGN_SIGNATURE - 用户签名控件；
+        # SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；
+
+        # 表单域的控件不能作为印章和签名控件
         # @type ComponentType: String
         # @param ComponentWidth: 参数控件宽度，单位pt
         # @type ComponentWidth: Float
@@ -313,8 +319,9 @@ module TencentCloud
         # TEXT - 文本内容
         # MULTI_LINE_TEXT - 文本内容
         # CHECK_BOX - true/false
-        # ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+        # FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
         # SELECTOR - 选项值
+        # DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
         # @type ComponentValue: String
         # @param IsFormType: 是否是表单域类型，默认不存在
         # @type IsFormType: Boolean
@@ -427,38 +434,34 @@ module TencentCloud
 
       # CreateConvertTaskApi请求参数结构体
       class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
-        # @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::Ess.v20201111.models.OrganizationInfo`
-        # @param Operator: 无
+        # @param ResourceId: 资源Id，通过UploadFiles获取
+        # @type ResourceId: String
+        # @param Operator: 操作者信息
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Agent: 无
+        # @param Agent: 应用号信息
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param Organization: 暂未开放
+        # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
 
-        attr_accessor :ResourceId, :ResourceType, :ResourceName, :Organization, :Operator, :Agent
+        attr_accessor :ResourceType, :ResourceName, :ResourceId, :Operator, :Agent, :Organization
         
-        def initialize(resourceid=nil, resourcetype=nil, resourcename=nil, organization=nil, operator=nil, agent=nil)
-          @ResourceId = resourceid
+        def initialize(resourcetype=nil, resourcename=nil, resourceid=nil, operator=nil, agent=nil, organization=nil)
           @ResourceType = resourcetype
           @ResourceName = resourcename
-          @Organization = organization
+          @ResourceId = resourceid
           @Operator = operator
           @Agent = agent
+          @Organization = organization
         end
 
         def deserialize(params)
-          @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'])
@@ -467,6 +470,10 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
+          unless params['Organization'].nil?
+            @Organization = OrganizationInfo.new
+            @Organization.deserialize(params['Organization'])
+          end
         end
       end
 
@@ -1065,7 +1072,7 @@ module TencentCloud
       class DescribeFlowBriefsRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 调用方用户信息，userId 必填
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowIds: 需要查询的流程ID列表
+        # @param FlowIds: 需要查询的流程ID列表，限制最大20个
         # @type FlowIds: Array
         # @param Agent: 应用相关信息
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
@@ -1124,7 +1131,7 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param Filters: 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
         # @type Filters: Array
-        # @param Limit: 查询个数，默认20，最大100
+        # @param Limit: 查询个数，默认20，最大200
         # @type Limit: Integer
         # @param Offset: 查询偏移位置，默认0
         # @type Offset: Integer
@@ -1434,12 +1441,13 @@ module TencentCloud
 
       # 电子文档的控件填充信息
       class FormField < TencentCloud::Common::AbstractModel
-        # @param ComponentValue: 控件填充value，ComponentType和传入值类型对应关系：
+        # @param ComponentValue: 控件填充vaule，ComponentType和传入值类型对应关系：
         # TEXT - 文本内容
         # MULTI_LINE_TEXT - 文本内容
         # CHECK_BOX - true/false
-        # ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
-        # SELECTOR - 模板中配置的选项值
+        # FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+        # SELECTOR - 选项值
+        # DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
         # @type ComponentValue: String
         # @param ComponentId: 控件id，和ComponentName选择一项传入即可
         # @type ComponentId: String
@@ -1463,30 +1471,26 @@ module TencentCloud
 
       # GetTaskResultApi请求参数结构体
       class GetTaskResultApiRequest < TencentCloud::Common::AbstractModel
-        # @param TaskId: 任务Id
+        # @param TaskId: 任务Id，通过CreateConvertTaskApi得到
         # @type TaskId: String
-        # @param Organization: 企业信息
-        # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
         # @param Operator: 操作人信息
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Agent: 渠道信息
+        # @param Agent: 应用号信息
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+        # @param Organization: 暂未开放
+        # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
 
-        attr_accessor :TaskId, :Organization, :Operator, :Agent
+        attr_accessor :TaskId, :Operator, :Agent, :Organization
         
-        def initialize(taskid=nil, organization=nil, operator=nil, agent=nil)
+        def initialize(taskid=nil, operator=nil, agent=nil, organization=nil)
           @TaskId = taskid
-          @Organization = organization
           @Operator = operator
           @Agent = agent
+          @Organization = organization
         end
 
         def deserialize(params)
           @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'])
@@ -1495,6 +1499,10 @@ module TencentCloud
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
+          unless params['Organization'].nil?
+            @Organization = OrganizationInfo.new
+            @Organization.deserialize(params['Organization'])
+          end
         end
       end
 
@@ -1502,11 +1510,23 @@ module TencentCloud
       class GetTaskResultApiResponse < 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
@@ -1850,8 +1870,8 @@ module TencentCloud
       # UploadFiles请求参数结构体
       class UploadFilesRequest < TencentCloud::Common::AbstractModel
         # @param BusinessType: 文件对应业务类型，用于区分文件存储路径：
-        # 1. TEMPLATE - 模板； 文件类型：.pdf/.html
-        # 2. DOCUMENT - 签署过程及签署后的合同文档 文件类型：.pdf/.html
+        # 1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
+        # 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
         # 3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
         # @type BusinessType: String
         # @param Caller: 调用方信息

metadata

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