Add support for projected-cost endpoint (#1735)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-15 20:43:38.292819",
-            "spec_repo_commit": "d994bc85"
+            "regenerated": "2023-11-16 09:45:01.256068",
+            "spec_repo_commit": "974acd6e"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-15 20:43:38.348351",
-            "spec_repo_commit": "d994bc85"
+            "regenerated": "2023-11-16 09:45:01.272834",
+            "spec_repo_commit": "974acd6e"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -11747,6 +11747,62 @@ 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/ProjectedCostType'
+      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
+    ProjectedCostType:
+      default: projected_cost
+      description: Type of cost data.
+      enum:
+      - projected_cost
+      example: projected_cost
+      type: string
+      x-enum-varnames:
+      - PROJECt_COST
     QueryFormula:
       description: A formula for calculation based on one or more queries.
       properties:
@@ -29935,6 +29991,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.

docs/datadog_api_client.v2.model.rst

@@ -5125,6 +5125,34 @@ process\_summary\_type
    :members:
    :show-inheritance:
 
+projected\_cost
+---------------
+
+.. automodule:: datadog_api_client.v2.model.projected_cost
+   :members:
+   :show-inheritance:
+
+projected\_cost\_attributes
+---------------------------
+
+.. automodule:: datadog_api_client.v2.model.projected_cost_attributes
+   :members:
+   :show-inheritance:
+
+projected\_cost\_response
+-------------------------
+
+.. automodule:: datadog_api_client.v2.model.projected_cost_response
+   :members:
+   :show-inheritance:
+
+projected\_cost\_type
+---------------------
+
+.. automodule:: datadog_api_client.v2.model.projected_cost_type
+   :members:
+   :show-inheritance:
+
 query\_formula
 --------------
 

examples/v2/usage-metering/GetProjectedCost.py

@@ -0,0 +1,15 @@
+"""
+Get projected cost across your account returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = UsageMeteringApi(api_client)
+    response = api_instance.get_projected_cost(
+        view="sub-org",
+    )
+
+    print(response)

src/datadog_api_client/v2/api/usage_metering_api.py

@@ -20,6 +20,7 @@
 from datadog_api_client.v2.model.hourly_usage_response import HourlyUsageResponse
 from datadog_api_client.v2.model.usage_lambda_traced_invocations_response import UsageLambdaTracedInvocationsResponse
 from datadog_api_client.v2.model.usage_observability_pipelines_response import UsageObservabilityPipelinesResponse
+from datadog_api_client.v2.model.projected_cost_response import ProjectedCostResponse
 
 
 class UsageMeteringApi:
@@ -207,6 +208,28 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._get_projected_cost_endpoint = _Endpoint(
+            settings={
+                "response_type": (ProjectedCostResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/usage/projected_cost",
+                "operation_id": "get_projected_cost",
+                "http_method": "GET",
+                "version": "v2",
+            },
+            params_map={
+                "view": {
+                    "openapi_types": (str,),
+                    "attribute": "view",
+                    "location": "query",
+                },
+            },
+            headers_map={
+                "accept": ["application/json;datetime-format=rfc3339"],
+            },
+            api_client=api_client,
+        )
+
         self._get_usage_application_security_monitoring_endpoint = _Endpoint(
             settings={
                 "response_type": (UsageApplicationSecurityMonitoringResponse,),
@@ -465,6 +488,27 @@ def get_hourly_usage(
 
         return self._get_hourly_usage_endpoint.call_with_http_info(**kwargs)
 
+    def get_projected_cost(
+        self,
+        *,
+        view: Union[str, UnsetType] = unset,
+    ) -> ProjectedCostResponse:
+        """Get projected cost across your account.
+
+        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 view: 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 view: str, optional
+        :rtype: ProjectedCostResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        if view is not unset:
+            kwargs["view"] = view
+
+        return self._get_projected_cost_endpoint.call_with_http_info(**kwargs)
+
     def get_usage_application_security_monitoring(
         self,
         start_hr: datetime,

src/datadog_api_client/v2/model/projected_cost.py

@@ -0,0 +1,64 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.projected_cost_attributes import ProjectedCostAttributes
+    from datadog_api_client.v2.model.projected_cost_type import ProjectedCostType
+
+
+class ProjectedCost(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.projected_cost_attributes import ProjectedCostAttributes
+        from datadog_api_client.v2.model.projected_cost_type import ProjectedCostType
+
+        return {
+            "attributes": (ProjectedCostAttributes,),
+            "id": (str,),
+            "type": (ProjectedCostType,),
+        }
+
+    attribute_map = {
+        "attributes": "attributes",
+        "id": "id",
+        "type": "type",
+    }
+
+    def __init__(
+        self_,
+        attributes: Union[ProjectedCostAttributes, UnsetType] = unset,
+        id: Union[str, UnsetType] = unset,
+        type: Union[ProjectedCostType, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Projected Cost data.
+
+        :param attributes: Projected Cost attributes data.
+        :type attributes: ProjectedCostAttributes, optional
+
+        :param id: Unique ID of the response.
+        :type id: str, optional
+
+        :param type: Type of cost data.
+        :type type: ProjectedCostType, optional
+        """
+        if attributes is not unset:
+            kwargs["attributes"] = attributes
+        if id is not unset:
+            kwargs["id"] = id
+        if type is not unset:
+            kwargs["type"] = type
+        super().__init__(kwargs)