resend 0.27.0.alpha.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4133247b039437fb66f5b38abbe61c41d9cc85e007ae7ef7a00b865af21f9875
4
- data.tar.gz: ab112b1b77f4f7023fe98c2ab23fa93448d1b1700d7c3ea3dbf68f78ea69e214
3
+ metadata.gz: 9388a0e6d79027b6f057669d807519fdb74433d89eafc50bd0a4db5d4626e7a5
4
+ data.tar.gz: 321c0387aa19dbf95b930ad5a79a00e40d09757714250aa44845b0f7e912efb4
5
5
  SHA512:
6
- metadata.gz: b525a8dabb6d312585fa59db58e17cf8982f3ac5603502a62046ce24211b3ba59c056361e80ac7a958d6d073cea940fece2493c320b5ac7842eed88e34b329c3
7
- data.tar.gz: 38a6ce6faf1b907ee646bf53f28f8f0b67b7d1174e3a2d7fd075879c24a2399817d820ed8f0a2e19f50251f84a3ad7d2e0327a669f4e368e45f531cc3413b43a
6
+ metadata.gz: 51e5ffc36f521db854067a10d6bb2e0e90d45837237177bb5620ff189b015595695b55c122cccefd020f4dae2d23c6cca7221c4ee7346863eda3c05a297c8740
7
+ data.tar.gz: 80637728c8fb04c3e521b79fd444cb3f92554062312070e324004863ee914fcea4da7d13be832ae6c4abcabedab0521e20e16e32dd778633a8a7169fb0d57732
data/CHANGELOG.md ADDED
@@ -0,0 +1,131 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [1.0.0] - 2025-10-31
9
+
10
+ ### Overview
11
+
12
+ This major release introduces breaking changes to the Contacts API and deprecates the Audiences API in favor of Segments. **If you only use the SDK for sending emails or the Audiences API, you can upgrade to v1.0.0 without any code changes.** The breaking changes are limited to the Contacts API only.
13
+
14
+ ### ⚠️ BREAKING CHANGES
15
+
16
+ #### Contacts API Changes
17
+
18
+ - ⚠️ **Change `Contacts.create` to accept hash parameter with optional `audience_id`** - Previously required `audience_id` in params, now it's optional. Supports global contacts.
19
+ - ⚠️ **Change `Contacts.get` from `get(audience_id, id)` to `get(params)`** - Now accepts a hash with optional `audience_id` and required `id` or `email`. Raises `ArgumentError: "Missing \`id\` or \`email\` field"` when neither is provided.
20
+ - ⚠️ **Change `Contacts.list` from `list(audience_id, params = {})` to `list(params = {})`** - Now accepts a hash with optional `audience_id` and pagination params
21
+ - ⚠️ **Change `Contacts.remove` from `remove(audience_id, contact_id)` to `remove(params)`** - Now accepts a hash with optional `audience_id` and required `id` or `email`. Raises `ArgumentError: "Missing \`id\` or \`email\` field"` when neither is provided.
22
+ - ⚠️ **Change `Contacts.update` error message** - Error changed from `"id or email is required"` to `"Missing \`id\` or \`email\` field"` to match Node.js SDK format
23
+ - ⚠️ **Change `Contacts.update` to accept optional `audience_id`** - Previously required `audience_id` in params, now it's optional
24
+
25
+ **Before (v0.x):**
26
+
27
+ ```ruby
28
+ # Methods used positional arguments and required audience_id
29
+ Resend::Contacts.create(audience_id: "aud_123", email: "user@example.com", first_name: "John")
30
+ contact = Resend::Contacts.get("aud_123", "contact_123")
31
+ contacts = Resend::Contacts.list("aud_123")
32
+ contacts = Resend::Contacts.list("aud_123", limit: 10)
33
+ Resend::Contacts.update(audience_id: "aud_123", id: "contact_123", first_name: "Jane")
34
+ Resend::Contacts.remove("aud_123", "contact_123")
35
+ ```
36
+
37
+ **After (v1.0.0):**
38
+
39
+ ```ruby
40
+ # Methods use hash parameters and support optional audience_id
41
+ # Global contacts (no audience_id)
42
+ Resend::Contacts.create(email: "user@example.com", first_name: "John")
43
+ contact = Resend::Contacts.get(id: "contact_123")
44
+ contact = Resend::Contacts.get(email: "user@example.com")
45
+ contacts = Resend::Contacts.list
46
+ contacts = Resend::Contacts.list(limit: 10)
47
+ Resend::Contacts.update(id: "contact_123", first_name: "Jane")
48
+ Resend::Contacts.remove(id: "contact_123")
49
+
50
+ # Audience-scoped contacts (with audience_id)
51
+ Resend::Contacts.create(audience_id: "aud_123", email: "user@example.com", first_name: "John")
52
+ contact = Resend::Contacts.get(audience_id: "aud_123", id: "contact_123")
53
+ contacts = Resend::Contacts.list(audience_id: "aud_123", limit: 10)
54
+ Resend::Contacts.update(audience_id: "aud_123", id: "contact_123", first_name: "Jane")
55
+ Resend::Contacts.remove(audience_id: "aud_123", id: "contact_123")
56
+ ```
57
+
58
+ #### Audiences API Deprecated
59
+
60
+ - ⚠️ **Deprecate `Resend::Audiences` in favor of `Resend::Segments`** - The Audiences module has been replaced with Segments. A backward-compatible alias `Audiences = Segments` has been added, so existing code will continue to work.
61
+
62
+ **Migration (Recommended):**
63
+
64
+ Update your code to use `Segments` instead of `Audiences`:
65
+
66
+ ```ruby
67
+ # Before (still works but deprecated)
68
+ Resend::Audiences.create(name: "My Audience")
69
+ Resend::Audiences.get("audience_123")
70
+ Resend::Audiences.list
71
+ Resend::Audiences.remove("audience_123")
72
+
73
+ # After (recommended)
74
+ Resend::Segments.create(name: "My Segment")
75
+ Resend::Segments.get("segment_123")
76
+ Resend::Segments.list
77
+ Resend::Segments.remove("segment_123")
78
+ ```
79
+
80
+ **Note:** The `Audiences` alias is deprecated and may be removed in a future major version. Please migrate to `Segments`.
81
+
82
+ ### Added
83
+
84
+ #### New API Modules
85
+
86
+ - Add `Resend::Templates` API for managing email templates
87
+ - `Templates.create` - Create a new template
88
+ - `Templates.get` - Retrieve a template by ID
89
+ - `Templates.update` - Update an existing template
90
+ - `Templates.publish` - Publish a template
91
+ - `Templates.duplicate` - Duplicate an existing template
92
+ - `Templates.list` - List all templates with pagination
93
+ - `Templates.remove` - Delete a template
94
+ - Add `Resend::Topics` API for managing topics
95
+ - `Topics.create` - Create a new topic
96
+ - `Topics.get` - Retrieve a topic by ID
97
+ - `Topics.update` - Update a topic
98
+ - `Topics.list` - List all topics with pagination
99
+ - `Topics.remove` - Delete a topic
100
+ - Add `Resend::Segments` API for managing segments (replacement for Audiences)
101
+ - `Segments.create` - Create a new segment
102
+ - `Segments.get` - Retrieve a segment by ID
103
+ - `Segments.list` - List all segments
104
+ - `Segments.remove` - Delete a segment
105
+ - Add `Resend::ContactProperties` API for managing custom contact properties
106
+ - `ContactProperties.update` - Update contact properties (validates and raises `ArgumentError: "Missing \`id\` field"` when id is not provided)
107
+ - `ContactProperties.get` - Retrieve contact properties by ID
108
+ - Add `Resend::Contacts::Segments` API for managing contact-segment relationships
109
+ - `Contacts::Segments.list` - List all segments for a contact
110
+ - `Contacts::Segments.add` - Add a contact to a segment
111
+ - `Contacts::Segments.remove` - Remove a contact from a segment
112
+ - Add `Resend::Contacts::Topics` API for managing contact topic subscriptions
113
+ - `Contacts::Topics.list` - List topic subscriptions for a contact
114
+ - `Contacts::Topics.update` - Update topic subscriptions (opt-in/opt-out) for a contact
115
+
116
+ #### Contacts API Enhancements
117
+
118
+ - Add support for `email` parameter in `Contacts.get` and `Contacts.remove` methods (can now use email instead of ID)
119
+ - Add `audience_id` support in Contacts API methods for scoped operations
120
+ - Add support for global contacts (contacts not scoped to a specific audience/segment)
121
+ - Add validation error messages matching Node.js SDK format with backticks around field names
122
+
123
+ #### Broadcasts API Updates
124
+
125
+ - Add deprecation warnings for `audience_id` in `Broadcasts.create` and `Broadcasts.update` (use `segment_id` instead)
126
+
127
+ ### Removed
128
+
129
+ - Remove deprecated `send_email` method from `Resend::Emails` module (use `Resend::Emails.send` instead)
130
+
131
+ [1.0.0]: https://github.com/resend/resend-ruby/compare/v0.26.0...v1.0.0
@@ -5,13 +5,23 @@ module Resend
5
5
  module Broadcasts
