ElasticEmail 4.0.27 → 4.0.28

data/lib/ElasticEmail/models/webhook_update_payload.rb

@@ -0,0 +1,306 @@
+=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
+  # Update webhook payload
+  class WebhookUpdatePayload
+    # Filename
+    attr_accessor :name
+
+    # URL of notification.
+    attr_accessor :url
+
+    attr_accessor :notify_once_per_email
+
+    attr_accessor :notification_for_sent
+
+    attr_accessor :notification_for_opened
+
+    attr_accessor :notification_for_clicked
+
+    attr_accessor :notification_for_unsubscribed
+
+    attr_accessor :notification_for_abuse_report
+
+    attr_accessor :notification_for_error
+
+    attr_accessor :is_enabled
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'Name',
+        :'url' => :'URL',
+        :'notify_once_per_email' => :'NotifyOncePerEmail',
+        :'notification_for_sent' => :'NotificationForSent',
+        :'notification_for_opened' => :'NotificationForOpened',
+        :'notification_for_clicked' => :'NotificationForClicked',
+        :'notification_for_unsubscribed' => :'NotificationForUnsubscribed',
+        :'notification_for_abuse_report' => :'NotificationForAbuseReport',
+        :'notification_for_error' => :'NotificationForError',
+        :'is_enabled' => :'IsEnabled'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'url' => :'String',
+        :'notify_once_per_email' => :'Boolean',
+        :'notification_for_sent' => :'Boolean',
+        :'notification_for_opened' => :'Boolean',
+        :'notification_for_clicked' => :'Boolean',
+        :'notification_for_unsubscribed' => :'Boolean',
+        :'notification_for_abuse_report' => :'Boolean',
+        :'notification_for_error' => :'Boolean',
+        :'is_enabled' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'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'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::WebhookUpdatePayload` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::WebhookUpdatePayload`. 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
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'notify_once_per_email')
+        self.notify_once_per_email = attributes[:'notify_once_per_email']
+      end
+
+      if attributes.key?(:'notification_for_sent')
+        self.notification_for_sent = attributes[:'notification_for_sent']
+      end
+
+      if attributes.key?(:'notification_for_opened')
+        self.notification_for_opened = attributes[:'notification_for_opened']
+      end
+
+      if attributes.key?(:'notification_for_clicked')
+        self.notification_for_clicked = attributes[:'notification_for_clicked']
+      end
+
+      if attributes.key?(:'notification_for_unsubscribed')
+        self.notification_for_unsubscribed = attributes[:'notification_for_unsubscribed']
+      end
+
+      if attributes.key?(:'notification_for_abuse_report')
+        self.notification_for_abuse_report = attributes[:'notification_for_abuse_report']
+      end
+
+      if attributes.key?(:'notification_for_error')
+        self.notification_for_error = attributes[:'notification_for_error']
+      end
+
+      if attributes.key?(:'is_enabled')
+        self.is_enabled = attributes[:'is_enabled']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          url == o.url &&
+          notify_once_per_email == o.notify_once_per_email &&
+          notification_for_sent == o.notification_for_sent &&
+          notification_for_opened == o.notification_for_opened &&
+          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 &&
+          is_enabled == o.is_enabled
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # 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, is_enabled].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = ElasticEmail.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ElasticEmail/version.rb

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

data/lib/ElasticEmail.rb

@@ -111,6 +111,9 @@ require 'ElasticEmail/models/utm'
 require 'ElasticEmail/models/verification_file_result'
 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_update_payload'
 
 # APIs
 require 'ElasticEmail/api/campaigns_api'
@@ -128,6 +131,7 @@ require 'ElasticEmail/api/sub_accounts_api'
 require 'ElasticEmail/api/suppressions_api'
 require 'ElasticEmail/api/templates_api'
 require 'ElasticEmail/api/verifications_api'
+require 'ElasticEmail/api/webhook_api'
 
 module ElasticEmail
   class << self

data/spec/api/webhook_api_spec.rb

@@ -0,0 +1,97 @@
+=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'
+
+# Unit tests for ElasticEmail::WebhookApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WebhookApi' do
+  before do
+    # run before each test
+    @api_instance = ElasticEmail::WebhookApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WebhookApi' do
+    it 'should create an instance of WebhookApi' do
+      expect(@api_instance).to be_instance_of(ElasticEmail::WebhookApi)
+    end
+  end
+
+  # unit tests for webhook_by_publicid_delete
+  # Delete Webhook
+  # Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications
+  # @param publicid 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'webhook_by_publicid_delete 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_by_publicid_get
+  # Load Webhook
+  # Load notifications webhook details. Required Access Level: ViewWebNotifications
+  # @param publicid 
+  # @param [Hash] opts the optional parameters
+  # @return [Webhook]
+  describe 'webhook_by_publicid_get 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_by_publicid_put
+  # Update Webhook
+  # Update notification webhook. Required Access Level: ModifyWebNotifications
+  # @param publicid 
+  # @param webhook_update_payload 
+  # @param [Hash] opts the optional parameters
+  # @return [Webhook]
+  describe 'webhook_by_publicid_put 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
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Maximum number of returned items.
+  # @option opts [Integer] :offset How many items should be returned ahead.
+  # @return [Array<Webhook>]
+  describe 'webhook_get 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_post
+  # Add Webhook
+  # Add a notification webhook. Required Access Level: ModifyWebNotifications
+  # @param webhook_create_payload 
+  # @param [Hash] opts the optional parameters
+  # @return [Webhook]
+  describe 'webhook_post test' 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/campaign_options_spec.rb

@@ -69,4 +69,10 @@ describe ElasticEmail::CampaignOptions do
     end
   end
 
+  describe 'test attribute "send_at_local_time"' 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_create_payload_spec.rb

@@ -0,0 +1,84 @@
+=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::WebhookCreatePayload
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe ElasticEmail::WebhookCreatePayload do
+  let(:instance) { ElasticEmail::WebhookCreatePayload.new }
+
+  describe 'test an instance of WebhookCreatePayload' do
+    it 'should create an instance of WebhookCreatePayload' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(ElasticEmail::WebhookCreatePayload)
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notify_once_per_email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_sent"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_opened"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_clicked"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_unsubscribed"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_abuse_report"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_error"' 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_spec.rb

@@ -0,0 +1,108 @@
+=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::Webhook
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe ElasticEmail::Webhook do
+  let(:instance) { ElasticEmail::Webhook.new }
+
+  describe 'test an instance of Webhook' do
+    it 'should create an instance of Webhook' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(ElasticEmail::Webhook)
+    end
+  end
+
+  describe 'test attribute "webhook_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "date_created"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "date_updated"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notify_once_per_email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_sent"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_opened"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_clicked"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_unsubscribed"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_abuse_report"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "notification_for_error"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "is_enabled"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end