Regenerate client from commit d7ce271f of spec repo (#910)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-04-04 09:25:03.516890",
-            "spec_repo_commit": "e6337d88"
+            "regenerated": "2022-04-04 14:19:26.161385",
+            "spec_repo_commit": "d7ce271f"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-04-04 09:25:03.528785",
-            "spec_repo_commit": "e6337d88"
+            "regenerated": "2022-04-04 14:19:26.172967",
+            "spec_repo_commit": "d7ce271f"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -3454,6 +3454,7 @@ components:
         next_record_id:
           description: The cursor to get the next results (if any). To make the next
             request, use the same parameters and add `next_record_id`.
+          nullable: true
           type: string
       type: object
     HourlyUsageAttributionResponse:
@@ -6628,6 +6629,7 @@ components:
         next_record_id:
           description: The cursor to use to get the next results, if any. To make
             the next request, use the same parameters with the addition of the `next_record_id`.
+          nullable: true
           type: string
       type: object
     MonthlyUsageAttributionResponse:
@@ -15495,6 +15497,7 @@ components:
         next_record_id:
           description: The cursor to get the next results (if any). To make the next
             request, use the same parameters and add `next_record_id`.
+          nullable: true
           type: string
         total_number_of_records:
           description: Total number of records.
@@ -26151,7 +26154,13 @@ paths:
         type: safe
   /api/v1/usage/hourly-attribution:
     get:
-      description: Get Hourly Usage Attribution.
+      description: "Get Hourly Usage Attribution.\n\nThis API endpoint is paginated.
+        To make sure you receive all records, check if the value of `next_record_id`
+        is\nset in the response. If it is, make another request and pass `next_record_id`
+        as a parameter.\nPseudo code example:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor
+        := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n
+        \ sleep(5 seconds)  # Avoid running into rate limit\n  response := GetHourlyUsageAttribution(start_month,
+        next_record_id=cursor)\n  cursor := response.metadata.pagination.next_record_id\nEND\n```"
       operationId: GetHourlyUsageAttribution
       parameters:
       - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
@@ -26185,8 +26194,12 @@ paths:
         required: false
         schema:
           type: string
-      - description: Comma separated list of tags used to group usage. If no value
+      - description: 'Comma separated list of tags used to group usage. If no value
           is provided the usage will not be broken down by tags.
+
+
+          To see which tags are available, look for the value of `tag_config_source`
+          in the API response.'
         in: query
         name: tag_breakdown_keys
         required: false
@@ -26641,7 +26654,13 @@ paths:
         type: safe
   /api/v1/usage/monthly-attribution:
     get:
-      description: Get Monthly Usage Attribution.
+      description: "Get Monthly Usage Attribution.\n\nThis API endpoint is paginated.
+        To make sure you receive all records, check if the value of `next_record_id`
+        is\nset in the response. If it is, make another request and pass `next_record_id`
+        as a parameter.\nPseudo code example:\n\n```\nresponse := GetMonthlyUsageAttribution(start_month)\ncursor
+        := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n
+        \ sleep(5 seconds)  # Avoid running into rate limit\n  response := GetMonthlyUsageAttribution(start_month,
+        next_record_id=cursor)\n  cursor := response.metadata.pagination.next_record_id\nEND\n```"
       operationId: GetMonthlyUsageAttribution
       parameters:
       - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -26681,8 +26700,12 @@ paths:
         required: false
         schema:
           $ref: '#/components/schemas/MonthlyUsageAttributionSupportedMetrics'
-      - description: Comma separated list of tags used to group usage. If no value
-          is provided the usage will not be broken down by tags.
+      - description: 'Comma separated list of tag keys used to group usage. If no
+          value is provided the usage will not be broken down by tags.
+
+
+          To see which tags are available, look for the value of `tag_config_source`
+          in the API response.'
         in: query
         name: tag_breakdown_keys
         required: false
@@ -26722,6 +26745,14 @@ paths:
       summary: Get Monthly Usage Attribution
       tags:
       - Usage Metering
+      x-given:
+        monthly_usage_attribution:
+          parameters:
+          - name: start_month
+            value: '"{{ timeISO(''now - 3d'') }}"'
+          - name: fields
+            value: '"infra_host_usage"'
+          step: there is a valid "monthly_usage_attribution" response
       x-menu-order: 31
       x-undo:
         type: safe

examples/v1/usage-metering/GetMonthlyUsageAttribution_3738504447.py

@@ -0,0 +1,28 @@
+"""
+Paginate Monthly Usage Attribution
+"""
+
+from datetime import datetime
+from dateutil.relativedelta import relativedelta
+from os import environ
+from datadog_api_client.v1 import ApiClient, Configuration
+from datadog_api_client.v1.api.usage_metering_api import UsageMeteringApi
+from datadog_api_client.v1.model.monthly_usage_attribution_supported_metrics import (
+    MonthlyUsageAttributionSupportedMetrics,
+)
+
+# there is a valid "monthly_usage_attribution" response
+MONTHLY_USAGE_ATTRIBUTION_METADATA_PAGINATION_NEXT_RECORD_ID = environ[
+    "MONTHLY_USAGE_ATTRIBUTION_METADATA_PAGINATION_NEXT_RECORD_ID"
+]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = UsageMeteringApi(api_client)
+    response = api_instance.get_monthly_usage_attribution(
+        start_month=(datetime.now() + relativedelta(days=-3)).isoformat(timespec="seconds"),
+        fields=MonthlyUsageAttributionSupportedMetrics("infra_host_usage"),
+        next_record_id=MONTHLY_USAGE_ATTRIBUTION_METADATA_PAGINATION_NEXT_RECORD_ID,
+    )
+
+    print(response)

src/datadog_api_client/v1/api/usage_metering_api.py

@@ -0,0 +1 @@
+2022-03-29T15:05:25.629Z

src/datadog_api_client/v1/model/hourly_usage_attribution_pagination.py

@@ -0,0 +1,35 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json;datetime-format=rfc3339
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/usage/monthly-attribution?start_month=2022-03-26T15%3A05%3A25.629Z&fields=infra_host_usage
+  response:
+    body:
+      string: '{"usage":[{"org_name":"DD Integration Tests (321813)","public_id":"fasjyydbcgwwc2uc","tag_config_source":"DD
+        Integration Tests (321813):::project","tags":null,"updated_at":"2022-03-28T23:02:55Z","month":"2022-03-01T00:00:00+00:00","values":{"infra_host_usage":15}}],"metadata":{"pagination":{"next_record_id":null},"aggregates":[{"field":"infra_host_usage","value":15.0,"agg_type":"sum"}]}}'
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json;datetime-format=rfc3339
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/usage/monthly-attribution?next_record_id=null&start_month=2022-03-26T15%3A05%3A25.629Z&fields=infra_host_usage
+  response:
+    body:
+      string: '{"usage":[],"metadata":{"pagination":{"next_record_id":null},"aggregates":[{"field":"infra_host_usage","value":15.0,"agg_type":"sum"}]}}'
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

src/datadog_api_client/v1/model/monthly_usage_attribution_pagination.py

@@ -166,5 +166,21 @@
     "key": "synthetics_api_test_with_wrong_dns_result",
     "tag": "Synthetics",
     "operationId": "TriggerTests"
+  },
+  {
+    "parameters": [
+      {
+        "name": "start_month",
+        "value": "\"{{ timeISO('now - 3d') }}\""
+      },
+      {
+        "name": "fields",
+        "value": "\"infra_host_usage\""
+      }
+    ],
+    "step": "there is a valid \"monthly_usage_attribution\" response",
+    "key": "monthly_usage_attribution",
+    "tag": "Usage Metering",
+    "operationId": "GetMonthlyUsageAttribution"
   }
 ]