6
6
  class << self
7
7
  # https://resend.com/docs/api-reference/broadcasts/create-broadcast
8
+ # @note Supports both segment_id and audience_id. At least one is required.
9
+ # audience_id is deprecated - use segment_id instead.
8
10
  def create(params = {})
11
+ if params[:audience_id] && !params[:segment_id]
12
+ warn "[DEPRECATION] Using audience_id in broadcasts is deprecated. Use segment_id instead."
13
+ end
9
14
  path = "broadcasts"
10
15
  Resend::Request.new(path, params, "post").perform
11
16
  end
12
17
 
13
18
  # https://resend.com/docs/api-reference/broadcasts/update-broadcast
19
+ # @note Supports both segment_id and audience_id. At least one may be required.
20
+ # audience_id is deprecated - use segment_id instead.
14
21
  def update(params = {})
22
+ if params[:audience_id] && !params[:segment_id]
23
+ warn "[DEPRECATION] Using audience_id in broadcasts is deprecated. Use segment_id instead."
24
+ end
15
25
  path = "broadcasts/#{params[:broadcast_id]}"
16
26
  Resend::Request.new(path, params, "patch").perform
17
27
  end
@@ -0,0 +1,106 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Resend
4
+ # Module for managing contact properties
5
+ #
6
+ # Contact properties allow you to store custom data about your contacts
7
+ module ContactProperties
8
+ class << self
9
+ # Create a custom property for your contacts
10
+ #
11
+ # @param params [Hash] Parameters for creating a contact property
12
+ # @option params [String] :key The property key (max 50 characters, alphanumeric and underscores only) (required)
13
+ # @option params [String] :type The property type ('string' or 'number') (required)
14
+ # @option params [String, Integer] :fallback_value The default value when property is not set (must match type)
15
+ #
16
+ # @return [Hash] Response containing the created contact property
17
+ #
18
+ # @example Create a string property
19
+ # Resend::ContactProperties.create({
20
+ # key: 'company_name',
21
+ # type: 'string',
22
+ # fallback_value: 'Acme Corp'
23
+ # })
24
+ #
25
+ # @example Create a number property
26
+ # Resend::ContactProperties.create({
27
+ # key: 'age',
28
+ # type: 'number',
29
+ # fallback_value: 0
30
+ # })
31
+ def create(params)
32
+ path = "contact-properties"
33
+ Resend::Request.new(path, params, "post").perform
34
+ end
35
+
36
+ # Retrieve a contact property by its ID
37
+ #
38
+ # @param contact_property_id [String] The Contact Property ID
39
+ #
40
+ # @return [Hash] Response containing the contact property details
41
+ #
42
+ # @example Get a contact property
43
+ # Resend::ContactProperties.get('b6d24b8e-af0b-4c3c-be0c-359bbd97381e')
44
+ def get(contact_property_id = "")
45
+ path = "contact-properties/#{contact_property_id}"
46
+ Resend::Request.new(path, {}, "get").perform
47
+ end
48
+
49
+ # Retrieve a list of contact properties
50
+ #
51
+ # @param params [Hash] Optional query parameters
52
+ # @option params [Integer] :limit Number of contact properties to retrieve (1-100, default: 20)
53
+ # @option params [String] :after The ID after which to retrieve more contact properties
54
+ # @option params [String] :before The ID before which to retrieve more contact properties
55
+ #
56
+ # @return [Hash] Response containing list of contact properties
57
+ #
58
+ # @example List all contact properties
59
+ # Resend::ContactProperties.list
60
+ #
61
+ # @example List with pagination
62
+ # Resend::ContactProperties.list({ limit: 10, after: 'cursor_123' })
63
+ def list(params = {})
64
+ path = Resend::PaginationHelper.build_paginated_path("contact-properties", params)
65
+ Resend::Request.new(path, {}, "get").perform
66
+ end
67
+
68
+ # Update an existing contact property
69
+ #
70
+ # Note: The 'key' and 'type' fields cannot be changed after creation
71
+ #
72
+ # @param params [Hash] Parameters for updating a contact property
73
+ # @option params [String] :id The Contact Property ID (required)
74
+ # @option params [String, Integer] :fallback_value The default value when property is not set
75
+ # (must match property type)
76
+ #
77
+ # @return [Hash] Response containing the updated contact property
78
+ #
79
+ # @example Update fallback value
80
+ # Resend::ContactProperties.update({
81
+ # id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e',
82
+ # fallback_value: 'Example Company'
83
+ # })
84
+ def update(params)
85
+ raise ArgumentError, "Missing `id` field" if params[:id].nil?
86
+
87
+ contact_property_id = params[:id]
88
+ path = "contact-properties/#{contact_property_id}"
89
+ Resend::Request.new(path, params, "patch").perform
90
+ end
91
+
92
+ # Remove an existing contact property
93
+ #
94
+ # @param contact_property_id [String] The Contact Property ID
95
+ #
96
+ # @return [Hash] Response containing the deleted property ID and confirmation
97
+ #
98
+ # @example Delete a contact property
99
+ # Resend::ContactProperties.remove('b6d24b8e-af0b-4c3c-be0c-359bbd97381e')
100
+ def remove(contact_property_id = "")
101
+ path = "contact-properties/#{contact_property_id}"
102
+ Resend::Request.new(path, {}, "delete").perform
103
+ end
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,66 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Resend
4
+ module Contacts
5
+ # Contact Segments api wrapper
6
+ module Segments
7
+ class << self
8
+ #
9
+ # List all segments for a contact
10
+ #
11
+ # @param params [Hash] the parameters
12
+ # @option params [String] :contact_id the contact id (either contact_id or email is required)
13
+ # @option params [String] :email the contact email (either contact_id or email is required)
14
+ # @option params [Integer] :limit the maximum number of results to return (optional)
15
+ # @option params [String] :after the cursor for pagination (optional)
16
+ # @option params [String] :before the cursor for pagination (optional)
17
+ #
18
+ # https://resend.com/docs/api-reference/contacts/list-contact-segments
19
+ def list(params)
20
+ raise ArgumentError, "contact_id or email is required" if params[:contact_id].nil? && params[:email].nil?
21
+
22
+ identifier = params[:contact_id] || params[:email]
23
+ base_path = "contacts/#{identifier}/segments"
24
+ path = Resend::PaginationHelper.build_paginated_path(base_path, params)
25
+ Resend::Request.new(path, {}, "get").perform
26
+ end
27
+
28
+ #
29
+ # Add a contact to a segment
30
+ #
31
+ # @param params [Hash] the parameters
32
+ # @option params [String] :contact_id the contact id (either contact_id or email is required)
33
+ # @option params [String] :email the contact email (either contact_id or email is required)
34
+ # @option params [String] :segment_id the segment id (required)
35
+ #
36
+ # https://resend.com/docs/api-reference/contacts/add-contact-to-segment
37
+ def add(params)
38
+ raise ArgumentError, "contact_id or email is required" if params[:contact_id].nil? && params[:email].nil?
39
+ raise ArgumentError, "segment_id is required" if params[:segment_id].nil?
40
+
41
+ identifier = params[:contact_id] || params[:email]
42
+ path = "contacts/#{identifier}/segments/#{params[:segment_id]}"
43
+ Resend::Request.new(path, {}, "post").perform
44
+ end
45
+
46
+ #
47
+ # Remove a contact from a segment
48
+ #
49
+ # @param params [Hash] the parameters
50
+ # @option params [String] :contact_id the contact id (either contact_id or email is required)
51
+ # @option params [String] :email the contact email (either contact_id or email is required)
52
+ # @option params [String] :segment_id the segment id (required)
53
+ #
54
+ # https://resend.com/docs/api-reference/contacts/remove-contact-from-segment
55
+ def remove(params)
56
+ raise ArgumentError, "contact_id or email is required" if params[:contact_id].nil? && params[:email].nil?
57
+ raise ArgumentError, "segment_id is required" if params[:segment_id].nil?
58
+
59
+ identifier = params[:contact_id] || params[:email]
60
+ path = "contacts/#{identifier}/segments/#{params[:segment_id]}"
61
+ Resend::Request.new(path, {}, "delete").perform
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,80 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Resend
4
+ module Contacts
5
+ # Module for managing contact topic subscriptions
6
+ #
7
+ # Allows you to manage which topics contacts are subscribed to
8
+ module Topics
9
+ class << self
10
+ # Retrieve a list of topics subscriptions for a contact
11
+ #
12
+ # @param params [Hash] Parameters for listing topics
13
+ # @option params [String] :id The Contact ID (either :id or :email must be provided)
14
+ # @option params [String] :email The Contact Email (either :id or :email must be provided)
15
+ # @option params [Integer] :limit Number of topics to retrieve (1-100)
16
+ # @option params [String] :after The ID after which to retrieve more topics
17
+ # @option params [String] :before The ID before which to retrieve more topics
18
+ #
19
+ # @return [Hash] Response containing list of topics with subscription status
20
+ #
21
+ # @example List topics by contact ID
22
+ # Resend::Contacts::Topics.list(id: 'e169aa45-1ecf-4183-9955-b1499d5701d3')
23
+ #
24
+ # @example List topics by contact email
25
+ # Resend::Contacts::Topics.list(email: 'steve.wozniak@gmail.com')
26
+ #
27
+ # @example List topics with pagination
28
+ # Resend::Contacts::Topics.list(id: 'contact-id', limit: 10, after: 'cursor_123')
29
+ def list(params = {})
30
+ contact_identifier = params[:id] || params[:email]
31
+ raise ArgumentError, "Either :id or :email must be provided" if contact_identifier.nil?
32
+
33
+ pagination_params = params.slice(:limit, :after, :before)
34
+ base_path = "contacts/#{contact_identifier}/topics"
35
+ path = Resend::PaginationHelper.build_paginated_path(base_path, pagination_params)
36
+
37
+ Resend::Request.new(path, {}, "get").perform
38
+ end
39
+
40
+ # Update topic subscriptions for a contact
41
+ #
42
+ # @param params [Hash] Parameters for updating topics
43
+ # @option params [String] :id The Contact ID (either :id or :email must be provided)
44
+ # @option params [String] :email The Contact Email (either :id or :email must be provided)
45
+ # @option params [Array<Hash>] :topics Array of topic subscription updates
46
+ # Each topic hash should contain:
47
+ # - :id [String] The Topic ID (required)
48
+ # - :subscription [String] The subscription action: 'opt_in' or 'opt_out' (required)
49
+ #
50
+ # @return [Hash] Response containing the contact ID
51
+ #
52
+ # @example Update by contact ID
53
+ # Resend::Contacts::Topics.update({
54
+ # id: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
55
+ # topics: [
56
+ # { id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e', subscription: 'opt_out' },
57
+ # { id: '07d84122-7224-4881-9c31-1c048e204602', subscription: 'opt_in' }
58
+ # ]
59
+ # })
60
+ #
61
+ # @example Update by contact email
62
+ # Resend::Contacts::Topics.update({
63
+ # email: 'steve.wozniak@gmail.com',
64
+ # topics: [
65
+ # { id: '07d84122-7224-4881-9c31-1c048e204602', subscription: 'opt_out' }
66
+ # ]
67
+ # })
68
+ def update(params)
69
+ contact_identifier = params[:id] || params[:email]
70
+ raise ArgumentError, "Either :id or :email must be provided" if contact_identifier.nil?
71
+
72
+ path = "contacts/#{contact_identifier}/topics"
73
+ body = params[:topics]
74
+
75
+ Resend::Request.new(path, body, "patch").perform
76
+ end
77
+ end
78
+ end
79
+ end
80
+ end
@@ -6,42 +6,96 @@ module Resend
6
6
  class << self
