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

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

api/datadogV2/model_case_attributes.go

@@ -34,8 +34,13 @@ type CaseAttributes struct {
 	Priority *CasePriority `json:"priority,omitempty"`
 	// ServiceNow ticket attached to case
 	ServiceNowTicket NullableServiceNowTicket `json:"service_now_ticket,omitempty"`
-	// Case status
+	// Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead.
+	// Deprecated
 	Status *CaseStatus `json:"status,omitempty"`
+	// Status group of the case.
+	StatusGroup *CaseStatusGroup `json:"status_group,omitempty"`
+	// Status of the case. Must be one of the existing statuses for the case's type.
+	StatusName *string `json:"status_name,omitempty"`
 	// Title
 	Title *string `json:"title,omitempty"`
 	// Case type
@@ -433,6 +438,7 @@ func (o *CaseAttributes) UnsetServiceNowTicket() {
 }
 
 // GetStatus returns the Status field value if set, zero value otherwise.
+// Deprecated
 func (o *CaseAttributes) GetStatus() CaseStatus {
 	if o == nil || o.Status == nil {
 		var ret CaseStatus
@@ -443,6 +449,7 @@ func (o *CaseAttributes) GetStatus() CaseStatus {
 
 // GetStatusOk returns a tuple with the Status field value if set, nil otherwise
 // and a boolean to check if the value has been set.
+// Deprecated
 func (o *CaseAttributes) GetStatusOk() (*CaseStatus, bool) {
 	if o == nil || o.Status == nil {
 		return nil, false
@@ -456,10 +463,67 @@ func (o *CaseAttributes) HasStatus() bool {
 }
 
 // SetStatus gets a reference to the given CaseStatus and assigns it to the Status field.
+// Deprecated
 func (o *CaseAttributes) SetStatus(v CaseStatus) {
 	o.Status = &v
 }
 
+// GetStatusGroup returns the StatusGroup field value if set, zero value otherwise.
+func (o *CaseAttributes) GetStatusGroup() CaseStatusGroup {
+	if o == nil || o.StatusGroup == nil {
+		var ret CaseStatusGroup
+		return ret
+	}
+	return *o.StatusGroup
+}
+
+// GetStatusGroupOk returns a tuple with the StatusGroup field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CaseAttributes) GetStatusGroupOk() (*CaseStatusGroup, bool) {
+	if o == nil || o.StatusGroup == nil {
+		return nil, false
+	}
+	return o.StatusGroup, true
+}
+
+// HasStatusGroup returns a boolean if a field has been set.
+func (o *CaseAttributes) HasStatusGroup() bool {
+	return o != nil && o.StatusGroup != nil
+}
+
+// SetStatusGroup gets a reference to the given CaseStatusGroup and assigns it to the StatusGroup field.
+func (o *CaseAttributes) SetStatusGroup(v CaseStatusGroup) {
+	o.StatusGroup = &v
+}
+
+// GetStatusName returns the StatusName field value if set, zero value otherwise.
+func (o *CaseAttributes) GetStatusName() string {
+	if o == nil || o.StatusName == nil {
+		var ret string
+		return ret
+	}
+	return *o.StatusName
+}
+
+// GetStatusNameOk returns a tuple with the StatusName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CaseAttributes) GetStatusNameOk() (*string, bool) {
+	if o == nil || o.StatusName == nil {
+		return nil, false
+	}
+	return o.StatusName, true
+}
+
+// HasStatusName returns a boolean if a field has been set.
+func (o *CaseAttributes) HasStatusName() bool {
+	return o != nil && o.StatusName != nil
+}
+
+// SetStatusName gets a reference to the given string and assigns it to the StatusName field.
+func (o *CaseAttributes) SetStatusName(v string) {
+	o.StatusName = &v
+}
+
 // GetTitle returns the Title field value if set, zero value otherwise.
 func (o *CaseAttributes) GetTitle() string {
 	if o == nil || o.Title == nil {
@@ -593,6 +657,12 @@ func (o CaseAttributes) MarshalJSON() ([]byte, error) {
 	if o.Status != nil {
 		toSerialize["status"] = o.Status
 	}
+	if o.StatusGroup != nil {
+		toSerialize["status_group"] = o.StatusGroup
+	}
+	if o.StatusName != nil {
+		toSerialize["status_name"] = o.StatusName
+	}
 	if o.Title != nil {
 		toSerialize["title"] = o.Title
 	}
@@ -624,6 +694,8 @@ func (o *CaseAttributes) UnmarshalJSON(bytes []byte) (err error) {
 		Priority         *CasePriority                   `json:"priority,omitempty"`
 		ServiceNowTicket NullableServiceNowTicket        `json:"service_now_ticket,omitempty"`
 		Status           *CaseStatus                     `json:"status,omitempty"`
+		StatusGroup      *CaseStatusGroup                `json:"status_group,omitempty"`
+		StatusName       *string                         `json:"status_name,omitempty"`
 		Title            *string                         `json:"title,omitempty"`
 		Type             *CaseType                       `json:"type,omitempty"`
 		TypeId           *string                         `json:"type_id,omitempty"`
@@ -633,7 +705,7 @@ func (o *CaseAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"archived_at", "attributes", "closed_at", "created_at", "custom_attributes", "description", "jira_issue", "key", "modified_at", "priority", "service_now_ticket", "status", "title", "type", "type_id"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"archived_at", "attributes", "closed_at", "created_at", "custom_attributes", "description", "jira_issue", "key", "modified_at", "priority", "service_now_ticket", "status", "status_group", "status_name", "title", "type", "type_id"})
 	} else {
 		return err
 	}
@@ -659,6 +731,12 @@ func (o *CaseAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	} else {
 		o.Status = all.Status
 	}
+	if all.StatusGroup != nil && !all.StatusGroup.IsValid() {
+		hasInvalidField = true
+	} else {
+		o.StatusGroup = all.StatusGroup
+	}
+	o.StatusName = all.StatusName
 	o.Title = all.Title
 	if all.Type != nil && !all.Type.IsValid() {
 		hasInvalidField = true

api/datadogV2/model_case_create_attributes.go

@@ -18,6 +18,8 @@ type CaseCreateAttributes struct {
 	Description *string `json:"description,omitempty"`
 	// Case priority
 	Priority *CasePriority `json:"priority,omitempty"`
+	// Status of the case. Must be one of the existing statuses for the case's type.
+	StatusName *string `json:"status_name,omitempty"`
 	// Title
 	Title string `json:"title"`
 	// Case type UUID
@@ -134,6 +136,34 @@ func (o *CaseCreateAttributes) SetPriority(v CasePriority) {
 	o.Priority = &v
 }
 
+// GetStatusName returns the StatusName field value if set, zero value otherwise.
+func (o *CaseCreateAttributes) GetStatusName() string {
+	if o == nil || o.StatusName == nil {
+		var ret string
+		return ret
+	}
+	return *o.StatusName
+}
+
+// GetStatusNameOk returns a tuple with the StatusName field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *CaseCreateAttributes) GetStatusNameOk() (*string, bool) {
+	if o == nil || o.StatusName == nil {
+		return nil, false
+	}
+	return o.StatusName, true
+}
+
+// HasStatusName returns a boolean if a field has been set.
+func (o *CaseCreateAttributes) HasStatusName() bool {
+	return o != nil && o.StatusName != nil
+}
+
+// SetStatusName gets a reference to the given string and assigns it to the StatusName field.
+func (o *CaseCreateAttributes) SetStatusName(v string) {
+	o.StatusName = &v
+}
+
 // GetTitle returns the Title field value.
 func (o *CaseCreateAttributes) GetTitle() string {
 	if o == nil {
@@ -195,6 +225,9 @@ func (o CaseCreateAttributes) MarshalJSON() ([]byte, error) {
 	if o.Priority != nil {
 		toSerialize["priority"] = o.Priority
 	}
+	if o.StatusName != nil {
+		toSerialize["status_name"] = o.StatusName
+	}
 	toSerialize["title"] = o.Title
 	toSerialize["type_id"] = o.TypeId
 
@@ -210,6 +243,7 @@ func (o *CaseCreateAttributes) UnmarshalJSON(bytes []byte) (err error) {
 		CustomAttributes map[string]CustomAttributeValue `json:"custom_attributes,omitempty"`
 		Description      *string                         `json:"description,omitempty"`
 		Priority         *CasePriority                   `json:"priority,omitempty"`
+		StatusName       *string                         `json:"status_name,omitempty"`
 		Title            *string                         `json:"title"`
 		TypeId           *string                         `json:"type_id"`
 	}{}
@@ -224,7 +258,7 @@ func (o *CaseCreateAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"custom_attributes", "description", "priority", "title", "type_id"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"custom_attributes", "description", "priority", "status_name", "title", "type_id"})
 	} else {
 		return err
 	}
@@ -237,6 +271,7 @@ func (o *CaseCreateAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	} else {
 		o.Priority = all.Priority
 	}
+	o.StatusName = all.StatusName
 	o.Title = *all.Title
 	o.TypeId = *all.TypeId
 

api/datadogV2/model_case_status.go

@@ -10,7 +10,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CaseStatus Case status
+// CaseStatus Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead.
 type CaseStatus string
 
 // List of CaseStatus.

api/datadogV2/model_case_status_group.go

@@ -0,0 +1,68 @@
+// 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.
+
+package datadogV2
+
+import (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// CaseStatusGroup Status group of the case.
+type CaseStatusGroup string
+
+// List of CaseStatusGroup.
+const (
+	CASESTATUSGROUP_SG_OPEN        CaseStatusGroup = "SG_OPEN"
+	CASESTATUSGROUP_SG_IN_PROGRESS CaseStatusGroup = "SG_IN_PROGRESS"
+	CASESTATUSGROUP_SG_CLOSED      CaseStatusGroup = "SG_CLOSED"
+)
+
+var allowedCaseStatusGroupEnumValues = []CaseStatusGroup{
+	CASESTATUSGROUP_SG_OPEN,
+	CASESTATUSGROUP_SG_IN_PROGRESS,
+	CASESTATUSGROUP_SG_CLOSED,
+}
+
+// GetAllowedValues reeturns the list of possible values.
+func (v *CaseStatusGroup) GetAllowedValues() []CaseStatusGroup {
+	return allowedCaseStatusGroupEnumValues
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (v *CaseStatusGroup) UnmarshalJSON(src []byte) error {
+	var value string
+	err := datadog.Unmarshal(src, &value)
+	if err != nil {
+		return err
+	}
+	*v = CaseStatusGroup(value)
+	return nil
+}
+
+// NewCaseStatusGroupFromValue returns a pointer to a valid CaseStatusGroup
+// for the value passed as argument, or an error if the value passed is not allowed by the enum.
+func NewCaseStatusGroupFromValue(v string) (*CaseStatusGroup, error) {
+	ev := CaseStatusGroup(v)
+	if ev.IsValid() {
+		return &ev, nil
+	}
+	return nil, fmt.Errorf("invalid value '%v' for CaseStatusGroup: valid values are %v", v, allowedCaseStatusGroupEnumValues)
+}
+
+// IsValid return true if the value is valid for the enum, false otherwise.
+func (v CaseStatusGroup) IsValid() bool {
+	for _, existing := range allowedCaseStatusGroupEnumValues {
+		if existing == v {
+			return true
+		}
+	}
+	return false
+}
+
+// Ptr returns reference to CaseStatusGroup value.
+func (v CaseStatusGroup) Ptr() *CaseStatusGroup {
+	return &v
+}