ElasticEmail 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e417f9c1ee7940472a88fcdf9932097a34b31dd40df9d079a57d13fca54843d
-  data.tar.gz: 1abc27316361fd6f040fd04287004f02a4252a548a0fe40560c21d28e1aa78b3
+  metadata.gz: 9470d9689fcf9c6e65c1f44be797ab27561bd5bcd98fb0b6baf35d6e210e4e16
+  data.tar.gz: d95732e383fcca6800e5609743054143063a90e7f408b68496d13b53e5d100a0
 SHA512:
-  metadata.gz: 6c096bec79e40c92f32fcf76fd0b41bf4b31d01450c7027431fd61dc872c9ae3303bcc292b5aacb26bcd2ce9ef1b971c4525591bb4ad3f6dbdd446f21f541e19
-  data.tar.gz: d02916126ff5c251304599e06cd1355e4afbc010d2794471fc7650af2adcc91efa80c78d36f8775839c6fa2f9fb68b30d5ed96ae64a5f8320613e9a88d173463
+  metadata.gz: 214c80b3c7b460233b9ccdf72756f35628c35f5b68990e5097fb7fb5b7ead366dd15269be80ff73c617f4cf752585514e117ebcafde40f6748d81ff89b2a660c
+  data.tar.gz: 9775b6796a85898870e941131e0c6f7b5f076588e9936725e5e7d3b73f051005497fe52aee536f75fdd01122cff105942b70ae1ea295f5d2f730bbac7218b6f6

data/CONTRIBUTING.md

@@ -18,7 +18,7 @@ If you're not sure whether something is generated, open an issue first and ask.
 
 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`)
+- SDK version (from RubyGems, e.g. `4.4.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`)
@@ -52,7 +52,7 @@ To build and install the gem locally:
 
 ```bash
 gem build ElasticEmail.gemspec
-gem install ./ElasticEmail-4.3.0.gem
+gem install ./ElasticEmail-4.4.0.gem
 ```
 
 Keep the gem compatible with Ruby 2.7 and don't add new runtime dependencies without discussing it in an issue first.

data/README.md

@@ -32,11 +32,12 @@ The official Ruby client library for the [Elastic Email](https://elasticemail.co
 ## Features
 
 - **Transactional and bulk email.** Send single messages, bulk campaigns or CSV merge-file sends.
+- **Safe retries.** Pass an optional `Idempotency-Key` to a send, so a retried request returns the first result instead of sending the email twice.
 - **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.
+- **Webhooks and inbound routes.** Receive delivery events, optionally signed with HMAC-SHA256 and sent as JSON, 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.
@@ -61,7 +62,7 @@ gem install ElasticEmail
 Or add it to your `Gemfile`:
 
 ```ruby
-gem 'ElasticEmail', '~> 4.3'
+gem 'ElasticEmail', '~> 4.4'
 ```
 
 and run `bundle install`. RubyGems installs the dependency ([Typhoeus](https://rubygems.org/gems/typhoeus)) for you.
@@ -111,6 +112,21 @@ 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).
 
+### Retry a send safely (Idempotency-Key)
+
+```ruby
+require 'securerandom'
+
+# One key per logical send. Reuse it only when you retry this same send.
+idempotency_key = SecureRandom.uuid
+
+# After a timeout or connection error, call this again with the same message and the same key.
+result = emails.emails_transactional_post(message, idempotency_key: idempotency_key)
+puts "TransactionID: #{result.transaction_id}"
+```
+
+If the same key arrives again with the same request within 24 hours, Elastic Email returns the stored response of the first one (same `TransactionID` and `MessageID`, plus an `Idempotency-Replayed: true` response header) and doesn't send or charge again. Retry with an identical body: the same key with a different body gets `422`, and a retry while the first request is still running gets `409`. A `503` means the key couldn't be checked, so wait for the `Retry-After` seconds and retry with the same key. `emails_post` and `emails_mergefile_post` take the same `idempotency_key:` option, and sends without a key work as before.
+
 ### Send from a template with merge fields
 
 ```ruby