7
7
  # https://resend.com/docs/api-reference/contacts/create-contact
8
8
  def create(params)
9
- path = "audiences/#{params[:audience_id]}/contacts"
10
- Resend::Request.new(path, params, "post").perform
9
+ if params[:audience_id]
10
+ path = "audiences/#{params[:audience_id]}/contacts"
11
+ # Audience-scoped contacts don't support properties
12
+ payload = params.reject { |key, _| key == :properties }
13
+ else
14
+ path = "contacts"
15
+ payload = params
16
+ end
17
+ Resend::Request.new(path, payload, "post").perform
11
18
  end
12
19
 
13
20
  #
14
- # Retrieves a contact from an audience
21
+ # Retrieves a contact
15
22
  #
16
- # @param audience_id [String] the audience id
17
- # @param id [String] either the contact id or contact's email
23
+ # @param params [Hash] the parameters
24
+ # @option params [String] :id either the contact id or contact's email (required)
25
+ # @option params [String] :audience_id optional audience id to scope the operation
26
+ #
27
+ # @example Get contact by ID
28
+ # Resend::Contacts.get(id: "contact_123")
29
+ #
30
+ # @example Get contact scoped to an audience
31
+ # Resend::Contacts.get(id: "contact_123", audience_id: "aud_456")
18
32
  #
