feat(app&service): enable provider to decline subscription request (#1171)

* added /api/apps/subscription/{subscriptionId}/decline
* added /api/services/subscription/{subscriptionId}/decline

------

Refs: #1140
Reviewed-by: Phil Schneider <[email protected]>

Author: tfjanjua

docs/api/apps-service.yaml

@@ -1838,6 +1838,52 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
         '401':
           description: The User is unauthorized
+  '/api/apps/subscription/{subscriptionId}/decline':
+    put:
+      tags:
+        - Apps
+      summary: 'Declines a pending app subscription. (Authorization required - Roles: decline_subscription)'
+      description: 'Example: PUT: /api/apps/subscription/{subscriptiondId}/decline'
+      parameters:
+        - name: subscriptionId
+          in: path
+          description: ID of the subscription to decline.
+          required: true
+          schema:
+            type: string
+            format: uuid
+          example: D3B1ECA2-6148-4008-9E6C-C1C2AEA5C645
+      responses:
+        '204':
+          description: App subscription was successfully declined.
+        '404':
+          description: 'If sub claim is empty/invalid or user does not exist, or any other parameters are invalid.'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '409':
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '400':
+          description: 'If sub claim is empty/invalid or user does not exist, or any other parameters are invalid.'
+        '401':
+          description: The User is unauthorized
   '/api/apps/{subscriptionId}/unsubscribe':
     put:
       tags:

docs/api/notifications-service.yaml

@@ -508,6 +508,8 @@ components:
         - CREDENTIAL_APPROVAL
         - CREDENTIAL_REJECTED
         - CREDENTIAL_EXPIRY
+        - APP_SUBSCRIPTION_DECLINE
+        - SERVICE_SUBSCRIPTION_DECLINE
       type: string
     SearchSemanticTypeId:
       enum:

docs/api/services-service.yaml

@@ -1514,6 +1514,52 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
         '401':
           description: The User is unauthorized
+  '/subscription/{subscriptionId}/decline':
+    put:
+      tags:
+        - Services
+      summary: 'Declines a pending service subscription. (Authorization required - Roles: decline_subscription)'
+      description: 'Example: PUT: /api/services/supscription/{subscriptiondId}/decline'
+      parameters:
+        - name: subscriptionId
+          in: path
+          description: ID of the subscription to decline.
+          required: true
+          schema:
+            type: string
+            format: uuid
+          example: D3B1ECA2-6148-4008-9E6C-C1C2AEA5C645
+      responses:
+        '204':
+          description: Service subscription was successfully declined.
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '409':
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal Server Error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '400':
+          description: 'If sub claim is empty/invalid or user does not exist, or any other parameters are invalid.'
+        '401':
+          description: The User is unauthorized
 components:
   schemas:
     AgreementConsentStatus:

src/mailing/Mailing.Template/EmailTemplates/app_subscription_decline.html

@@ -83,6 +83,12 @@ public enum EmailTemplateType
         [Path("appprovider_subscription_request.html")]
         AppSubscriptionRequest,
 
+        /// <summary>
+        /// Email template for notifying requester (subscriber) of subscription declination.
+        /// </summary>
+        [Path("app_subscription_decline.html")]
+        AppSubscriptionDecline,
+
         /// <summary>
         /// Email template for notifying app providers of subscription activition.
         /// </summary>
@@ -95,6 +101,12 @@ public enum EmailTemplateType
         [Path("serviceprovider_subscription_request.html")]
         ServiceSubscriptionRequest,
 
+        /// <summary>
+        /// Email template for notifying requester (subscriber) of subscription declination.
+        /// </summary>
+        [Path("service_subscription_decline.html")]
+        ServiceSubscriptionDecline,
+
         /// <summary>
         /// Email template for notifying requester of subscription activations.
         /// </summary>

src/mailing/Mailing.Template/EmailTemplates/service_subscription_decline.html

@@ -185,6 +185,10 @@ public async Task AddFavouriteAppForUserAsync(Guid appId)
     public Task<Guid> AddOwnCompanyAppSubscriptionAsync(Guid appId, IEnumerable<OfferAgreementConsentData> offerAgreementConsentData) =>
         _offerSubscriptionService.AddOfferSubscriptionAsync(appId, offerAgreementConsentData, OfferTypeId.APP, _settings.BasePortalAddress, _settings.SubscriptionManagerRoles, _settings.ServiceManagerRoles);
 
+    /// <inheritdoc/>
+    public Task DeclineAppSubscriptionAsync(Guid subscriptionId) =>
+        _offerSubscriptionService.RemoveOfferSubscriptionAsync(subscriptionId, OfferTypeId.APP, _settings.BasePortalAddress);
+
     /// <inheritdoc/>
     public Task TriggerActivateOfferSubscription(Guid subscriptionId) =>
         _offerSetupService.TriggerActivateSubscription(subscriptionId);

src/mailing/Mailing.Template/Enums/EmailTemplateType.cs

@@ -99,6 +99,12 @@ public interface IAppsBusinessLogic
     /// <param name="offerAgreementConsentData">The agreement consent data</param>
     public Task<Guid> AddOwnCompanyAppSubscriptionAsync(Guid appId, IEnumerable<OfferAgreementConsentData> offerAgreementConsentData);
 
+    /// <summary>
+    /// Declines a pending app subscription of an app, provided by the current user's company.
+    /// </summary>
+    /// <param name="subscriptionId">ID of the pending app to be declined.</param>
+    public Task DeclineAppSubscriptionAsync(Guid subscriptionId);
+
     /// <summary>
     /// Activates a pending app subscription for an app provided by the current user's company.
     /// </summary>

src/marketplace/Apps.Service/BusinessLogic/AppsBusinessLogic.cs

@@ -248,6 +248,31 @@ public async Task<IActionResult> ActivateOfferSubscription([FromRoute] Guid subs
         return NoContent();
     }
 
+    /// <summary>
+    /// Declines a pending app subscription.
+    /// </summary>
+    /// <param name="subscriptionId" example="D3B1ECA2-6148-4008-9E6C-C1C2AEA5C645">ID of the subscription to decline.</param>
+    /// <remarks>Example: PUT: /api/apps/subscription/{subscriptiondId}/decline</remarks>
+    /// <response code="204">App subscription was successfully declined.</response>
+    /// <response code="400">If sub claim is empty/invalid or user does not exist, or any other parameters are invalid.</response>
+    /// <response code="404">If sub claim is empty/invalid or user does not exist, or any other parameters are invalid.</response>
+    /// <response code="500">Internal Server Error.</response>
+    [HttpPut]
+    [Route("subscription/{subscriptionId}/decline")]
+    [Authorize(Roles = "decline_subscription")]
+    [Authorize(Policy = PolicyTypes.ValidIdentity)]
+    [Authorize(Policy = PolicyTypes.ValidCompany)]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    [ProducesResponseType(typeof(ErrorResponse), StatusCodes.Status404NotFound)]
+    [ProducesResponseType(typeof(ErrorResponse), StatusCodes.Status403Forbidden)]
+    [ProducesResponseType(typeof(ErrorResponse), StatusCodes.Status409Conflict)]
+    [ProducesResponseType(typeof(ErrorResponse), StatusCodes.Status500InternalServerError)]
+    public async Task<IActionResult> DeclineAppSubscriptionAsync([FromRoute] Guid subscriptionId)
+    {
+        await _appsBusinessLogic.DeclineAppSubscriptionAsync(subscriptionId).ConfigureAwait(ConfigureAwaitOptions.None);
+        return NoContent();
+    }
+
     /// <summary>
     /// Unsubscribes an app from the current user's company's subscriptions.
     /// </summary>

src/marketplace/Apps.Service/BusinessLogic/IAppsBusinessLogic.cs

@@ -0,0 +1,44 @@
+/********************************************************************************
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ********************************************************************************/
+
+using Org.Eclipse.TractusX.Portal.Backend.Framework.ErrorHandling.Service;
+using System.Collections.Immutable;
+
+namespace Org.Eclipse.TractusX.Portal.Backend.Offers.Library.ErrorHandling;
+
+public class OfferSubscriptionServiceErrorMessageContainer : IErrorMessageContainer
+{
+    private static readonly IReadOnlyDictionary<int, string> _messageContainer = new Dictionary<OfferSubscriptionServiceErrors, string> {
+                { OfferSubscriptionServiceErrors.OFFER_NOTFOUND, "Offer {offerId} does not exist." },
+                { OfferSubscriptionServiceErrors.SUBSCRIPTION_NOTFOUND, "Subscription {subscriptionId} does not exist." },
+                { OfferSubscriptionServiceErrors.NON_PROVIDER_IS_FORBIDDEN, "Only the providing company can decline the subscription request." },
+                { OfferSubscriptionServiceErrors.OFFER_STATUS_CONFLICT_INCORR_OFFER_STATUS, "Subscription of offer {offerName} should be in {offerStatus} state." },
+            }.ToImmutableDictionary(x => (int)x.Key, x => x.Value);
+
+    public Type Type { get => typeof(OfferSubscriptionServiceErrors); }
+    public IReadOnlyDictionary<int, string> MessageContainer { get => _messageContainer; }
+}
+
+public enum OfferSubscriptionServiceErrors
+{
+    OFFER_NOTFOUND,
+    SUBSCRIPTION_NOTFOUND,
+    NON_PROVIDER_IS_FORBIDDEN,
+    OFFER_STATUS_CONFLICT_INCORR_OFFER_STATUS
+}