@@ -136,6 +152,30 @@ ElasticEmail.configure do |config|
 end
 ```
 
+### Create a signed webhook
+
+Webhooks can sign every request with HMAC-SHA256 and send events as a `POST` with a JSON body. Both options are set when you create the webhook and can't be changed later. Webhooks created without them keep working as unsigned `GET` requests.
+
+```ruby
+webhooks = ElasticEmail::WebhookApi.new
+
+payload = ElasticEmail::WebhookCreatePayload.new(
+  name: 'my-webhook',
+  url: 'https://your-app.example.com/webhook',
+  notification_for_sent: true,
+  notification_for_opened: true,
+  notification_for_clicked: true,
+  enable_signing: true,
+  delivery_method: ElasticEmail::WebhookDeliveryMethod::POST_JSON
+)
+
+webhook = webhooks.webhook_post(payload)
+# Returned only now: store it, e.g. as ELASTICEMAIL_WEBHOOK_SECRET.
+puts webhook.signing_secret
+```
+
+`SigningSecret` is returned only when the webhook is created and when you rotate it with `webhook_by_publicid_secret_rotate_post`, so store it right away. Each signed request carries `X-ElasticEmail-Timestamp` and `X-ElasticEmail-Signature: v1=<hex>`, where the signature is `hex(HMAC-SHA256(secret, "{timestamp}\n{METHOD}\n{path and query}\n{raw body}"))`. Verify it against the raw body before you parse the JSON, reject timestamps more than 5 minutes old, and compare in constant time. The [webhooks guide](https://github.com/ElasticEmail/elasticemail-examples/blob/main/docs/webhooks.md) and the [examples repository](https://github.com/ElasticEmail/elasticemail-examples) have ready-made handlers.
+
 ## 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.
@@ -406,7 +446,7 @@ The SDK follows the Elastic Email API v4. Package versions and release notes are
 <summary>Build details</summary>
 
 - API version: 4.0.0
-- SDK version: 4.3.0
+- SDK version: 4.4.0
 - Generator version: 7.11.0
 - Build package: `org.openapitools.codegen.languages.RubyClientCodegen`
 

data/VERSION

@@ -1 +1 @@
-4.3.0
+4.4.0

data/docs/EmailsApi.md

@@ -177,7 +177,7 @@ end
 
 ## emails_mergefile_post
 
-> <EmailSend> emails_mergefile_post(merge_email_payload)
+> <EmailSend> emails_mergefile_post(merge_email_payload, opts)
 
 Send Bulk Emails CSV
 
@@ -198,10 +198,13 @@ end
 
 api_instance = ElasticEmail::EmailsApi.new
 merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # MergeEmailPayload | Email data
+opts = {
+  idempotency_key: '6f1c2a7e-3b4d-4e8f-9a1b-2c3d4e5f6a7b' # String | Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
+}
 
 begin
   # Send Bulk Emails CSV
-  result = api_instance.emails_mergefile_post(merge_email_payload)
+  result = api_instance.emails_mergefile_post(merge_email_payload, opts)
   p result
 rescue ElasticEmail::ApiError => e
   puts "Error when calling EmailsApi->emails_mergefile_post: #{e}"
@@ -212,12 +215,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<EmailSend>, Integer, Hash)> emails_mergefile_post_with_http_info(merge_email_payload)
+> <Array(<EmailSend>, Integer, Hash)> emails_mergefile_post_with_http_info(merge_email_payload, opts)
 
 ```ruby
 begin
   # Send Bulk Emails CSV
-  data, status_code, headers = api_instance.emails_mergefile_post_with_http_info(merge_email_payload)
+  data, status_code, headers = api_instance.emails_mergefile_post_with_http_info(merge_email_payload, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EmailSend>
@@ -231,6 +234,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **merge_email_payload** | [**MergeEmailPayload**](MergeEmailPayload.md) | Email data |  |
+| **idempotency_key** | **String** | Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request. | [optional] |
 
 ### Return type
 
@@ -248,7 +252,7 @@ end
 
 ## emails_post
 
-> <EmailSend> emails_post(email_message_data)
+> <EmailSend> emails_post(email_message_data, opts)
 
 Send Bulk Emails
 
@@ -269,10 +273,13 @@ end
 
 api_instance = ElasticEmail::EmailsApi.new
 email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})], content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailMessageData | Email data
+opts = {
+  idempotency_key: '6f1c2a7e-3b4d-4e8f-9a1b-2c3d4e5f6a7b' # String | Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
+}
 
 begin
   # Send Bulk Emails