19
33
  # https://resend.com/docs/api-reference/contacts/get-contact
20
- def get(audience_id, id)
21
- path = "audiences/#{audience_id}/contacts/#{id}"
34
+ def get(params = {})
35
+ raise ArgumentError, "Missing `id` or `email` field" if params[:id].nil? && params[:email].nil?
36
+
37
+ audience_id = params[:audience_id]
38
+ contact_id = params[:id] || params[:email]
39
+ path = if audience_id
40
+ "audiences/#{audience_id}/contacts/#{contact_id}"
41
+ else
42
+ "contacts/#{contact_id}"
43
+ end
22
44
  Resend::Request.new(path, {}, "get").perform
23
45
  end
24
46
 
25
47
  #
26
- # List contacts in an audience
48
+ # List contacts
49
+ #
50
+ # @param params [Hash] optional parameters including pagination
51
+ # @option params [String] :audience_id optional audience id to scope the operation
52
+ # @option params [Integer] :limit number of records to return
53
+ # @option params [String] :cursor pagination cursor
54
+ #
55
+ # @example List all contacts
56
+ # Resend::Contacts.list
57
+ #
58
+ # @example List contacts with pagination
59
+ # Resend::Contacts.list(limit: 10)
60
+ #
61
+ # @example List contacts scoped to an audience
62
+ # Resend::Contacts.list(audience_id: "aud_456", limit: 10)
27
63
  #
