ElasticEmail 4.0.29 → 4.3.0

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/campaigns_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/contacts_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/domains_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/emails_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/events_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/files_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/inbound_route_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/lists_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/security_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/segments_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/statistics_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/sub_accounts_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/suppressions_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/templates_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/verifications_api.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/api/webhook_api.rb

@@ -6,7 +6,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
 
@@ -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/api_client.rb

@@ -6,7 +6,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
 
@@ -49,8 +49,7 @@ module ElasticEmail
     #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
-      tempfile = nil
-      (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File'
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -189,17 +188,19 @@ module ElasticEmail
         chunk.force_encoding(encoding)
         tempfile.write(chunk)
       end
-      request.on_complete do
-        if !tempfile
-          fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
-        end
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      if tempfile
         tempfile.close
         @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
                             "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
                             "will be deleted automatically with GC. It's also recommended to delete the temp file "\
                             "explicitly with `tempfile.delete`"
-        yield tempfile if block_given?
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.

data/lib/ElasticEmail/api_error.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/configuration.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/models/access_level.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/models/account_status_enum.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/models/api_key.rb

@@ -6,7 +6,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
 
@@ -46,14 +46,9 @@ module ElasticEmail
       }
     end
 
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      acceptable_attribute_map.values
+      attribute_map.values
     end
 
     # Attribute type mapping.
@@ -84,10 +79,9 @@ module ElasticEmail
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::ApiKey`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::ApiKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/ElasticEmail/models/api_key_payload.rb

@@ -6,7 +6,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
 
@@ -42,14 +42,9 @@ module ElasticEmail
       }
     end
 
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      acceptable_attribute_map.values
+      attribute_map.values
     end
 
     # Attribute type mapping.
@@ -78,10 +73,9 @@ module ElasticEmail
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::ApiKeyPayload`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::ApiKeyPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -140,26 +134,6 @@ module ElasticEmail
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      @name = name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] access_level Value to be assigned
-    def access_level=(access_level)
-      if access_level.nil?
-        fail ArgumentError, 'access_level cannot be nil'
-      end
-
-      @access_level = access_level
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ElasticEmail/models/body_content_type.rb

@@ -6,7 +6,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
 

data/lib/ElasticEmail/models/body_part.rb

@@ -6,7 +6,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
 
@@ -55,14 +55,9 @@ module ElasticEmail
       }
     end
 
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      acceptable_attribute_map.values
+      attribute_map.values
     end
 
     # Attribute type mapping.
@@ -88,10 +83,9 @@ module ElasticEmail
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::BodyPart`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::BodyPart`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -131,16 +125,6 @@ module ElasticEmail
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] content_type Value to be assigned
-    def content_type=(content_type)
-      if content_type.nil?
-        fail ArgumentError, 'content_type cannot be nil'
-      end
-
-      @content_type = content_type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ElasticEmail/models/campaign.rb

@@ -6,7 +6,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
 
@@ -63,14 +63,9 @@ module ElasticEmail
       }
     end
 
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      acceptable_attribute_map.values
+      attribute_map.values
     end
 
     # Attribute type mapping.
@@ -99,10 +94,9 @@ module ElasticEmail
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::Campaign`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::Campaign`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -165,26 +159,6 @@ module ElasticEmail
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      @name = name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] recipients Value to be assigned
-    def recipients=(recipients)
-      if recipients.nil?
-        fail ArgumentError, 'recipients cannot be nil'
-      end
-
-      @recipients = recipients
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)