Regenerate client from commit a68d81e0 of spec repo (#1116)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
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.2",
-            "regenerated": "2022-07-29 13:43:05.545760",
-            "spec_repo_commit": "42e24f61"
+            "regenerated": "2022-07-29 18:24:30.284645",
+            "spec_repo_commit": "a68d81e0"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-07-29 13:43:05.557589",
-            "spec_repo_commit": "42e24f61"
+            "regenerated": "2022-07-29 18:24:30.301047",
+            "spec_repo_commit": "a68d81e0"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -13917,14 +13917,25 @@ paths:
       x-menu-order: 5
       x-undo:
         type: safe
-  /api/v2/usage/estimated_cost_by_org:
+  /api/v2/usage/estimated_cost:
     get:
-      description: Get estimated cost across multi-org account.
+      description: '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.'
       operationId: GetEstimatedCostByOrg
       parameters:
+      - description: 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.
+        in: query
+        name: view
+        required: true
+        schema:
+          type: string
       - description: '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.'
+          specified, but not both. (start_month cannot go beyond two months in the
+          past)'
         in: query
         name: start_month
         required: false
@@ -13941,7 +13952,8 @@ paths:
           type: string
       - description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]`
           for cost beginning this day. Either start_month or start_date should be
-          specified, but not both.'
+          specified, but not both. (start_date cannot go beyond two months in the
+          past)'
         in: query
         name: start_date
         required: false
@@ -13986,12 +13998,16 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - usage_read
-      summary: Get estimated cost across multi-org account
+      summary: Get estimated cost across your account
       tags:
       - Usage Metering
       x-menu-order: 39
       x-undo:
         type: safe
+      x-unstable: '**Note**: This endpoint is in public beta.
+
+        Only the sub-org view is available currently, the summary view will be released
+        at a later date.'
   /api/v2/usage/hourly_usage:
     get:
       description: Get hourly usage by product family

examples/v2/usage-metering/GetEstimatedCostByOrg.py

@@ -1,13 +1,16 @@
 """
-Get estimated cost across multi-org account returns "OK" response
+Get estimated 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()
+configuration.unstable_operations["get_estimated_cost_by_org"] = True
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
-    response = api_instance.get_estimated_cost_by_org()
+    response = api_instance.get_estimated_cost_by_org(
+        view="view",
+    )
 
     print(response)

examples/v2/usage-metering/GetEstimatedCostByOrg_627383212.py renamed to examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.py

@@ -1,5 +1,5 @@
 """
-Get estimated cost across multi-org account with date returns "OK" response
+GetEstimatedCostByOrg with start_date returns "OK" response
 """
 
 from datetime import datetime
@@ -8,11 +8,12 @@
 from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
 
 configuration = Configuration()
+configuration.unstable_operations["get_estimated_cost_by_org"] = True
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_estimated_cost_by_org(
+        view="sub-org",
         start_date=(datetime.now() + relativedelta(days=-5)),
-        end_date=(datetime.now() + relativedelta(days=-3)),
     )
 
     print(response)

examples/v2/usage-metering/GetEstimatedCostByOrg_1171921972.py renamed to examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.py

@@ -1,5 +1,5 @@
 """
-Get estimated cost across multi-org account with month returns "OK" response
+GetEstimatedCostByOrg with start_month returns "OK" response
 """
 
 from datetime import datetime
@@ -8,11 +8,12 @@
 from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
 
 configuration = Configuration()
+configuration.unstable_operations["get_estimated_cost_by_org"] = True
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_estimated_cost_by_org(
+        view="sub-org",
         start_month=(datetime.now() + relativedelta(days=-5)),
-        end_month=(datetime.now() + relativedelta(days=-3)),
     )
 
     print(response)

src/datadog_api_client/configuration.py

@@ -245,6 +245,7 @@ def __init__(
                 "v2.get_incident_team": False,
                 "v2.list_incident_teams": False,
                 "v2.update_incident_team": False,
+                "v2.get_estimated_cost_by_org": False,
             }
         )
 

src/datadog_api_client/v2/api/usage_metering_api.py

@@ -73,13 +73,19 @@ def __init__(self, api_client=None):
             settings={
                 "response_type": (CostByOrgResponse,),
                 "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
-                "endpoint_path": "/api/v2/usage/estimated_cost_by_org",
+                "endpoint_path": "/api/v2/usage/estimated_cost",
                 "operation_id": "get_estimated_cost_by_org",
                 "http_method": "GET",
                 "version": "v2",
                 "servers": None,
             },
             params_map={
+                "view": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "view",
+                    "location": "query",
+                },
                 "start_month": {
                     "openapi_types": (datetime,),
                     "attribute": "start_month",
@@ -284,27 +290,33 @@ def get_cost_by_org(
 
     def get_estimated_cost_by_org(
         self,
+        view: str,
         *,
         start_month: Union[datetime, UnsetType] = unset,
         end_month: Union[datetime, UnsetType] = unset,
         start_date: Union[datetime, UnsetType] = unset,
         end_date: Union[datetime, UnsetType] = unset,
     ) -> CostByOrgResponse:
-        """Get estimated cost across multi-org account.
+        """Get estimated cost across your account.
 
-        Get estimated cost across multi-org account.
+        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.
 
-        :param start_month: 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.
+        :param view: 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.
+        :type view: str
+        :param start_month: 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 start_month: datetime, optional
         :param end_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost ending this month.
         :type end_month: datetime, optional
-        :param start_date: Datetime in ISO-8601 format, UTC, precise to day: ``[YYYY-MM-DD]`` for cost beginning this day. Either start_month or start_date should be specified, but not both.
+        :param start_date: Datetime in ISO-8601 format, UTC, precise to day: ``[YYYY-MM-DD]`` for cost beginning this day. Either start_month or start_date should be specified, but not both. (start_date cannot go beyond two months in the past)
         :type start_date: datetime, optional
         :param end_date: Datetime in ISO-8601 format, UTC, precise to day: ``[YYYY-MM-DD]`` for cost ending this day.
         :type end_date: datetime, optional
         :rtype: CostByOrgResponse
         """
         kwargs: Dict[str, Any] = {}
+        kwargs["view"] = view
+
         if start_month is not unset:
             kwargs["start_month"] = start_month
 

tests/v2/cassettes/test_scenarios/test_getestimatedcostbyorg_with_start_date_returns_ok_response.frozen

@@ -0,0 +1 @@
+2022-07-29T14:22:55.359Z

tests/v2/cassettes/test_scenarios/test_getestimatedcostbyorg_with_start_date_returns_ok_response.yaml

@@ -0,0 +1,20 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json;datetime-format=rfc3339
+    method: GET
+    uri: https://api.datadoghq.com/api/v2/usage/estimated_cost?start_date=2022-07-24T14%3A22%3A55.359Z&view=sub-org
+  response:
+    body:
+      string: '{"data":[]}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v2/features/usage_metering.feature

@@ -28,33 +28,19 @@ Feature: Usage Metering
     When the request is sent
     Then the response status is 200 OK
 
-  @skip @team:DataDog/red-zone-revenue-query
-  Scenario: Get estimated cost across multi-org account returns "Bad Request" response
-    Given new "GetEstimatedCostByOrg" request
-    And request contains "start_month" parameter with value "{{ timeISO('now - 3d') }}"
-    And request contains "start_date" parameter with value "{{ timeISO('now - 3d') }}"
+  @generated @skip @team:DataDog/red-zone-revenue-query
+  Scenario: Get estimated cost across your account returns "Bad Request" response
+    Given operation "GetEstimatedCostByOrg" enabled
+    And new "GetEstimatedCostByOrg" request
+    And request contains "view" parameter from "REPLACE.ME"
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/red-zone-revenue-query
-  Scenario: Get estimated cost across multi-org account returns "OK" response
-    Given new "GetEstimatedCostByOrg" request
-    When the request is sent
-    Then the response status is 200 OK
-
-  @replay-only @team:DataDog/red-zone-revenue-query
-  Scenario: Get estimated cost across multi-org account with date returns "OK" response
-    Given new "GetEstimatedCostByOrg" request
-    And request contains "start_date" parameter with value "{{ timeISO('now - 5d') }}"
-    And request contains "end_date" parameter with value "{{ timeISO('now - 3d') }}"
-    When the request is sent
-    Then the response status is 200 OK
-
-  @replay-only @team:DataDog/red-zone-revenue-query
-  Scenario: Get estimated cost across multi-org account with month returns "OK" response
-    Given new "GetEstimatedCostByOrg" request
-    And request contains "start_month" parameter with value "{{ timeISO('now - 5d') }}"
-    And request contains "end_month" parameter with value "{{ timeISO('now - 3d') }}"
+  Scenario: Get estimated cost across your account returns "OK" response
+    Given operation "GetEstimatedCostByOrg" enabled
+    And new "GetEstimatedCostByOrg" request
+    And request contains "view" parameter from "REPLACE.ME"
     When the request is sent
     Then the response status is 200 OK
 
@@ -164,3 +150,30 @@ Feature: Usage Metering
     And request contains "start_hr" parameter from "REPLACE.ME"
     When the request is sent
     Then the response status is 200 OK
+
+  @skip @team:DataDog/red-zone-revenue-query
+  Scenario: GetEstimatedCostByOrg with both start_month and start_date returns "Bad Request" response
+    Given new "GetEstimatedCostByOrg" request
+    And request contains "view" parameter with value "sub-org"
+    And request contains "start_month" parameter with value "{{ timeISO('now - 3d') }}"
+    And request contains "start_date" parameter with value "{{ timeISO('now - 3d') }}"
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @replay-only @team:DataDog/red-zone-revenue-query
+  Scenario: GetEstimatedCostByOrg with start_date returns "OK" response
+    Given operation "GetEstimatedCostByOrg" enabled
+    And new "GetEstimatedCostByOrg" request
+    And request contains "view" parameter with value "sub-org"
+    And request contains "start_date" parameter with value "{{ timeISO('now - 5d') }}"
+    When the request is sent
+    Then the response status is 200 OK
+
+  @skip @team:DataDog/red-zone-revenue-query
+  Scenario: GetEstimatedCostByOrg with start_month returns "OK" response
+    Given operation "GetEstimatedCostByOrg" enabled
+    And new "GetEstimatedCostByOrg" request
+    And request contains "view" parameter with value "sub-org"
+    And request contains "start_month" parameter with value "{{ timeISO('now - 5d') }}"
+    When the request is sent
+    Then the response status is 200 OK