tencentcloud-sdk-ess 3.0.693 → 3.0.695

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6465abe233f3a7a2aeb9bd63812b342ee8796246
-  data.tar.gz: 744a01a624814b3c22eca57cf01e9ba64ee0177c
+  metadata.gz: 1779d3f9f5b8bd80a71e30d34290351323196d66
+  data.tar.gz: b70d2e8acab83745d6b26613a66510e15576a134
 SHA512:
-  metadata.gz: e0e4c1e1ebdb628929c09aa1ac7c18430fbd0d68ac6dd085f77731d6933f98a251b41e3d747d138e79f0dd8b0a39715a21ce4416c10078b933c116bd229b74e0
-  data.tar.gz: fe6e3e82f9c70cb3413cb2efb1443384de2c473e94123a2d748723a140cfde17c2ac540b6394c1b5a68518f12b5e241678c35dfd6df4f6127ebea899bb9c750a
+  metadata.gz: 128f9bdb6a2b64893302789210b9d7377538a42f336acb0f1ba9c1bc0288a198e30e74c4ccb61ec8d4190315085a7eee1f4fa8b3c7d37d0281deb7cc9d3fbed9
+  data.tar.gz: d097a419e1a748d6e7c1ae662f7b16c00d28fab7a60a4d288bb1309bf593be111a41601c9c234e9a7dbbfbf9eebbbb5f05aa97794093cb218c503e5532e16e6a

data/lib/VERSION

@@ -1 +1 @@
-3.0.693
+3.0.695

data/lib/v20201111/client.rb

@@ -314,9 +314,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 给企业员工。
+        # 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
+        # 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。
 
-        # 注：支持集团代子企业操作，请联系运营开通此功能。
+        # 注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。
 
         # @param request: Request instance for CreateExtendedServiceAuthInfos.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateExtendedServiceAuthInfosRequest`
@@ -1119,7 +1120,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 删除企业扩展服务授权，当前仅支持 “企业自动签” 取消授权。
+        # 删除企业扩展服务授权，当前仅支持 “企业自动签” 和“批量签署”  的取消授权。
+        # 该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口取消企业员工授权。
 
         # 注：支持集团代子企业操作，请联系运营开通此功能。
 
@@ -1245,6 +1247,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 查询企业使用情况
+
+        # @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. 企业与港澳台居民签署合同
@@ -1417,6 +1443,8 @@ module TencentCloud
         # >- 签署控件 SignComponents
         # >- 生成模板的文件基础信息 FileInfos
 
+        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
+
         # 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。
 
         # 适用场景：

data/lib/v20201111/models.rb

@@ -460,6 +460,76 @@ 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: 套餐类型
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type QuotaType: String
+        # @param UseCount: 合同使用量
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type UseCount: Integer
+        # @param CostTime: 消耗的时间戳
+        # 注意：此字段可能返回 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。
@@ -1664,10 +1734,9 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param UserIds: 本企业员工的id，需要已实名，正常在职员工
         # @type UserIds: Array
-        # @param ExtendServiceType: 要查询的扩展服务类型。
-        # 默认为空，即查询当前支持的所有扩展服务信息。
-        # 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+        # @param ExtendServiceType: 取值
         # <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+        # <li>BATCH_SIGN：批量签署</li>
         # </ul>
         # @type ExtendServiceType: String
         # @param Agent: 代理企业和员工的信息。
@@ -3942,7 +4011,7 @@ module TencentCloud
         # @param SealType: 电子印章类型 , 可选类型如下:
         # <ul><li>**OFFICIAL**: (默认)公章</li>
         # <li>**CONTRACT**: 合同专用章;</li>
-        # <li>**FINANCE**: 合财务专用章;</li>
+        # <li>**FINANCE**: 财务专用章;</li>
         # <li>**PERSONNEL**: 人事专用章</li>
         # </ul>
         # 注: `同企业下只能有一个公章, 重复创建会报错`
@@ -4347,10 +4416,9 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param UserIds: 本企业员工的id，需要已实名，正常在职员工
         # @type UserIds: Array
-        # @param ExtendServiceType: 要查询的扩展服务类型。
-        # 默认为空，即查询当前支持的所有扩展服务信息。
-        # 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+        # @param ExtendServiceType: 取值如下所示：
         # <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+        # <li>BATCH_SIGN：批量签署</li>
         # </ul>
         # @type ExtendServiceType: String
         # @param Agent: 代理企业和员工的信息。