28
- # @param audience_id [String] the audience id
29
- # @param params [Hash] optional pagination parameters
30
64
  # https://resend.com/docs/api-reference/contacts/list-contacts
31
- def list(audience_id, params = {})
32
- path = Resend::PaginationHelper.build_paginated_path("audiences/#{audience_id}/contacts", params)
65
+ def list(params = {})
66
+ audience_id = params[:audience_id]
67
+ path = if audience_id
68
+ Resend::PaginationHelper.build_paginated_path("audiences/#{audience_id}/contacts", params)
69
+ else
70
+ Resend::PaginationHelper.build_paginated_path("contacts", params)
71
+ end
33
72
  Resend::Request.new(path, {}, "get").perform
34
73
  end
35
74
 
36
75
  #
37
- # Remove a contact from an audience
76
+ # Remove a contact
77
+ #
78
+ # @param params [Hash] the parameters
79
+ # @option params [String] :id either the contact id or contact email (required)
80
+ # @option params [String] :audience_id optional audience id to scope the operation
38
81
  #
39
- # @param audience_id [String] the audience id
40
- # @param contact_id [String] either the contact id or contact email
82
+ # @example Remove contact by ID
83
+ # Resend::Contacts.remove(id: "contact_123")
41
84
  #
42
- # see also: https://resend.com/docs/api-reference/contacts/delete-contact
43
- def remove(audience_id, contact_id)
44
- path = "audiences/#{audience_id}/contacts/#{contact_id}"
85
+ # @example Remove contact scoped to an audience
86
+ # Resend::Contacts.remove(id: "contact_123", audience_id: "aud_456")
87
+ #
88
+ # https://resend.com/docs/api-reference/contacts/delete-contact
89
+ def remove(params = {})
90
+ raise ArgumentError, "Missing `id` or `email` field" if params[:id].nil? && params[:email].nil?
91
+
92
+ audience_id = params[:audience_id]
93
+ contact_id = params[:id] || params[:email]
94
+ path = if audience_id
95
+ "audiences/#{audience_id}/contacts/#{contact_id}"
96
+ else
97
+ "contacts/#{contact_id}"
98
+ end
45
99
  Resend::Request.new(path, {}, "delete").perform
