ElasticEmail 4.2.0 → 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/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

data/lib/ElasticEmail/models/webhook_create_payload.rb

@@ -36,6 +36,33 @@ module ElasticEmail
 
     attr_accessor :notification_for_error
 
+    # Sign every request with HMAC-SHA256. Can be set only when the webhook is created. Default: false.
+    attr_accessor :enable_signing
+
+    attr_accessor :delivery_method
+
+    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
       {
@@ -47,7 +74,9 @@ module ElasticEmail
         :'notification_for_clicked' => :'NotificationForClicked',
         :'notification_for_unsubscribed' => :'NotificationForUnsubscribed',
         :'notification_for_abuse_report' => :'NotificationForAbuseReport',
-        :'notification_for_error' => :'NotificationForError'
+        :'notification_for_error' => :'NotificationForError',
+        :'enable_signing' => :'EnableSigning',
+        :'delivery_method' => :'DeliveryMethod'
       }
     end
 
@@ -67,13 +96,16 @@ module ElasticEmail
         :'notification_for_clicked' => :'Boolean',
         :'notification_for_unsubscribed' => :'Boolean',
         :'notification_for_abuse_report' => :'Boolean',
-        :'notification_for_error' => :'Boolean'
+        :'notification_for_error' => :'Boolean',
+        :'enable_signing' => :'Boolean',
+        :'delivery_method' => :'WebhookDeliveryMethod'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'enable_signing',
       ])
     end
 
@@ -131,6 +163,16 @@ module ElasticEmail
       if attributes.key?(:'notification_for_error')
         self.notification_for_error = attributes[:'notification_for_error']
       end
+
+      if attributes.key?(:'enable_signing')
+        self.enable_signing = attributes[:'enable_signing']
+      end
+
+      if attributes.key?(:'delivery_method')
+        self.delivery_method = attributes[:'delivery_method']
+      else
+        self.delivery_method = 'Get'
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -171,7 +213,9 @@ module ElasticEmail
           notification_for_clicked == o.notification_for_clicked &&
           notification_for_unsubscribed == o.notification_for_unsubscribed &&
           notification_for_abuse_report == o.notification_for_abuse_report &&
-          notification_for_error == o.notification_for_error
+          notification_for_error == o.notification_for_error &&
+          enable_signing == o.enable_signing &&
+          delivery_method == o.delivery_method
     end
 
     # @see the `==` method
@@ -183,7 +227,7 @@ module ElasticEmail
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, url, notify_once_per_email, notification_for_sent, notification_for_opened, notification_for_clicked, notification_for_unsubscribed, notification_for_abuse_report, notification_for_error].hash
+      [name, url, notify_once_per_email, notification_for_sent, notification_for_opened, notification_for_clicked, notification_for_unsubscribed, notification_for_abuse_report, notification_for_error, enable_signing, delivery_method].hash
     end
 
     # Builds the object from hash

data/lib/ElasticEmail/models/webhook_delivery_method.rb

@@ -0,0 +1,40 @@
+=begin
+#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.    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?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
+
+The version of the OpenAPI document: 4.0.0
+Contact: support@elasticemail.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ElasticEmail
+  class WebhookDeliveryMethod
+    GET = "Get".freeze
+    POST_JSON = "PostJson".freeze
+
+    def self.all_vars
+      @all_vars ||= [GET, POST_JSON].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if WebhookDeliveryMethod.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #WebhookDeliveryMethod"
+    end
+  end
+end

data/lib/ElasticEmail/version.rb

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

data/lib/ElasticEmail.rb

@@ -114,6 +114,7 @@ require 'ElasticEmail/models/verification_file_result_details'
 require 'ElasticEmail/models/verification_status'
 require 'ElasticEmail/models/webhook'
 require 'ElasticEmail/models/webhook_create_payload'
+require 'ElasticEmail/models/webhook_delivery_method'
 require 'ElasticEmail/models/webhook_update_payload'
 
 # APIs

data/spec/api/webhook_api_spec.rb

@@ -69,6 +69,18 @@ describe 'WebhookApi' do
     end
   end
 
+  # unit tests for webhook_by_publicid_secret_rotate_post
+  # 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 
+  # @param [Hash] opts the optional parameters
+  # @return [Webhook]
+  describe 'webhook_by_publicid_secret_rotate_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for webhook_get
   # Load Webhooks
   # Returns a list of notification webhooks. Required Access Level: ViewWebNotifications

data/spec/models/webhook_create_payload_spec.rb

@@ -81,4 +81,16 @@ describe ElasticEmail::WebhookCreatePayload do
     end
   end
 
+  describe 'test attribute "enable_signing"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "delivery_method"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/webhook_delivery_method_spec.rb

@@ -0,0 +1,30 @@
+=begin
+#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.    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?tab=repositories&q=%22rest+api%22+in%3Areadme'>here</a>
+
+The version of the OpenAPI document: 4.0.0
+Contact: support@elasticemail.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for ElasticEmail::WebhookDeliveryMethod
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe ElasticEmail::WebhookDeliveryMethod do
+  let(:instance) { ElasticEmail::WebhookDeliveryMethod.new }
+
+  describe 'test an instance of WebhookDeliveryMethod' do
+    it 'should create an instance of WebhookDeliveryMethod' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(ElasticEmail::WebhookDeliveryMethod)
+    end
+  end
+
+end

data/spec/models/webhook_spec.rb

@@ -105,4 +105,22 @@ describe ElasticEmail::Webhook do
     end
   end
 
+  describe 'test attribute "signing_enabled"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "delivery_method"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "signing_secret"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end