ElasticEmail 4.2.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/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
 )
 ```
 

data/docs/WebhookApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.elasticemail.com/v4*
 | [**webhook_by_publicid_delete**](WebhookApi.md#webhook_by_publicid_delete) | **DELETE** /webhook/{publicid} | Delete Webhook |
 | [**webhook_by_publicid_get**](WebhookApi.md#webhook_by_publicid_get) | **GET** /webhook/{publicid} | Load Webhook |
 | [**webhook_by_publicid_put**](WebhookApi.md#webhook_by_publicid_put) | **PUT** /webhook/{publicid} | Update Webhook |
+| [**webhook_by_publicid_secret_rotate_post**](WebhookApi.md#webhook_by_publicid_secret_rotate_post) | **POST** /webhook/{publicid}/secret/rotate | Rotate Webhook Secret |
 | [**webhook_get**](WebhookApi.md#webhook_get) | **GET** /webhook | Load Webhooks |
 | [**webhook_post**](WebhookApi.md#webhook_post) | **POST** /webhook | Add Webhook |
 
@@ -225,6 +226,77 @@ end
 - **Accept**: application/json
 
 
+## webhook_by_publicid_secret_rotate_post
+
+> <Webhook> webhook_by_publicid_secret_rotate_post(publicid)
+
+Rotate Webhook Secret
+
+Replace the signing secret of a webhook created with signing. The old secret stops being used at once - there is no grace period.             The new secret is returned only in this response. Notifications your endpoint rejects while it still has the old secret are retried and signed with the new one. Required Access Level: ModifyWebNotifications
+
+### Examples
+
+```ruby
+require 'time'
+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'
+end
+
+api_instance = ElasticEmail::WebhookApi.new
+publicid = 'publicid_example' # String | 
+
+begin
+  # Rotate Webhook Secret
+  result = api_instance.webhook_by_publicid_secret_rotate_post(publicid)
+  p result
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_secret_rotate_post: #{e}"
+end
+```
+
+#### Using the webhook_by_publicid_secret_rotate_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> webhook_by_publicid_secret_rotate_post_with_http_info(publicid)
+
+```ruby
+begin
+  # Rotate Webhook Secret
+  data, status_code, headers = api_instance.webhook_by_publicid_secret_rotate_post_with_http_info(publicid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue ElasticEmail::ApiError => e
+  puts "Error when calling WebhookApi->webhook_by_publicid_secret_rotate_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **publicid** | **String** |  |  |
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## webhook_get
 
 > <Array<Webhook>> webhook_get(opts)

data/docs/WebhookCreatePayload.md

@@ -13,6 +13,8 @@
 | **notification_for_unsubscribed** | **Boolean** |  | [optional] |
 | **notification_for_abuse_report** | **Boolean** |  | [optional] |
 | **notification_for_error** | **Boolean** |  | [optional] |
+| **enable_signing** | **Boolean** | Sign every request with HMAC-SHA256. Can be set only when the webhook is created. Default: false. | [optional] |
+| **delivery_method** | [**WebhookDeliveryMethod**](WebhookDeliveryMethod.md) |  | [optional][default to 'Get'] |
 
 ## Example
 
@@ -28,7 +30,9 @@ instance = ElasticEmail::WebhookCreatePayload.new(
   notification_for_clicked: null,
   notification_for_unsubscribed: null,
   notification_for_abuse_report: null,
-  notification_for_error: null
+  notification_for_error: null,
+  enable_signing: null,
+  delivery_method: null
 )
 ```
 

data/docs/WebhookDeliveryMethod.md

@@ -0,0 +1,15 @@
+# ElasticEmail::WebhookDeliveryMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ElasticEmail'
+
+instance = ElasticEmail::WebhookDeliveryMethod.new()
+```
+

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/api/webhook_api.rb

@@ -217,6 +217,69 @@ module ElasticEmail
       return data, status_code, headers
     end
 
+    # Rotate Webhook Secret
+    # Replace the signing secret of a webhook created with signing. The old secret stops being used at once - there is no grace period.             The new secret is returned only in this response. Notifications your endpoint rejects while it still has the old secret are retried and signed with the new one. Required Access Level: ModifyWebNotifications
+    # @param publicid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Webhook]
+    def webhook_by_publicid_secret_rotate_post(publicid, opts = {})
+      data, _status_code, _headers = webhook_by_publicid_secret_rotate_post_with_http_info(publicid, opts)
+      data
+    end
+
+    # Rotate Webhook Secret
+    # Replace the signing secret of a webhook created with signing. The old secret stops being used at once - there is no grace period.             The new secret is returned only in this response. Notifications your endpoint rejects while it still has the old secret are retried and signed with the new one. Required Access Level: ModifyWebNotifications
+    # @param publicid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
+    def webhook_by_publicid_secret_rotate_post_with_http_info(publicid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookApi.webhook_by_publicid_secret_rotate_post ...'
+      end
+      # verify the required parameter 'publicid' is set
+      if @api_client.config.client_side_validation && publicid.nil?
+        fail ArgumentError, "Missing the required parameter 'publicid' when calling WebhookApi.webhook_by_publicid_secret_rotate_post"
+      end
+      # resource path
+      local_var_path = '/webhook/{publicid}/secret/rotate'.sub('{' + 'publicid' + '}', CGI.escape(publicid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Webhook'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apikey']
+
+      new_options = opts.merge(
+        :operation => :"WebhookApi.webhook_by_publicid_secret_rotate_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookApi#webhook_by_publicid_secret_rotate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Load Webhooks
     # Returns a list of notification webhooks. Required Access Level: ViewWebNotifications
     # @param [Hash] opts the optional parameters

data/lib/ElasticEmail/models/webhook.rb

@@ -47,6 +47,36 @@ module ElasticEmail
 
     attr_accessor :is_enabled
 
+    # Requests carry an HMAC-SHA256 signature. Chosen when the webhook is created and can't be changed.
+    attr_accessor :signing_enabled
+
+    attr_accessor :delivery_method
+
+    # Signing secret - returned only once, when a webhook is created with signing or its secret is rotated. Store it safely.
+    attr_accessor :signing_secret
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -62,7 +92,10 @@ module ElasticEmail
         :'notification_for_unsubscribed' => :'NotificationForUnsubscribed',
         :'notification_for_abuse_report' => :'NotificationForAbuseReport',
         :'notification_for_error' => :'NotificationForError',
-        :'is_enabled' => :'IsEnabled'
+        :'is_enabled' => :'IsEnabled',
+        :'signing_enabled' => :'SigningEnabled',
+        :'delivery_method' => :'DeliveryMethod',
+        :'signing_secret' => :'SigningSecret'
       }
     end
 
@@ -86,7 +119,10 @@ module ElasticEmail
         :'notification_for_unsubscribed' => :'Boolean',
         :'notification_for_abuse_report' => :'Boolean',
         :'notification_for_error' => :'Boolean',
-        :'is_enabled' => :'Boolean'
+        :'is_enabled' => :'Boolean',
+        :'signing_enabled' => :'Boolean',
+        :'delivery_method' => :'WebhookDeliveryMethod',
+        :'signing_secret' => :'String'
       }
     end
 
@@ -164,6 +200,20 @@ module ElasticEmail
       if attributes.key?(:'is_enabled')
         self.is_enabled = attributes[:'is_enabled']
       end
+
+      if attributes.key?(:'signing_enabled')
+        self.signing_enabled = attributes[:'signing_enabled']
+      end
+
+      if attributes.key?(:'delivery_method')
+        self.delivery_method = attributes[:'delivery_method']
+      else
+        self.delivery_method = 'Get'
+      end
+
+      if attributes.key?(:'signing_secret')
+        self.signing_secret = attributes[:'signing_secret']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -198,7 +248,10 @@ module ElasticEmail
           notification_for_unsubscribed == o.notification_for_unsubscribed &&
           notification_for_abuse_report == o.notification_for_abuse_report &&
           notification_for_error == o.notification_for_error &&
-          is_enabled == o.is_enabled
+          is_enabled == o.is_enabled &&
+          signing_enabled == o.signing_enabled &&
+          delivery_method == o.delivery_method &&
+          signing_secret == o.signing_secret
     end
 
     # @see the `==` method
@@ -210,7 +263,7 @@ module ElasticEmail
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_id, name, date_created, date_updated, url, notify_once_per_email, notification_for_sent, notification_for_opened, notification_for_clicked, notification_for_unsubscribed, notification_for_abuse_report, notification_for_error, is_enabled].hash
+      [webhook_id, name, date_created, date_updated, url, notify_once_per_email, notification_for_sent, notification_for_opened, notification_for_clicked, notification_for_unsubscribed, notification_for_abuse_report, notification_for_error, is_enabled, signing_enabled, delivery_method, signing_secret].hash
     end
 
     # Builds the object from hash