Add domain allowlist endpoints (#2539)

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

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-29 20:46:31.079470",
-            "spec_repo_commit": "c0b9551e"
+            "regenerated": "2024-10-30 18:58:12.249463",
+            "spec_repo_commit": "755120dd"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-29 20:46:31.098654",
-            "spec_repo_commit": "c0b9551e"
+            "regenerated": "2024-10-30 18:58:12.267886",
+            "spec_repo_commit": "755120dd"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -7115,6 +7115,81 @@ components:
           description: The type of the resource. The value should always be device.
           type: string
       type: object
+    DomainAllowlist:
+      description: The email domain allowlist for an org.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DomainAllowlistAttributes'
+        id:
+          description: The unique identifier of the org.
+          nullable: true
+          type: string
+        type:
+          $ref: '#/components/schemas/DomainAllowlistType'
+      required:
+      - type
+      type: object
+    DomainAllowlistAttributes:
+      description: The details of the email domain allowlist.
+      properties:
+        domains:
+          description: The list of domains in the email domain allowlist.
+          items:
+            type: string
+          type: array
+        enabled:
+          description: Whether the email domain allowlist is enabled for the org.
+          type: boolean
+      type: object
+    DomainAllowlistRequest:
+      description: Request containing the desired email domain allowlist configuration.
+      properties:
+        data:
+          $ref: '#/components/schemas/DomainAllowlist'
+      required:
+      - data
+      type: object
+    DomainAllowlistResponse:
+      description: Response containing information about the email domain allowlist.
+      properties:
+        data:
+          $ref: '#/components/schemas/DomainAllowlistResponseData'
+      type: object
+    DomainAllowlistResponseData:
+      description: The email domain allowlist response for an org.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DomainAllowlistResponseDataAttributes'
+        id:
+          description: The unique identifier of the org.
+          nullable: true
+          type: string
+        type:
+          $ref: '#/components/schemas/DomainAllowlistType'
+      required:
+      - type
+      type: object
+    DomainAllowlistResponseDataAttributes:
+      description: The details of the email domain allowlist.
+      properties:
+        domains:
+          description: The list of domains in the email domain allowlist.
+          items:
+            type: string
+          type: array
+        enabled:
+          description: Whether the email domain allowlist is enabled for the org.
+          type: boolean
+      type: object
+    DomainAllowlistType:
+      default: domain_allowlist
+      description: Email domain allowlist allowlist type.
+      enum:
+      - domain_allowlist
+      example: domain_allowlist
+      type: string
+      x-enum-varnames:
+      - DOMAIN_ALLOWLIST
     DowntimeCreateRequest:
       description: Request for creating a downtime.
       properties:
@@ -29433,6 +29508,61 @@ paths:
       tags:
       - Dashboard Lists
       x-codegen-request-body-name: body
+  /api/v2/domain_allowlist:
+    get:
+      description: Get the domain allowlist for an organization.
+      operationId: GetDomainAllowlist
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainAllowlistResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - org_management
+      summary: Get Domain Allowlist
+      tags:
+      - Domain Allowlist
+      x-permission:
+        operator: OR
+        permissions:
+        - org_management
+    patch:
+      description: Update the domain allowlist for an organization.
+      operationId: PatchDomainAllowlist
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DomainAllowlistRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainAllowlistResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - org_management
+      summary: Sets Domain Allowlist
+      tags:
+      - Domain Allowlist
+      x-permission:
+        operator: OR
+        permissions:
+        - org_management
   /api/v2/dora/deployment:
     post:
       description: 'Use this API endpoint to provide data about deployments for DORA
@@ -41786,6 +41916,14 @@ tags:
 
     organization.'
   name: Dashboard Lists
+- description: 'Configure your Datadog Email Domain Allowlist directly through the
+    Datadog API.
+
+    The Email Domain Allowlist controls the domains that certain datadog emails can
+    be sent to.
+
+    For more information, see the [Domain Allowlist docs page](https://docs.datadoghq.com/account_management/org_settings/domain_allowlist)'
+  name: Domain Allowlist
 - description: '**Note**: Downtime V2 is currently in private beta. To request access,
     contact [Datadog support](https://docs.datadoghq.com/help/).
 

examples/v2/domain-allowlist/GetDomainAllowlist.java

@@ -0,0 +1,24 @@
+// Get Domain Allowlist returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.DomainAllowlistApi;
+import com.datadog.api.client.v2.model.DomainAllowlistResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    DomainAllowlistApi apiInstance = new DomainAllowlistApi(defaultClient);
+
+    try {
+      DomainAllowlistResponse result = apiInstance.getDomainAllowlist();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DomainAllowlistApi#getDomainAllowlist");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/domain-allowlist/PatchDomainAllowlist.java

@@ -0,0 +1,39 @@
+// Sets Domain Allowlist returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.DomainAllowlistApi;
+import com.datadog.api.client.v2.model.DomainAllowlist;
+import com.datadog.api.client.v2.model.DomainAllowlistAttributes;
+import com.datadog.api.client.v2.model.DomainAllowlistRequest;
+import com.datadog.api.client.v2.model.DomainAllowlistResponse;
+import com.datadog.api.client.v2.model.DomainAllowlistType;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    DomainAllowlistApi apiInstance = new DomainAllowlistApi(defaultClient);
+
+    DomainAllowlistRequest body =
+        new DomainAllowlistRequest()
+            .data(
+                new DomainAllowlist()
+                    .attributes(
+                        new DomainAllowlistAttributes()
+                            .domains(Collections.singletonList("@static-test-domain.test"))
+                            .enabled(false))
+                    .type(DomainAllowlistType.DOMAIN_ALLOWLIST));
+
+    try {
+      DomainAllowlistResponse result = apiInstance.patchDomainAllowlist(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DomainAllowlistApi#patchDomainAllowlist");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}