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

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 0ef72772123f · 2022-07-29T19:09:50.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-07-29 13:43:08.165233",
-            "spec_repo_commit": "42e24f61"
+            "regenerated": "2022-07-29 18:24:29.943707",
+            "spec_repo_commit": "a68d81e0"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-07-29 13:43:08.177187",
-            "spec_repo_commit": "42e24f61"
+            "regenerated": "2022-07-29 18:24:29.959460",
+            "spec_repo_commit": "a68d81e0"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.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
diff --git a/cassettes/v2/Usage-Metering_938753175/GetEstimatedCostByOrg-with-start_date-returns-OK-response_1940328472/frozen.json b/cassettes/v2/Usage-Metering_938753175/GetEstimatedCostByOrg-with-start_date-returns-OK-response_1940328472/frozen.json
@@ -0,0 +1 @@
+"2022-07-29T14:22:55.359Z"
diff --git a/cassettes/v2/Usage-Metering_938753175/GetEstimatedCostByOrg-with-start_date-returns-OK-response_1940328472/recording.har b/cassettes/v2/Usage-Metering_938753175/GetEstimatedCostByOrg-with-start_date-returns-OK-response_1940328472/recording.har
@@ -0,0 +1,66 @@
+{
+  "log": {
+    "_recordingName": "Usage Metering/GetEstimatedCostByOrg with start_date returns \"OK\" response",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.4"
+    },
+    "entries": [
+      {
+        "_id": "7cb949d5c1eece97c2e37535350712e3",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json;datetime-format=rfc3339"
+            }
+          ],
+          "headersSize": 599,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [
+            {
+              "name": "start_date",
+              "value": "2022-07-24T14:22:55.359Z"
+            },
+            {
+              "name": "view",
+              "value": "sub-org"
+            }
+          ],
+          "url": "https://api.datadoghq.com/api/v2/usage/estimated_cost?start_date=2022-07-24T14%3A22%3A55.359Z&view=sub-org"
+        },
+        "response": {
+          "bodySize": 12,
+          "content": {
+            "mimeType": "application/json",
+            "size": 12,
+            "text": "{\"data\":[]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 595,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-07-29T14:22:55.378Z",
+        "time": 714
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v2/usage-metering/GetEstimatedCostByOrg.ts b/examples/v2/usage-metering/GetEstimatedCostByOrg.ts
@@ -1,14 +1,19 @@
 /**
- * Get estimated cost across multi-org account returns "OK" response
+ * Get estimated cost across your account returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
+configuration.unstableOperations["getEstimatedCostByOrg"] = true;
 const apiInstance = new v2.UsageMeteringApi(configuration);
 
+const params: v2.UsageMeteringApiGetEstimatedCostByOrgRequest = {
+  view: "view",
+};
+
 apiInstance
-  .getEstimatedCostByOrg()
+  .getEstimatedCostByOrg(params)
   .then((data: v2.CostByOrgResponse) => {
     console.log(
       "API called successfully. Returned data: " + JSON.stringify(data)
diff --git a/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.ts b/examples/v2/usage-metering/GetEstimatedCostByOrg_2734954020.ts
@@ -1,15 +1,16 @@
 /**
- * Get estimated cost across multi-org account with date returns "OK" response
+ * GetEstimatedCostByOrg with start_date returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
+configuration.unstableOperations["getEstimatedCostByOrg"] = true;
 const apiInstance = new v2.UsageMeteringApi(configuration);
 
 const params: v2.UsageMeteringApiGetEstimatedCostByOrgRequest = {
+  view: "sub-org",
   startDate: new Date(new Date().getTime() / 1000 + -5 * 86400),
-  endDate: new Date(new Date().getTime() / 1000 + -3 * 86400),
 };
 
 apiInstance
diff --git a/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.ts b/examples/v2/usage-metering/GetEstimatedCostByOrg_3186693804.ts
@@ -1,15 +1,16 @@
 /**
- * Get estimated cost across multi-org account with month returns "OK" response
+ * GetEstimatedCostByOrg with start_month returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
+configuration.unstableOperations["getEstimatedCostByOrg"] = true;
 const apiInstance = new v2.UsageMeteringApi(configuration);
 
 const params: v2.UsageMeteringApiGetEstimatedCostByOrgRequest = {
+  view: "sub-org",
   startMonth: new Date(new Date().getTime() / 1000 + -5 * 86400),
-  endMonth: new Date(new Date().getTime() / 1000 + -3 * 86400),
 };
 
 apiInstance
diff --git a/features/v2/usage_metering.feature b/features/v2/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
diff --git a/packages/datadog-api-client-common/configuration.ts b/packages/datadog-api-client-common/configuration.ts
@@ -127,6 +127,7 @@ export function createConfiguration(
       "v2.getIncidentTeam": false,
       "v2.listIncidentTeams": false,
       "v2.updateIncidentTeam": false,
+      "v2.getEstimatedCostByOrg": false,
     },
     httpApi: conf.httpApi || new DefaultHttpLibrary(),
     authMethods: configureAuthMethods(authMethods),
diff --git a/packages/datadog-api-client-v2/apis/UsageMeteringApi.ts b/packages/datadog-api-client-v2/apis/UsageMeteringApi.ts
@@ -13,6 +13,7 @@ import {
   ResponseContext,
 } from "../../datadog-api-client-common/http/http";
 
+import { logger } from "../../../logger";
 import { ObjectSerializer } from "../models/ObjectSerializer";
 import { ApiException } from "../../datadog-api-client-common/exception";
 import { isCodeInRange } from "../../datadog-api-client-common/util";
@@ -78,6 +79,7 @@ export class UsageMeteringApiRequestFactory extends BaseAPIRequestFactory {
   }
 
   public async getEstimatedCostByOrg(
+    view: string,
     startMonth?: Date,
     endMonth?: Date,
     startDate?: Date,
@@ -86,8 +88,20 @@ export class UsageMeteringApiRequestFactory extends BaseAPIRequestFactory {
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
 
+    logger.warn("Using unstable operation 'getEstimatedCostByOrg'");
+    if (!_config.unstableOperations["v2.getEstimatedCostByOrg"]) {
+      throw new Error("Unstable operation 'getEstimatedCostByOrg' is disabled");
+    }
+
+    // verify required parameter 'view' is not null or undefined
+    if (view === null || view === undefined) {
+      throw new RequiredError(
+        "Required parameter view was null or undefined when calling getEstimatedCostByOrg."
+      );
+    }
+
     // Path Params
-    const localVarPath = "/api/v2/usage/estimated_cost_by_org";
+    const localVarPath = "/api/v2/usage/estimated_cost";
 
     // Make Request Context
     const requestContext = getServer(
@@ -101,6 +115,12 @@ export class UsageMeteringApiRequestFactory extends BaseAPIRequestFactory {
     requestContext.setHttpConfig(_config.httpConfig);
 
     // Query Params
+    if (view !== undefined) {
+      requestContext.setQueryParam(
+        "view",
+        ObjectSerializer.serialize(view, "string", "")
+      );
+    }
     if (startMonth !== undefined) {
       requestContext.setQueryParam(
         "start_month",
@@ -788,7 +808,12 @@ export interface UsageMeteringApiGetCostByOrgRequest {
 
 export interface UsageMeteringApiGetEstimatedCostByOrgRequest {
   /**
-   * 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.
+   * 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 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
    */
   startMonth?: Date;
@@ -798,7 +823,7 @@ export interface UsageMeteringApiGetEstimatedCostByOrgRequest {
    */
   endMonth?: 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.
+   * 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 Date
    */
   startDate?: Date;
@@ -936,14 +961,16 @@ export class UsageMeteringApi {
   }
 
   /**
-   * 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 param The request object
    */
   public getEstimatedCostByOrg(
-    param: UsageMeteringApiGetEstimatedCostByOrgRequest = {},
+    param: UsageMeteringApiGetEstimatedCostByOrgRequest,
     options?: Configuration
   ): Promise<CostByOrgResponse> {
     const requestContextPromise = this.requestFactory.getEstimatedCostByOrg(
+      param.view,
       param.startMonth,
       param.endMonth,
       param.startDate,

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.2",`
`7`		`- "regenerated": "2022-07-29 13:43:08.165233",`
`8`		`- "spec_repo_commit": "42e24f61"`
	`7`	`+ "regenerated": "2022-07-29 18:24:29.943707",`
	`8`	`+ "spec_repo_commit": "a68d81e0"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.2",`
`12`		`- "regenerated": "2022-07-29 13:43:08.177187",`
`13`		`- "spec_repo_commit": "42e24f61"`
	`12`	`+ "regenerated": "2022-07-29 18:24:29.959460",`
	`13`	`+ "spec_repo_commit": "a68d81e0"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`