tencentcloud-sdk-ess 3.0.682 → 3.0.684

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b9f6303390069e02d65b677a1d6c8aec52e76f2
-  data.tar.gz: 505bc397ccca715c558a2a0fa27245ffe57402b7
+  metadata.gz: 6b0e06ccc9e48117541d40b45e0c53f25c630861
+  data.tar.gz: 213f376f9833001afae19bd09423611023b7be9d
 SHA512:
-  metadata.gz: 05a1214484ea4f7cc4aeea79a9d34a419790bb743e5c1ac67c5a32a819622271c0c922a859ec26e7f7ca3e7a2ed0dc142f80e48e28cd5ba45f47292d283a1c84
-  data.tar.gz: 74ffcde575b3e9ff00891c9ed8a39d4579483aff04465ed2c0a9d1aa0e0e7883514b2f109465fdec718ee33ff90e848b0d940001fda7d220ebf3b62807456ffd
+  metadata.gz: 7a95480617954616ad22b04ca1254d8345801cdd7a23f49e85707060b60117fe5c13a2e0e4b868c2af80944a1fb333f245cbac8c590c2bf91ddcc152b701d0d1
+  data.tar.gz: e07bf6dccc2cf46d70a3cecf30bf0fe3534c724ca866656612be9224940ea9bac00c58ed74fa1c4d17d2197de6c127b6cabd094302d946b9de473898622e0b4b

data/lib/VERSION

@@ -1 +1 @@
-3.0.682
+3.0.684

data/lib/v20201111/client.rb

@@ -191,13 +191,13 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口（CreateConvertTaskApi）用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
+        # 此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
         # 前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
         # 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
         # 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
         # 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
         # 注:
-        # 1. `支持的文件类型有doc、docx、xls、xlsx、jpg、jpeg、png、bmp、txt`
+        # 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
         # 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
 
         # @param request: Request instance for CreateConvertTaskApi.
