ElasticEmail 4.0.29 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59705a70ea428595c16c3ef845e70eedc79052b11e390376fc15f6e2656a9998
-  data.tar.gz: fc78dceec1fa757ca56ce642233b64f3d39c9320fea82d0c96fb95f04589b8bd
+  metadata.gz: 1e417f9c1ee7940472a88fcdf9932097a34b31dd40df9d079a57d13fca54843d
+  data.tar.gz: 1abc27316361fd6f040fd04287004f02a4252a548a0fe40560c21d28e1aa78b3
 SHA512:
-  metadata.gz: 896859eac4d297d086b72556c9557fe1587910a7a53dc32fc4a62f76abc79a68c78e4904dc730067b46456255f8146a3234a2bf9da3c467db1512c661107d339
-  data.tar.gz: 0467c882f5050392dfd711a307cdd47550e3611d2d47a45fd62f3f3280942e1f0861aa705e4ec2306c44bc64da933b5561149783e2c18d6575200528b76730ef
+  metadata.gz: 6c096bec79e40c92f32fcf76fd0b41bf4b31d01450c7027431fd61dc872c9ae3303bcc292b5aacb26bcd2ce9ef1b971c4525591bb4ad3f6dbdd446f21f541e19
+  data.tar.gz: d02916126ff5c251304599e06cd1355e4afbc010d2794471fc7650af2adcc91efa80c78d36f8775839c6fa2f9fb68b30d5ed96ae64a5f8320613e9a88d173463

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+**integrations@elasticemail.com**.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to the Elastic Email Ruby SDK
+
+Thanks for taking the time to contribute! This document explains how to report problems, suggest changes and submit pull requests.
+
+## Before you start: this SDK is generated
+
+Almost everything in this repository (`lib/ElasticEmail/api`, `lib/ElasticEmail/models`, the client files in `lib/ElasticEmail`, `spec/`, `docs/` and most of `README.md`) is generated by [OpenAPI Generator](https://openapi-generator.tech) from the Elastic Email API specification.
+
+This means:
+
+- **Manual edits to generated files will be overwritten** by the next release.
+- If an endpoint, model, parameter or description is wrong or missing, the fix belongs in the API specification. Please [open an issue](https://github.com/ElasticEmail/elasticemail-ruby/issues/new/choose) describing the problem. We'll fix it upstream and regenerate the SDK.
+- Pull requests are most useful for non-generated content: documentation, examples, tests, build and CI configuration, and repository tooling.
+
+If you're not sure whether something is generated, open an issue first and ask.
+
+## Reporting bugs
+
+Search [existing issues](https://github.com/ElasticEmail/elasticemail-ruby/issues) first. If nothing matches, open a new issue using the **Bug report** template and include:
+
+- SDK version (from RubyGems, e.g. `4.3.0`; run `gem list ElasticEmail`)
+- Ruby version (`ruby -v`)
+- The API method you called and a minimal code sample
+- The full error message, HTTP status code and response body (`ElasticEmail::ApiError#code` and `#response_body`)
+
+**Never paste your API key** into an issue, log or code sample.
+
+Questions about your Elastic Email account, sending limits, deliverability or billing aren't handled in this repository. The preferred way to get help is the **chat widget on [elasticemail.com](https://elasticemail.com)**.
+
+Looking for sample code? See the [Elastic Email examples repository](https://github.com/ElasticEmail/elasticemail-examples), including the [Ruby examples](https://github.com/ElasticEmail/elasticemail-examples/tree/main/ruby-elasticemail-examples).
+
+## Suggesting features
+
+Open an issue using the **Feature request** template. Describe the use case first and the solution second. It helps us decide whether the change belongs in the API, the SDK or the documentation.
+
+## Security issues
+
+Please do **not** report security vulnerabilities in public issues. See [SECURITY.md](SECURITY.md).
+
+## Development setup
+
+Requirements: Ruby 2.7 or later and [Bundler](https://bundler.io).
+
+```bash
+git clone https://github.com/ElasticEmail/elasticemail-ruby.git
+cd elasticemail-ruby
+bundle install
+bundle exec rspec
+```
+
+To build and install the gem locally:
+
+```bash
+gem build ElasticEmail.gemspec
+gem install ./ElasticEmail-4.3.0.gem
+```
+
+Keep the gem compatible with Ruby 2.7 and don't add new runtime dependencies without discussing it in an issue first.
+
+## Pull requests
+
+1. Fork the repository and create a branch from `master` (`git checkout -b fix/short-description`).
+2. Keep each change focused. One logical change per pull request.
+3. Make sure `bundle exec rspec` and `gem build ElasticEmail.gemspec` pass.
+4. Update documentation if your change affects how the SDK is used.
+5. Open a pull request against `master` and fill in the template.
+
+A maintainer will review your pull request and may ask for changes. When a change touches generated code, we may apply it upstream instead of merging the PR directly. You'll still get credit in the release notes.
+
+## Code of Conduct
+
+This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).

data/ElasticEmail.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 4.0.0
 Contact: support@elasticemail.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.14.0
+Generator version: 7.11.0
 
 =end
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://elasticemail.com"
   s.summary     = "Elastic Email REST API Ruby Gem"
   s.description = "The Ruby library for the Elastic Email REST API. This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. To start using this API, you will need your Access Token. Remember to keep it safe."
-  s.license     = "Unlicense"
+  s.license     = "MIT"
   s.required_ruby_version = ">= 2.7"
   s.metadata    = {}
 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2026 Elastic Email
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,94 +1,166 @@
-# ElasticEmail
+<div align="center">
 
-ElasticEmail - the Ruby gem for the Elastic Email REST API
+<img src=".github/ee-logo.png" alt="Elastic Email" width="96" />
 
-This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.
-
-Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.
-
-The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.
-
-To start using this API, you will need your Access Token (available <a target='_blank' href='https://app.elasticemail.com/marketing/settings/new/manage-api'>here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.
-
-Downloadable library clients can be found in our Github repository <a target='_blank' href='https://github.com/ElasticEmail/elasticemail-ruby'>here</a>
+# Elastic Email Ruby SDK
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+The official Ruby client library for the [Elastic Email](https://elasticemail.com) REST API v4.
 
-- API version: 4.0.0
-- Package version: 4.0.29
-- Generator version: 7.14.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+[![RubyGems](https://img.shields.io/gem/v/ElasticEmail?logo=rubygems&logoColor=white&label=RubyGems&color=E9573F)](https://rubygems.org/gems/ElasticEmail)
+[![RubyGems downloads](https://img.shields.io/gem/dt/ElasticEmail?logo=rubygems&logoColor=white&label=downloads&color=E9573F)](https://rubygems.org/gems/ElasticEmail)
+[![Ruby](https://img.shields.io/badge/Ruby-2.7%2B-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org/en/downloads/branches/)
+[![API](https://img.shields.io/badge/API-v4-0A7BBB)](https://elasticemail.com/developers/api-documentation/rest-api)
+[![OpenAPI Generator](https://img.shields.io/badge/generated%20by-OpenAPI%20Generator-6BA539?logo=openapiinitiative&logoColor=white)](https://openapi-generator.tech)
+[![License: MIT](https://img.shields.io/github/license/ElasticEmail/elasticemail-ruby?color=yellow)](LICENSE)
 
-## Installation
+[![Latest release](https://img.shields.io/github/v/release/ElasticEmail/elasticemail-ruby?logo=github&label=release)](https://github.com/ElasticEmail/elasticemail-ruby/releases)
+[![Last commit](https://img.shields.io/github/last-commit/ElasticEmail/elasticemail-ruby?logo=github)](https://github.com/ElasticEmail/elasticemail-ruby/commits/master)
+[![Open issues](https://img.shields.io/github/issues/ElasticEmail/elasticemail-ruby?logo=github)](https://github.com/ElasticEmail/elasticemail-ruby/issues)
+[![GitHub stars](https://img.shields.io/github/stars/ElasticEmail/elasticemail-ruby?style=flat&logo=github)](https://github.com/ElasticEmail/elasticemail-ruby/stargazers)
 
-### Build a gem
+[Installation](#installation) •
+[Quick start](#quick-start) •
+[Examples](#more-examples) •
+[API reference](#api-reference) •
+[Models](#models) •
+[Contributing](#contributing)
 
-To build the Ruby code into a gem:
+</div>
 
-```shell
-gem build ElasticEmail.gemspec
-```
+---
 
-Then either install the gem locally:
+## Features
 
-```shell
-gem install ./ElasticEmail-4.0.29.gem
-```
+- **Transactional and bulk email.** Send single messages, bulk campaigns or CSV merge-file sends.
+- **Contacts, lists and segments.** Add, update, import, export and bulk-delete contacts.
+- **Campaigns and automations.** Create, update, pause and trigger automations for a contact.
+- **Templates, files and attachments.** Manage templates and uploaded files.
+- **Domains.** Verify sending domains and check SPF, DKIM, tracking and certificate status.
+- **Webhooks and inbound routes.** Receive delivery events and route incoming mail.
+- **Statistics, events and suppressions.** Track delivery, bounces, complaints and unsubscribes.
+- **Subaccounts and security.** Manage subaccounts and API keys.
+- **Plain Ruby objects.** Models are built from keyword hashes with snake_case keys, and every call has a `…_with_http_info` variant that also returns the status code and headers.
 
-(for development, run `gem install --dev ./ElasticEmail-4.0.29.gem` to install the development dependencies)
+## Requirements
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+| Dependency | Version |
+| --- | --- |
+| Ruby | 2.7 or later |
+| [Typhoeus](https://rubygems.org/gems/typhoeus) | `~> 1.0` (installed automatically) |
 
-Finally add this to the Gemfile:
+You'll also need an Elastic Email **API key**. You can create one in your [API settings](https://app.elasticemail.com/marketing/settings/new/manage-api). Each endpoint's documentation lists the access level it needs.
 
-    gem 'ElasticEmail', '~> 4.0.29'
+## Installation
 
-### Install from Git
+Install the [`ElasticEmail`](https://rubygems.org/gems/ElasticEmail) gem from RubyGems:
 
-If the Ruby gem is hosted at a git repository: https://github.com/elasticemail/elasticemail-ruby, then add the following in the Gemfile:
+```bash
+gem install ElasticEmail
+```
 
-    gem 'ElasticEmail', :git => 'https://github.com/elasticemail/elasticemail-ruby.git'
+Or add it to your `Gemfile`:
 
-### Include the Ruby code directly
+```ruby
+gem 'ElasticEmail', '~> 4.3'
+```
 
-Include the Ruby code directly using `-I` as follows:
+and run `bundle install`. RubyGems installs the dependency ([Typhoeus](https://rubygems.org/gems/typhoeus)) for you.
 
-```shell
-ruby -Ilib script.rb
-```
+## Quick start
 
-## Getting Started
+> [!IMPORTANT]
+> Elastic Email only sends from verified domains. Before your first send, [verify your sending domain](https://help.elasticemail.com/en/articles/4934400-how-to-verify-your-domain) and use an address on that domain as the sender.
 
-Please follow the [installation](#installation) procedure and then run the following code:
+### Configure the client
 
 ```ruby
-# Load the gem
 require 'ElasticEmail'
 
-# Setup authorization
 ElasticEmail.configure do |config|
-  # Configure API key authorization: apikey
-  config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
+  config.api_key['X-ElasticEmail-ApiKey'] = ENV.fetch('ELASTICEMAIL_API_KEY')
 end
+```
+
+> [!TIP]
+> Keep your API key out of source code. Load it from an environment variable, Rails credentials or a secrets manager.
 
-api_instance = ElasticEmail::CampaignsApi.new
-name = 'name_example' # String | 
-contact_email = 'contact_email_example' # String | 
+### Send a transactional email
+
+```ruby
+emails = ElasticEmail::EmailsApi.new
+
+message = ElasticEmail::EmailTransactionalMessageData.new(
+  recipients: ElasticEmail::TransactionalRecipient.new(to: ['john.doe@example.com']),
+  content: ElasticEmail::EmailContent.new(
+    from: 'My App <no-reply@yourdomain.com>',
+    subject: 'Welcome aboard!',
+    body: [
+      ElasticEmail::BodyPart.new(content_type: ElasticEmail::BodyContentType::HTML, content: '<h1>Hello!</h1><p>Thanks for signing up.</p>'),
+      ElasticEmail::BodyPart.new(content_type: ElasticEmail::BodyContentType::PLAIN_TEXT, content: 'Hello! Thanks for signing up.')
+    ]
+  )
+)
 
 begin
-  #Trigger Automation for Contact
-  api_instance.campaigns_automation_by_name_trigger_post(name, contact_email)
+  result = emails.emails_transactional_post(message)
+  puts "Sent. TransactionID: #{result.transaction_id}, MessageID: #{result.message_id}"
 rescue ElasticEmail::ApiError => e
-  puts "Exception when calling CampaignsApi->campaigns_automation_by_name_trigger_post: #{e}"
+  puts "Elastic Email API error #{e.code}: #{e.response_body}"
 end
+```
+
+The `from` address must use a domain you've [verified in your Elastic Email account](https://help.elasticemail.com/en/articles/4934400-how-to-verify-your-domain).
+
+### Send from a template with merge fields
 
+```ruby
+message = ElasticEmail::EmailTransactionalMessageData.new(
+  recipients: ElasticEmail::TransactionalRecipient.new(to: ['john.doe@example.com']),
+  content: ElasticEmail::EmailContent.new(
+    from: 'My App <no-reply@yourdomain.com>',
+    template_name: 'welcome-template',
+    merge: { 'firstname' => 'John' }
+  )
+)
+
+emails.emails_transactional_post(message)
 ```
 
+### Timeouts, debugging and SSL
 
+```ruby
+ElasticEmail.configure do |config|
+  config.timeout = 30          # seconds; 0 (default) means no timeout
+  config.debugging = true      # log requests and responses to config.logger
+  config.ssl_ca_cert = '/path/to/ca-bundle.crt'
+end
+```
 
-All URIs are relative to *https://api.elasticemail.com/v4*
+## More examples
+
+More complete, runnable samples are in the **[Elastic Email examples repository](https://github.com/ElasticEmail/elasticemail-examples)**. It covers transactional email, SMTP, webhooks, inbound email, contacts and serverless platforms across 20+ languages and frameworks.
+
+- 💎 [Ruby examples](https://github.com/ElasticEmail/elasticemail-examples/tree/main/ruby-elasticemail-examples)
+- 📂 [All examples](https://github.com/ElasticEmail/elasticemail-examples)
+
+## Authentication
+
+| Scheme | Header | Used for |
+| --- | --- | --- |
+| `apikey` | `X-ElasticEmail-ApiKey` | All standard API calls |
+| `ApiKeyAuthCustomBranding` | `X-Auth-Token` | Custom-branding (white-label) accounts |
+
+## API limits
+
+- Up to **20 concurrent connections** per account
+- A hard timeout of **600 seconds** per request
+
+## API reference
+
+All URIs are relative to `https://api.elasticemail.com/v4`. The SDK covers **115 endpoints** across 16 API classes: `CampaignsApi`, `ContactsApi`, `DomainsApi`, `EmailsApi`, `EventsApi`, `FilesApi`, `InboundRouteApi`, `ListsApi`, `SecurityApi`, `SegmentsApi`, `StatisticsApi`, `SubAccountsApi`, `SuppressionsApi`, `TemplatesApi`, `VerificationsApi` and `WebhookApi`, all in the `ElasticEmail` module.
+
+<details>
+<summary><strong>Show all endpoints</strong></summary>
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -204,11 +276,16 @@ Class | Method | HTTP request | Description
 *ElasticEmail::WebhookApi* | [**webhook_by_publicid_delete**](docs/WebhookApi.md#webhook_by_publicid_delete) | **DELETE** /webhook/{publicid} | Delete Webhook
 *ElasticEmail::WebhookApi* | [**webhook_by_publicid_get**](docs/WebhookApi.md#webhook_by_publicid_get) | **GET** /webhook/{publicid} | Load Webhook
 *ElasticEmail::WebhookApi* | [**webhook_by_publicid_put**](docs/WebhookApi.md#webhook_by_publicid_put) | **PUT** /webhook/{publicid} | Update Webhook
+*ElasticEmail::WebhookApi* | [**webhook_by_publicid_secret_rotate_post**](docs/WebhookApi.md#webhook_by_publicid_secret_rotate_post) | **POST** /webhook/{publicid}/secret/rotate | Rotate Webhook Secret
 *ElasticEmail::WebhookApi* | [**webhook_get**](docs/WebhookApi.md#webhook_get) | **GET** /webhook | Load Webhooks
 *ElasticEmail::WebhookApi* | [**webhook_post**](docs/WebhookApi.md#webhook_post) | **POST** /webhook | Add Webhook
 
+</details>
+
+## Models
 
-## Documentation for Models
+<details>
+<summary><strong>Show all 99 models</strong></summary>
 
  - [ElasticEmail::AccessLevel](docs/AccessLevel.md)
  - [ElasticEmail::AccountStatusEnum](docs/AccountStatusEnum.md)
@@ -307,24 +384,54 @@ Class | Method | HTTP request | Description
  - [ElasticEmail::VerificationStatus](docs/VerificationStatus.md)
  - [ElasticEmail::Webhook](docs/Webhook.md)
  - [ElasticEmail::WebhookCreatePayload](docs/WebhookCreatePayload.md)
+ - [ElasticEmail::WebhookDeliveryMethod](docs/WebhookDeliveryMethod.md)
  - [ElasticEmail::WebhookUpdatePayload](docs/WebhookUpdatePayload.md)
 
+</details>
+
+## Tests
+
+The `spec/` folder has generated RSpec specs for every API class and model:
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+## Versioning
+
+The SDK follows the Elastic Email API v4. Package versions and release notes are listed on [RubyGems](https://rubygems.org/gems/ElasticEmail/versions) and in [GitHub Releases](https://github.com/ElasticEmail/elasticemail-ruby/releases).
+
+<details>
+<summary>Build details</summary>
+
+- API version: 4.0.0
+- SDK version: 4.3.0
+- Generator version: 7.11.0
+- Build package: `org.openapitools.codegen.languages.RubyClientCodegen`
+
+</details>
 
-## Documentation for Authorization
+## Contributing
 
+Contributions are welcome! Most of this SDK is generated from the Elastic Email OpenAPI specification, so please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request.
 
-Authentication schemes defined for the API:
-### apikey
+- 🐛 [Report a bug](https://github.com/ElasticEmail/elasticemail-ruby/issues/new?template=bug_report.md)
+- 💡 [Request a feature](https://github.com/ElasticEmail/elasticemail-ruby/issues/new?template=feature_request.md)
+- 🔒 [Report a security issue](SECURITY.md)
 
+This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
 
-- **Type**: API key
-- **API key parameter name**: X-ElasticEmail-ApiKey
-- **Location**: HTTP header
+## Support
 
-### ApiKeyAuthCustomBranding
+> [!IMPORTANT]
+> The fastest way to get help is the **chat widget on [elasticemail.com](https://elasticemail.com)**. Our support team can help with your account, sending, deliverability and API questions.
 
+- 💬 [Chat with support on elasticemail.com](https://elasticemail.com) (preferred)
+- 📚 [API documentation](https://elasticemail.com/developers/api-documentation/rest-api)
+- 🧪 [Examples repository](https://github.com/ElasticEmail/elasticemail-examples)
+- 🐛 [GitHub issues](https://github.com/ElasticEmail/elasticemail-ruby/issues), for bugs in this SDK only
 
-- **Type**: API key
-- **API key parameter name**: X-Auth-Token
-- **Location**: HTTP header
+## License
 
+Released under the [MIT License](LICENSE). Copyright © 2021–2026 Elastic Email.

data/SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+## Supported versions
+
+Security fixes are released for the latest published version of the [`ElasticEmail`](https://rubygems.org/gems/ElasticEmail) gem on RubyGems. Please upgrade to the latest version before reporting an issue.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 4.2.x   | :white_check_mark: |
+| < 4.2   | :x:                |
+
+## Reporting a vulnerability
+
+**Please do not open a public GitHub issue for security vulnerabilities.**
+
+Report them privately by one of these methods:
+
+- [GitHub private vulnerability reporting](https://github.com/ElasticEmail/elasticemail-ruby/security/advisories/new)
+- Email **integrations@elasticemail.com** with the subject `Security: elasticemail-ruby`
+
+Please include:
+
+- A description of the issue and its impact
+- Steps to reproduce, or a proof of concept
+- The affected SDK version(s)
+
+We will acknowledge your report, investigate, and keep you updated on the fix. Please give us reasonable time to release a fix before disclosing the issue publicly.
+
+## API key safety
+
+If you think an API key has been exposed (in a commit, log, issue or screenshot), revoke it right away in your [Elastic Email API settings](https://app.elasticemail.com/marketing/settings/new/manage-api) and create a new one.

data/VERSION

@@ -1 +1 @@
-4.0.29
+4.3.0

data/docs/Webhook.md

@@ -17,6 +17,9 @@
 | **notification_for_abuse_report** | **Boolean** |  | [optional] |
 | **notification_for_error** | **Boolean** |  | [optional] |
 | **is_enabled** | **Boolean** |  | [optional] |
+| **signing_enabled** | **Boolean** | Requests carry an HMAC-SHA256 signature. Chosen when the webhook is created and can't be changed. | [optional] |
+| **delivery_method** | [**WebhookDeliveryMethod**](WebhookDeliveryMethod.md) |  | [optional][default to 'Get'] |
+| **signing_secret** | **String** | Signing secret - returned only once, when a webhook is created with signing or its secret is rotated. Store it safely. | [optional] |
 
 ## Example
 
@@ -36,7 +39,10 @@ instance = ElasticEmail::Webhook.new(
   notification_for_unsubscribed: null,
   notification_for_abuse_report: null,
   notification_for_error: null,
-  is_enabled: null
+  is_enabled: null,
+  signing_enabled: null,
+  delivery_method: null,
+  signing_secret: null
 )
 ```