renames to bearer token in client options to be more readable, adds documentation for MailjetClient methods

Author: sdiakovskyi-gd

src/main/java/com/mailjet/client/ClientOptions.java

@@ -23,7 +23,7 @@ public class ClientOptions {
   /**
    * Bearer token used for SMS Api calls
    */
-  private String apiAccessToken;
+  private String bearerAccessToken;
 
   /**
    * API key to authenticate Email Api calls

src/main/java/com/mailjet/client/MailjetClient.java

@@ -61,7 +61,7 @@ public MailjetClient(String apiKey, String apiSecret) {
     public MailjetClient(String token) {
         this(ClientOptions
                 .builder()
-                .apiAccessToken(token)
+                .bearerAccessToken(token)
                 .build());
     }
 
@@ -76,10 +76,10 @@ public MailjetClient(ClientOptions clientOptions) {
     }
 
     /**
-     * Performs a get request to the Mailjet endpoint
-     * @param request formed request to the MailJet API
-     * @return MailjetResponse
-     * @throws MailjetException exception is thrown in case of unsuccessful HTTP call execution
+     * performs GET request.
+     * @param request request to be sent to Mailjet server
+     * @return MailjetResponse with parameters of the response
+     * @throws com.mailjet.client.errors.MailjetException in case of unsuccess response status code
      */
      public MailjetResponse get(MailjetRequest request) throws MailjetException {
         try {
@@ -98,12 +98,11 @@ public MailjetResponse get(MailjetRequest request) throws MailjetException {
     }
 
 
-
     /**
-     * perform a Mailjet POST request.
-     * @param request
-     * @return
-     * @throws com.mailjet.client.errors.MailjetException
+     * performs POST request.
+     * @param request request to be sent to Mailjet server
+     * @return MailjetResponse with parameters of the response
+     * @throws com.mailjet.client.errors.MailjetException in case of unsuccess response status code
      */
     public MailjetResponse post(MailjetRequest request) throws MailjetException {
 
@@ -124,6 +123,12 @@ public MailjetResponse post(MailjetRequest request) throws MailjetException {
         }
     }
 
+    /**
+     * performs PUT request.
+     * @param request request to be sent to Mailjet server
+     * @return MailjetResponse with parameters of the response
+     * @throws com.mailjet.client.errors.MailjetException in case of unsuccess response status code
+     */
     public MailjetResponse put(MailjetRequest request) throws MailjetException {
         try {
             final RequestBody requestBody = RequestBody.create(
@@ -142,6 +147,12 @@ public MailjetResponse put(MailjetRequest request) throws MailjetException {
         }
     }
 
+    /**
+     * performs DELETE request.
+     * @param request request to be sent to Mailjet server
+     * @return MailjetResponse with parameters of the response
+     * @throws com.mailjet.client.errors.MailjetException in case of unsuccess response status code
+     */
     public MailjetResponse delete(MailjetRequest request) throws MailjetException {
         try {
 
@@ -197,10 +208,10 @@ private Request.Builder getPreconfiguredRequestBuilder(MailjetRequest request) t
                 break;
 
             case Bearer:
-                if (_options.getApiAccessToken() == null)
+                if (_options.getBearerAccessToken() == null)
                     throw new MailjetUnauthorizedException("To do a request to MailJet api, api access token should be set");
 
-                builder.addHeader("Authorization", "Bearer " + _options.getApiAccessToken());
+                builder.addHeader("Authorization", "Bearer " + _options.getBearerAccessToken());
                 break;
         }
 

src/main/java/com/mailjet/client/easy/MJEasyClient.java

@@ -34,7 +34,7 @@ public MJEasyClient(String apiKeyPublic, String apiKeyPrivate) {
     public MJEasyClient(String token) {
         ClientOptions clientOptions = ClientOptions
                 .builder()
-                .apiAccessToken(token)
+                .bearerAccessToken(token)
                 .build();
 
         client = new MailjetClient(clientOptions);

src/test/java/com/mailjet/client/MailjetClientTest.java

@@ -33,7 +33,7 @@ public static void initialize() throws IOException {
                 .baseUrl(mockWebServer.url("/").toString())
                 .apiSecretKey("secret-key")
                 .apiKey("api-key")
-                .apiAccessToken("bearer-token")
+                .bearerAccessToken("bearer-token")
                 .build();
 
         client = new MailjetClient(clientOptions);

src/test/java/com/mailjet/client/SendSmsIT.java

@@ -14,7 +14,7 @@ public void sendSms_UnsupportedCountry_ThrowsMailjetException() {
         // arrange
         MailjetClient mailjetClient = new MailjetClient(ClientOptions
                 .builder()
-                .apiAccessToken(System.getenv("MJ_APITOKEN"))
+                .bearerAccessToken(System.getenv("MJ_APITOKEN"))
                 .build());
 
         String ukrainePhoneNumber = "+380507363100";
@@ -38,7 +38,7 @@ public void sendSms_SupportedCountry_ReturnsSuccessResponse() throws MailjetExce
         // arrange
         MailjetClient mailjetClient = new MailjetClient(ClientOptions
                 .builder()
-                .apiAccessToken(System.getenv("MJ_APITOKEN"))
+                .bearerAccessToken(System.getenv("MJ_APITOKEN"))
                 .build());
 
         // to verify other countries, free services like https://receive-smss.com/ can be used