Regenerate client from commit f39beecd of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-14 15:18:14.889333",
-            "spec_repo_commit": "b95546fe"
+            "regenerated": "2023-11-15 13:47:24.562787",
+            "spec_repo_commit": "f39beecd"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-14 15:18:14.904239",
-            "spec_repo_commit": "b95546fe"
+            "regenerated": "2023-11-15 13:47:24.578752",
+            "spec_repo_commit": "f39beecd"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -11747,6 +11747,53 @@ components:
       type: string
       x-enum-varnames:
       - PROCESS
+    ProjectedCost:
+      description: Projected Cost data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/ProjectedCostAttributes'
+        id:
+          description: Unique ID of the response.
+          type: string
+        type:
+          $ref: '#/components/schemas/CostByOrgType'
+      type: object
+    ProjectedCostAttributes:
+      description: Projected Cost attributes data.
+      properties:
+        charges:
+          description: List of charges data reported for the requested month.
+          items:
+            $ref: '#/components/schemas/ChargebackBreakdown'
+          type: array
+        date:
+          description: The month requested.
+          format: date-time
+          type: string
+        org_name:
+          description: The organization name.
+          type: string
+        projected_total_cost:
+          description: The total projected cost of products for the month.
+          format: double
+          type: number
+        public_id:
+          description: The organization public ID.
+          type: string
+        region:
+          description: The region of the Datadog instance that the organization belongs
+            to.
+          type: string
+      type: object
+    ProjectedCostResponse:
+      description: Projected Cost response.
+      properties:
+        data:
+          description: Response containing Projected Cost.
+          items:
+            $ref: '#/components/schemas/ProjectedCost'
+          type: array
+      type: object
     QueryFormula:
       description: A formula for calculation based on one or more queries.
       properties:
@@ -29935,6 +29982,57 @@ paths:
       summary: Get hourly usage for observability pipelines
       tags:
       - Usage Metering
