@datadog/datadog-api-client 1.3.0 → 1.5.0

package/dist/packages/datadog-api-client-v2/apis/UsageMeteringApi.d.ts

@@ -8,7 +8,8 @@ import { UsageLambdaTracedInvocationsResponse } from "../models/UsageLambdaTrace
 import { UsageObservabilityPipelinesResponse } from "../models/UsageObservabilityPipelinesResponse";
 export declare class UsageMeteringApiRequestFactory extends BaseAPIRequestFactory {
     getCostByOrg(startMonth: Date, endMonth?: Date, _options?: Configuration): Promise<RequestContext>;
-    getEstimatedCostByOrg(view: string, startMonth?: Date, endMonth?: Date, startDate?: Date, endDate?: Date, _options?: Configuration): Promise<RequestContext>;
+    getEstimatedCostByOrg(view?: string, startMonth?: Date, endMonth?: Date, startDate?: Date, endDate?: Date, _options?: Configuration): Promise<RequestContext>;
+    getHistoricalCostByOrg(startMonth: Date, view?: string, endMonth?: Date, _options?: Configuration): Promise<RequestContext>;
     getHourlyUsage(filterTimestampStart: Date, filterProductFamilies: string, filterTimestampEnd?: Date, filterIncludeDescendants?: boolean, filterVersions?: string, pageLimit?: number, pageNextRecordId?: string, _options?: Configuration): Promise<RequestContext>;
     getUsageApplicationSecurityMonitoring(startHr: Date, endHr?: Date, _options?: Configuration): Promise<RequestContext>;
     getUsageLambdaTracedInvocations(startHr: Date, endHr?: Date, _options?: Configuration): Promise<RequestContext>;
@@ -31,6 +32,14 @@ export declare class UsageMeteringApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getEstimatedCostByOrg(response: ResponseContext): Promise<CostByOrgResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getHistoricalCostByOrg
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getHistoricalCostByOrg(response: ResponseContext): Promise<CostByOrgResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -78,10 +87,10 @@ export interface UsageMeteringApiGetCostByOrgRequest {
 }
 export interface UsageMeteringApiGetEstimatedCostByOrgRequest {
     /**
-     * String to specify whether cost is broken down at a parent-org level or at the sub-org level. Currently, only the 'sub-org' view is supported.
+     * String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`. Defaults to `summary`.
      * @type string
      */
-    view: string;
+    view?: string;
     /**
      * Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month. Either start_month or start_date should be specified, but not both. (start_month cannot go beyond two months in the past)
      * @type Date
@@ -103,6 +112,23 @@ export interface UsageMeteringApiGetEstimatedCostByOrgRequest {
      */
     endDate?: Date;
 }
+export interface UsageMeteringApiGetHistoricalCostByOrgRequest {
+    /**
+     * Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month.
+     * @type Date
+     */
+    startMonth: Date;
+    /**
+     * String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are `summary` and `sub-org`.  Defaults to `summary`.
+     * @type string
+     */
+    view?: string;
+    /**
+     * Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month.
+     * @type Date
+     */
+    endMonth?: Date;
+}
 export interface UsageMeteringApiGetHourlyUsageRequest {
     /**
      * Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.
@@ -192,16 +218,27 @@ export declare class UsageMeteringApi {
     private configuration;
     constructor(configuration: Configuration, requestFactory?: UsageMeteringApiRequestFactory, responseProcessor?: UsageMeteringApiResponseProcessor);
     /**
-     * Get cost across multi-org account. Cost by org data for a given month becomes available no later than the 16th of the following month.
+     * Get cost across multi-org account.
+     * Cost by org data for a given month becomes available no later than the 16th of the following month.
+     * **Note:** This endpoint has been deprecated. Please use the new endpoint
+     * [`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account)
+     * instead.
      * @param param The request object
      */
     getCostByOrg(param: UsageMeteringApiGetCostByOrgRequest, options?: Configuration): Promise<CostByOrgResponse>;
     /**
      * Get estimated cost across multi-org and single root-org accounts.
-     * Estimated cost data is only available for the current month and previous month. To access historical costs prior to this, use the /cost_by_org endpoint.
+     * Estimated cost data is only available for the current month and previous month.
+     * To access historical costs prior to this, use the `/historical_cost` endpoint.
+     * @param param The request object
+     */
+    getEstimatedCostByOrg(param?: UsageMeteringApiGetEstimatedCostByOrgRequest, options?: Configuration): Promise<CostByOrgResponse>;
+    /**
+     * Get historical cost across multi-org and single root-org accounts.
+     * Cost data for a given month becomes available no later than the 16th of the following month.
      * @param param The request object
      */
-    getEstimatedCostByOrg(param: UsageMeteringApiGetEstimatedCostByOrgRequest, options?: Configuration): Promise<CostByOrgResponse>;
+    getHistoricalCostByOrg(param: UsageMeteringApiGetHistoricalCostByOrgRequest, options?: Configuration): Promise<CostByOrgResponse>;
     /**
      * Get hourly usage by product family
      * @param param The request object