tencentcloud-sdk-ess 3.0.694 → 3.0.696

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd6378c93cb00aca67ac735ef919ceec42b0df48
-  data.tar.gz: 5b23808e041cda500682d3eb2f592f5e177267be
+  metadata.gz: 9de9e8688a43803a3e97d353615affdcb5c95c98
+  data.tar.gz: 384d28830d26804ca8f594374313f6f3c4b50d91
 SHA512:
-  metadata.gz: 0f9c4957f10b3bdcb73c043a6be1b02de4dd1e87c55d7526ae2dd71df3e0a0533adcfd026b6a792907faa9e56afe146c96e05043d481217d21ab7c737f06c0a2
-  data.tar.gz: 81ddaad8d62604474462d817ae0de12fbcd07ee6a728d81ce3293a73b91dcf7ae7a6b1f7af169a8a96fc8f09f7a9aabeb874e7c777bb745e92cbff92033e0fdd
+  metadata.gz: 063fb5ebc7b2d682957c0b42e532442f1ef2f9ebba8bfab7348707a011a608ae83d112fdec2dc121c6e456df00c3044f1c2826d49182aa0a216780dfcbfe3a5b
+  data.tar.gz: a0bdcdbde4c00eb233e9ed63d0158a3595b879ece6d61d7c9a55f5a3496fc321ee8474b01c6d99a9c89a3f6f9bfc979d284b4c5ca3b5ac263358b3763a299a38

data/lib/VERSION

@@ -1 +1 @@
-3.0.694
+3.0.696

data/lib/v20201111/client.rb

