Add conditional recipients to notification rule (#3375)

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

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

.generator/schemas/v2/openapi.yaml

@@ -29565,6 +29565,8 @@ components:
       additionalProperties: false
       description: Attributes of the monitor notification rule.
       properties:
+        conditional_recipients:
+          $ref: '#/components/schemas/MonitorNotificationRuleConditionalRecipients'
         filter:
           $ref: '#/components/schemas/MonitorNotificationRuleFilter'
         name:
@@ -29573,8 +29575,36 @@ components:
           $ref: '#/components/schemas/MonitorNotificationRuleRecipients'
       required:
       - name
+      type: object
+    MonitorNotificationRuleCondition:
+      description: Conditions for `conditional_recipients`.
+      properties:
+        recipients:
+          $ref: '#/components/schemas/MonitorNotificationRuleRecipients'
+        scope:
+          $ref: '#/components/schemas/MonitorNotificationRuleScope'
+      required:
+      - scope
       - recipients
       type: object
+    MonitorNotificationRuleConditionalRecipients:
+      description: Use conditional recipients to define different recipients for different
+        situations.
+      properties:
+        conditions:
+          description: Conditions of the notification rule.
+          items:
+            $ref: '#/components/schemas/MonitorNotificationRuleCondition'
+          maxItems: 10
+          minItems: 1
+          type: array
+        fallback_recipients:
+          $ref: '#/components/schemas/MonitorNotificationRuleRecipients'
+          description: If none of the `conditions` applied, `fallback_recipients`
+            will get notified.
+      required:
+      - conditions
+      type: object
     MonitorNotificationRuleCreateRequest:
       description: Request for creating a monitor notification rule.
       properties:
@@ -29714,6 +29744,8 @@ components:
       additionalProperties: {}
       description: Attributes of the monitor notification rule.
       properties:
+        conditional_recipients:
+          $ref: '#/components/schemas/MonitorNotificationRuleConditionalRecipients'
         created:
           description: Creation time of the monitor notification rule.
           example: 2020-01-02 03:04:00+00:00
@@ -29735,6 +29767,12 @@ components:
       description: An object related to a monitor notification rule.
       oneOf:
       - $ref: '#/components/schemas/User'
+    MonitorNotificationRuleScope:
+      description: The scope to which the monitor applied.
+      example: transition_type:alert
+      maxLength: 3000
+      minLength: 1
+      type: string
     MonitorNotificationRuleUpdateRequest:
       description: Request for updating a monitor notification rule.
       properties:

api/datadogV2/model_monitor_notification_rule_attributes.go

@@ -12,12 +12,14 @@ import (
 
 // MonitorNotificationRuleAttributes Attributes of the monitor notification rule.
 type MonitorNotificationRuleAttributes struct {
+	// Use conditional recipients to define different recipients for different situations.
+	ConditionalRecipients *MonitorNotificationRuleConditionalRecipients `json:"conditional_recipients,omitempty"`
 	// Filter used to associate the notification rule with monitors.
 	Filter *MonitorNotificationRuleFilter `json:"filter,omitempty"`
 	// The name of the monitor notification rule.
 	Name string `json:"name"`
 	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
-	Recipients []string `json:"recipients"`
+	Recipients []string `json:"recipients,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject map[string]interface{} `json:"-"`
 }
@@ -26,10 +28,9 @@ type MonitorNotificationRuleAttributes struct {
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed.
-func NewMonitorNotificationRuleAttributes(name string, recipients []string) *MonitorNotificationRuleAttributes {
+func NewMonitorNotificationRuleAttributes(name string) *MonitorNotificationRuleAttributes {
 	this := MonitorNotificationRuleAttributes{}
 	this.Name = name
-	this.Recipients = recipients
 	return &this
 }
 
@@ -41,6 +42,34 @@ func NewMonitorNotificationRuleAttributesWithDefaults() *MonitorNotificationRule
 	return &this
 }
 
+// GetConditionalRecipients returns the ConditionalRecipients field value if set, zero value otherwise.
+func (o *MonitorNotificationRuleAttributes) GetConditionalRecipients() MonitorNotificationRuleConditionalRecipients {
+	if o == nil || o.ConditionalRecipients == nil {
+		var ret MonitorNotificationRuleConditionalRecipients
+		return ret
+	}
+	return *o.ConditionalRecipients
+}
+
+// GetConditionalRecipientsOk returns a tuple with the ConditionalRecipients field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *MonitorNotificationRuleAttributes) GetConditionalRecipientsOk() (*MonitorNotificationRuleConditionalRecipients, bool) {
+	if o == nil || o.ConditionalRecipients == nil {
+		return nil, false
+	}
+	return o.ConditionalRecipients, true
+}
+
+// HasConditionalRecipients returns a boolean if a field has been set.
+func (o *MonitorNotificationRuleAttributes) HasConditionalRecipients() bool {
+	return o != nil && o.ConditionalRecipients != nil
+}
+
+// SetConditionalRecipients gets a reference to the given MonitorNotificationRuleConditionalRecipients and assigns it to the ConditionalRecipients field.
+func (o *MonitorNotificationRuleAttributes) SetConditionalRecipients(v MonitorNotificationRuleConditionalRecipients) {
+	o.ConditionalRecipients = &v
+}
+
 // GetFilter returns the Filter field value if set, zero value otherwise.
 func (o *MonitorNotificationRuleAttributes) GetFilter() MonitorNotificationRuleFilter {
 	if o == nil || o.Filter == nil {
@@ -92,25 +121,30 @@ func (o *MonitorNotificationRuleAttributes) SetName(v string) {
 	o.Name = v
 }
 
-// GetRecipients returns the Recipients field value.
+// GetRecipients returns the Recipients field value if set, zero value otherwise.
 func (o *MonitorNotificationRuleAttributes) GetRecipients() []string {
-	if o == nil {
+	if o == nil || o.Recipients == nil {
 		var ret []string
 		return ret
 	}
 	return o.Recipients
 }
 
-// GetRecipientsOk returns a tuple with the Recipients field value
+// GetRecipientsOk returns a tuple with the Recipients field value if set, nil otherwise
 // and a boolean to check if the value has been set.
 func (o *MonitorNotificationRuleAttributes) GetRecipientsOk() (*[]string, bool) {
-	if o == nil {
+	if o == nil || o.Recipients == nil {
 		return nil, false
 	}
 	return &o.Recipients, true
 }
 
-// SetRecipients sets field value.
+// HasRecipients returns a boolean if a field has been set.
+func (o *MonitorNotificationRuleAttributes) HasRecipients() bool {
+	return o != nil && o.Recipients != nil
+}
+
+// SetRecipients gets a reference to the given []string and assigns it to the Recipients field.
 func (o *MonitorNotificationRuleAttributes) SetRecipients(v []string) {
 	o.Recipients = v
 }
@@ -121,33 +155,46 @@ func (o MonitorNotificationRuleAttributes) MarshalJSON() ([]byte, error) {
 	if o.UnparsedObject != nil {
 		return datadog.Marshal(o.UnparsedObject)
 	}
+	if o.ConditionalRecipients != nil {
+		toSerialize["conditional_recipients"] = o.ConditionalRecipients
+	}
 	if o.Filter != nil {
 		toSerialize["filter"] = o.Filter
 	}
 	toSerialize["name"] = o.Name
-	toSerialize["recipients"] = o.Recipients
+	if o.Recipients != nil {
+		toSerialize["recipients"] = o.Recipients
+	}
 	return datadog.Marshal(toSerialize)
 }
 
 // UnmarshalJSON deserializes the given payload.
 func (o *MonitorNotificationRuleAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Filter     *MonitorNotificationRuleFilter `json:"filter,omitempty"`
-		Name       *string                        `json:"name"`
-		Recipients *[]string                      `json:"recipients"`
+		ConditionalRecipients *MonitorNotificationRuleConditionalRecipients `json:"conditional_recipients,omitempty"`
+		Filter                *MonitorNotificationRuleFilter                `json:"filter,omitempty"`
+		Name                  *string                                       `json:"name"`
+		Recipients            []string                                      `json:"recipients,omitempty"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
 	}
 	if all.Name == nil {
 		return fmt.Errorf("required field name missing")
 	}
-	if all.Recipients == nil {
-		return fmt.Errorf("required field recipients missing")
+
+	hasInvalidField := false
+	if all.ConditionalRecipients != nil && all.ConditionalRecipients.UnparsedObject != nil && o.UnparsedObject == nil {
+		hasInvalidField = true
 	}
+	o.ConditionalRecipients = all.ConditionalRecipients
 	o.Filter = all.Filter
 	o.Name = *all.Name
-	o.Recipients = *all.Recipients
+	o.Recipients = all.Recipients
+
+	if hasInvalidField {
+		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	}
 
 	return nil
 }

api/datadogV2/model_monitor_notification_rule_condition.go

@@ -0,0 +1,133 @@
+// 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"
+)
+
+// MonitorNotificationRuleCondition Conditions for `conditional_recipients`.
+type MonitorNotificationRuleCondition struct {
+	// A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
+	Recipients []string `json:"recipients"`
+	// The scope to which the monitor applied.
+	Scope string `json:"scope"`
+	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
+	UnparsedObject       map[string]interface{} `json:"-"`
+	AdditionalProperties map[string]interface{} `json:"-"`
+}
+
+// NewMonitorNotificationRuleCondition instantiates a new MonitorNotificationRuleCondition object.
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed.
+func NewMonitorNotificationRuleCondition(recipients []string, scope string) *MonitorNotificationRuleCondition {
+	this := MonitorNotificationRuleCondition{}
+	this.Recipients = recipients
+	this.Scope = scope
+	return &this
+}
+
+// NewMonitorNotificationRuleConditionWithDefaults instantiates a new MonitorNotificationRuleCondition object.
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set.
+func NewMonitorNotificationRuleConditionWithDefaults() *MonitorNotificationRuleCondition {
+	this := MonitorNotificationRuleCondition{}
+	return &this
+}
+
+// GetRecipients returns the Recipients field value.
+func (o *MonitorNotificationRuleCondition) GetRecipients() []string {
+	if o == nil {
+		var ret []string
+		return ret
+	}
+	return o.Recipients
+}
+
+// GetRecipientsOk returns a tuple with the Recipients field value
+// and a boolean to check if the value has been set.
+func (o *MonitorNotificationRuleCondition) GetRecipientsOk() (*[]string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.Recipients, true
+}
+
+// SetRecipients sets field value.
+func (o *MonitorNotificationRuleCondition) SetRecipients(v []string) {
+	o.Recipients = v
+}
+
+// GetScope returns the Scope field value.
+func (o *MonitorNotificationRuleCondition) GetScope() string {
+	if o == nil {
+		var ret string
+		return ret
+	}
+	return o.Scope
+}
+
+// GetScopeOk returns a tuple with the Scope field value
+// and a boolean to check if the value has been set.
+func (o *MonitorNotificationRuleCondition) GetScopeOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.Scope, true
+}
+
+// SetScope sets field value.
+func (o *MonitorNotificationRuleCondition) SetScope(v string) {
+	o.Scope = v
+}
+
+// MarshalJSON serializes the struct using spec logic.
+func (o MonitorNotificationRuleCondition) MarshalJSON() ([]byte, error) {
+	toSerialize := map[string]interface{}{}
+	if o.UnparsedObject != nil {
+		return datadog.Marshal(o.UnparsedObject)
+	}
+	toSerialize["recipients"] = o.Recipients
+	toSerialize["scope"] = o.Scope
+
+	for key, value := range o.AdditionalProperties {
+		toSerialize[key] = value
+	}
+	return datadog.Marshal(toSerialize)
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (o *MonitorNotificationRuleCondition) UnmarshalJSON(bytes []byte) (err error) {
+	all := struct {
+		Recipients *[]string `json:"recipients"`
+		Scope      *string   `json:"scope"`
+	}{}
+	if err = datadog.Unmarshal(bytes, &all); err != nil {
+		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	}
+	if all.Recipients == nil {
+		return fmt.Errorf("required field recipients missing")
+	}
+	if all.Scope == nil {
+		return fmt.Errorf("required field scope missing")
+	}
+	additionalProperties := make(map[string]interface{})
+	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
+		datadog.DeleteKeys(additionalProperties, &[]string{"recipients", "scope"})
+	} else {
+		return err
+	}
+	o.Recipients = *all.Recipients
+	o.Scope = *all.Scope
+
+	if len(additionalProperties) > 0 {
+		o.AdditionalProperties = additionalProperties
+	}
+
+	return nil
+}