Add flexible status_name support for Case Management API (#3090)

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

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

.generator/schemas/v2/openapi.yaml

@@ -9229,6 +9229,10 @@ components:
           $ref: '#/components/schemas/ServiceNowTicket'
         status:
           $ref: '#/components/schemas/CaseStatus'
+        status_group:
+          $ref: '#/components/schemas/CaseStatusGroup'
+        status_name:
+          $ref: '#/components/schemas/CaseStatusName'
         title:
           description: Title
           example: Memory leak investigation on API
@@ -9295,6 +9299,8 @@ components:
           type: string
         priority:
           $ref: '#/components/schemas/CasePriority'
+        status_name:
+          $ref: '#/components/schemas/CaseStatusName'
         title:
           description: Title
           example: Security breach investigation
@@ -9463,7 +9469,9 @@ components:
       - PRIORITY
       - STATUS
     CaseStatus:
-      description: Case status
+      deprecated: true
+      description: Deprecated way of representing the case status, which only supports
+        OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead.
       enum:
       - OPEN
       - IN_PROGRESS
@@ -9474,6 +9482,23 @@ components:
       - OPEN
       - IN_PROGRESS
       - CLOSED
+    CaseStatusGroup:
+      description: Status group of the case.
+      enum:
+      - SG_OPEN
+      - SG_IN_PROGRESS
+      - SG_CLOSED
+      example: SG_OPEN
+      type: string
+      x-enum-varnames:
+      - SG_OPEN
+      - SG_IN_PROGRESS
+      - SG_CLOSED
+    CaseStatusName:
+      description: Status of the case. Must be one of the existing statuses for the
+        case's type.
+      example: Open
+      type: string
     CaseTrigger:
       description: Trigger a workflow from a Case. For automatic triggering a handle
         must be configured and the workflow must be published.
@@ -9697,8 +9722,9 @@ components:
       properties:
         status:
           $ref: '#/components/schemas/CaseStatus'
-      required:
-      - status
+          deprecated: true
+        status_name:
+          $ref: '#/components/schemas/CaseStatusName'
       type: object
     CaseUpdateStatusRequest:
       description: Case update status request

docs/datadog_api_client.v2.model.rst

@@ -3063,6 +3063,13 @@ datadog\_api\_client.v2.model.case\_status module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.case\_status\_group module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.case_status_group
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.case\_trigger module
 --------------------------------------------------
 

src/datadog_api_client/v2/model/case_attributes.py

@@ -22,6 +22,7 @@
     from datadog_api_client.v2.model.case_priority import CasePriority
     from datadog_api_client.v2.model.service_now_ticket import ServiceNowTicket
     from datadog_api_client.v2.model.case_status import CaseStatus
+    from datadog_api_client.v2.model.case_status_group import CaseStatusGroup
     from datadog_api_client.v2.model.case_type import CaseType
 
 
@@ -34,6 +35,7 @@ def openapi_types(_):
         from datadog_api_client.v2.model.case_priority import CasePriority
         from datadog_api_client.v2.model.service_now_ticket import ServiceNowTicket
         from datadog_api_client.v2.model.case_status import CaseStatus
+        from datadog_api_client.v2.model.case_status_group import CaseStatusGroup
         from datadog_api_client.v2.model.case_type import CaseType
 
         return {
@@ -49,6 +51,8 @@ def openapi_types(_):
             "priority": (CasePriority,),
             "service_now_ticket": (ServiceNowTicket,),
             "status": (CaseStatus,),
+            "status_group": (CaseStatusGroup,),
+            "status_name": (str,),
             "title": (str,),
             "type": (CaseType,),
             "type_id": (str,),
@@ -67,6 +71,8 @@ def openapi_types(_):
         "priority": "priority",
         "service_now_ticket": "service_now_ticket",
         "status": "status",
+        "status_group": "status_group",
+        "status_name": "status_name",
         "title": "title",
         "type": "type",
         "type_id": "type_id",
@@ -94,6 +100,8 @@ def __init__(
         priority: Union[CasePriority, UnsetType] = unset,
         service_now_ticket: Union[ServiceNowTicket, none_type, UnsetType] = unset,
         status: Union[CaseStatus, UnsetType] = unset,
+        status_group: Union[CaseStatusGroup, UnsetType] = unset,
+        status_name: Union[str, UnsetType] = unset,
         title: Union[str, UnsetType] = unset,
         type: Union[CaseType, UnsetType] = unset,
         type_id: Union[str, UnsetType] = unset,
@@ -135,9 +143,15 @@ def __init__(
         :param service_now_ticket: ServiceNow ticket attached to case
         :type service_now_ticket: ServiceNowTicket, none_type, optional
 
-        :param status: Case status
+        :param status: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use ``status_name`` instead. **Deprecated**.
         :type status: CaseStatus, optional
 
+        :param status_group: Status group of the case.
+        :type status_group: CaseStatusGroup, optional
+
+        :param status_name: Status of the case. Must be one of the existing statuses for the case's type.
+        :type status_name: str, optional
+
         :param title: Title
         :type title: str, optional
 
@@ -171,6 +185,10 @@ def __init__(
             kwargs["service_now_ticket"] = service_now_ticket
         if status is not unset:
             kwargs["status"] = status
+        if status_group is not unset:
+            kwargs["status_group"] = status_group
+        if status_name is not unset:
+            kwargs["status_name"] = status_name
         if title is not unset:
             kwargs["title"] = title
         if type is not unset:

src/datadog_api_client/v2/model/case_create_attributes.py

@@ -28,6 +28,7 @@ def openapi_types(_):
             "custom_attributes": ({str: (CustomAttributeValue,)},),
             "description": (str,),
             "priority": (CasePriority,),
+            "status_name": (str,),
             "title": (str,),
             "type_id": (str,),
         }
@@ -36,6 +37,7 @@ def openapi_types(_):
         "custom_attributes": "custom_attributes",
         "description": "description",
         "priority": "priority",
+        "status_name": "status_name",
         "title": "title",
         "type_id": "type_id",
     }
@@ -47,6 +49,7 @@ def __init__(
         custom_attributes: Union[Dict[str, CustomAttributeValue], UnsetType] = unset,
         description: Union[str, UnsetType] = unset,
         priority: Union[CasePriority, UnsetType] = unset,
+        status_name: Union[str, UnsetType] = unset,
         **kwargs,
     ):
         """
@@ -61,6 +64,9 @@ def __init__(
         :param priority: Case priority
         :type priority: CasePriority, optional
 
+        :param status_name: Status of the case. Must be one of the existing statuses for the case's type.
+        :type status_name: str, optional
+
         :param title: Title
         :type title: str
 
@@ -73,6 +79,8 @@ def __init__(
             kwargs["description"] = description
         if priority is not unset:
             kwargs["priority"] = priority
+        if status_name is not unset:
+            kwargs["status_name"] = status_name
         super().__init__(kwargs)
 
         self_.title = title

src/datadog_api_client/v2/model/case_status.py

@@ -14,7 +14,7 @@
 
 class CaseStatus(ModelSimple):
     """
-    Case status
+    Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead.
 
     :param value: Must be one of ["OPEN", "IN_PROGRESS", "CLOSED"].
     :type value: str

src/datadog_api_client/v2/model/case_status_group.py

@@ -0,0 +1,41 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class CaseStatusGroup(ModelSimple):
+    """
+    Status group of the case.
+
+    :param value: Must be one of ["SG_OPEN", "SG_IN_PROGRESS", "SG_CLOSED"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "SG_OPEN",
+        "SG_IN_PROGRESS",
+        "SG_CLOSED",
+    }
+    SG_OPEN: ClassVar["CaseStatusGroup"]
+    SG_IN_PROGRESS: ClassVar["CaseStatusGroup"]
+    SG_CLOSED: ClassVar["CaseStatusGroup"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+CaseStatusGroup.SG_OPEN = CaseStatusGroup("SG_OPEN")
+CaseStatusGroup.SG_IN_PROGRESS = CaseStatusGroup("SG_IN_PROGRESS")
+CaseStatusGroup.SG_CLOSED = CaseStatusGroup("SG_CLOSED")

src/datadog_api_client/v2/model/case_update_status_attributes.py

@@ -3,11 +3,13 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import Union, TYPE_CHECKING
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    unset,
+    UnsetType,
 )
 
 
@@ -22,19 +24,28 @@ def openapi_types(_):
 
         return {
             "status": (CaseStatus,),
+            "status_name": (str,),
         }
 
     attribute_map = {
         "status": "status",
+        "status_name": "status_name",
     }
 
-    def __init__(self_, status: CaseStatus, **kwargs):
+    def __init__(
+        self_, status: Union[CaseStatus, UnsetType] = unset, status_name: Union[str, UnsetType] = unset, **kwargs
+    ):
         """
         Case update status attributes
 
-        :param status: Case status
-        :type status: CaseStatus
+        :param status: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use ``status_name`` instead. **Deprecated**.
+        :type status: CaseStatus, optional
+
+        :param status_name: Status of the case. Must be one of the existing statuses for the case's type.
+        :type status_name: str, optional
         """
+        if status is not unset:
+            kwargs["status"] = status
+        if status_name is not unset:
+            kwargs["status_name"] = status_name
         super().__init__(kwargs)
-
-        self_.status = status

src/datadog_api_client/v2/model/issue_case_attributes.py

@@ -117,7 +117,7 @@ def __init__(
         :param priority: Case priority
         :type priority: CasePriority, optional
 
-        :param status: Case status
+        :param status: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use ``status_name`` instead. **Deprecated**.
         :type status: CaseStatus, optional
 
         :param title: Title of the case.

src/datadog_api_client/v2/models/__init__.py

@@ -675,6 +675,7 @@
 from datadog_api_client.v2.model.case_response import CaseResponse
 from datadog_api_client.v2.model.case_sortable_field import CaseSortableField
 from datadog_api_client.v2.model.case_status import CaseStatus
+from datadog_api_client.v2.model.case_status_group import CaseStatusGroup
 from datadog_api_client.v2.model.case_trigger import CaseTrigger
 from datadog_api_client.v2.model.case_trigger_wrapper import CaseTriggerWrapper
 from datadog_api_client.v2.model.case_type import CaseType
@@ -6206,6 +6207,7 @@
     "CaseResponse",
     "CaseSortableField",
     "CaseStatus",
+    "CaseStatusGroup",
     "CaseTrigger",
     "CaseTriggerWrapper",
     "CaseType",