Added Notifications APIs|| Refactored Class and Role names

Durdush · Aug 19, 2023 · d08bb33 · d08bb33
1 parent ee78c9c
commit d08bb33
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 33 deletions.
diff --git a/src/main/java/com/crowdin/client/notifications/NotificationsApi.java b/src/main/java/com/crowdin/client/notifications/NotificationsApi.java
@@ -6,9 +6,9 @@
 import com.crowdin.client.core.http.exceptions.HttpException;
 import com.crowdin.client.core.model.ClientConfig;
 import com.crowdin.client.core.model.Credentials;
-import com.crowdin.client.notifications.model.NotificationRequestToAuthenticatedUsers;
-import com.crowdin.client.notifications.model.NotificationRequestToOrganizationMembers;
-import com.crowdin.client.notifications.model.NotificationRequestToProjectMember;
+import com.crowdin.client.notifications.model.SendNotificationToAuthenticatedUserRequest;
+import com.crowdin.client.notifications.model.SendNotificationToOrganizationMembersRequest;
+import com.crowdin.client.notifications.model.SendNotificationToProjectMemberRequest;
 
 public class NotificationsApi extends  CrowdinApi {
     public NotificationsApi(Credentials credentials) {
@@ -23,10 +23,9 @@ public NotificationsApi(Credentials credentials, ClientConfig clientConfig) {
      * @param request request object
      * @see <ul>
      * <li><a href="https://developer.crowdin.com/api/v2/#tag/Notifications/api.projects.notification.post" target="_blank"><b>API Documentation</b></a></li>
-     * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#tag/Notifications/api.projects.notification.post" target="_blank"><b>Enterprise API Documentation</b></a></li>
      * </ul>
      */
-    public void sendNotificationToAuthenticatedUser(NotificationRequestToAuthenticatedUsers request) throws HttpException, HttpBadRequestException {
+    public void sendNotificationToAuthenticatedUser(SendNotificationToAuthenticatedUserRequest request) throws HttpException, HttpBadRequestException {
         String builtUrl = String.format("%s/notify", this.url);
         this.httpClient.post(builtUrl, request, new HttpRequestConfig(), Void.class);
     }
@@ -39,19 +38,18 @@ public void sendNotificationToAuthenticatedUser(NotificationRequestToAuthenticat
      * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.notify.post" target="_blank"><b>Enterprise API Documentation</b></a></li>
      * </ul>
      */
-    public void sendNotificationToProjectMembers(Long projectId, NotificationRequestToProjectMember request) throws HttpException, HttpBadRequestException {
+    public void sendNotificationToProjectMembers(Long projectId, SendNotificationToProjectMemberRequest request) throws HttpException, HttpBadRequestException {
         String builtUrl = String.format("%s/projects/%d/notify", this.url, projectId);
         this.httpClient.post(builtUrl, request, new HttpRequestConfig(), Void.class);
     }
 
     /**
      * @param request request object
      * @see <ul>
-     * <li><a href="https://developer.crowdin.com/api/v2/#operation/api.notify.post" target="_blank"><b>API Documentation</b></a></li>
      * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.notify.post" target="_blank"><b>Enterprise API Documentation</b></a></li>
      * </ul>
      */
-    public void sendNotificationToOrganizationMembers(NotificationRequestToOrganizationMembers request) throws HttpException, HttpBadRequestException {
+    public void sendNotificationToOrganizationMembers(SendNotificationToOrganizationMembersRequest request) throws HttpException, HttpBadRequestException {
         String builtUrl = String.format("%s/notify", this.url);
         this.httpClient.post(builtUrl, request, new HttpRequestConfig(), Void.class);
     }

diff --git a/...java/com/crowdin/client/notifications/model/NotificationRequestToOrganizationMembers.java b/...java/com/crowdin/client/notifications/model/NotificationRequestToOrganizationMembers.java
diff --git a/src/main/java/com/crowdin/client/notifications/model/NotificationRequestToProjectMember.java b/src/main/java/com/crowdin/client/notifications/model/NotificationRequestToProjectMember.java
diff --git a/...ificationRequestToAuthenticatedUsers.java → ...tificationToAuthenticatedUserRequest.java b/...ificationRequestToAuthenticatedUsers.java → ...tificationToAuthenticatedUserRequest.java
@@ -3,6 +3,6 @@
 import lombok.Data;
 
 @Data
-public class NotificationRequestToAuthenticatedUsers {
+public class SendNotificationToAuthenticatedUserRequest {
     private String message;
 }
diff --git a/...onRequestToOrganizationMembersByRole.java → ...onToOrganizationMembersByRoleRequest.java b/...onRequestToOrganizationMembersByRole.java → ...onToOrganizationMembersByRoleRequest.java
@@ -3,7 +3,7 @@
 import lombok.Data;
 
 @Data
-public class NotificationRequestToOrganizationMembersByRole extends  NotificationRequestToOrganizationMembers{
+public class SendNotificationToOrganizationMembersByRoleRequest extends SendNotificationToOrganizationMembersRequest {
     private String role;
     private String message;
 }
diff --git a/...equestToOrganizationMembersByUserIds.java → ...oOrganizationMembersByUserIdsRequest.java b/...equestToOrganizationMembersByUserIds.java → ...oOrganizationMembersByUserIdsRequest.java
@@ -5,7 +5,7 @@
 import java.util.List;
 
 @Data
-public class NotificationRequestToOrganizationMembersByUserIds extends  NotificationRequestToOrganizationMembers{
+public class SendNotificationToOrganizationMembersByUserIdsRequest extends SendNotificationToOrganizationMembersRequest {
     private List<Long> userIds;
     private String message;
 }
diff --git a/.../com/crowdin/client/notifications/model/SendNotificationToOrganizationMembersRequest.java b/.../com/crowdin/client/notifications/model/SendNotificationToOrganizationMembersRequest.java
@@ -0,0 +1,4 @@
+package com.crowdin.client.notifications.model;
+
+public abstract class SendNotificationToOrganizationMembersRequest {
+}
diff --git a/...ficationRequestToProjectMemberByRole.java → ...ficationToProjectMemberByRoleRequest.java b/...ficationRequestToProjectMemberByRole.java → ...ficationToProjectMemberByRoleRequest.java
@@ -3,7 +3,7 @@
 import lombok.Data;
 
 @Data
-public class NotificationRequestToProjectMemberByRole extends NotificationRequestToProjectMember {
+public class SendNotificationToProjectMemberByRoleRequest extends SendNotificationToProjectMemberRequest {
     private String role;
     private String message;
 }
diff --git a/...ationRequestToProjectMemberByUserIds.java → ...ationToProjectMemberByUserIdsRequest.java b/...ationRequestToProjectMemberByUserIds.java → ...ationToProjectMemberByUserIdsRequest.java
@@ -5,7 +5,7 @@
 import java.util.List;
 
 @Data
-public class NotificationRequestToProjectMemberByUserIds extends NotificationRequestToProjectMember {
+public class SendNotificationToProjectMemberByUserIdsRequest extends SendNotificationToProjectMemberRequest {
     private List<Long> userIds;
     private String message;
 }
diff --git a/...n/java/com/crowdin/client/notifications/model/SendNotificationToProjectMemberRequest.java b/...n/java/com/crowdin/client/notifications/model/SendNotificationToProjectMemberRequest.java
@@ -0,0 +1,4 @@
+package com.crowdin.client.notifications.model;
+
+public abstract class SendNotificationToProjectMemberRequest {
+}
diff --git a/src/test/java/com/crowdin/client/notifications/NotificationsApiTest.java b/src/test/java/com/crowdin/client/notifications/NotificationsApiTest.java
@@ -2,13 +2,9 @@
 
 import com.crowdin.client.framework.RequestMock;
 import com.crowdin.client.framework.TestClient;
-import com.crowdin.client.notifications.model.NotificationRequestToAuthenticatedUsers;
-import com.crowdin.client.notifications.model.NotificationRequestToOrganizationMembers;
-import com.crowdin.client.notifications.model.NotificationRequestToOrganizationMembersByRole;
-import com.crowdin.client.notifications.model.NotificationRequestToOrganizationMembersByUserIds;
-import com.crowdin.client.notifications.model.NotificationRequestToProjectMember;
-import com.crowdin.client.notifications.model.NotificationRequestToProjectMemberByRole;
-import com.crowdin.client.notifications.model.NotificationRequestToProjectMemberByUserIds;
+import com.crowdin.client.notifications.model.SendNotificationToAuthenticatedUserRequest;
+import com.crowdin.client.notifications.model.SendNotificationToProjectMemberRequest;
+import com.crowdin.client.notifications.model.SendNotificationToProjectMemberByRoleRequest;
 import org.apache.http.client.methods.HttpPost;
 import org.junit.jupiter.api.Test;
 
@@ -29,7 +25,7 @@ public List<RequestMock> getMocks() {
 
     @Test
     public void sendNotificationToAuthenticatedUserTest(){
-        NotificationRequestToAuthenticatedUsers request = new NotificationRequestToAuthenticatedUsers(){{
+        SendNotificationToAuthenticatedUserRequest request = new SendNotificationToAuthenticatedUserRequest(){{
             setMessage("Hiii...");
         }};
         this.getNotificationsApi().sendNotificationToAuthenticatedUser(request);
@@ -38,8 +34,8 @@ public void sendNotificationToAuthenticatedUserTest(){
 
     @Test
     public void sendNotificationToProjectMembersByRole(){
-        NotificationRequestToProjectMember request = new NotificationRequestToProjectMemberByRole(){{
-                setRole("Admin");
+        SendNotificationToProjectMemberRequest request = new SendNotificationToProjectMemberByRoleRequest(){{
+                setRole("owner");
                 setMessage("Hiii...");
             }};
         this.getNotificationsApi().sendNotificationToProjectMembers(projectId,request);

diff --git a/src/test/resources/api/notifications/notificationRequestToOrganizationMembersByRole.json b/src/test/resources/api/notifications/notificationRequestToOrganizationMembersByRole.json
@@ -1,4 +1,4 @@
 {
-  "role": "Admin",
+  "role": "owner",
   "message": "New notification message to Admin"
 }
diff --git a/src/test/resources/api/notifications/notificationRequestToProjectMembersByRole.json b/src/test/resources/api/notifications/notificationRequestToProjectMembersByRole.json
@@ -1,4 +1,4 @@
 {
-  "role": "Admin",
+  "role": "owner",
   "message": "Hiii..."
 }