46
100
  end
47
101
 
@@ -51,10 +105,18 @@ module Resend
51
105
  # @param params [Hash] the contact params
52
106
  # https://resend.com/docs/api-reference/contacts/update-contact
53
107
  def update(params)
54
- raise ArgumentError, "id or email is required" if params[:id].nil? && params[:email].nil?
108
+ raise ArgumentError, "Missing `id` or `email` field" if params[:id].nil? && params[:email].nil?
55
109
 
56
- path = "audiences/#{params[:audience_id]}/contacts/#{params[:id] || params[:email]}"
57
- Resend::Request.new(path, params, "patch").perform
110
+ contact_id = params[:id] || params[:email]
111
+ if params[:audience_id]
112
+ path = "audiences/#{params[:audience_id]}/contacts/#{contact_id}"
113
+ # Audience-scoped contacts don't support properties
114
+ payload = params.reject { |key, _| key == :properties }
115
+ else
116
+ path = "contacts/#{contact_id}"
117
+ payload = params
118
+ end
119
+ Resend::Request.new(path, payload, "patch").perform
58
120
  end
59
121
  end
60
122
  end
data/lib/resend/emails.rb CHANGED
@@ -51,12 +51,5 @@ module Resend
51
51
  Resend::Request.new(path, query_params, "get").perform
