Merge pull request #24 from railsware/pre-1.0.0-release

Pre 1.0.0 release

Author: vitalii-t

.gitignore

@@ -35,4 +35,4 @@ build/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Railsware Products Studio LLC
+Copyright (c) 2025 Railsware Products Studio LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -8,33 +8,31 @@ Quickly add email sending functionality to your Java application with Mailtrap.
 
 ## Java Version
 
-Requires JDK 11 or higher
+Requires JDK 11 or higher.
 
-## Usage
-
-### Dependency
+## Install package
 
-Maven dependency
+As Maven dependency:
 
 ```xml
 
 <dependency>
     <groupId>io.mailtrap</groupId>
     <artifactId>mailtrap-java</artifactId>
-    <version>0.0.1</version>
+    <version>1.0.0</version>
 </dependency>
 ```
 
-Gradle Groovy dependency
+As Gradle Groovy dependency:
 
 ```groovy
-implementation 'io.mailtrap:mailtrap-java:0.0.1'
+implementation 'io.mailtrap:mailtrap-java:1.0.0'
 ```
 
-Gradle Kotlin DSL dependency
+As Gradle Kotlin DSL dependency:
 
 ```kotlin
-implementation("io.mailtrap:mailtrap-java:0.0.1")
+implementation("io.mailtrap:mailtrap-java:1.0.0")
 ```
 
 ## Usage
@@ -72,14 +70,14 @@ public class MailtrapJavaSDKTest {
                 .text("Welcome to Mailtrap Sending!")
                 .build();
 
+        // Send email using Mailtrap Sending API
         try {
             System.out.println(client.send(mail));
         } catch (Exception e) {
             System.out.println("Caught exception : " + e);
         }
 
-        // OR send email to the Mailtrap Sandbox
-
+        // Or send email using Mailtrap Testing API
         try {
             long inboxId = 1000001L;
 
@@ -98,7 +96,7 @@ public class MailtrapJavaSDKTest {
 
             System.out.println(client.send(mail));
 
-            // Or use directly Testing API to send email to Sandbox
+            // Or use Testing API directly
             System.out.println(client.testingApi().emails().send(mail, inboxId));
         } catch (Exception e) {
             System.out.println("Caught exception : " + e);
@@ -127,18 +125,23 @@ You can find the API reference [here](https://railsware.github.io/mailtrap-java/
 - [Error handling](examples/java/io/mailtrap/examples/sending/Errors.java)
 - [Send email using template](examples/java/io/mailtrap/examples/sending/Template.java)
 
-### Email testing API
+### Email Testing API
 
 - [Attachments](examples/java/io/mailtrap/examples/testing/Attachments.java)
 - [Inboxes](examples/java/io/mailtrap/examples/testing/Inboxes.java)
 - [Messages](examples/java/io/mailtrap/examples/testing/Messages.java)
 - [Projects](examples/java/io/mailtrap/examples/testing/Projects.java)
 - [Send mail using template](examples/java/io/mailtrap/examples/testing/Email.java)
 
-### Bulk sending API
+### Bulk Sending API
 
 - [Send mail](examples/java/io/mailtrap/examples/bulk/BulkSend.java)
 
+### Contacts API
+
+- [Contacts](examples/java/io/mailtrap/examples/contacts/Contacts.java)
+- [Contact lists](examples/java/io/mailtrap/examples/contact_lists/ContactLists.java)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/railsware/mailtrap-java). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).

docs/docfx.json

@@ -15,4 +15,4 @@
     ],
     "dest": "_site"
   }
-}
+}

docs/getting-started.md

@@ -4,36 +4,39 @@ Follow these few simple steps to add Mailtrap API functionality into your Java p
 
 # Prerequisites
 
-Make sure your project uses JDK 11 or higher
+Make sure your project uses JDK 11 or higher.
 
 ## Setup
 
 ### 1. Add the library as a Maven/Gradle dependency
-Maven dependency
+
+Maven dependency:
 
 ```xml
 
 <dependency>
     <groupId>io.mailtrap</groupId>
     <artifactId>mailtrap-java</artifactId>
-    <version>*latest-version*</version>
+    <version>1.0.0</version>
 </dependency>
 ```
 
-Gradle Groovy dependency
+Gradle Groovy dependency:
 
 ```groovy
-implementation 'io.mailtrap:mailtrap-java:*latest-version*'
+implementation 'io.mailtrap:mailtrap-java:1.0.0'
 ```
 
-Gradle Kotlin DSL dependency
+Gradle Kotlin DSL dependency:
 
 ```kotlin
-implementation("io.mailtrap:mailtrap-java:*latest-version*")
+implementation("io.mailtrap:mailtrap-java:1.0.0")
 ```
 
-### 2. Register/login into Mailtrap account
-Obtain API token to configure and use MailtrapClient
+### 2. Authentication
+
+- Register/login into Mailtrap
+- Obtain an API token [with respective permissions and access level](https://help.mailtrap.io/article/103-api-tokens) to configure and use MailtrapClient.
 
 ### 3. Configuration and usage
 
@@ -73,4 +76,4 @@ public class Minimal {
         }
     }
 }
-```
+```

docs/index.md

@@ -7,12 +7,12 @@ Welcome to the documentation portal for the official <a href="https://mailtrap.i
 
 This client allows you to quickly and easily integrate your Java application with Mailtrap API.
 
-
 ## Table of contents
 
 - [Getting Started](getting-started.md) - quick overview on how to integrate Mailtrap into your project
 - [Usage Examples](usage-examples.md) 
 - [API Reference](javadocs.md) - Detailed API Reference
 
 ## License
-Licensed under the <a href="https://github.com/railsware/mailtrap-java/blob/main/LICENSE.txt" target="_blank">MIT License</a>.
+
+Licensed under the <a href="https://github.com/railsware/mailtrap-java/blob/main/LICENSE.txt" target="_blank">MIT License</a>.

docs/toc.yml

@@ -5,4 +5,4 @@
 - name: Usage Examples
   href: usage-examples.md
 - name: API Reference
-  href: javadocs.md
+  href: javadocs.md

docs/usage-examples.md

@@ -1,3 +1,3 @@
 # Detailed Usage Examples
 
-Code examples, that covers all possible APIs can be found <a href="https://github.com/railsware/mailtrap-java/tree/main/examples/java/io/mailtrap/examples" target="_blank">here</a>
+Code examples covering all APIs can be found <a href="https://github.com/railsware/mailtrap-java/tree/main/examples/java/io/mailtrap/examples" target="_blank">here</a>.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.mailtrap</groupId>
     <artifactId>mailtrap-java</artifactId>
-    <version>0.0.1</version>
+    <version>1.0.0</version>
 
     <name>Mailtrap Java SDK</name>
     <description>The official Mailtrap SDK for Java provides Java APIs
@@ -236,4 +236,4 @@
         </plugins>
     </build>
 
-</project>
+</project>

src/test/resources/api/accounts/getAllAccountsResponse.json

@@ -13,4 +13,4 @@
       1000
     ]
   }
-]
+]

src/test/resources/api/billing/currentBillingCycleUsageResponse.json

@@ -29,4 +29,4 @@
       }
     }
   }
-}
+}

src/test/resources/api/emails/sendRequestFromTemplate.json

@@ -18,4 +18,4 @@
   "template_variables": {
     "user_name": "John Doe"
   }
-}
+}