tencentcloud-sdk-nodejs-billing 4.0.301 → 4.0.304

package/src/services/billing/v20180709/billing_models.ts

@@ -80,6 +80,68 @@ export interface CostComponentSet {
   IncentivePayAmount: string
 }
 
+/**
+ * 代金券相关信息
+ */
+export interface VoucherInfos {
+  /**
+   * 代金券拥有者
+   */
+  OwnerUin: string
+
+  /**
+   * 券状态：待使用：unUsed，已使用： used，已发货：delivered，已作废： cancel，已过期：overdue
+   */
+  Status: string
+
+  /**
+   * 代金券面额（微分）
+   */
+  NominalValue: number
+
+  /**
+   * 剩余金额（微分）
+   */
+  Balance: number
+
+  /**
+   * 代金券id
+   */
+  VoucherId: string
+
+  /**
+   * postPay后付费/prePay预付费/riPay预留实例/空字符串或者'*'表示全部模式
+   */
+  PayMode: string
+
+  /**
+   * 付费场景PayMode=postPay时：spotpay-竞价实例,"settle account"-普通后付费PayMode=prePay时：purchase-包年包月新购，renew-包年包月续费（自动续费），modify-包年包月配置变更(变配）PayMode=riPay时：oneOffFee-预留实例预付，hourlyFee-预留实例每小时扣费，*-支持全部付费场景
+   */
+  PayScene: string
+
+  /**
+   * 有效期生效时间
+   */
+  BeginTime: string
+
+  /**
+   * 有效期截止时间
+   */
+  EndTime: string
+
+  /**
+      * 适用商品信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ApplicableProducts: ApplicableProducts
+
+  /**
+      * 不适用商品信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ExcludedProducts: Array<ExcludedProducts>
+}
+
 /**
  * DescribeCostSummaryByProduct请求参数结构体
  */
@@ -895,54 +957,29 @@ export interface BillTransactionInfo {
 }
 
 /**
- * 按地域汇总消费详情
+ * DescribeVoucherInfo返回参数结构体
  */
-export interface RegionSummaryOverviewItem {
-  /**
-      * 地域ID
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  RegionId: string
-
-  /**
-   * 地域名称
-   */
-  RegionName: string
-
-  /**
-   * 实际花费
-   */
-  RealTotalCost: string
-
-  /**
-   * 费用所占百分比，两位小数
-   */
-  RealTotalCostRatio: string
-
+export interface DescribeVoucherInfoResponse {
   /**
-   * 现金金额
+   * 券总数
    */
-  CashPayAmount: string
+  TotalCount: number
 
   /**
-   * 赠送金金额
+   * 总余额（微分）
    */
-  IncentivePayAmount: string
+  TotalBalance: number
 
   /**
-   * 代金券金额
-   */
-  VoucherPayAmount: string
-
-  /**
-   * 账单月份，格式2019-08
-   */
-  BillMonth: string
+      * 代金券相关信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  VoucherInfos: Array<VoucherInfos>
 
   /**
-   * 原价，单位为元。TotalCost字段自账单3.0（即2021-05）之后开始生效，账单3.0之前返回"-"。合同价的情况下，TotalCost字段与官网价格存在差异，也返回“-”。
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  TotalCost: string
+  RequestId?: string
 }
 
 /**
@@ -1152,6 +1189,57 @@ export interface ConsumptionProjectSummaryDataItem {
   Business: Array<ConsumptionBusinessSummaryDataItem>
 }
 
+/**
+ * 按地域汇总消费详情
+ */
+export interface RegionSummaryOverviewItem {
+  /**
+      * 地域ID
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  RegionId: string
+
+  /**
+   * 地域名称
+   */
+  RegionName: string
+
+  /**
+   * 实际花费
+   */
+  RealTotalCost: string
+
+  /**
+   * 费用所占百分比，两位小数
+   */
+  RealTotalCostRatio: string
+
+  /**
+   * 现金金额
+   */
+  CashPayAmount: string
+
+  /**
+   * 赠送金金额
+   */
+  IncentivePayAmount: string
+
+  /**
+   * 代金券金额
+   */
+  VoucherPayAmount: string
+
+  /**
+   * 账单月份，格式2019-08
+   */
+  BillMonth: string
+
+  /**
+   * 原价，单位为元。TotalCost字段自账单3.0（即2021-05）之后开始生效，账单3.0之前返回"-"。合同价的情况下，TotalCost字段与官网价格存在差异，也返回“-”。
+   */
+  TotalCost: string
+}
+
 /**
  * DescribeCostSummaryByProduct返回参数结构体
  */
@@ -1658,6 +1746,27 @@ export interface DescribeCostSummaryByProjectRequest {
   NeedRecordNum?: number
 }
 
+/**
+ * 使用记录
+ */
+export interface UsageRecords {
+  /**
+   * 使用金额（微分）
+   */
+  UsedAmount: number
+
+  /**
+   * 使用时间
+   */
+  UsedTime: string
+
+  /**
+      * 使用记录细节
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UsageDetails: Array<UsageDetails>
+}
+
 /**
  * 消耗按地域汇总详情
  */
@@ -1703,6 +1812,23 @@ export interface DescribeDosageCosDetailByDateResponse {
   RequestId?: string
 }
 
+/**
+ * 购买商品信息
+ */
+export interface UsageDetails {
+  /**
+      * 商品名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ProductName: string
+
+  /**
+      * 商品细节
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SubProductName: string
+}
+
 /**
  * DescribeBillResourceSummary返回参数结构体
  */
@@ -1774,6 +1900,101 @@ export interface ActionSummaryOverviewItem {
   TotalCost: string
 }
 
+/**
+ * DescribeVoucherInfo请求参数结构体
+ */
+export interface DescribeVoucherInfoRequest {
+  /**
+   * 一页多少条数据，默认是20条，最大不超过1000
+   */
+  Limit: number
+
+  /**
+   * 第多少页，默认是1
+   */
+  Offset: number
+
+  /**
+   * 券状态：待使用：unUsed，已使用： used，已发货：delivered，已作废： cancel，已过期：overdue
+   */
+  Status?: string
+
+  /**
+   * 代金券id
+   */
+  VoucherId?: string
+
+  /**
+   * 代金券订单id
+   */
+  CodeId?: string
+
+  /**
+   * 商品码
+   */
+  ProductCode?: string
+
+  /**
+   * 活动id
+   */
+  ActivityId?: string
+
+  /**
+   * 代金券名称
+   */
+  VoucherName?: string
+
+  /**
+   * 发放开始时间
+   */
+  TimeFrom?: string
+
+  /**
+   * 发放结束时间
+   */
+  TimeTo?: string
+
+  /**
+   * 指定排序字段：BeginTime开始时间、EndTime到期时间、CreateTime创建时间
+   */
+  SortField?: string
+
+  /**
+   * 指定升序降序：desc、asc
+   */
+  SortOrder?: string
+
+  /**
+   * 付费模式，postPay后付费/prePay预付费/riPay预留实例/""或者"*"表示全部模式，如果payMode为""或"*"，那么productCode与subProductCode必须传空
+   */
+  PayMode?: string
+
+  /**
+   * 付费场景PayMode=postPay时：spotpay-竞价实例,"settle account"-普通后付费PayMode=prePay时：purchase-包年包月新购，renew-包年包月续费（自动续费），modify-包年包月配置变更(变配）PayMode=riPay时：oneOffFee-预留实例预付，hourlyFee-预留实例每小时扣费，*-支持全部付费场景
+   */
+  PayScene?: string
+
+  /**
+   * 操作人，默认就是用户uin
+   */
+  Operator?: string
+}
+
+/**
+ * 适用商品信息
+ */
+export interface ApplicableProducts {
+  /**
+   * 适用商品名称，值为“全产品通用”或商品名称组成的string，以","分割。
+   */
+  GoodsName: string
+
+  /**
+   * postPay后付费/prePay预付费/riPay预留实例/空字符串或者"*"表示全部模式。如GoodsName为多个商品名以","分割组成的string，而PayMode为"*"，表示每一件商品的模式都为"*"。
+   */
+  PayMode: string
+}
+
 /**
  * 付费模式过滤条件
  */
@@ -1789,6 +2010,31 @@ export interface ConditionPayMode {
   PayModeName: string
 }
 
+/**
+ * DescribeVoucherUsageDetails请求参数结构体
+ */
+export interface DescribeVoucherUsageDetailsRequest {
+  /**
+   * 一页多少条数据，默认是20条，最大不超过1000
+   */
+  Limit: number
+
+  /**
+   * 第多少页，默认是1
+   */
+  Offset: number
+
+  /**
+   * 代金券id
+   */
+  VoucherId?: string
+
+  /**
+   * 操作人，默认就是用户uin
+   */
+  Operator?: string
+}
+
 /**
  * DescribeDealsByCond请求参数结构体
  */
@@ -2036,6 +2282,23 @@ export interface PayDealsResponse {
   RequestId?: string
 }
 
+/**
+ * 总数
+ */
+export interface SummaryTotal {
+  /**
+      * 总数
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  RealTotalCost: string
+
+  /**
+      * 原价，单位为元。TotalCost字段自账单3.0（即2021-05）之后开始生效，账单3.0之前返回"-"。合同价的情况下，TotalCost字段与官网价格存在差异，也返回“-”。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  TotalCost: string
+}
+
 /**
  * 账单明细数据对象
  */
@@ -2506,6 +2769,32 @@ export interface DescribeCostDetailRequest {
   ResourceId?: string
 }
 
+/**
+ * DescribeVoucherUsageDetails返回参数结构体
+ */
+export interface DescribeVoucherUsageDetailsResponse {
+  /**
+   * 券总数
+   */
+  TotalCount: number
+
+  /**
+   * 总已用金额（微分）
+   */
+  TotalUsedAmount: number
+
+  /**
+      * 代金券使用记录细节
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UsageRecords: Array<UsageRecords>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeDealsByCond返回参数结构体
  */
@@ -2725,20 +3014,18 @@ export interface DescribeDosageCosDetailByDateRequest {
 }
 
 /**
- * 总数
+ * 不适用商品信息
  */
-export interface SummaryTotal {
+export interface ExcludedProducts {
   /**
-      * 总数
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  RealTotalCost: string
+   * 不适用商品名称
+   */
+  GoodsName: string
 
   /**
-      * 原价，单位为元。TotalCost字段自账单3.0（即2021-05）之后开始生效，账单3.0之前返回"-"。合同价的情况下，TotalCost字段与官网价格存在差异，也返回“-”。
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  TotalCost: string
+   * postPay后付费/prePay预付费/riPay预留实例/空字符串或者"*"表示全部模式。
+   */
+  PayMode: string
 }
 
 /**

package/tencentcloud/services/billing/v20180709/billing_client.d.ts

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { DescribeCostSummaryByProductRequest, DescribeCostSummaryByProjectResponse, DescribeDosageDetailByDateRequest, DescribeBillSummaryByProductRequest, DescribeBillSummaryByPayModeResponse, DescribeBillSummaryByTagRequest, DescribeBillSummaryByProductResponse, DescribeBillSummaryByRegionResponse, DescribeAccountBalanceRequest, DescribeBillDetailRequest, DescribeCostSummaryByProductResponse, DescribeDosageDetailByDateResponse, DescribeBillListResponse, DescribeAccountBalanceResponse, DescribeCostSummaryByRegionRequest, DescribeBillSummaryByRegionRequest, DescribeBillSummaryByPayModeRequest, DescribeCostSummaryByProjectRequest, DescribeDosageCosDetailByDateResponse, DescribeBillResourceSummaryResponse, DescribeDealsByCondRequest, DescribeBillResourceSummaryRequest, PayDealsRequest, DescribeBillListRequest, PayDealsResponse, DescribeBillSummaryByTagResponse, DescribeCostSummaryByResourceResponse, DescribeBillDetailResponse, DescribeCostDetailRequest, DescribeDealsByCondResponse, DescribeBillSummaryByProjectRequest, DescribeBillSummaryByProjectResponse, DescribeCostSummaryByResourceRequest, DescribeCostDetailResponse, DescribeDosageCosDetailByDateRequest, DescribeCostSummaryByRegionResponse } from "./billing_models";
+import { DescribeCostSummaryByProductRequest, DescribeCostSummaryByProjectResponse, DescribeDosageDetailByDateRequest, DescribeBillSummaryByProductRequest, DescribeBillSummaryByPayModeResponse, DescribeBillSummaryByTagRequest, DescribeBillSummaryByProductResponse, DescribeBillSummaryByRegionResponse, DescribeVoucherInfoResponse, DescribeAccountBalanceRequest, DescribeBillDetailRequest, DescribeCostSummaryByProductResponse, DescribeDosageDetailByDateResponse, DescribeBillListResponse, DescribeAccountBalanceResponse, DescribeCostSummaryByRegionRequest, DescribeBillSummaryByRegionRequest, DescribeBillSummaryByPayModeRequest, DescribeCostSummaryByProjectRequest, DescribeDosageCosDetailByDateResponse, DescribeBillResourceSummaryResponse, DescribeVoucherInfoRequest, DescribeVoucherUsageDetailsRequest, DescribeDealsByCondRequest, DescribeBillResourceSummaryRequest, PayDealsRequest, DescribeBillListRequest, PayDealsResponse, DescribeBillSummaryByTagResponse, DescribeCostSummaryByResourceResponse, DescribeBillDetailResponse, DescribeCostDetailRequest, DescribeVoucherUsageDetailsResponse, DescribeDealsByCondResponse, DescribeBillSummaryByProjectRequest, DescribeBillSummaryByProjectResponse, DescribeCostSummaryByResourceRequest, DescribeCostDetailResponse, DescribeDosageCosDetailByDateRequest, DescribeCostSummaryByRegionResponse } from "./billing_models";
 /**
  * billing client
  * @class
@@ -10,6 +10,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 获取云账户余额信息。
      */
     DescribeAccountBalance(req?: DescribeAccountBalanceRequest, cb?: (error: string, rep: DescribeAccountBalanceResponse) => void): Promise<DescribeAccountBalanceResponse>;
+    /**
+     * 获取代金券相关信息
+     */
+    DescribeVoucherInfo(req: DescribeVoucherInfoRequest, cb?: (error: string, rep: DescribeVoucherInfoResponse) => void): Promise<DescribeVoucherInfoResponse>;
     /**
      * 按日期获取产品用量明细
      */
@@ -18,6 +22,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 获取按资源汇总消耗详情
      */
     DescribeCostSummaryByResource(req: DescribeCostSummaryByResourceRequest, cb?: (error: string, rep: DescribeCostSummaryByResourceResponse) => void): Promise<DescribeCostSummaryByResourceResponse>;
+    /**
+     * 获取代金券使用记录
+     */
+    DescribeVoucherUsageDetails(req: DescribeVoucherUsageDetailsRequest, cb?: (error: string, rep: DescribeVoucherUsageDetailsResponse) => void): Promise<DescribeVoucherUsageDetailsResponse>;
     /**
      * 获取收支明细列表，支持翻页和参数过滤
      */

package/tencentcloud/services/billing/v20180709/billing_client.js

@@ -33,6 +33,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeAccountBalance(req, cb) {
         return this.request("DescribeAccountBalance", req, cb);
     }
+    /**
+     * 获取代金券相关信息
+     */
+    async DescribeVoucherInfo(req, cb) {
+        return this.request("DescribeVoucherInfo", req, cb);
+    }
     /**
      * 按日期获取产品用量明细
      */
@@ -45,6 +51,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeCostSummaryByResource(req, cb) {
         return this.request("DescribeCostSummaryByResource", req, cb);
     }
+    /**
+     * 获取代金券使用记录
+     */
+    async DescribeVoucherUsageDetails(req, cb) {
+        return this.request("DescribeVoucherUsageDetails", req, cb);
+    }
     /**
      * 获取收支明细列表，支持翻页和参数过滤
      */