platformnotificationsv1

type Acknowledgement struct {
	// Indicates whether the user has unread notifications.
	HasUnread *bool `json:"has_unread" validate:"required"`

	// The timestamp of the last acknowledgement.
	LastAcknowledged *int64 `json:"last_acknowledged" validate:"required"`
}

type AddDestination struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id,omitempty"`

	// The type of the destination.
	DestinationType *string `json:"destination_type,omitempty"`
}

type AddDestinationCollection struct {
	// Array of destination entries.
	Destinations []AddDestinationIntf `json:"destinations" validate:"required"`
}

type AddDestinationEventNotificationDestination struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id" validate:"required"`

	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`
}

type AddDestinationIntf interface {
	// contains filtered or unexported methods
}

type AddDestinationPrototype struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id,omitempty"`

	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`
}

type AddDestinationPrototypeEventNotificationDestinationPrototype struct {
	// The GUID of the Event Notifications instance.
	DestinationID *strfmt.UUID `json:"destination_id" validate:"required"`

	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`
}

type AddDestinationPrototypeIntf interface {
	// contains filtered or unexported methods
}

type CreateDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	AddDestinationPrototype AddDestinationPrototypeIntf `json:"AddDestinationPrototype" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type CreatePreferencesOptions struct {
	// The IAM ID of the user. Must match the IAM ID in the bearer token.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// Preference settings for notification types that support updates.
	IncidentSeverity1 *PreferenceValueWithUpdates `json:"incident_severity1,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity2 *PreferenceValueWithUpdates `json:"incident_severity2,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity3 *PreferenceValueWithUpdates `json:"incident_severity3,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity4 *PreferenceValueWithUpdates `json:"incident_severity4,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceHigh *PreferenceValueWithUpdates `json:"maintenance_high,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceMedium *PreferenceValueWithUpdates `json:"maintenance_medium,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceLow *PreferenceValueWithUpdates `json:"maintenance_low,omitempty"`

	// Preference settings for notification types that do not support updates.
	AnnouncementsMajor *PreferenceValueWithoutUpdates `json:"announcements_major,omitempty"`

	// Preference settings for notification types that do not support updates.
	AnnouncementsMinor *PreferenceValueWithoutUpdates `json:"announcements_minor,omitempty"`

	// Preference settings for notification types that do not support updates.
	SecurityNormal *PreferenceValueWithoutUpdates `json:"security_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	AccountNormal *PreferenceValueWithoutUpdates `json:"account_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageOrder *PreferenceValueWithoutUpdates `json:"billing_and_usage_order,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageInvoices *PreferenceValueWithoutUpdates `json:"billing_and_usage_invoices,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsagePayments *PreferenceValueWithoutUpdates `json:"billing_and_usage_payments,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageSubscriptionsAndPromoCodes *PreferenceValueWithoutUpdates `json:"billing_and_usage_subscriptions_and_promo_codes,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageSpendingAlerts *PreferenceValueWithoutUpdates `json:"billing_and_usage_spending_alerts,omitempty"`

	// Preference settings for notification types that do not support updates.
	ResourceactivityNormal *PreferenceValueWithoutUpdates `json:"resourceactivity_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingReview *PreferenceValueWithoutUpdates `json:"ordering_review,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApproved *PreferenceValueWithoutUpdates `json:"ordering_approved,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApprovedVsi *PreferenceValueWithoutUpdates `json:"ordering_approved_vsi,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApprovedServer *PreferenceValueWithoutUpdates `json:"ordering_approved_server,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningReloadComplete *PreferenceValueWithoutUpdates `json:"provisioning_reload_complete,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningCompleteVsi *PreferenceValueWithoutUpdates `json:"provisioning_complete_vsi,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningCompleteServer *PreferenceValueWithoutUpdates `json:"provisioning_complete_server,omitempty"`

	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type DeleteDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type DeleteNotificationPreferencesOptions struct {
	// The IAM ID of the user. Must match the IAM ID in the bearer token.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type GetAcknowledgementOptions struct {
	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type GetDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type GetPreferencesOptions struct {
	// The IAM ID of the user. Must match the IAM ID in the bearer token.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type ListDistributionListDestinationsOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type ListNotificationsOptions struct {
	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// An opaque page token that specifies the resource to start the page on or after. If unspecified, the first page of
	// results is returned.
	Start *string `json:"start,omitempty"`

	// The maximum number of items to return per page. If unspecified, a default limit of 50 is used.
	Limit *int64 `json:"limit,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type Notification struct {
	// The title of the notification.
	Title *string `json:"title" validate:"required"`

	// The body content of the notification.
	Body *string `json:"body" validate:"required"`

	// The unique identifier for the notification.
	ID *string `json:"id" validate:"required"`

	// The category of the notification.
	Category *string `json:"category" validate:"required"`

	// Array of component/service names affected by this notification.
	ComponentNames []string `json:"component_names" validate:"required"`

	// The start time of the notification in Unix timestamp (seconds).
	StartTime *int64 `json:"start_time,omitempty"`

	// Indicates if the notification is global.
	IsGlobal *bool `json:"is_global" validate:"required"`

	// The current state of the notification.
	State *string `json:"state,omitempty"`

	// Array of region identifiers affected by this notification.
	Regions []string `json:"regions" validate:"required"`

	// Array of CRN masks that define the scope of affected resources.
	CrnMasks []string `json:"crn_masks" validate:"required"`

	// The record identifier for tracking purposes.
	RecordID *string `json:"record_id,omitempty"`

	// The source identifier of the notification.
	SourceID *string `json:"source_id,omitempty"`

	// The completion code of the notification.
	CompletionCode *string `json:"completion_code,omitempty"`

	// The end time of the notification in Unix timestamp (seconds).
	EndTime *int64 `json:"end_time,omitempty"`

	// The last update time of the notification in Unix timestamp (seconds).
	UpdateTime *int64 `json:"update_time,omitempty"`

	// The severity level of the notification (0-3). The display value depends on the notification type:
	//
	// **Incidents:**
	// - 1 = Severity 1
	// - 2 = Severity 2
	// - 3 = Severity 3
	// - 0 = Severity 4
	//
	// **Maintenance:**
	// - 1 = High
	// - 2 = Medium
	// - 3 = Low
	//
	// **Announcements:**
	// - 1 = Major
	// - 0 = Minor.
	Severity *int64 `json:"severity" validate:"required"`

	// Lucene query string for filtering affected resources. Only present when instance targets are specified and
	// resource_link is not available. Mutually exclusive with resource_link.
	LuceneQuery *string `json:"lucene_query,omitempty"`

	// Link to additional resource information or documentation. Takes precedence over lucene_query when both are
	// available. Mutually exclusive with lucene_query.
	ResourceLink *string `json:"resource_link,omitempty"`

	// The timestamp when the notification was created.
	CreationTimestamp *int64 `json:"creation_timestamp" validate:"required"`
}

type NotificationCollection struct {
	// The maximum number of items returned in this response.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of notifications in the collection.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// A pagination link object containing the URL to a page.
	First *PaginationLink `json:"first" validate:"required"`

	// A pagination link object with a page token. Used for next, previous, and last page links.
	Previous *PaginationLinkWithToken `json:"previous,omitempty"`

	// A pagination link object with a page token. Used for next, previous, and last page links.
	Next *PaginationLinkWithToken `json:"next,omitempty"`

	// A pagination link object with a page token. Used for next, previous, and last page links.
	Last *PaginationLinkWithToken `json:"last,omitempty"`

	// Array of notification entries.
	Notifications []Notification `json:"notifications" validate:"required"`
}

type NotificationsPager struct {
	// contains filtered or unexported fields
}

type PaginationLink struct {
	// The full URL path to the page.
	Href *string `json:"href" validate:"required"`
}

type PaginationLinkWithToken struct {
	// Complete URL to the page.
	Href *string `json:"href" validate:"required"`

	// Opaque page token that can be used to retrieve the page.
	Start *string `json:"start" validate:"required"`
}

type PlatformNotificationsV1 struct {
	Service *core.BaseService
}

type PlatformNotificationsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

type PreferenceValueWithUpdates struct {
	// Array of communication channels for this preference.
	Channels []string `json:"channels" validate:"required"`

	// Whether to receive updates for this preference. Optional, defaults to false if not provided.
	Updates *bool `json:"updates,omitempty"`
}

type PreferenceValueWithoutUpdates struct {
	// Array of communication channels for this preference.
	Channels []string `json:"channels" validate:"required"`
}

type PreferencesObject struct {
	// Preference settings for notification types that support updates.
	IncidentSeverity1 *PreferenceValueWithUpdates `json:"incident_severity1,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity2 *PreferenceValueWithUpdates `json:"incident_severity2,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity3 *PreferenceValueWithUpdates `json:"incident_severity3,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity4 *PreferenceValueWithUpdates `json:"incident_severity4,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceHigh *PreferenceValueWithUpdates `json:"maintenance_high,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceMedium *PreferenceValueWithUpdates `json:"maintenance_medium,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceLow *PreferenceValueWithUpdates `json:"maintenance_low,omitempty"`

	// Preference settings for notification types that do not support updates.
	AnnouncementsMajor *PreferenceValueWithoutUpdates `json:"announcements_major,omitempty"`

	// Preference settings for notification types that do not support updates.
	AnnouncementsMinor *PreferenceValueWithoutUpdates `json:"announcements_minor,omitempty"`

	// Preference settings for notification types that do not support updates.
	SecurityNormal *PreferenceValueWithoutUpdates `json:"security_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	AccountNormal *PreferenceValueWithoutUpdates `json:"account_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageOrder *PreferenceValueWithoutUpdates `json:"billing_and_usage_order,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageInvoices *PreferenceValueWithoutUpdates `json:"billing_and_usage_invoices,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsagePayments *PreferenceValueWithoutUpdates `json:"billing_and_usage_payments,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageSubscriptionsAndPromoCodes *PreferenceValueWithoutUpdates `json:"billing_and_usage_subscriptions_and_promo_codes,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageSpendingAlerts *PreferenceValueWithoutUpdates `json:"billing_and_usage_spending_alerts,omitempty"`

	// Preference settings for notification types that do not support updates.
	ResourceactivityNormal *PreferenceValueWithoutUpdates `json:"resourceactivity_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingReview *PreferenceValueWithoutUpdates `json:"ordering_review,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApproved *PreferenceValueWithoutUpdates `json:"ordering_approved,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApprovedVsi *PreferenceValueWithoutUpdates `json:"ordering_approved_vsi,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApprovedServer *PreferenceValueWithoutUpdates `json:"ordering_approved_server,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningReloadComplete *PreferenceValueWithoutUpdates `json:"provisioning_reload_complete,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningCompleteVsi *PreferenceValueWithoutUpdates `json:"provisioning_complete_vsi,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningCompleteServer *PreferenceValueWithoutUpdates `json:"provisioning_complete_server,omitempty"`
}

type ReplaceNotificationAcknowledgementOptions struct {
	// The timestamp of the last acknowledgement.
	LastAcknowledged *int64 `json:"last_acknowledged" validate:"required"`

	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type ReplaceNotificationPreferencesOptions struct {
	// The IAM ID of the user. Must match the IAM ID in the bearer token.
	IamID *string `json:"iam_id" validate:"required,ne="`

	// Preference settings for notification types that support updates.
	IncidentSeverity1 *PreferenceValueWithUpdates `json:"incident_severity1,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity2 *PreferenceValueWithUpdates `json:"incident_severity2,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity3 *PreferenceValueWithUpdates `json:"incident_severity3,omitempty"`

	// Preference settings for notification types that support updates.
	IncidentSeverity4 *PreferenceValueWithUpdates `json:"incident_severity4,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceHigh *PreferenceValueWithUpdates `json:"maintenance_high,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceMedium *PreferenceValueWithUpdates `json:"maintenance_medium,omitempty"`

	// Preference settings for notification types that support updates.
	MaintenanceLow *PreferenceValueWithUpdates `json:"maintenance_low,omitempty"`

	// Preference settings for notification types that do not support updates.
	AnnouncementsMajor *PreferenceValueWithoutUpdates `json:"announcements_major,omitempty"`

	// Preference settings for notification types that do not support updates.
	AnnouncementsMinor *PreferenceValueWithoutUpdates `json:"announcements_minor,omitempty"`

	// Preference settings for notification types that do not support updates.
	SecurityNormal *PreferenceValueWithoutUpdates `json:"security_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	AccountNormal *PreferenceValueWithoutUpdates `json:"account_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageOrder *PreferenceValueWithoutUpdates `json:"billing_and_usage_order,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageInvoices *PreferenceValueWithoutUpdates `json:"billing_and_usage_invoices,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsagePayments *PreferenceValueWithoutUpdates `json:"billing_and_usage_payments,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageSubscriptionsAndPromoCodes *PreferenceValueWithoutUpdates `json:"billing_and_usage_subscriptions_and_promo_codes,omitempty"`

	// Preference settings for notification types that do not support updates.
	BillingAndUsageSpendingAlerts *PreferenceValueWithoutUpdates `json:"billing_and_usage_spending_alerts,omitempty"`

	// Preference settings for notification types that do not support updates.
	ResourceactivityNormal *PreferenceValueWithoutUpdates `json:"resourceactivity_normal,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingReview *PreferenceValueWithoutUpdates `json:"ordering_review,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApproved *PreferenceValueWithoutUpdates `json:"ordering_approved,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApprovedVsi *PreferenceValueWithoutUpdates `json:"ordering_approved_vsi,omitempty"`

	// Preference settings for notification types that do not support updates.
	OrderingApprovedServer *PreferenceValueWithoutUpdates `json:"ordering_approved_server,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningReloadComplete *PreferenceValueWithoutUpdates `json:"provisioning_reload_complete,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningCompleteVsi *PreferenceValueWithoutUpdates `json:"provisioning_complete_vsi,omitempty"`

	// Preference settings for notification types that do not support updates.
	ProvisioningCompleteServer *PreferenceValueWithoutUpdates `json:"provisioning_complete_server,omitempty"`

	// The IBM Cloud account ID. If not provided, the account ID from the bearer token will be used.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}

type TestDestinationRequestBodyPrototype struct {
	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`

	// The type of the notification to test.
	NotificationType *string `json:"notification_type,omitempty"`
}

type TestDestinationRequestBodyPrototypeIntf interface {
	// contains filtered or unexported methods
}

type TestDestinationRequestBodyPrototypeTestEventNotificationDestinationRequestBodyPrototype struct {
	// The type of the destination.
	DestinationType *string `json:"destination_type" validate:"required"`

	// The type of the notification to test.
	NotificationType *string `json:"notification_type" validate:"required"`
}

type TestDestinationResponseBody struct {
	// The status message that indicates the test result.
	Message *string `json:"message" validate:"required"`
}

type TestDistributionListDestinationOptions struct {
	// The IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The ID of the destination.
	DestinationID *string `json:"destination_id" validate:"required,ne="`

	TestDestinationRequestBodyPrototype TestDestinationRequestBodyPrototypeIntf `json:"TestDestinationRequestBodyPrototype" validate:"required"`

	// Allows users to set headers on API requests.
	Headers map[string]string
}