Skip to content

Commit

Permalink
[OCM-5426] Add the /notify_details endpoint to the SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
Liran Roitman committed Jan 2, 2024
1 parent e832faa commit 7e0cbe7
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
23 changes: 23 additions & 0 deletions model/accounts_mgmt/v1/notify_details_resource.model
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
Copyright (c) 2024 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Manages the notify endpoint
resource NotifyDetails {
// Get Notification details about user related to subscription/cluster via email
method Add {
in out Body NotificationDetails
}
}
40 changes: 40 additions & 0 deletions model/accounts_mgmt/v1/notify_details_type.model
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
Copyright (c) 2024 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// This struct is a request to get a templated email to a user related to this
// subscription/cluster.
struct NotificationDetails {
// Indicates which Cluster (internal id) the resource type belongs to
ClusterID String

// Indicates which Cluster (external id) the resource type belongs to
ClusterUUID String

// Indicates which Subscription the resource type belongs to
SubscriptionID String

// The BCC address to be included on the email that is sent
BccAddress String

// The email subject
Subject String

// Indicates whether to include red hat associates in the email notification
IncludeRedHatAssociates Boolean

// Indicates whether the service log is internal only to RH
InternalOnly Boolean
}
5 changes: 5 additions & 0 deletions model/accounts_mgmt/v1/root_resource.model
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@ resource Root {
target Notify
}

// Reference to the resource that manages the notifications details.
locator NotifyDetails {
target NotifyDetails
}

// Reference to the resource that manages token authorization.
locator TokenAuthorization {
target TokenAuthorization
Expand Down

0 comments on commit 7e0cbe7

Please sign in to comment.