@@ -4692,6 +4760,92 @@ module TencentCloud
         end
       end
 
+      # DescribeBillUsageDetail请求参数结构体
+      class DescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
+        # @param StartTime: 查询开始时间，时间跨度不能大于31天
+        # @type StartTime: String
+        # @param EndTime: 查询结束时间，时间跨度不能大于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: 非必填，查询某个渠道企业的消耗情况。
+        # 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+        # @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: 执行本接口操作的员工信息。
@@ -5348,6 +5502,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。
@@ -6452,26 +6607,28 @@ module TencentCloud
         end
       end
 
-      # 签署链接信息
+      # 签署链接信息。
       class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
-        # @param SignUrl: 签署链接(短链形式呈现)。请注意保密，不要将其外泄给无关用户。
-        # 注: `注意该链接有效期为30分钟`
+        # @param SignUrl: 签署短链接。</br>
+        # 注意:
+        # - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+        # - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SignUrl: String
-        # @param ApproverType: 签署参与人类型
-        # <ul><li> **1** :个人参与方</li></ul>
-
-        # 注: `现在仅支持个人参与方`
+        # @param ApproverType: 签署人类型。
+        # - **1**: 个人
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverType: Integer
-        # @param ApproverName: 签署人姓名
+        # @param ApproverName: 签署人姓名。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverName: String
-        # @param ApproverMobile: 签署人手机号
+        # @param ApproverMobile: 签署人手机号。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ApproverMobile: String
-        # @param LongUrl: 签署链接(长链形式呈现)。请注意保密，不要将其外泄给无关用户。
-        # 注: `注意该链接有效期为30分钟`
+        # @param LongUrl: 签署长链接。</br>
+        # 注意:
+        # - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+        # - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LongUrl: String
 
@@ -7784,27 +7941,37 @@ module TencentCloud
       class PdfVerifyResult < TencentCloud::Common::AbstractModel
         # @param VerifyResult: 验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。
         # @type VerifyResult: Integer
-        # @param SignPlatform: 签署平台，如果文件是在腾讯电子签平台签署，则返回腾讯电子签，如果文件不在腾讯电子签平台签署，则返回其他平台。
+        # @param SignPlatform: 签署平台
+        # 如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
+        # 如果文件不在腾讯电子签平台签署，则为**其他平台**。
         # @type SignPlatform: String
-        # @param SignerName: 签署人名称
+        # @param SignerName: 申请证书的主体的名字
+
+        # 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
+        # **企业**:  ESS@企业名称@编码
+        # **个人**: ESS@个人姓名@证件号@808854
+
+        # 如果在其他平台签署的, 主体的名字参考其他平台的说明
         # @type SignerName: String
-        # @param SignTime: 签署时间戳，单位秒
+        # @param SignTime: 签署时间的Unix时间戳，单位毫秒
         # @type SignTime: Integer
-        # @param SignAlgorithm: 签名算法
+        # @param SignAlgorithm: 证书签名算法,  如SHA1withRSA等算法
         # @type SignAlgorithm: String
-        # @param CertSn: 签名证书序列号
+        # @param CertSn: CA供应商下发给用户的证书编号
+
+        # 注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下`。
         # @type CertSn: String
-        # @param CertNotBefore: 证书起始时间戳，单位毫秒
+        # @param CertNotBefore: 证书起始时间的Unix时间戳，单位毫秒
         # @type CertNotBefore: Integer
-        # @param CertNotAfter: 证书过期时间戳，单位毫秒
+        # @param CertNotAfter: 证书过期时间的时间戳，单位毫秒
         # @type CertNotAfter: Integer
-        # @param ComponentPosX: 签名域横坐标，单位pt
+        # @param ComponentPosX: 签名域横坐标，单位px
         # @type ComponentPosX: Float
-        # @param ComponentPosY: 签名域纵坐标，单位pt
+        # @param ComponentPosY: 签名域纵坐标，单位px
         # @type ComponentPosY: Float
-        # @param ComponentWidth: 签名域宽度，单位pt
+        # @param ComponentWidth: 签名域宽度，单位px
         # @type ComponentWidth: Float
-        # @param ComponentHeight: 签名域高度，单位pt
+        # @param ComponentHeight: 签名域高度，单位px
         # @type ComponentHeight: Float
         # @param ComponentPage: 签名域所在页码，1～N
         # @type ComponentPage: Integer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.693
+  version: 3.0.695
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common