Update GetBudget API spec with cost query parameters and custom forecast fields (#1722)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.generator/schemas/v2/openapi.yaml

@@ -13185,6 +13185,20 @@ components:
     BudgetAttributes:
       description: The attributes of a budget.
       properties:
+        costs:
+          $ref: "#/components/schemas/BudgetAttributesCosts"
+          description: Aggregated cost data for the budget. Present only when `actual=true` or `forecast=true` is requested.
+        costs_period_end:
+          description: The end of the period used to compute cost data, in milliseconds since epoch.
+          format: int64
+          type: integer
+        costs_period_start:
+          description: The start of the period used to compute cost data, in milliseconds since epoch.
+          format: int64
+          type: integer
+        costs_unit:
+          $ref: "#/components/schemas/BudgetAttributesCostsUnit"
+          description: The unit used for all cost values in the response.
         created_at:
           description: The timestamp when the budget was created.
           example: 1738258683590
@@ -13237,6 +13251,53 @@ components:
           example: 00000000-0a0a-0a0a-aaa0-00000000000a
           type: string
       type: object
+    BudgetAttributesCosts:
+      description: Aggregated cost data for the budget over the requested period.
+      properties:
+        actual:
+          description: The total actual cost. Present only when `actual=true` is requested.
+          format: double
+          nullable: true
+          type: number
+        amount:
+          description: The total budgeted amount over the requested period.
+          format: double
+          nullable: true
+          type: number
+        forecast:
+          description: The total forecast cost, with any custom forecast overrides applied. Present only when `forecast=true` is requested.
+          format: double
+          nullable: true
+          type: number
+        ootb_forecast:
+          description: The out-of-the-box ML forecast before custom overrides. Present only when `forecast=true` is requested.
+          format: double
+          nullable: true
+          type: number
+      type: object
+    BudgetAttributesCostsUnit:
+      description: The unit used for all cost values in the response.
+      properties:
+        family:
+          description: The unit family (for example, `currency`).
+          type: string
+        id:
+          description: The unique identifier for the unit.
+          type: string
+        name:
+          description: The full name of the unit.
+          type: string
+        plural:
+          description: The plural form of the unit name.
+          type: string
+        scale_factor:
+          description: The scale factor applied to raw cost values.
+          format: double
+          type: number
+        short_name:
+          description: The abbreviated unit name.
+          type: string
+      type: object
     BudgetValidationRequest:
       description: The request object for validating a budget configuration before creating or updating it.
       example:
@@ -13402,6 +13463,9 @@ components:
           description: The budgeted amount for this entry.
           format: double
           type: number
+        costs:
+          $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsCosts"
+          description: Cost data for this entry. Present only when `actual=true` or `forecast=true` is requested.
         month:
           description: The month this budget entry applies to, in YYYYMM format.
           format: int64
@@ -13412,6 +13476,36 @@ components:
             $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems"
           type: array
       type: object
+    BudgetWithEntriesDataAttributesEntriesItemsCosts:
+      description: Cost data for a single budget entry.
+      properties:
+        actual:
+          description: The actual cost for this entry. Present only when `actual=true` is requested.
+          format: double
+          nullable: true
+          type: number
+        amount:
+          description: The budgeted amount for this entry.
+          format: double
+          nullable: true
+          type: number
+        custom_forecast:
+          description: |-
+            The custom forecast override for this entry. `null` when `forecast=true` is requested but no custom forecast has been set for this entry's month. A numeric value, including `0`, indicates an explicit custom forecast override. Omitted when `forecast=false` or the feature is not available for the organization.
+          format: double
+          nullable: true
+          type: number
+        forecast:
+          description: The final forecast for this entry, with any custom forecast override applied. Present only when `forecast=true` is requested.
+          format: double
+          nullable: true
+          type: number
+        ootb_forecast:
+          description: The out-of-the-box ML forecast for this entry, before custom overrides. Present only when `forecast=true` is requested.
+          format: double
+          nullable: true
+          type: number
+      type: object
     BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems:
       description: A tag filter used to scope a budget entry to specific resource tags.
       properties:
@@ -124497,10 +124591,36 @@ paths:
       tags:
         - Cloud Cost Management
     get:
-      description: Get a budget
+      description: Get a budget by ID. Pass `actual=true` or `forecast=true` to include cost data in the response. Use `start` and `end` (millisecond epochs, both required) to set the cost window. When `forecast=true`, each entry also includes `ootb_forecast` (the ML forecast before overrides) and `custom_forecast` (`null` if no override is set, a number if one is).
       operationId: GetBudget
       parameters:
         - $ref: "#/components/parameters/BudgetID"
+        - description: When `true`, includes actual cost data in the response.
+          in: query
+          name: actual
+          required: false
+          schema:
+            type: boolean
+        - description: When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
+          in: query
+          name: forecast
+          required: false
+          schema:
+            type: boolean
+        - description: Start of the cost window in milliseconds since epoch. Must be used together with `end`.
+          in: query
+          name: start
+          required: false
+          schema:
+            format: int64
+            type: integer
+        - description: End of the cost window in milliseconds since epoch. Must be used together with `start`.
+          in: query
+          name: end
+          required: false
+          schema:
+            format: int64
+            type: integer
       responses:
         "200":
           content:
@@ -124510,11 +124630,31 @@ paths:
                   value:
                     data:
                       attributes:
+                        costs:
+                          actual: 850.25
+                          amount: 1000.0
+                          forecast: 1100.5
+                          ootb_forecast: 1100.5
+                        costs_period_end: 1740873600000
+                        costs_period_start: 1738281600000
+                        costs_unit:
+                          family: currency
+                          id: "1"
+                          name: dollar
+                          plural: dollars
+                          scale_factor: 1.0
+                          short_name: $
                         created_at: 1738258683590
                         created_by: 00000000-0a0a-0a0a-aaa0-00000000000a
                         end_month: 202502
                         entries:
                           - amount: 500
+                            costs:
+                              actual: 425.5
+                              amount: 500.0
+                              custom_forecast:
+                              forecast: 550.25
+                              ootb_forecast: 550.25
                             month: 202501
                             tag_filters:
                               - tag_key: service
@@ -124531,6 +124671,10 @@ paths:
               schema:
                 $ref: "#/components/schemas/BudgetWithEntries"
           description: OK
+        "400":
+          $ref: "#/components/responses/BadRequestResponse"
+        "404":
+          $ref: "#/components/responses/NotFoundResponse"
         "429":
           $ref: "#/components/responses/TooManyRequestsResponse"
       security:

examples/v2_cloud-cost-management_GetBudget.rs

@@ -1,12 +1,15 @@
 // Get budget returns "OK" response
 use datadog_api_client::datadog;
 use datadog_api_client::datadogV2::api_cloud_cost_management::CloudCostManagementAPI;
+use datadog_api_client::datadogV2::api_cloud_cost_management::GetBudgetOptionalParams;
 
 #[tokio::main]
 async fn main() {
     let configuration = datadog::Configuration::new();
     let api = CloudCostManagementAPI::with_config(configuration);
-    let resp = api.get_budget("budget_id".to_string()).await;
+    let resp = api
+        .get_budget("budget_id".to_string(), GetBudgetOptionalParams::default())
+        .await;
     if let Ok(value) = resp {
         println!("{:#?}", value);
     } else {

examples/v2_cloud-cost-management_UpsertBudget.rs

@@ -2,9 +2,12 @@
 use datadog_api_client::datadog;
 use datadog_api_client::datadogV2::api_cloud_cost_management::CloudCostManagementAPI;
 use datadog_api_client::datadogV2::model::BudgetAttributes;
+use datadog_api_client::datadogV2::model::BudgetAttributesCosts;
+use datadog_api_client::datadogV2::model::BudgetAttributesCostsUnit;
 use datadog_api_client::datadogV2::model::BudgetWithEntries;
 use datadog_api_client::datadogV2::model::BudgetWithEntriesData;
 use datadog_api_client::datadogV2::model::BudgetWithEntriesDataAttributesEntriesItems;
+use datadog_api_client::datadogV2::model::BudgetWithEntriesDataAttributesEntriesItemsCosts;
 use datadog_api_client::datadogV2::model::BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems;
 
 #[tokio::main]
@@ -13,10 +16,26 @@ async fn main() {
         BudgetWithEntriesData::new()
             .attributes(
                 BudgetAttributes::new()
+                    .costs(
+                        BudgetAttributesCosts::new()
+                            .actual(None)
+                            .amount(None)
+                            .forecast(None)
+                            .ootb_forecast(None),
+                    )
+                    .costs_unit(BudgetAttributesCostsUnit::new())
                     .created_at(1738258683590)
                     .created_by("00000000-0a0a-0a0a-aaa0-00000000000a".to_string())
                     .end_month(202502)
                     .entries(vec![BudgetWithEntriesDataAttributesEntriesItems::new()
+                        .costs(
+                            BudgetWithEntriesDataAttributesEntriesItemsCosts::new()
+                                .actual(None)
+                                .amount(None)
+                                .custom_forecast(None)
+                                .forecast(None)
+                                .ootb_forecast(None),
+                        )
                         .tag_filters(vec![
                             BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems::new(),
                         ])])

src/datadogV2/api/api_cloud_cost_management.rs

@@ -27,6 +27,43 @@ impl DeleteCostTagDescriptionByKeyOptionalParams {
     }
 }
 
+/// GetBudgetOptionalParams is a struct for passing parameters to the method [`CloudCostManagementAPI::get_budget`]
+#[non_exhaustive]
+#[derive(Clone, Default, Debug)]
+pub struct GetBudgetOptionalParams {
+    /// When `true`, includes actual cost data in the response.
+    pub actual: Option<bool>,
+    /// When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
+    pub forecast: Option<bool>,
+    /// Start of the cost window in milliseconds since epoch. Must be used together with `end`.
+    pub start: Option<i64>,
+    /// End of the cost window in milliseconds since epoch. Must be used together with `start`.
+    pub end: Option<i64>,
+}
+
+impl GetBudgetOptionalParams {
+    /// When `true`, includes actual cost data in the response.
+    pub fn actual(mut self, value: bool) -> Self {
+        self.actual = Some(value);
+        self
+    }
+    /// When `true`, includes forecast cost data in the response, including `ootb_forecast` and `custom_forecast` per entry.
+    pub fn forecast(mut self, value: bool) -> Self {
+        self.forecast = Some(value);
+        self
+    }
+    /// Start of the cost window in milliseconds since epoch. Must be used together with `end`.
+    pub fn start(mut self, value: i64) -> Self {
+        self.start = Some(value);
+        self
+    }
+    /// End of the cost window in milliseconds since epoch. Must be used together with `start`.
+    pub fn end(mut self, value: i64) -> Self {
+        self.end = Some(value);
+        self
+    }
+}
+
 /// GetCommitmentsCommitmentListOptionalParams is a struct for passing parameters to the method [`CloudCostManagementAPI::get_commitments_commitment_list`]
 #[non_exhaustive]
 #[derive(Clone, Default, Debug)]
@@ -2946,12 +2983,13 @@ impl CloudCostManagementAPI {
         }
     }
 
-    /// Get a budget
+    /// Get a budget by ID. Pass `actual=true` or `forecast=true` to include cost data in the response. Use `start` and `end` (millisecond epochs, both required) to set the cost window. When `forecast=true`, each entry also includes `ootb_forecast` (the ML forecast before overrides) and `custom_forecast` (`null` if no override is set, a number if one is).
     pub async fn get_budget(
         &self,
         budget_id: String,
+        params: GetBudgetOptionalParams,
     ) -> Result<crate::datadogV2::model::BudgetWithEntries, datadog::Error<GetBudgetError>> {
-        match self.get_budget_with_http_info(budget_id).await {
+        match self.get_budget_with_http_info(budget_id, params).await {
             Ok(response_content) => {
                 if let Some(e) = response_content.entity {
                     Ok(e)
@@ -2965,17 +3003,24 @@ impl CloudCostManagementAPI {
         }
     }
 
-    /// Get a budget
+    /// Get a budget by ID. Pass `actual=true` or `forecast=true` to include cost data in the response. Use `start` and `end` (millisecond epochs, both required) to set the cost window. When `forecast=true`, each entry also includes `ootb_forecast` (the ML forecast before overrides) and `custom_forecast` (`null` if no override is set, a number if one is).
     pub async fn get_budget_with_http_info(
         &self,
         budget_id: String,
+        params: GetBudgetOptionalParams,
     ) -> Result<
         datadog::ResponseContent<crate::datadogV2::model::BudgetWithEntries>,
         datadog::Error<GetBudgetError>,
     > {
         let local_configuration = &self.config;
         let operation_id = "v2.get_budget";
 
+        // unbox and build optional parameters
+        let actual = params.actual;
+        let forecast = params.forecast;
+        let start = params.start;
+        let end = params.end;
+
         let local_client = &self.client;
 
         let local_uri_str = format!(
@@ -2986,6 +3031,22 @@ impl CloudCostManagementAPI {
         let mut local_req_builder =
             local_client.request(reqwest::Method::GET, local_uri_str.as_str());
 
+        if let Some(ref local_query_param) = actual {
+            local_req_builder =
+                local_req_builder.query(&[("actual", &local_query_param.to_string())]);
+        };
+        if let Some(ref local_query_param) = forecast {
+            local_req_builder =
+                local_req_builder.query(&[("forecast", &local_query_param.to_string())]);
+        };
+        if let Some(ref local_query_param) = start {
+            local_req_builder =
+                local_req_builder.query(&[("start", &local_query_param.to_string())]);
+        };
+        if let Some(ref local_query_param) = end {
+            local_req_builder = local_req_builder.query(&[("end", &local_query_param.to_string())]);
+        };
+
         // build headers
         let mut headers = HeaderMap::new();
         headers.insert("Accept", HeaderValue::from_static("application/json"));

src/datadogV2/model/mod.rs

@@ -2794,8 +2794,14 @@ pub mod model_budget_with_entries_data;
 pub use self::model_budget_with_entries_data::BudgetWithEntriesData;
 pub mod model_budget_attributes;
 pub use self::model_budget_attributes::BudgetAttributes;
+pub mod model_budget_attributes_costs;
+pub use self::model_budget_attributes_costs::BudgetAttributesCosts;
+pub mod model_budget_attributes_costs_unit;
+pub use self::model_budget_attributes_costs_unit::BudgetAttributesCostsUnit;
 pub mod model_budget_with_entries_data_attributes_entries_items;
 pub use self::model_budget_with_entries_data_attributes_entries_items::BudgetWithEntriesDataAttributesEntriesItems;
+pub mod model_budget_with_entries_data_attributes_entries_items_costs;
+pub use self::model_budget_with_entries_data_attributes_entries_items_costs::BudgetWithEntriesDataAttributesEntriesItemsCosts;
 pub mod model_budget_with_entries_data_attributes_entries_items_tag_filters_items;
 pub use self::model_budget_with_entries_data_attributes_entries_items_tag_filters_items::BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems;
 pub mod model_validation_response;