52
52
  end
53
53
  end
54
-
55
- # This method is kept here for backwards compatibility
56
- # Use Resend::Emails.send instead.
57
- def send_email(params)
58
- warn "[DEPRECATION] `send_email` is deprecated. Please use `Resend::Emails.send` instead."
59
- Resend::Emails.send(params)
60
- end
61
54
  end
62
55
  end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Resend
4
+ # Segments api wrapper
5
+ module Segments
6
+ class << self
7
+ # https://resend.com/docs/api-reference/segments/create-segment
8
+ def create(params)
9
+ path = "segments"
10
+ Resend::Request.new(path, params, "post").perform
11
+ end
12
+
13
+ # https://resend.com/docs/api-reference/segments/get-segment
14
+ def get(segment_id = "")
15
+ path = "segments/#{segment_id}"
16
+ Resend::Request.new(path, {}, "get").perform
17
+ end
18
+
19
+ # https://resend.com/docs/api-reference/segments/list-segments
20
+ def list(params = {})
21
+ path = Resend::PaginationHelper.build_paginated_path("segments", params)
22
+ Resend::Request.new(path, {}, "get").perform
23
+ end
24
+
25
+ # https://resend.com/docs/api-reference/segments/delete-segment
26
+ def remove(segment_id = "")
27
+ path = "segments/#{segment_id}"
28
+ Resend::Request.new(path, {}, "delete").perform
29
+ end
30
+ end
31
+ end
32
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Resend
4
- VERSION = "0.27.0.alpha.2"
4
+ VERSION = "1.0.0"
5
5
  end