+  /api/v2/usage/projected_cost:
+    get:
+      description: 'Get projected cost across multi-org and single root-org accounts.
+
+        Projected cost data is only available for the current month and becomes available
+        around the 12th of the month.
+
+        This endpoint requires the usage_read authorization scope.'
+      operationId: GetProjectedCost
+      parameters:
+      - description: 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`.
+        in: query
+        name: view
+        required: false
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/ProjectedCostResponse'
+          description: OK
+        '400':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Bad Request
+        '403':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden - User is not authorized
+        '429':
+          content:
+            application/json;datetime-format=rfc3339:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Too many requests
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - usage_read
+      summary: Get projected cost across your account
+      tags:
+      - Usage Metering
   /api/v2/user_invitations:
     post:
       description: Sends emails to one or more users inviting them to join the organization.

examples/v2/usage-metering/GetProjectedCost.ts

@@ -0,0 +1,21 @@
+/**
+ * Get projected cost across your account returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.UsageMeteringApi(configuration);
+
+const params: v2.UsageMeteringApiGetProjectedCostRequest = {
+  view: "sub-org",
+};
+
+apiInstance
+  .getProjectedCost(params)
+  .then((data: v2.ProjectedCostResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

@@ -5180,6 +5180,13 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             },
         "operationResponseType": "UsageObservabilityPipelinesResponse",
     },
+    "v2.GetProjectedCost": {
+        "view": {
+            "type": "string",
+            "format": "",
+            },
+        "operationResponseType": "ProjectedCostResponse",
+    },
     "v2.SendInvitations": {
         "body": {
             "type": "UserInvitationsRequest",

features/v2/undo.json

@@ -1884,6 +1884,12 @@
       "type": "safe"
     }
   },
+  "GetProjectedCost": {
+    "tag": "Usage Metering",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "SendInvitations": {
     "tag": "Users",
     "undo": {

features/v2/usage_metering.feature

@@ -149,6 +149,19 @@ Feature: Usage Metering
     And the response "data[0].type" is equal to "usage_timeseries"
     And the response "data[0].attributes.product_family" is equal to "observability-pipelines"
 
+  @generated @skip @team:DataDog/red-zone-revenue-query
+  Scenario: Get projected cost across your account returns "Bad Request" response
+    Given new "GetProjectedCost" request
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @skip @team:DataDog/red-zone-revenue-query
+  Scenario: Get projected cost across your account returns "OK" response
+    Given new "GetProjectedCost" request
+    And request contains "view" parameter with value "sub-org"
+    When the request is sent
+    Then the response status is 200 OK
+
   @team:DataDog/red-zone-revenue-query
   Scenario: GetEstimatedCostByOrg with both start_month and start_date returns "Bad Request" response
     Given new "GetEstimatedCostByOrg" request

packages/datadog-api-client-v2/apis/UsageMeteringApi.ts

@@ -19,6 +19,7 @@ import { ApiException } from "../../datadog-api-client-common/exception";
 import { APIErrorResponse } from "../models/APIErrorResponse";
 import { CostByOrgResponse } from "../models/CostByOrgResponse";
 import { HourlyUsageResponse } from "../models/HourlyUsageResponse";
+import { ProjectedCostResponse } from "../models/ProjectedCostResponse";
 import { UsageApplicationSecurityMonitoringResponse } from "../models/UsageApplicationSecurityMonitoringResponse";
 import { UsageLambdaTracedInvocationsResponse } from "../models/UsageLambdaTracedInvocationsResponse";
 import { UsageObservabilityPipelinesResponse } from "../models/UsageObservabilityPipelinesResponse";
@@ -290,6 +291,43 @@ export class UsageMeteringApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
+  public async getProjectedCost(
+    view?: string,
+    _options?: Configuration
+  ): Promise<RequestContext> {
+    const _config = _options || this.configuration;
+
+    // Path Params
+    const localVarPath = "/api/v2/usage/projected_cost";
+
+    // Make Request Context
+    const requestContext = _config
+      .getServer("v2.UsageMeteringApi.getProjectedCost")
+      .makeRequestContext(localVarPath, HttpMethod.GET);
+    requestContext.setHeaderParam(
+      "Accept",
+      "application/json;datetime-format=rfc3339"
+    );
+    requestContext.setHttpConfig(_config.httpConfig);
+
+    // Query Params
+    if (view !== undefined) {
+      requestContext.setQueryParam(
+        "view",
+        ObjectSerializer.serialize(view, "string", "")
+      );
+    }
+
+    // Apply auth methods
+    applySecurityAuthentication(_config, requestContext, [
+      "AuthZ",
+      "apiKeyAuth",
+      "appKeyAuth",
+    ]);
+
+    return requestContext;
+  }
+
   public async getUsageApplicationSecurityMonitoring(
     startHr: Date,
     endHr?: Date,
@@ -690,6 +728,68 @@ export class UsageMeteringApiResponseProcessor {
     );
   }
 
+  /**
+   * 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 getProjectedCost
+   * @throws ApiException if the response code was not in [200, 299]
+   */
+  public async getProjectedCost(
+    response: ResponseContext
+  ): Promise<ProjectedCostResponse> {
+    const contentType = ObjectSerializer.normalizeMediaType(
+      response.headers["content-type"]
+    );
+    if (response.httpStatusCode == 200) {
+      const body: ProjectedCostResponse = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "ProjectedCostResponse"
+      ) as ProjectedCostResponse;
+      return body;
+    }
+    if (
+      response.httpStatusCode == 400 ||
+      response.httpStatusCode == 403 ||
+      response.httpStatusCode == 429
+    ) {
+      const bodyText = ObjectSerializer.parse(
+        await response.body.text(),
+        contentType
+      );
+      let body: APIErrorResponse;
+      try {
+        body = ObjectSerializer.deserialize(
+          bodyText,
+          "APIErrorResponse"
+        ) as APIErrorResponse;
+      } catch (error) {
+        logger.info(`Got error deserializing error: ${error}`);
+        throw new ApiException<APIErrorResponse>(
+          response.httpStatusCode,
+          bodyText
+        );
+      }
+      throw new ApiException<APIErrorResponse>(response.httpStatusCode, body);
+    }
+
+    // Work around for missing responses in specification, e.g. for petstore.yaml
+    if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+      const body: ProjectedCostResponse = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "ProjectedCostResponse",
+        ""
+      ) as ProjectedCostResponse;
+      return body;
+    }
+
+    const body = (await response.body.text()) || "";
+    throw new ApiException<string>(
+      response.httpStatusCode,
+      'Unknown API Status Code!\nBody: "' + body + '"'
+    );
+  }
+
   /**
    * Unwraps the actual response sent by the server from the response context and deserializes the response content
    * to the expected objects
@@ -994,6 +1094,14 @@ export interface UsageMeteringApiGetHourlyUsageRequest {
   pageNextRecordId?: string;
 }
 
+export interface UsageMeteringApiGetProjectedCostRequest {
+  /**
+   * 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;
+}
+
 export interface UsageMeteringApiGetUsageApplicationSecurityMonitoringRequest {
   /**
    * Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
@@ -1159,6 +1267,29 @@ export class UsageMeteringApi {
     });
   }
 
+  /**
+   * Get projected cost across multi-org and single root-org accounts.
+   * Projected cost data is only available for the current month and becomes available around the 12th of the month.
+   * This endpoint requires the usage_read authorization scope.
+   * @param param The request object
+   */
+  public getProjectedCost(
+    param: UsageMeteringApiGetProjectedCostRequest = {},
+    options?: Configuration
+  ): Promise<ProjectedCostResponse> {
+    const requestContextPromise = this.requestFactory.getProjectedCost(
+      param.view,
+      options
+    );
+    return requestContextPromise.then((requestContext) => {
+      return this.configuration.httpApi
+        .send(requestContext)
+        .then((responseContext) => {
+          return this.responseProcessor.getProjectedCost(responseContext);
+        });
+    });
+  }
+
   /**
    * Get hourly usage for application security .
    * **Note:** hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)

packages/datadog-api-client-v2/index.ts

@@ -405,6 +405,7 @@ export {
   UsageMeteringApiGetEstimatedCostByOrgRequest,
   UsageMeteringApiGetHistoricalCostByOrgRequest,
   UsageMeteringApiGetHourlyUsageRequest,
+  UsageMeteringApiGetProjectedCostRequest,
   UsageMeteringApiGetUsageApplicationSecurityMonitoringRequest,
   UsageMeteringApiGetUsageLambdaTracedInvocationsRequest,
   UsageMeteringApiGetUsageObservabilityPipelinesRequest,
@@ -1144,6 +1145,9 @@ export { ProcessSummariesResponse } from "./models/ProcessSummariesResponse";
 export { ProcessSummary } from "./models/ProcessSummary";
 export { ProcessSummaryAttributes } from "./models/ProcessSummaryAttributes";
 export { ProcessSummaryType } from "./models/ProcessSummaryType";
+export { ProjectedCost } from "./models/ProjectedCost";
+export { ProjectedCostAttributes } from "./models/ProjectedCostAttributes";
+export { ProjectedCostResponse } from "./models/ProjectedCostResponse";
 export { QueryFormula } from "./models/QueryFormula";
 export { QuerySortOrder } from "./models/QuerySortOrder";
 export { RelationshipToIncidentAttachment } from "./models/RelationshipToIncidentAttachment";