@@ -283,6 +283,32 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 给企业员工。
+
+        # 注：支持集团代子企业操作，请联系运营开通此功能。
+
+        # @param request: Request instance for CreateExtendedServiceAuthInfos.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateExtendedServiceAuthInfosRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateExtendedServiceAuthInfosResponse`
+        def CreateExtendedServiceAuthInfos(request)
+          body = send_request('CreateExtendedServiceAuthInfos', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateExtendedServiceAuthInfosResponse.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/>
         # 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
 
@@ -1057,6 +1083,32 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 删除企业扩展服务授权，当前仅支持 “企业自动签” 取消授权。
+
+        # 注：支持集团代子企业操作，请联系运营开通此功能。
+
+        # @param request: Request instance for DeleteExtendedServiceAuthInfos.
+        # @type request: :class:`Tencentcloud::ess::V20201111::DeleteExtendedServiceAuthInfosRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::DeleteExtendedServiceAuthInfosResponse`
+        def DeleteExtendedServiceAuthInfos(request)
+          body = send_request('DeleteExtendedServiceAuthInfos', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DeleteExtendedServiceAuthInfosResponse.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
+
         # 此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。
 
         # @param request: Request instance for DeleteIntegrationDepartment.

data/lib/v20201111/models.rb

@@ -782,7 +782,14 @@ module TencentCloud
         end
       end
 
-      # 模板/流程中控件信息，可以是填充控件或签署控件
+      # 此结构体 (Component) 用于描述控件属性。
+
+      # 在通过文件发起合同时，对应的component有三种定位方式
+      # 1. 绝对定位方式
+      # 2. 表单域(FIELD)定位方式
+      # 3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
+      # 可以参考官网说明
+      # https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
       class Component < TencentCloud::Common::AbstractModel
         # @param ComponentType: 如果是Component填写控件类型，则可选的字段为：
         # TEXT - 普通文本控件，输入文本字符串；
@@ -947,9 +954,10 @@ module TencentCloud
         # 学历控件：
         #   同单行文本控件约束，填写选择值中的字符串
         # @type ComponentValue: String
-        # @param GenerateMode: NORMAL 正常模式，使用坐标制定签署控件位置
-        # FIELD 表单域，需使用ComponentName指定表单域名称
-        # KEYWORD 关键字，使用ComponentId指定关键字
+        # @param GenerateMode: 控件生成的方式：
+        # NORMAL - 普通控件
+        # FIELD - 表单域
+        # KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）
         # @type GenerateMode: String
         # @param ComponentDateFontSize: 日期签署控件的字号，默认为 12
         # @type ComponentDateFontSize: Integer
@@ -1378,12 +1386,13 @@ module TencentCloud
         # @param NeedPreview: 是否为预览模式，取值如下：
         # <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
         # <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
-        # 注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容`
+        # 注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
         # @type NeedPreview: Boolean
         # @param PreviewType: 预览模式下产生的预览链接类型
         # <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
-        # <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
-        # 注: `此参数在NeedPreview 为true时有效`
+        # <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>
+        # 注: `1.此参数在NeedPreview 为true时有效`
+        # `2.动态表格控件不支持H5链接方式预览`
         # @type PreviewType: Integer
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -1557,6 +1566,62 @@ module TencentCloud
         end
       end
 
+      # CreateExtendedServiceAuthInfos请求参数结构体
+      class CreateExtendedServiceAuthInfosRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param UserIds: 本企业员工的id，需要已实名，正常在职员工
+        # @type UserIds: Array
+        # @param ExtendServiceType: 要查询的扩展服务类型。
+        # 默认为空，即查询当前支持的所有扩展服务信息。
+        # 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+        # <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+        # </ul>
+        # @type ExtendServiceType: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :UserIds, :ExtendServiceType, :Agent
+
+        def initialize(operator=nil, userids=nil, extendservicetype=nil, agent=nil)
+          @Operator = operator
+          @UserIds = userids
+          @ExtendServiceType = extendservicetype
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @UserIds = params['UserIds']
+          @ExtendServiceType = params['ExtendServiceType']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # CreateExtendedServiceAuthInfos返回参数结构体
+      class CreateExtendedServiceAuthInfosResponse < 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
+
       # CreateFlowApprovers请求参数结构体
       class CreateFlowApproversRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -4181,6 +4246,62 @@ module TencentCloud
         end
       end
 
+      # DeleteExtendedServiceAuthInfos请求参数结构体
+      class DeleteExtendedServiceAuthInfosRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param UserIds: 本企业员工的id，需要已实名，正常在职员工
+        # @type UserIds: Array
+        # @param ExtendServiceType: 要查询的扩展服务类型。
+        # 默认为空，即查询当前支持的所有扩展服务信息。
+        # 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+        # <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+        # </ul>
+        # @type ExtendServiceType: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :UserIds, :ExtendServiceType, :Agent
+
+        def initialize(operator=nil, userids=nil, extendservicetype=nil, agent=nil)
+          @Operator = operator
+          @UserIds = userids
+          @ExtendServiceType = extendservicetype
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @UserIds = params['UserIds']
+          @ExtendServiceType = params['ExtendServiceType']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # DeleteExtendedServiceAuthInfos返回参数结构体
+      class DeleteExtendedServiceAuthInfosResponse < 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
+
       # DeleteIntegrationDepartment请求参数结构体
       class DeleteIntegrationDepartmentRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -4956,8 +5077,10 @@ module TencentCloud
         # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
         # @param GenerateSource: 暂未开放
         # @type GenerateSource: Integer
+        # @param WithPreviewUrl: 是否获取模板预览链接
+        # @type WithPreviewUrl: Boolean
 
-        attr_accessor :Operator, :Agent, :ContentType, :Filters, :Offset, :Limit, :ApplicationId, :IsChannel, :Organization, :GenerateSource
+        attr_accessor :Operator, :Agent, :ContentType, :Filters, :Offset, :Limit, :ApplicationId, :IsChannel, :Organization, :GenerateSource, :WithPreviewUrl
         extend Gem::Deprecate
         deprecate :IsChannel, :none, 2023, 10
         deprecate :IsChannel=, :none, 2023, 10
@@ -4966,7 +5089,7 @@ module TencentCloud
         deprecate :GenerateSource, :none, 2023, 10
         deprecate :GenerateSource=, :none, 2023, 10
 
-        def initialize(operator=nil, agent=nil, contenttype=nil, filters=nil, offset=nil, limit=nil, applicationid=nil, ischannel=nil, organization=nil, generatesource=nil)
+        def initialize(operator=nil, agent=nil, contenttype=nil, filters=nil, offset=nil, limit=nil, applicationid=nil, ischannel=nil, organization=nil, generatesource=nil, withpreviewurl=nil)
           @Operator = operator
           @Agent = agent
           @ContentType = contenttype
@@ -4977,6 +5100,7 @@ module TencentCloud
           @IsChannel = ischannel
           @Organization = organization
           @GenerateSource = generatesource
+          @WithPreviewUrl = withpreviewurl
         end
 
         def deserialize(params)
@@ -5006,6 +5130,7 @@ module TencentCloud
             @Organization.deserialize(params['Organization'])
           end
           @GenerateSource = params['GenerateSource']
+          @WithPreviewUrl = params['WithPreviewUrl']
         end
       end
 

metadata

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