data/lib/resend.rb CHANGED
@@ -13,11 +13,14 @@ require "resend/request"
13
13
  require "resend/pagination_helper"
14
14
 
15
15
  # API Operations
16
- require "resend/audiences"
16
+ require "resend/segments"
17
17
  require "resend/api_keys"
18
18
  require "resend/broadcasts"
19
19
  require "resend/batch"
20
20
  require "resend/contacts"
21
+ require "resend/contacts/segments"
22
+ require "resend/contacts/topics"
23
+ require "resend/contact_properties"
21
24
  require "resend/domains"
22
25
  require "resend/emails"
23
26
  require "resend/templates"
@@ -41,4 +44,7 @@ module Resend
41
44
  end
42
45
  alias config configure
43
46
  end
47
+
48
+ # @deprecated Use Segments instead
49
+ Audiences = Segments
44
50
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: resend
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.27.0.alpha.2
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Derich Pacheco
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-10-28 00:00:00.000000000 Z
11
+ date: 2025-10-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -44,14 +44,17 @@ executables: []
44
44
  extensions: []
45
45
  extra_rdoc_files: []
46
46
  files:
47
+ - CHANGELOG.md
47
48
  - README.md
48
49
  - lib/resend.rb
49
50
  - lib/resend/api_keys.rb
50
- - lib/resend/audiences.rb
51
51
  - lib/resend/batch.rb
52
52
  - lib/resend/broadcasts.rb
53
53
  - lib/resend/client.rb
54
+ - lib/resend/contact_properties.rb
54
55
  - lib/resend/contacts.rb
56
+ - lib/resend/contacts/segments.rb
57
+ - lib/resend/contacts/topics.rb
55
58
  - lib/resend/domains.rb
56
59
  - lib/resend/emails.rb
57
60
  - lib/resend/emails/attachments.rb
@@ -62,6 +65,7 @@ files:
62
65
  - lib/resend/pagination_helper.rb
63
66
  - lib/resend/railtie.rb
64
67
  - lib/resend/request.rb
68
+ - lib/resend/segments.rb
65
69
  - lib/resend/templates.rb
66
70
  - lib/resend/topics.rb
67
71
  - lib/resend/version.rb
@@ -81,9 +85,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
81
85
  version: '2.6'
82
86
  required_rubygems_version: !ruby/object:Gem::Requirement
83
87
  requirements:
84
- - - ">"
88
+ - - ">="
85
89
  - !ruby/object:Gem::Version
86
- version: 1.3.1
90
+ version: '0'
87
91
  requirements: []
88
92
  rubygems_version: 3.4.10
89
93
  signing_key:
@@ -1,32 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Resend
4
- # Audiences api wrapper
5
- module Audiences
6
- class << self
7
- # https://resend.com/docs/api-reference/audiences/create-audience
8
- def create(params)
9
- path = "audiences"
10
- Resend::Request.new(path, params, "post").perform
11
- end
12
-
13
- # https://resend.com/docs/api-reference/audiences/get-audience
14
- def get(audience_id = "")
15
- path = "audiences/#{audience_id}"
16
- Resend::Request.new(path, {}, "get").perform
17
- end
18
-
19
- # https://resend.com/docs/api-reference/audiences/list-audiences
20
- def list(params = {})
21
- path = Resend::PaginationHelper.build_paginated_path("audiences", params)
22
- Resend::Request.new(path, {}, "get").perform
23
- end
24
-
25
- # https://resend.com/docs/api-reference/audiences/delete-audience
26
- def remove(audience_id = "")
27
- path = "audiences/#{audience_id}"
28
- Resend::Request.new(path, {}, "delete").perform
29
- end
30
- end
31
- end
32
- end