-  result = api_instance.emails_post(email_message_data)
+  result = api_instance.emails_post(email_message_data, opts)
   p result
 rescue ElasticEmail::ApiError => e
   puts "Error when calling EmailsApi->emails_post: #{e}"
@@ -283,12 +290,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<EmailSend>, Integer, Hash)> emails_post_with_http_info(email_message_data)
+> <Array(<EmailSend>, Integer, Hash)> emails_post_with_http_info(email_message_data, opts)
 
 ```ruby
 begin
   # Send Bulk Emails
-  data, status_code, headers = api_instance.emails_post_with_http_info(email_message_data)
+  data, status_code, headers = api_instance.emails_post_with_http_info(email_message_data, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EmailSend>
@@ -302,6 +309,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **email_message_data** | [**EmailMessageData**](EmailMessageData.md) | Email data |  |
+| **idempotency_key** | **String** | Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request. | [optional] |
 
 ### Return type
 
@@ -319,7 +327,7 @@ end
 
 ## emails_transactional_post
 
-> <EmailSend> emails_transactional_post(email_transactional_message_data)
+> <EmailSend> emails_transactional_post(email_transactional_message_data, opts)
 
 Send Transactional Email
 
@@ -340,10 +348,13 @@ end
 
 api_instance = ElasticEmail::EmailsApi.new
 email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailTransactionalMessageData | Email data
+opts = {
+  idempotency_key: '6f1c2a7e-3b4d-4e8f-9a1b-2c3d4e5f6a7b' # String | Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
+}
 
 begin
   # Send Transactional Email
-  result = api_instance.emails_transactional_post(email_transactional_message_data)
+  result = api_instance.emails_transactional_post(email_transactional_message_data, opts)
   p result
 rescue ElasticEmail::ApiError => e
   puts "Error when calling EmailsApi->emails_transactional_post: #{e}"
@@ -354,12 +365,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<EmailSend>, Integer, Hash)> emails_transactional_post_with_http_info(email_transactional_message_data)
+> <Array(<EmailSend>, Integer, Hash)> emails_transactional_post_with_http_info(email_transactional_message_data, opts)
 
 ```ruby
 begin
   # Send Transactional Email
-  data, status_code, headers = api_instance.emails_transactional_post_with_http_info(email_transactional_message_data)
+  data, status_code, headers = api_instance.emails_transactional_post_with_http_info(email_transactional_message_data, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EmailSend>
@@ -373,6 +384,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **email_transactional_message_data** | [**EmailTransactionalMessageData**](EmailTransactionalMessageData.md) | Email data |  |
+| **idempotency_key** | **String** | Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request. | [optional] |
 
 ### Return type
 

data/lib/ElasticEmail/api/emails_api.rb

@@ -179,6 +179,7 @@ module ElasticEmail
     # Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content.                           Example CSV:                           email, firstname, lastname              test1@gmail.com, michael, smith              test2@gmail.com, janet, smith                           Merge file must not be empty. Required Access Level: SendHttp
     # @param merge_email_payload [MergeEmailPayload] Email data
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
     # @return [EmailSend]
     def emails_mergefile_post(merge_email_payload, opts = {})
       data, _status_code, _headers = emails_mergefile_post_with_http_info(merge_email_payload, opts)
@@ -189,6 +190,7 @@ module ElasticEmail
     # Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content.                           Example CSV:                           email, firstname, lastname              test1@gmail.com, michael, smith              test2@gmail.com, janet, smith                           Merge file must not be empty. Required Access Level: SendHttp
     # @param merge_email_payload [MergeEmailPayload] Email data
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
     # @return [Array<(EmailSend, Integer, Hash)>] EmailSend data, response status code and response headers
     def emails_mergefile_post_with_http_info(merge_email_payload, opts = {})
       if @api_client.config.debugging
@@ -198,6 +200,19 @@ module ElasticEmail
       if @api_client.config.client_side_validation && merge_email_payload.nil?
         fail ArgumentError, "Missing the required parameter 'merge_email_payload' when calling EmailsApi.emails_mergefile_post"
       end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.emails_mergefile_post, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.emails_mergefile_post, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[\x20-\x7E]+$/)
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"idempotency_key\"]' when calling EmailsApi.emails_mergefile_post, must conform to the pattern #{pattern}."
+      end
+
       # resource path
       local_var_path = '/emails/mergefile'
 