@@ -1247,6 +1247,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。
+
+        # @param request: Request instance for DescribeBillUsageDetail.
+        # @type request: :class:`Tencentcloud::ess::V20201111::DescribeBillUsageDetailRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeBillUsageDetailResponse`
+        def DescribeBillUsageDetail(request)
+          body = send_request('DescribeBillUsageDetail', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeBillUsageDetailResponse.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
+
         # 查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
         # 1. 企业自动签
         # 2. 企业与港澳台居民签署合同
@@ -1412,21 +1436,24 @@ module TencentCloud
         end
 
         # 此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。
-        # >  一个模板通常会包含以下结构信息
-        # >- 模板基本信息
-        # >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
-        # >- 填写控件 Components
-        # >- 签署控件 SignComponents
-        # >- 生成模板的文件基础信息 FileInfos
 
-        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
-
-        # 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。
 
-        # 适用场景：
+        # **适用场景**
         # 该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口，作为创建电子文档的前置接口使用。
         # 通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。
 
+        # **一个模板通常会包含以下结构信息**
+
+        # - 模板模版ID, 模板名字等基本信息
+        # - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+        # - 发起方和签署方的填写控件 Components
+        # - 签署方的签署控件 SignComponents
+
+        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
+
+        # 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
+
         # @param request: Request instance for DescribeFlowTemplates.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesResponse`
@@ -1499,8 +1526,6 @@ module TencentCloud
 
         # 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
 
-        # 注：`法人角色是系统保留角色，因此返回列表中不含法人角色。`
-
         # @param request: Request instance for DescribeIntegrationRoles.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesResponse`

data/lib/v20201111/models.rb

@@ -460,6 +460,105 @@ module TencentCloud
         end
       end
 
+      # 用户计费使用情况详情
+      class BillUsageDetail < TencentCloud::Common::AbstractModel
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowId: String
+        # @param OperatorName: 合同经办人名称
+        # 如果有多个经办人用分号隔开。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type OperatorName: String
+        # @param CreateOrganizationName: 发起方组织机构名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CreateOrganizationName: String
+        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+        # 该名称还将用于合同签署完成后的下载文件名。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type FlowName: String
+        # @param Status: 当前合同状态,如下是状态码对应的状态。
+        # 0-还没有发起
+        # 1-等待签署
+        # 2-部分签署
+        # 3-拒签
+        # 4-已签署
+        # 5-已过期
+        # 6-已撤销
+        # 7-还没有预发起
+        # 8-等待填写
+        # 9-部分填写
+        # 10-拒填
+        # 11-已解除
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Status: Integer
+        # @param QuotaType: 套餐类型
+        # 对应关系如下
+        # CloudEnterprise-企业版合同
+        # SingleSignature-单方签章
+        # CloudProve-签署报告
+        # CloudOnlineSign-腾讯会议在线签约
+        # ChannelWeCard-微工卡
+        # SignFlow-合同套餐
+        # SignFace-签署意愿（人脸识别）
+        # SignPassword-签署意愿（密码）
+        # SignSMS-签署意愿（短信）
+        # PersonalEssAuth-签署人实名（腾讯电子签认证）
+        # PersonalThirdAuth-签署人实名（信任第三方认证）
+        # OrgEssAuth-签署企业实名
+        # FlowNotify-短信通知
+        # AuthService-企业工商信息查询
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type QuotaType: String
+        # @param UseCount: 合同使用量
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type UseCount: Integer
+        # @param CostTime: 消耗的时间戳，格式为Unix标准时间戳（秒）。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CostTime: Integer
+        # @param QuotaName: 消耗的套餐名称
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type QuotaName: String
+        # @param CostType: 消耗类型
+        # 1.扣费 2.撤销返还
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CostType: Integer
+        # @param Remark: 备注
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Remark: String
+
+        attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
+
+        def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, status=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil)
+          @FlowId = flowid
+          @OperatorName = operatorname
+          @CreateOrganizationName = createorganizationname
+          @FlowName = flowname
+          @Status = status
+          @QuotaType = quotatype
+          @UseCount = usecount
+          @CostTime = costtime
+          @QuotaName = quotaname
+          @CostType = costtype
+          @Remark = remark
+        end
+
+        def deserialize(params)
+          @FlowId = params['FlowId']
+          @OperatorName = params['OperatorName']
+          @CreateOrganizationName = params['CreateOrganizationName']
+          @FlowName = params['FlowName']
+          @Status = params['Status']
+          @QuotaType = params['QuotaType']
+          @UseCount = params['UseCount']
+          @CostTime = params['CostTime']
+          @QuotaName = params['QuotaName']
+          @CostType = params['CostType']
+          @Remark = params['Remark']
+        end
+      end
+
       # BindEmployeeUserIdWithClientOpenId请求参数结构体
       class BindEmployeeUserIdWithClientOpenIdRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写UserId。
@@ -3500,18 +3599,22 @@ module TencentCloud
       class CreatePrepareFlowResponse < TencentCloud::Common::AbstractModel
         # @param Url: 发起流程的web页面链接，有效期5分钟
         # @type Url: String
+        # @param FlowId: 创建的合同id（还未实际发起），每次调用会生成新的id，用户可以记录此字段对应后续页面发起的合同，若在页面上未成功发起，则此字段无效。
+        # @type FlowId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :Url, :RequestId
+        attr_accessor :Url, :FlowId, :RequestId
 
-        def initialize(url=nil, requestid=nil)
+        def initialize(url=nil, flowid=nil, requestid=nil)
           @Url = url
+          @FlowId = flowid
           @RequestId = requestid
         end
 
         def deserialize(params)
           @Url = params['Url']
+          @FlowId = params['FlowId']
           @RequestId = params['RequestId']
         end
       end
@@ -3941,7 +4044,7 @@ module TencentCloud
         # @param SealType: 电子印章类型 , 可选类型如下:
         # <ul><li>**OFFICIAL**: (默认)公章</li>
         # <li>**CONTRACT**: 合同专用章;</li>
-        # <li>**FINANCE**: 合财务专用章;</li>
+        # <li>**FINANCE**: 财务专用章;</li>
         # <li>**PERSONNEL**: 人事专用章</li>
         # </ul>
         # 注: `同企业下只能有一个公章, 重复创建会报错`
