Regenerate client from commit 898cd727 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-13 18:28:08.995813",
-            "spec_repo_commit": "3517c947"
+            "regenerated": "2025-01-14 17:10:38.716474",
+            "spec_repo_commit": "898cd727"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-13 18:28:09.011266",
-            "spec_repo_commit": "3517c947"
+            "regenerated": "2025-01-14 17:10:38.732035",
+            "spec_repo_commit": "898cd727"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -213,6 +213,13 @@ components:
       required: true
       schema:
         type: string
+    CustomFrameworkOrgID:
+      description: The ID of the organization.
+      in: path
+      name: org_id
+      required: true
+      schema:
+        type: string
     EntityID:
       description: UUID or Entity Ref.
       in: path
@@ -7145,6 +7152,44 @@ components:
       type: string
       x-enum-varnames:
       - APPDEFINITIONS
+    CreateCustomFrameworkRequest:
+      description: Create a custom framework.
+      properties:
+        description:
+          description: Framework Description
+          type: string
+        handle:
+          description: Framework Handle
+          example: ''
+          type: string
+        icon_url:
+          description: Framework Icon URL
+          type: string
+        id:
+          description: Custom Framework ID
+          type: string
+        name:
+          description: Framework Name
+          example: ''
+          type: string
+        requirements:
+          description: Framework Requirements
+          items:
+            $ref: '#/components/schemas/FrameworkRequirement'
+          type: array
+        user_email:
+          description: Framework Creator
+          type: string
+        version:
+          description: Framework Version
+          example: ''
+          type: string
+      required:
+      - handle
+      - version
+      - name
+      - requirements
+      type: object
     CreateDataDeletionRequestBody:
       description: Object needed to create a data deletion request.
       properties:
@@ -11936,6 +11981,40 @@ components:
         order:
           $ref: '#/components/schemas/QuerySortOrder'
       type: object
+    FrameworkControl:
+      description: Framework Control.
+      properties:
+        name:
+          description: Control Name.
+          example: ''
+          type: string
+        rule_ids:
+          description: Rule IDs.
+          example:
+          - ''
+          items:
+            type: string
+          type: array
+      required:
+      - name
+      - rule_ids
+      type: object
+    FrameworkRequirement:
+      description: Framework Requirement.
+      properties:
+        controls:
+          description: Requirement Controls.
+          items:
+            $ref: '#/components/schemas/FrameworkControl'
+          type: array
+        name:
+          description: Requirement Name.
+          example: ''
+          type: string
+      required:
+      - name
+      - controls
+      type: object
     FullAPIKey:
       description: Datadog API key.
       properties:
@@ -30263,6 +30342,12 @@ components:
       scheme: bearer
       type: http
       x-env-name: DD_BEARER_TOKEN
+    userAuth:
+      description: Your Datadog User ID.
+      in: header
+      name: X-Datadog-UserId
+      type: http
+      x-env-name: X_Datadog_UserId
 info:
   contact:
     email: [email protected]
@@ -40135,6 +40220,43 @@ paths:
         operator: OR
         permissions:
         - org_management
+  /api/v2/orgs/{org_id}/cloud_security_management/custom_frameworks:
+    post:
+      description: Create a custom framework.
+      operationId: CreateCustomFramework
+      parameters:
+      - $ref: '#/components/parameters/CustomFrameworkOrgID'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateCustomFrameworkRequest'
+        required: true
+      responses:
+        '200':
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+        '500':
+          $ref: '#/components/responses/BadRequestResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+        userAuth: []
+      - AuthZ:
+        - security_monitoring_rules_read
+        - security_monitoring_rules_write
+      summary: Create a custom framework
+      tags:
+      - Security Monitoring
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: AND
+        permissions:
+        - security_monitoring_rules_read
+        - security_monitoring_rules_write
   /api/v2/permissions:
     get:
       description: Returns a list of all permissions, including name, description,

docs/datadog_api_client.v2.model.rst

@@ -2727,6 +2727,13 @@ datadog\_api\_client.v2.model.create\_app\_response\_data\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.create\_custom\_framework\_request module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_custom_framework_request
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.create\_data\_deletion\_request\_body module
 --------------------------------------------------------------------------
 
@@ -4883,6 +4890,20 @@ datadog\_api\_client.v2.model.formula\_limit module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.framework\_control module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.framework_control
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.framework\_requirement module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.framework_requirement
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.full\_api\_key module
 ---------------------------------------------------
 

examples/v2/security-monitoring/CreateCustomFramework.py

@@ -0,0 +1,33 @@
+"""
+Create a custom framework returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.create_custom_framework_request import CreateCustomFrameworkRequest
+from datadog_api_client.v2.model.framework_control import FrameworkControl
+from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement
+
+body = CreateCustomFrameworkRequest(
+    handle="",
+    name="",
+    requirements=[
+        FrameworkRequirement(
+            controls=[
+                FrameworkControl(
+                    name="",
+                    rule_ids=[
+                        "",
+                    ],
+                ),
+            ],
+            name="",
+        ),
+    ],
+    version="",
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    api_instance.create_custom_framework(org_id="org_id", body=body)

src/datadog_api_client/v2/api/security_monitoring_api.py

@@ -15,6 +15,7 @@
     UnsetType,
     unset,
 )
+from datadog_api_client.v2.model.create_custom_framework_request import CreateCustomFrameworkRequest
 from datadog_api_client.v2.model.list_findings_response import ListFindingsResponse
 from datadog_api_client.v2.model.finding_evaluation import FindingEvaluation
 from datadog_api_client.v2.model.finding_status import FindingStatus
@@ -182,6 +183,32 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._create_custom_framework_endpoint = _Endpoint(
+            settings={
+                "response_type": None,
+                "auth": ["apiKeyAuth", "appKeyAuth", "userAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/orgs/{org_id}/cloud_security_management/custom_frameworks",
+                "operation_id": "create_custom_framework",
+                "http_method": "POST",
+                "version": "v2",
+            },
+            params_map={
+                "org_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "org_id",
+                    "location": "path",
+                },
+                "body": {
+                    "required": True,
+                    "openapi_types": (CreateCustomFrameworkRequest,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["*/*"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
         self._create_security_filter_endpoint = _Endpoint(
             settings={
                 "response_type": (SecurityFilterResponse,),
@@ -1401,6 +1428,27 @@ def convert_security_monitoring_rule_from_json_to_terraform(
 
         return self._convert_security_monitoring_rule_from_json_to_terraform_endpoint.call_with_http_info(**kwargs)
 
+    def create_custom_framework(
+        self,
+        org_id: str,
+        body: CreateCustomFrameworkRequest,
+    ) -> None:
+        """Create a custom framework.
+
+        Create a custom framework.
+
+        :param org_id: The ID of the organization.
+        :type org_id: str
+        :type body: CreateCustomFrameworkRequest
+        :rtype: None
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["org_id"] = org_id
+
+        kwargs["body"] = body
+
+        return self._create_custom_framework_endpoint.call_with_http_info(**kwargs)
+
     def create_security_filter(
         self,
         body: SecurityFilterCreateRequest,