@@ -213,6 +228,7 @@ module ElasticEmail
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -247,6 +263,7 @@ module ElasticEmail
     # Send bulk merge email. Required Access Level: SendHttp
     # @param email_message_data [EmailMessageData] Email data
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
     # @return [EmailSend]
     def emails_post(email_message_data, opts = {})
       data, _status_code, _headers = emails_post_with_http_info(email_message_data, opts)
@@ -257,6 +274,7 @@ module ElasticEmail
     # Send bulk merge email. Required Access Level: SendHttp
     # @param email_message_data [EmailMessageData] Email data
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
     # @return [Array<(EmailSend, Integer, Hash)>] EmailSend data, response status code and response headers
     def emails_post_with_http_info(email_message_data, opts = {})
       if @api_client.config.debugging
@@ -266,6 +284,19 @@ module ElasticEmail
       if @api_client.config.client_side_validation && email_message_data.nil?
         fail ArgumentError, "Missing the required parameter 'email_message_data' when calling EmailsApi.emails_post"
       end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.emails_post, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.emails_post, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[\x20-\x7E]+$/)
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"idempotency_key\"]' when calling EmailsApi.emails_post, must conform to the pattern #{pattern}."
+      end
+
       # resource path
       local_var_path = '/emails'
 
@@ -281,6 +312,7 @@ module ElasticEmail
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -315,6 +347,7 @@ module ElasticEmail
     # Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
     # @param email_transactional_message_data [EmailTransactionalMessageData] Email data
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
     # @return [EmailSend]
     def emails_transactional_post(email_transactional_message_data, opts = {})
       data, _status_code, _headers = emails_transactional_post_with_http_info(email_transactional_message_data, opts)
@@ -325,6 +358,7 @@ module ElasticEmail
     # Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
     # @param email_transactional_message_data [EmailTransactionalMessageData] Email data
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
     # @return [Array<(EmailSend, Integer, Hash)>] EmailSend data, response status code and response headers
     def emails_transactional_post_with_http_info(email_transactional_message_data, opts = {})
       if @api_client.config.debugging
@@ -334,6 +368,19 @@ module ElasticEmail
       if @api_client.config.client_side_validation && email_transactional_message_data.nil?
         fail ArgumentError, "Missing the required parameter 'email_transactional_message_data' when calling EmailsApi.emails_transactional_post"
       end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.emails_transactional_post, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.emails_transactional_post, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[\x20-\x7E]+$/)
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"idempotency_key\"]' when calling EmailsApi.emails_transactional_post, must conform to the pattern #{pattern}."
+      end
+
       # resource path
       local_var_path = '/emails/transactional'
 
@@ -349,6 +396,7 @@ module ElasticEmail
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}

data/lib/ElasticEmail/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.11.0
 =end
 
 module ElasticEmail
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

data/spec/api/emails_api_spec.rb

@@ -71,6 +71,7 @@ describe 'EmailsApi' do
   # Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content.                           Example CSV:                           email, firstname, lastname              test1@gmail.com, michael, smith              test2@gmail.com, janet, smith                           Merge file must not be empty. Required Access Level: SendHttp
   # @param merge_email_payload Email data
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
   # @return [EmailSend]
   describe 'emails_mergefile_post test' do
     it 'should work' do
@@ -83,6 +84,7 @@ describe 'EmailsApi' do
   # Send bulk merge email. Required Access Level: SendHttp
   # @param email_message_data Email data
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
   # @return [EmailSend]
   describe 'emails_post test' do
     it 'should work' do
@@ -95,6 +97,7 @@ describe 'EmailsApi' do
   # Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp
   # @param email_transactional_message_data Email data
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Makes a retry of this request safe. A repeated request with the same key and the same body gets the stored response of the first one and is not executed again. Generate a new key, e.g. a UUID v4, for each request and reuse it only to retry that request. Keys are scoped to the account and kept for 24 hours after the first request.
   # @return [EmailSend]
   describe 'emails_transactional_post test' do
     it 'should work' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ElasticEmail
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - ElasticEmail
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- ElasticEmail-4.3.0.gem
 - ElasticEmail.gemspec
 - Gemfile
 - LICENSE