@@ -4690,6 +4793,92 @@ module TencentCloud
         end
       end
 
+      # DescribeBillUsageDetail请求参数结构体
+      class DescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
+        # @param StartTime: 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
+        # @type StartTime: String
+        # @param EndTime: 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
+        # @type EndTime: String
+        # @param Offset: 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
+        # @type Offset: Integer
+        # @param Limit: 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
+        # @type Limit: Integer
+        # @param QuotaType: 查询的套餐类型 （选填 ）不传则查询所有套餐；
+        # 对应关系如下
+        # CloudEnterprise-企业版合同
+        # SingleSignature-单方签章
+        # CloudProve-签署报告
+        # CloudOnlineSign-腾讯会议在线签约
+        # ChannelWeCard-微工卡
+        # SignFlow-合同套餐
+        # SignFace-签署意愿（人脸识别）
+        # SignPassword-签署意愿（密码）
+        # SignSMS-签署意愿（短信）
+        # PersonalEssAuth-签署人实名（腾讯电子签认证）
+        # PersonalThirdAuth-签署人实名（信任第三方认证）
+        # OrgEssAuth-签署企业实名
+        # FlowNotify-短信通知
+        # AuthService-企业工商信息查询
+        # @type QuotaType: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :StartTime, :EndTime, :Offset, :Limit, :QuotaType, :Agent
+
+        def initialize(starttime=nil, endtime=nil, offset=nil, limit=nil, quotatype=nil, agent=nil)
+          @StartTime = starttime
+          @EndTime = endtime
+          @Offset = offset
+          @Limit = limit
+          @QuotaType = quotatype
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          @StartTime = params['StartTime']
+          @EndTime = params['EndTime']
+          @Offset = params['Offset']
+          @Limit = params['Limit']
+          @QuotaType = params['QuotaType']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        end
+      end
+
+      # DescribeBillUsageDetail返回参数结构体
+      class DescribeBillUsageDetailResponse < TencentCloud::Common::AbstractModel
+        # @param Total: 总数
+        # @type Total: Integer
+        # @param Details: 消耗详情
+        # @type Details: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :Total, :Details, :RequestId
+
+        def initialize(total=nil, details=nil, requestid=nil)
+          @Total = total
+          @Details = details
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Total = params['Total']
+          unless params['Details'].nil?
+            @Details = []
+            params['Details'].each do |i|
+              billusagedetail_tmp = BillUsageDetail.new
+              billusagedetail_tmp.deserialize(i)
+              @Details << billusagedetail_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeExtendedServiceAuthInfos请求参数结构体
       class DescribeExtendedServiceAuthInfosRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 执行本接口操作的员工信息。
@@ -5346,6 +5535,7 @@ module TencentCloud
         #   <li>Key:**"UserId"**，根据用户ID查询员工，Values为指定的用户ID：**["UserId"]**</li>
         #   <li>Key:**"UserWeWorkOpenId"**，根据用户企微账号ID查询员工，Values为指定用户的企微账号ID：**["UserWeWorkOpenId"]**</li>
         #   <li>Key:**"StaffOpenId"**，根据第三方系统用户OpenId查询员工，Values为第三方系统用户OpenId列表：**["OpenId1","OpenId2",...]**</li>
+        #   <li>Key:**"RoleId"**，根据电子签角色ID查询员工，Values为指定的角色ID，满足其中任意一个角色即可：**["RoleId1","RoleId2",...]**</li>
         # </ul>
         # @type Filters: Array
         # @param Offset: 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大20000。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.694
+  version: 3.0.696
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
@@ -33,8 +33,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/v20201111/models.rb
 - lib/v20201111/client.rb
+- lib/v20201111/models.rb
 - lib/tencentcloud-sdk-ess.rb
 - lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby