Add support for Cloudflare API zone and resource fields (#1823)

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.6",
-            "regenerated": "2024-01-08 16:03:17.520602",
-            "spec_repo_commit": "8b5aed97"
+            "regenerated": "2024-01-08 19:23:25.412666",
+            "spec_repo_commit": "150ace98"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-08 16:03:17.535558",
-            "spec_repo_commit": "8b5aed97"
+            "regenerated": "2024-01-08 19:23:25.429398",
+            "spec_repo_commit": "150ace98"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -3776,6 +3776,22 @@ components:
           description: The name of the Cloudflare account.
           example: test-name
           type: string
+        resources:
+          description: An allowlist of resources to restrict pulling metrics for.
+          example:
+          - web
+          - dns
+          items:
+            type: string
+          type: array
+        zones:
+          description: An allowlist of zones to restrict pulling metrics for.
+          example:
+          - zone_id_1
+          - zone_id_2
+          items:
+            type: string
+          type: array
       required:
       - api_key
       - name
@@ -3808,6 +3824,22 @@ components:
           description: The name of the Cloudflare account.
           example: test-name
           type: string
+        resources:
+          description: An allowlist of resources to restrict pulling metrics for.
+          example:
+          - web
+          - dns
+          items:
+            type: string
+          type: array
+        zones:
+          description: An allowlist of zones to restrict pulling metrics for.
+          example:
+          - zone_id_1
+          - zone_id_2
+          items:
+            type: string
+          type: array
       required:
       - name
       type: object
@@ -3856,6 +3888,22 @@ components:
             key is provided (and not a token), this field is also required.
           example: test-email@example.com
           type: string
+        resources:
+          description: An allowlist of resources to restrict pulling metrics for.
+          example:
+          - web
+          - dns
+          items:
+            type: string
+          type: array
+        zones:
+          description: An allowlist of zones to restrict pulling metrics for.
+          example:
+          - zone_id_1
+          - zone_id_2
+          items:
+            type: string
+          type: array
       required:
       - api_key
       type: object

examples/v2/cloudflare-integration/CreateCloudflareAccount.py

@@ -15,7 +15,7 @@
     data=CloudflareAccountCreateRequestData(
         attributes=CloudflareAccountCreateRequestAttributes(
             api_key="fakekey",
-            email="new@email",
+            email="dev@datadoghq.com",
             name="examplecloudflareintegration",
         ),
         type=CloudflareAccountType.CLOUDFLARE_ACCOUNTS,

examples/v2/cloudflare-integration/UpdateCloudflareAccount.py

@@ -19,7 +19,10 @@
     data=CloudflareAccountUpdateRequestData(
         attributes=CloudflareAccountUpdateRequestAttributes(
             api_key="fakekey",
-            email="new@email",
+            email="dev@datadoghq.com",
+            zones=[
+                "zone-id-3",
+            ],
         ),
         type=CloudflareAccountType.CLOUDFLARE_ACCOUNTS,
     ),

src/datadog_api_client/v2/model/cloudflare_account_create_request_attributes.py

@@ -3,7 +3,7 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import Union
+from typing import List, Union
 
 from datadog_api_client.model_utils import (
     ModelNormal,
@@ -20,15 +20,27 @@ def openapi_types(_):
             "api_key": (str,),
             "email": (str,),
             "name": (str,),
+            "resources": ([str],),
+            "zones": ([str],),
         }
 
     attribute_map = {
         "api_key": "api_key",
         "email": "email",
         "name": "name",
+        "resources": "resources",
+        "zones": "zones",
     }
 
-    def __init__(self_, api_key: str, name: str, email: Union[str, UnsetType] = unset, **kwargs):
+    def __init__(
+        self_,
+        api_key: str,
+        name: str,
+        email: Union[str, UnsetType] = unset,
+        resources: Union[List[str], UnsetType] = unset,
+        zones: Union[List[str], UnsetType] = unset,
+        **kwargs,
+    ):
         """
         Attributes object for creating a Cloudflare account.
 
@@ -40,9 +52,19 @@ def __init__(self_, api_key: str, name: str, email: Union[str, UnsetType] = unse
 
         :param name: The name of the Cloudflare account.
         :type name: str
+
+        :param resources: An allowlist of resources to restrict pulling metrics for.
+        :type resources: [str], optional
+
+        :param zones: An allowlist of zones to restrict pulling metrics for.
+        :type zones: [str], optional
         """
         if email is not unset:
             kwargs["email"] = email
+        if resources is not unset:
+            kwargs["resources"] = resources
+        if zones is not unset:
+            kwargs["zones"] = zones
         super().__init__(kwargs)
 
         self_.api_key = api_key

src/datadog_api_client/v2/model/cloudflare_account_response_attributes.py

@@ -3,7 +3,7 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import Union
+from typing import List, Union
 
 from datadog_api_client.model_utils import (
     ModelNormal,
@@ -19,14 +19,25 @@ def openapi_types(_):
         return {
             "email": (str,),
             "name": (str,),
+            "resources": ([str],),
+            "zones": ([str],),
         }
 
     attribute_map = {
         "email": "email",
         "name": "name",
+        "resources": "resources",
+        "zones": "zones",
     }
 
-    def __init__(self_, name: str, email: Union[str, UnsetType] = unset, **kwargs):
+    def __init__(
+        self_,
+        name: str,
+        email: Union[str, UnsetType] = unset,
+        resources: Union[List[str], UnsetType] = unset,
+        zones: Union[List[str], UnsetType] = unset,
+        **kwargs,
+    ):
         """
         Attributes object of a Cloudflare account.
 
@@ -35,9 +46,19 @@ def __init__(self_, name: str, email: Union[str, UnsetType] = unset, **kwargs):
 
         :param name: The name of the Cloudflare account.
         :type name: str
+
+        :param resources: An allowlist of resources to restrict pulling metrics for.
+        :type resources: [str], optional
+
+        :param zones: An allowlist of zones to restrict pulling metrics for.
+        :type zones: [str], optional
         """
         if email is not unset:
             kwargs["email"] = email
+        if resources is not unset:
+            kwargs["resources"] = resources
+        if zones is not unset:
+            kwargs["zones"] = zones
         super().__init__(kwargs)
 
         self_.name = name

src/datadog_api_client/v2/model/cloudflare_account_update_request_attributes.py

@@ -3,7 +3,7 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import Union
+from typing import List, Union
 
 from datadog_api_client.model_utils import (
     ModelNormal,
@@ -19,14 +19,25 @@ def openapi_types(_):
         return {
             "api_key": (str,),
             "email": (str,),
+            "resources": ([str],),
+            "zones": ([str],),
         }
 
     attribute_map = {
         "api_key": "api_key",
         "email": "email",
+        "resources": "resources",
+        "zones": "zones",
     }
 
-    def __init__(self_, api_key: str, email: Union[str, UnsetType] = unset, **kwargs):
+    def __init__(
+        self_,
+        api_key: str,
+        email: Union[str, UnsetType] = unset,
+        resources: Union[List[str], UnsetType] = unset,
+        zones: Union[List[str], UnsetType] = unset,
+        **kwargs,
+    ):
         """
         Attributes object for updating a Cloudflare account.
 
@@ -35,9 +46,19 @@ def __init__(self_, api_key: str, email: Union[str, UnsetType] = unset, **kwargs
 
         :param email: The email associated with the Cloudflare account. If an API key is provided (and not a token), this field is also required.
         :type email: str, optional
+
+        :param resources: An allowlist of resources to restrict pulling metrics for.
+        :type resources: [str], optional
+
+        :param zones: An allowlist of zones to restrict pulling metrics for.
+        :type zones: [str], optional
         """
         if email is not unset:
             kwargs["email"] = email
+        if resources is not unset:
+            kwargs["resources"] = resources
+        if zones is not unset:
+            kwargs["zones"] = zones
         super().__init__(kwargs)
 
         self_.api_key = api_key

tests/v2/cassettes/test_scenarios/test_add_cloudflare_account_returns_bad_request_response_due_to_missing_email.frozen

@@ -1 +1 @@
-2023-01-26T10:55:04.225Z
+2024-01-04T18:40:40.939Z

tests/v2/cassettes/test_scenarios/test_add_cloudflare_account_returns_bad_request_response_due_to_missing_email.yaml

@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: '{"data":{"attributes":{"api_key":"test-api-key","name":"testaddcloudflareaccountreturnsbadrequestresponseduetomissingemail1674730504"},"type":"cloudflare-accounts"}}'
+    body: '{"data":{"attributes":{"api_key":"fakekey","name":"testaddcloudflareaccountreturnsbadrequestresponseduetomissingemail1704393640"},"type":"cloudflare-accounts"}}'
     headers:
       accept:
       - application/json
@@ -10,7 +10,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/integrations/cloudflare/accounts
   response:
     body:
-      string: '{"errors":["{u''_schema'': [''Email address is required if providing
+      string: '{"errors":["{''_schema'': [''Email address is required if providing
         an api key and not an api token.'']}"]}'
     headers:
       content-type:

tests/v2/cassettes/test_scenarios/test_add_cloudflare_account_returns_bad_request_response_using_invalid_auth_key.frozen

@@ -1 +1 @@
-2023-01-26T10:54:47.296Z
+2024-01-04T18:40:41.099Z