Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.18.0"
".": "0.19.0"
}
8 changes: 4 additions & 4 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 40
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/ark%2Fark-628db0b9b7c9da594fa6ad6ce9d95f4ecad92c9e0313f2f1f9977216494dbc5d.yml
openapi_spec_hash: 1773341fbff31b84d2cbcdb37eaad877
config_hash: b090c2bdd7a719c56c825edddc587737
configured_endpoints: 58
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/ark%2Fark-ee4b9d190e3aaa146b08bc0ffed1c802dc353c3fdc37fc0097f2350ab3714b70.yml
openapi_spec_hash: 0dad8b2e562ba7ce879425ab92169d85
config_hash: b70b11b10fc614f91f1c6f028b40780f
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Changelog

## 0.19.0 (2026-02-07)

Full Changelog: [v0.18.0...v0.19.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.18.0...v0.19.0)

### Features

* **api:** add Credentials endpoint ([e1b4536](https://github.com/ArkHQ-io/ark-ruby/commit/e1b45361e3a4e4cfd9de4648def64e2622baea81))
* **api:** add Platform webhooks ([56ac161](https://github.com/ArkHQ-io/ark-ruby/commit/56ac1617e16253ec182b5705621159edddb8791c))
* **api:** endpoint updates ([f492b2e](https://github.com/ArkHQ-io/ark-ruby/commit/f492b2e39082aed03ef6d104a1e3d9695e3d66b6))
* **api:** standardization improvements ([b187d9b](https://github.com/ArkHQ-io/ark-ruby/commit/b187d9b397de264ac9dbf6d7b882b28e6850ddf6))
* **api:** tenant usage ([b3aca3d](https://github.com/ArkHQ-io/ark-ruby/commit/b3aca3dfd1957992552c18d94bba4cd6e1db31f3))


### Bug Fixes

* **client:** loosen json header parsing ([209ac67](https://github.com/ArkHQ-io/ark-ruby/commit/209ac6701b972d01b0d83ec8319bb6a36812909d))


### Chores

* **docs:** remove www prefix ([80b201f](https://github.com/ArkHQ-io/ark-ruby/commit/80b201fff6de57f5d2496f488e137ac1535304ef))

## 0.18.0 (2026-02-03)

Full Changelog: [v0.17.0...v0.18.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.17.0...v0.18.0)
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ If you’d like to use the repository from source, you can either install from g
To install via git in your `Gemfile`:

```ruby
gem "ark-email", git: "https://www.github.com/ArkHQ-io/ark-ruby"
gem "ark-email", git: "https://github.com/ArkHQ-io/ark-ruby"
```

Alternatively, reference local copy of the repo:

```bash
$ git clone -- 'https://www.github.com/ArkHQ-io/ark-ruby' '<path-to-repo>'
$ git clone -- 'https://github.com/ArkHQ-io/ark-ruby' '<path-to-repo>'
```

```ruby
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GIT
PATH
remote: .
specs:
ark-email (0.18.0)
ark-email (0.19.0)
cgi
connection_pool

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
<!-- x-release-please-start-version -->

```ruby
gem "ark-email", "~> 0.18.0"
gem "ark-email", "~> 0.19.0"
```

<!-- x-release-please-end -->
Expand All @@ -46,7 +46,7 @@ response = ark.emails.send_(
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome"
)

Expand Down Expand Up @@ -92,7 +92,7 @@ begin
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome"
)
rescue ArkEmail::Errors::APIConnectionError => e
Expand Down Expand Up @@ -142,7 +142,7 @@ ark.emails.send_(
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome",
request_options: {max_retries: 5}
)
Expand All @@ -164,7 +164,7 @@ ark.emails.send_(
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome",
request_options: {timeout: 5}
)
Expand Down Expand Up @@ -203,7 +203,7 @@ response =
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome",
request_options: {
extra_query: {my_query_parameter: value},
Expand Down Expand Up @@ -255,7 +255,7 @@ ark.emails.send_(
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome"
)
```
Expand All @@ -269,7 +269,7 @@ ark.emails.send_(
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome"
)

Expand All @@ -279,7 +279,7 @@ params = ArkEmail::EmailSendParams.new(
subject: "Hello World",
to: ["user@example.com"],
html: "<h1>Welcome!</h1>",
metadata: {user_id: "usr_123", campaign: "onboarding"},
metadata: {user_id: "usr_123456", campaign: "onboarding"},
tag: "welcome"
)
ark.emails.send_(**params)
Expand Down
161 changes: 104 additions & 57 deletions lib/ark_email.rb
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,10 @@
require_relative "ark_email/internal/page_number_pagination"
require_relative "ark_email/models/log_entry"
require_relative "ark_email/models/api_meta"
require_relative "ark_email/models/dns_record"
require_relative "ark_email/models/domain_create_params"
require_relative "ark_email/models/domain_create_response"
require_relative "ark_email/models/domain_delete_params"
require_relative "ark_email/models/domain_delete_response"
require_relative "ark_email/models/domain_list_params"
require_relative "ark_email/models/domain_list_response"
require_relative "ark_email/models/domain_retrieve_params"
require_relative "ark_email/models/domain_retrieve_response"
require_relative "ark_email/models/domain_verify_params"
require_relative "ark_email/models/domain_verify_response"
require_relative "ark_email/models/email_counts"
require_relative "ark_email/models/email_list_params"
require_relative "ark_email/models/email_list_response"
require_relative "ark_email/models/email_rates"
require_relative "ark_email/models/email_retrieve_deliveries_params"
require_relative "ark_email/models/email_retrieve_deliveries_response"
require_relative "ark_email/models/email_retrieve_params"
Expand All @@ -80,20 +71,32 @@
require_relative "ark_email/models/email_send_raw_params"
require_relative "ark_email/models/email_send_raw_response"
require_relative "ark_email/models/email_send_response"
require_relative "ark_email/models/limit_retrieve_params"
require_relative "ark_email/models/limit_retrieve_response"
require_relative "ark_email/models/limits_data"
require_relative "ark_email/models/log_entry_detail"
require_relative "ark_email/models/log_list_params"
require_relative "ark_email/models/log_retrieve_params"
require_relative "ark_email/models/log_retrieve_response"
require_relative "ark_email/models/suppression_bulk_create_params"
require_relative "ark_email/models/suppression_bulk_create_response"
require_relative "ark_email/models/suppression_create_params"
require_relative "ark_email/models/suppression_create_response"
require_relative "ark_email/models/suppression_delete_params"
require_relative "ark_email/models/suppression_delete_response"
require_relative "ark_email/models/suppression_list_params"
require_relative "ark_email/models/suppression_list_response"
require_relative "ark_email/models/suppression_retrieve_params"
require_relative "ark_email/models/suppression_retrieve_response"
require_relative "ark_email/models/org_usage_summary"
require_relative "ark_email/models/platform/webhook_create_params"
require_relative "ark_email/models/platform/webhook_create_response"
require_relative "ark_email/models/platform/webhook_delete_params"
require_relative "ark_email/models/platform/webhook_delete_response"
require_relative "ark_email/models/platform/webhook_list_deliveries_params"
require_relative "ark_email/models/platform/webhook_list_deliveries_response"
require_relative "ark_email/models/platform/webhook_list_params"
require_relative "ark_email/models/platform/webhook_list_response"
require_relative "ark_email/models/platform/webhook_replay_delivery_params"
require_relative "ark_email/models/platform/webhook_replay_delivery_response"
require_relative "ark_email/models/platform/webhook_retrieve_delivery_params"
require_relative "ark_email/models/platform/webhook_retrieve_delivery_response"
require_relative "ark_email/models/platform/webhook_retrieve_params"
require_relative "ark_email/models/platform/webhook_retrieve_response"
require_relative "ark_email/models/platform/webhook_test_params"
require_relative "ark_email/models/platform/webhook_test_response"
require_relative "ark_email/models/platform/webhook_update_params"
require_relative "ark_email/models/platform/webhook_update_response"
require_relative "ark_email/models/tenant"
require_relative "ark_email/models/tenant_create_params"
require_relative "ark_email/models/tenant_create_response"
Expand All @@ -102,47 +105,91 @@
require_relative "ark_email/models/tenant_list_params"
require_relative "ark_email/models/tenant_retrieve_params"
require_relative "ark_email/models/tenant_retrieve_response"
require_relative "ark_email/models/tenants/credential_create_params"
require_relative "ark_email/models/tenants/credential_create_response"
require_relative "ark_email/models/tenants/credential_delete_params"
require_relative "ark_email/models/tenants/credential_delete_response"
require_relative "ark_email/models/tenants/credential_list_params"
require_relative "ark_email/models/tenants/credential_list_response"
require_relative "ark_email/models/tenants/credential_retrieve_params"
require_relative "ark_email/models/tenants/credential_retrieve_response"
require_relative "ark_email/models/tenants/credential_update_params"
require_relative "ark_email/models/tenants/credential_update_response"
require_relative "ark_email/models/tenants/dns_record"
require_relative "ark_email/models/tenants/domain_create_params"
require_relative "ark_email/models/tenants/domain_create_response"
require_relative "ark_email/models/tenants/domain_delete_params"
require_relative "ark_email/models/tenants/domain_delete_response"
require_relative "ark_email/models/tenants/domain_list_params"
require_relative "ark_email/models/tenants/domain_list_response"
require_relative "ark_email/models/tenants/domain_retrieve_params"
require_relative "ark_email/models/tenants/domain_retrieve_response"
require_relative "ark_email/models/tenants/domain_verify_params"
require_relative "ark_email/models/tenants/domain_verify_response"
require_relative "ark_email/models/tenants/suppression_create_params"
require_relative "ark_email/models/tenants/suppression_create_response"
require_relative "ark_email/models/tenants/suppression_delete_params"
require_relative "ark_email/models/tenants/suppression_delete_response"
require_relative "ark_email/models/tenants/suppression_list_params"
require_relative "ark_email/models/tenants/suppression_list_response"
require_relative "ark_email/models/tenants/suppression_retrieve_params"
require_relative "ark_email/models/tenants/suppression_retrieve_response"
require_relative "ark_email/models/tenants/tenant_usage"
require_relative "ark_email/models/tenants/tenant_usage_timeseries"
require_relative "ark_email/models/tenants/track_domain"
require_relative "ark_email/models/tenants/tracking_create_params"
require_relative "ark_email/models/tenants/tracking_create_response"
require_relative "ark_email/models/tenants/tracking_delete_params"
require_relative "ark_email/models/tenants/tracking_delete_response"
require_relative "ark_email/models/tenants/tracking_list_params"
require_relative "ark_email/models/tenants/tracking_list_response"
require_relative "ark_email/models/tenants/tracking_retrieve_params"
require_relative "ark_email/models/tenants/tracking_retrieve_response"
require_relative "ark_email/models/tenants/tracking_update_params"
require_relative "ark_email/models/tenants/tracking_update_response"
require_relative "ark_email/models/tenants/tracking_verify_params"
require_relative "ark_email/models/tenants/tracking_verify_response"
require_relative "ark_email/models/tenants/usage_retrieve_params"
require_relative "ark_email/models/tenants/usage_retrieve_response"
require_relative "ark_email/models/tenants/usage_retrieve_timeseries_params"
require_relative "ark_email/models/tenants/usage_retrieve_timeseries_response"
require_relative "ark_email/models/tenants/webhook_create_params"
require_relative "ark_email/models/tenants/webhook_create_response"
require_relative "ark_email/models/tenants/webhook_delete_params"
require_relative "ark_email/models/tenants/webhook_delete_response"
require_relative "ark_email/models/tenants/webhook_list_deliveries_params"
require_relative "ark_email/models/tenants/webhook_list_deliveries_response"
require_relative "ark_email/models/tenants/webhook_list_params"
require_relative "ark_email/models/tenants/webhook_list_response"
require_relative "ark_email/models/tenants/webhook_replay_delivery_params"
require_relative "ark_email/models/tenants/webhook_replay_delivery_response"
require_relative "ark_email/models/tenants/webhook_retrieve_delivery_params"
require_relative "ark_email/models/tenants/webhook_retrieve_delivery_response"
require_relative "ark_email/models/tenants/webhook_retrieve_params"
require_relative "ark_email/models/tenants/webhook_retrieve_response"
require_relative "ark_email/models/tenants/webhook_test_params"
require_relative "ark_email/models/tenants/webhook_test_response"
require_relative "ark_email/models/tenants/webhook_update_params"
require_relative "ark_email/models/tenants/webhook_update_response"
require_relative "ark_email/models/tenant_update_params"
require_relative "ark_email/models/tenant_update_response"
require_relative "ark_email/models/track_domain"
require_relative "ark_email/models/tracking_create_params"
require_relative "ark_email/models/tracking_create_response"
require_relative "ark_email/models/tracking_delete_params"
require_relative "ark_email/models/tracking_delete_response"
require_relative "ark_email/models/tracking_list_params"
require_relative "ark_email/models/tracking_list_response"
require_relative "ark_email/models/tracking_retrieve_params"
require_relative "ark_email/models/tracking_retrieve_response"
require_relative "ark_email/models/tracking_update_params"
require_relative "ark_email/models/tracking_update_response"
require_relative "ark_email/models/tracking_verify_params"
require_relative "ark_email/models/tracking_verify_response"
require_relative "ark_email/models/tenant_usage_item"
require_relative "ark_email/models/usage_export_params"
require_relative "ark_email/models/usage_export_response"
require_relative "ark_email/models/usage_list_tenants_params"
require_relative "ark_email/models/usage_period"
require_relative "ark_email/models/usage_retrieve_params"
require_relative "ark_email/models/usage_retrieve_response"
require_relative "ark_email/models/webhook_create_params"
require_relative "ark_email/models/webhook_create_response"
require_relative "ark_email/models/webhook_delete_params"
require_relative "ark_email/models/webhook_delete_response"
require_relative "ark_email/models/webhook_list_deliveries_params"
require_relative "ark_email/models/webhook_list_deliveries_response"
require_relative "ark_email/models/webhook_list_params"
require_relative "ark_email/models/webhook_list_response"
require_relative "ark_email/models/webhook_replay_delivery_params"
require_relative "ark_email/models/webhook_replay_delivery_response"
require_relative "ark_email/models/webhook_retrieve_delivery_params"
require_relative "ark_email/models/webhook_retrieve_delivery_response"
require_relative "ark_email/models/webhook_retrieve_params"
require_relative "ark_email/models/webhook_retrieve_response"
require_relative "ark_email/models/webhook_test_params"
require_relative "ark_email/models/webhook_test_response"
require_relative "ark_email/models/webhook_update_params"
require_relative "ark_email/models/webhook_update_response"
require_relative "ark_email/models"
require_relative "ark_email/resources/domains"
require_relative "ark_email/resources/emails"
require_relative "ark_email/resources/limits"
require_relative "ark_email/resources/logs"
require_relative "ark_email/resources/suppressions"
require_relative "ark_email/resources/platform"
require_relative "ark_email/resources/platform/webhooks"
require_relative "ark_email/resources/tenants"
require_relative "ark_email/resources/tracking"
require_relative "ark_email/resources/tenants/credentials"
require_relative "ark_email/resources/tenants/domains"
require_relative "ark_email/resources/tenants/suppressions"
require_relative "ark_email/resources/tenants/tracking"
require_relative "ark_email/resources/tenants/usage"
require_relative "ark_email/resources/tenants/webhooks"
require_relative "ark_email/resources/usage"
require_relative "ark_email/resources/webhooks"
24 changes: 8 additions & 16 deletions lib/ark_email/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,21 @@ class Client < ArkEmail::Internal::Transport::BaseClient
# @return [ArkEmail::Resources::Emails]
attr_reader :emails

# @return [ArkEmail::Resources::Domains]
attr_reader :domains

# @return [ArkEmail::Resources::Suppressions]
attr_reader :suppressions

# @return [ArkEmail::Resources::Webhooks]
attr_reader :webhooks

# @return [ArkEmail::Resources::Tracking]
attr_reader :tracking

# @return [ArkEmail::Resources::Logs]
attr_reader :logs

# @return [ArkEmail::Resources::Usage]
attr_reader :usage

# @return [ArkEmail::Resources::Limits]
attr_reader :limits

# @return [ArkEmail::Resources::Tenants]
attr_reader :tenants

# @return [ArkEmail::Resources::Platform]
attr_reader :platform

# @api private
#
# @return [Hash{String=>String}]
Expand Down Expand Up @@ -102,13 +96,11 @@ def initialize(
)

@emails = ArkEmail::Resources::Emails.new(client: self)
@domains = ArkEmail::Resources::Domains.new(client: self)
@suppressions = ArkEmail::Resources::Suppressions.new(client: self)
@webhooks = ArkEmail::Resources::Webhooks.new(client: self)
@tracking = ArkEmail::Resources::Tracking.new(client: self)
@logs = ArkEmail::Resources::Logs.new(client: self)
@usage = ArkEmail::Resources::Usage.new(client: self)
@limits = ArkEmail::Resources::Limits.new(client: self)
@tenants = ArkEmail::Resources::Tenants.new(client: self)
@platform = ArkEmail::Resources::Platform.new(client: self)
end
end
end
Loading
Loading