feat: introduce the /segment API endpoints

Author: kewynakshlley

src/main/java/com/resend/Resend.java

@@ -7,6 +7,7 @@
 import com.resend.services.contacts.Contacts;
 import com.resend.services.domains.Domains;
 import com.resend.services.emails.Emails;
+import com.resend.services.segments.Segments;
 import com.resend.services.webhooks.Webhooks;
 import com.resend.services.receiving.Receiving;
 import com.resend.services.topics.Topics;
@@ -71,11 +72,22 @@ public Contacts contacts() {
      * Returns an Audience object that can be used to interact with the Audiences service.
      *
      * @return an Audiences object.
+     * @deprecated Use {@link #segments()} instead.
      */
+    @Deprecated
     public Audiences audiences() {
         return new Audiences(apiKey);
     }
 
+    /**
+     * Returns a Segments object that can be used to interact with the Segments service.
+     *
+     * @return a Segments object.
+     */
+    public Segments segments() {
+        return new Segments(apiKey);
+    }
+
     /**
      * Returns a Batch object that can be used to interact with the Batch service.
      *

src/main/java/com/resend/services/audiences/Audiences.java

@@ -29,7 +29,9 @@ public Audiences(final String apiKey) {
      * @param createAudienceOptions The Audience details.
      * @return The details of the created audience.
      * @throws ResendException If an error occurs during the Audience creation process.
+     * @deprecated Use {@link com.resend.services.segments.Segments#create(com.resend.services.segments.model.CreateSegmentOptions)} instead.
      */
+    @Deprecated
     public CreateAudienceResponseSuccess create(CreateAudienceOptions createAudienceOptions) throws ResendException {
         String payload = super.resendMapper.writeValue(createAudienceOptions);
         AbstractHttpResponse<String> response = httpClient.perform("/audiences", super.apiKey, HttpMethod.POST, payload, MediaType.get("application/json"));
@@ -47,7 +49,9 @@ public CreateAudienceResponseSuccess create(CreateAudienceOptions createAudience
      *
      * @return A ListAudiencesResponseSuccess containing the list of audiences.
      * @throws ResendException If an error occurs during the audiences list retrieval process.
+     * @deprecated Use {@link com.resend.services.segments.Segments#list()} instead.
      */
+    @Deprecated
     public ListAudiencesResponseSuccess list() throws ResendException {
         AbstractHttpResponse<String> response = this.httpClient.perform("/audiences", super.apiKey, HttpMethod.GET, null, MediaType.get("application/json"));
 
@@ -66,7 +70,9 @@ public ListAudiencesResponseSuccess list() throws ResendException {
      *
      * @return A ListAudiencesResponseSuccess containing the paginated list of audiences.
      * @throws ResendException If an error occurs during the audiences list retrieval process.
+     * @deprecated Use {@link com.resend.services.segments.Segments#list(ListParams)} instead.
      */
+    @Deprecated
     public ListAudiencesResponseSuccess list(ListParams params) throws ResendException {
         String pathWithQuery = "/audiences" + URLHelper.parse(params);
         AbstractHttpResponse<String> response = this.httpClient.perform(pathWithQuery, super.apiKey, HttpMethod.GET, null, MediaType.get("application/json"));
@@ -86,7 +92,9 @@ public ListAudiencesResponseSuccess list(ListParams params) throws ResendExcepti
      * @param id The unique identifier of the audience.
      * @return The retrieved audience details.
      * @throws ResendException If an error occurs while retrieving the audience.
+     * @deprecated Use {@link com.resend.services.segments.Segments#get(String)} instead.
      */
+    @Deprecated
     public GetAudienceResponseSuccess get(String id) throws ResendException {
         AbstractHttpResponse<String> response = this.httpClient.perform("/audiences/" +id, super.apiKey, HttpMethod.GET, null, MediaType.get("application/json"));
 
@@ -105,7 +113,9 @@ public GetAudienceResponseSuccess get(String id) throws ResendException {
      * @param id The unique identifier of the audience to delete.
      * @return The RemoveAudiencesResponseSuccess with the details of the removed audience.
      * @throws ResendException If an error occurs during the audience deletion process.
+     * @deprecated Use {@link com.resend.services.segments.Segments#remove(String)} instead.
      */
+    @Deprecated
     public RemoveAudienceResponseSuccess remove(String id) throws ResendException {
         AbstractHttpResponse<String> response = httpClient.perform("/audiences/" +id, super.apiKey, HttpMethod.DELETE, "", null);
 

src/main/java/com/resend/services/broadcasts/model/BroadcastOptions.java

@@ -9,8 +9,12 @@
  */
 public class BroadcastOptions {
     @JsonProperty("audience_id")
+    @Deprecated
     private final String audienceId;
 
+    @JsonProperty("segment_id")
+    private final String segmentId;
+
     @JsonProperty("from")
     private final String from;
 
@@ -36,6 +40,7 @@ public class BroadcastOptions {
      */
     protected BroadcastOptions(Builder builder) {
         this.audienceId = builder.audienceId;
+        this.segmentId = builder.segmentId;
         this.from = builder.from;
         this.subject = builder.subject;
         this.replyTo = builder.replyTo;
@@ -48,11 +53,22 @@ protected BroadcastOptions(Builder builder) {
      * Gets the audience ID.
      *
      * @return the unique identifier of the audience.
+     * @deprecated Use {@link #getSegmentId()} instead.
      */
+    @Deprecated
     public String getAudienceId() {
         return audienceId;
     }
 
+    /**
+     * Gets the segment ID.
+     *
+     * @return the unique identifier of the segment.
+     */
+    public String getSegmentId() {
+        return segmentId;
+    }
+
     /**
      * Gets the sender's email address.
      *
@@ -114,9 +130,16 @@ protected static abstract class Builder<T extends BroadcastOptions, B extends Bu
 
         /**
          * The ID of the audience targeted by the broadcast.
+         * @deprecated Use {@link #segmentId} instead.
          */
+        @Deprecated
         protected String audienceId;
 
+        /**
+         * The ID of the segment targeted by the broadcast.
+         */
+        protected String segmentId;
+
         /**
          * The email address of the sender.
          */
@@ -152,12 +175,25 @@ protected static abstract class Builder<T extends BroadcastOptions, B extends Bu
          *
          * @param audienceId the unique identifier of the audience.
          * @return the builder instance.
+         * @deprecated Use {@link #segmentId(String)} instead.
          */
+        @Deprecated
         public B audienceId(String audienceId) {
             this.audienceId = audienceId;
             return self();
         }
 
+        /**
+         * Sets the segment ID.
+         *
+         * @param segmentId the unique identifier of the segment.
+         * @return the builder instance.
+         */
+        public B segmentId(String segmentId) {
+            this.segmentId = segmentId;
+            return self();
+        }
+
         /**
          * Sets the sender's email address.
          *

src/main/java/com/resend/services/contacts/Contacts.java

@@ -31,8 +31,9 @@ public Contacts(final String apiKey) {
      * @throws ResendException If an error occurs during the Contact creation process.
      */
     public CreateContactResponseSuccess create(CreateContactOptions createContactOptions) throws ResendException {
+        String segmentId = createContactOptions.getSegmentId() != null ? createContactOptions.getSegmentId() : createContactOptions.getAudienceId();
         String payload = super.resendMapper.writeValue(createContactOptions);
-        AbstractHttpResponse<String> response = httpClient.perform("/audiences/" + createContactOptions.getAudienceId()+ "/contacts" , super.apiKey, HttpMethod.POST, payload, MediaType.get("application/json"));
+        AbstractHttpResponse<String> response = httpClient.perform("/audiences/" + segmentId + "/contacts" , super.apiKey, HttpMethod.POST, payload, MediaType.get("application/json"));
 
         if (!response.isSuccessful()) {
             throw new ResendException(response.getCode(), response.getBody());
@@ -101,8 +102,9 @@ public GetContactResponseSuccess get(GetContactOptions params) throws ResendExce
         }
 
         String contactIdentifier =  (id != null && !id.isEmpty()) ? id : email;
+        String segmentId = params.getSegmentId() != null ? params.getSegmentId() : params.getAudienceId();
 
-        AbstractHttpResponse<String> response = this.httpClient.perform("/audiences/" +params.getAudienceId()+ "/contacts/" +contactIdentifier, super.apiKey, HttpMethod.GET, null, MediaType.get("application/json"));
+        AbstractHttpResponse<String> response = this.httpClient.perform("/audiences/" + segmentId + "/contacts/" + contactIdentifier, super.apiKey, HttpMethod.GET, null, MediaType.get("application/json"));
 
         if (!response.isSuccessful()) {
             throw new ResendException(response.getCode(), response.getBody());
@@ -127,8 +129,9 @@ public RemoveContactResponseSuccess remove(RemoveContactOptions params) throws R
         }
 
         String pathParameter = params.getId() != null ? params.getId() : params.getEmail();
+        String segmentId = params.getSegmentId() != null ? params.getSegmentId() : params.getAudienceId();
 
-        AbstractHttpResponse<String> response = httpClient.perform("/audiences/" +params.getAudienceId()+ "/contacts/" + pathParameter, super.apiKey, HttpMethod.DELETE, "", null);
+        AbstractHttpResponse<String> response = httpClient.perform("/audiences/" + segmentId + "/contacts/" + pathParameter, super.apiKey, HttpMethod.DELETE, "", null);
 
         if (!response.isSuccessful()) {
             throw new ResendException(response.getCode(), response.getBody());
@@ -153,9 +156,10 @@ public UpdateContactResponseSuccess update(UpdateContactOptions params) throws R
         }
 
         String pathParameter = params.getId() != null ? params.getId() : params.getEmail();
+        String segmentId = params.getSegmentId() != null ? params.getSegmentId() : params.getAudienceId();
 
         String payload = super.resendMapper.writeValue(params);
-        AbstractHttpResponse<String> response = httpClient.perform("/audiences/" +params.getAudienceId()+ "/contacts/" + pathParameter, super.apiKey, HttpMethod.PATCH, payload, MediaType.get("application/json"));
+        AbstractHttpResponse<String> response = httpClient.perform("/audiences/" + segmentId + "/contacts/" + pathParameter, super.apiKey, HttpMethod.PATCH, payload, MediaType.get("application/json"));
 
         if (!response.isSuccessful()) {
             throw new ResendException(response.getCode(), response.getBody());

src/main/java/com/resend/services/contacts/model/ContactOptions.java

@@ -15,10 +15,18 @@ public abstract class ContactOptions {
 
     /**
      * The audience_id of the contact options
+     * @deprecated Use {@link #segmentId} instead.
      */
+    @Deprecated
     @JsonProperty("audience_id")
     protected final String audienceId;
 
+    /**
+     * The segment_id of the contact options
+     */
+    @JsonProperty("segment_id")
+    protected final String segmentId;
+
     /**
      * The email of the contact options
      */
@@ -33,6 +41,7 @@ public abstract class ContactOptions {
     protected ContactOptions(Builder builder) {
         this.id = builder.id;
         this.audienceId = builder.audienceId;
+        this.segmentId = builder.segmentId;
         this.email = builder.email;
     }
 
@@ -49,11 +58,22 @@ public String getId() {
      * Get the audienceId of the ContactOptions.
      *
      * @return The audienceId of the ContactOptions.
+     * @deprecated Use {@link #getSegmentId()} instead.
      */
+    @Deprecated
     public String getAudienceId() {
         return audienceId;
     }
 
+    /**
+     * Get the segmentId of the ContactOptions.
+     *
+     * @return The segmentId of the ContactOptions.
+     */
+    public String getSegmentId() {
+        return segmentId;
+    }
+
     /**
      * Get the email of the ContactOptions.
      *
@@ -74,9 +94,16 @@ protected static abstract class Builder<T extends ContactOptions, B extends Buil
 
         /**
          * The audienceId of the contact options builder
+         * @deprecated Use {@link #segmentId} instead.
          */
+        @Deprecated
         protected String audienceId;
 
+        /**
+         * The segmentId of the contact options builder
+         */
+        protected String segmentId;
+
         /**
          * The email of the contact options builder
          */
@@ -98,12 +125,25 @@ public B id(String id) {
          *
          * @param audienceId The audienceId of the ContactOptions.
          * @return The builder instance.
+         * @deprecated Use {@link #segmentId(String)} instead.
          */
+        @Deprecated
         public B audienceId(String audienceId) {
             this.audienceId = audienceId;
             return self();
         }
 
+        /**
+         * Set the segmentId of the ContactOptions.
+         *
+         * @param segmentId The segmentId of the ContactOptions.
+         * @return The builder instance.
+         */
+        public B segmentId(String segmentId) {
+            this.segmentId = segmentId;
+            return self();
+        }
+
         /**
          * Set the email of the ContactOptions.
          *

src/main/java/com/resend/services/contacts/model/CreateContactOptions.java

@@ -8,8 +8,12 @@
 public class CreateContactOptions {
 
     @JsonProperty("audience_id")
+    @Deprecated
     private final String audienceId;
 
+    @JsonProperty("segment_id")
+    private final String segmentId;
+
     @JsonProperty("email")
     private final String email;
 
@@ -29,6 +33,7 @@ public class CreateContactOptions {
      */
     public CreateContactOptions(Builder builder) {
         this.audienceId = builder.audienceId;
+        this.segmentId = builder.segmentId;
         this.email = builder.email;
         this.unsubscribed = builder.unsubscribed;
         this.firstName = builder.firstName;
@@ -39,11 +44,22 @@ public CreateContactOptions(Builder builder) {
      * Get the audience ID of the contact.
      *
      * @return The audience ID of the contact.
+     * @deprecated Use {@link #getSegmentId()} instead.
      */
+    @Deprecated
     public String getAudienceId() {
         return audienceId;
     }
 
+    /**
+     * Get the segment ID of the contact.
+     *
+     * @return The segment ID of the contact.
+     */
+    public String getSegmentId() {
+        return segmentId;
+    }
+
     /**
      * Get the email of the contact.
      *
@@ -94,6 +110,7 @@ public static Builder builder() {
      */
     public static class Builder {
         private String audienceId;
+        private String segmentId;
         private String email;
         private Boolean unsubscribed;
         private String firstName;
@@ -104,12 +121,25 @@ public static class Builder {
          *
          * @param audienceId The audience ID of the contact.
          * @return The builder instance.
+         * @deprecated Use {@link #segmentId(String)} instead.
          */
+        @Deprecated
         public Builder audienceId(String audienceId) {
             this.audienceId = audienceId;
             return this;
         }
 
+        /**
+         * Set the segment ID of the contact.
+         *
+         * @param segmentId The segment ID of the contact.
+         * @return The builder instance.
+         */
+        public Builder segmentId(String segmentId) {
+            this.segmentId = segmentId;
+            return this;
+        }
+
         /**
          * Set the email of the contact.
          *