maropost-api 0.1.0

data/lib/maropost_api/custom_types/order_item.rb

@@ -0,0 +1,24 @@
+class OrderItem
+  
+  attr_accessor :item_id, :price, :quantity, :description, :adcode, :category
+  
+  def initialize(item_id, price, quantity, description, adcode, category)
+    @item_id = item_id
+    @price = price
+    @quantity = quantity
+    @description = description
+    @adcode = adcode
+    @category = category    
+  end
+  
+  def to_hash
+    {
+      item_id: @item_id,
+      price: @price,
+      quantity: @quantity,
+      description: @description,
+      adcode: @adcode,
+      category: @category
+    }
+  end
+end

data/lib/maropost_api/journeys.rb

@@ -0,0 +1,137 @@
+module MaropostApi
+  ##
+  # Contains methods that get journey contacts based on provided parameters.
+  # The method names themselves reveal the type of reports they are getting.
+  class Journeys
+    ##
+    # Creates a new instance of Reports class.
+    # @param account [Integer] is authentic user account id (Integer) provided by maropost.com
+    # @param api_key [String] is the auth token (String) that is validated on the server to authenticate the user
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    ##
+    # gets all the journey contacts grouped by
+    # @param page [Integer] number that decides which page of result to retrieve
+    def get(page)
+      full_path = full_resource_path
+      query_params = MaropostApi.set_query_params({:page => page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all campaigns for the provided
+    # @param journey_id [Integer] Unique id of Journey
+    # @param page [Integer] number that decides which page of result to retrieve
+    def get_campaigns(journey_id, page)
+      full_path = full_resource_path("/#{journey_id}/journey_campaigns")
+      query_params = MaropostApi.set_query_params({:pae => page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets contacts for the provided
+    # @param journey_id [Integer] Unique id of Journey
+    # @param page [Integer] number that decides which page of result to retrieve
+    def get_contacts(journey_id, page)
+      full_path = full_resource_path("/#{journey_id}/journey_contacts")
+      query_params = MaropostApi.set_query_params({:pae => page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ## 
+    # stops all journeys for the given
+    # @param contact_id [Integer] Unique id of Contact
+    # @param uid [String] Unique ID
+    # @param email_recipient [String] Email
+    def stop_all(contact_id: nil, uid: nil, email_recipient: nil)
+      query_params = {}
+      query_params[:contact_id] = contact_id unless contact_id.nil?
+      query_params[:uid] = uid unless uid.nil?
+      query_params[:email] = email_recipient unless email_recipient.nil?
+      full_path = full_resource_path "/stop_all_journeys"
+      
+      MaropostApi.put_result(full_path, {}, MaropostApi.set_query_params(query_params))
+      
+    end
+    
+    ##
+    # pauses journey for for the provided
+    # @param journey_id [Integer] Unique id of Journey
+    # @param contact_id [Integer] Unique id of Contact
+    def pause_for_contact(journey_id, contact_id)
+      full_path = full_resource_path "/#{journey_id}/stop/#{contact_id}"
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    ##
+    # pauses journey for the given
+    # @param jouerney_id [Integer] Unique Journey ID
+    # @param uid [String] Unique Identifier
+    def pause_for_uid(journey_id, uid)
+      full_path = full_resource_path "/#{journey_id}/stop/uid"
+      query_params = MaropostApi.set_query_params({:uid => uid})
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    ##
+    # resets journey for the given contact
+    # @param journey_id [Integer] Unique id of Journey
+    # @param contact_id [Integer] Unique id of Contact 
+    def reset_for_contact(journey_id, contact_id)
+      full_path = full_resource_path "/#{journey_id}/reset/#{contact_id}"
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    ##
+    # resets journey for the given uid
+    # @param jouerney_id [Integer] Unique Journey ID
+    # @param uid [String] Unique Identifier
+    def reset_for_uid(journey_id, uid)
+      full_path = full_resource_path "/#{journey_id}/reset/uid"
+      query_params = MaropostApi.set_query_params({:uid => uid})
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    ##
+    # starts journey for the given contact
+    # @param jouerney_id [Integer] Unique Journey ID
+    # @param contact_id [Integer] Unique id of Contact 
+    def start_for_contact(journey_id, contact_id)
+      full_path = full_resource_path "/#{journey_id}/start/#{contact_id}"
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    ##
+    # starts journey for the given uid
+    # @param jouerney_id [Integer] Unique Journey ID
+    # @param uid [String] Unique Identifier
+    def start_for_uid(journey_id, uid)
+      full_path = full_resource_path "/#{journey_id}/start/uid"
+      query_params = MaropostApi.set_query_params({:uid => uid})
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    
+      private
+      
+      def full_resource_path(specifics = '', root_resource = "journeys")
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/#{root_resource}" << specifics
+      end
+  end
+end

data/lib/maropost_api/products_and_revenue.rb

@@ -0,0 +1,140 @@
+require 'maropost_api/custom_types/order_item'
+
+module MaropostApi
+  
+  class ProductsAndRevenue
+    
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    def get_order(id)
+      full_path = full_resource_path("/find")
+      query_params = MaropostApi.set_query_params({"where[id]" => id})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    def get_order_for_original_order_id(original_order_id)
+      full_path = full_resource_path("/#{original_order_id}")
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    def create_order(
+      require_unique, 
+      contact: {}, 
+      order: {},
+      order_items: [],
+      add_tags: [], 
+      remove_tags: [],
+      uid: nil, 
+      list_ids: nil, 
+      grand_total: nil,
+      campaign_id: nil,
+      coupon_code: nil
+    )
+      # required contacts fields to check for
+      [:email,].each do |contact_field|
+        raise ArgumentError.new "contact[:#{contact_field}] is required!" if contact.has_key?(contact_field.to_sym) == false
+      end
+      # order items validation
+      order_items.each do |item|
+        raise TypeError.new("Each order item must be an instance of maropost_api/custom_types/OrderItem: " << item.class.to_s << " given") unless item.kind_of?(OrderItem)
+        order[:order_items] ||= []
+        order[:order_items].push(item.to_hash)
+      end
+      # required order fields to check for
+      [:order_date, :order_status, :original_order_id, :order_items].each do |order_field|
+        raise ArgumentError.new "order[:#{order_field}] is required!" if order.has_key?(order_field) == false
+      end
+
+      params = order
+      params[:contact] = contact
+      params[:uid] = uid
+      params[:list_ids] = list_ids
+      params[:grand_total] = grand_total
+      params[:campaign_id] = campaign_id
+      params[:coupon_code] = coupon_code
+      
+      full_path = full_resource_path
+      
+      MaropostApi.post_result(full_path, {"order" => params})
+    end
+    
+    def update_order_for_original_order_id(original_order_id, order: {})
+      raise ArgumentError.new('original_order_id is required') if original_order_id.nil?
+      
+      [:order_date, :order_status, :order_items].each do |f|
+        raise ArgumentError.new("order[:#{f}] is required") unless order.has_key?(f)
+      end
+      order[:order_items].each do |oi|
+        raise TypeError.new('each order item should be a type of ' << OrderItem.class.to_s) unless oi.kind_of? OrderItem
+      end
+      order[:order_items].map! {|i| i.to_hash }
+      
+      full_path = full_resource_path("/#{original_order_id}")
+      form_body = {order: order}
+      
+      MaropostApi.put_result(full_path, form_body)   
+    end
+    
+    def update_order_for_order_id(order_id, order: {})
+      raise ArgumentError.new('order_id is required') if order_id.nil?
+      
+      [:order_date, :order_status, :order_items].each do |f|
+        raise ArgumentError.new("order[:#{f}] is required") unless order.has_key?(f)
+      end
+      order[:order_items].each do |oi|
+        raise TypeError.new('each order item should be a type of ' << OrderItem.class.to_s) unless oi.kind_of? OrderItem
+      end
+      order[:order_items].map! {|i| i.to_hash }
+      
+      full_path = full_resource_path("/find")
+      query_params = MaropostApi.set_query_params({"where[id]" => order_id})
+      
+      MaropostApi.put_result(full_path, {order: order}, query_params)
+    end
+    
+    def delete_for_original_order_id(original_order_id)
+      full_path = full_resource_path("/#{original_order_id}")
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+    
+    def delete_for_order_id(order_id)
+      full_path = full_resource_path('/find')
+      query_params = MaropostApi.set_query_params({'where[id]' => order_id})
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+    
+    def delete_products_for_original_order_id(original_order_id, product_ids)
+      raise TypeError.new('product_ids should be an Array') if ! product_ids.kind_of? Array
+      full_path = full_resource_path("/#{original_order_id}")
+      query_params = MaropostApi.set_query_params({"product_ids" => product_ids.join(',')})
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+    
+    def delete_products_for_order_id(order_id, product_ids)
+      raise TypeError.new('product_ids should be an Array') if ! product_ids.kind_of? Array
+      full_path = full_resource_path("/find")
+      query_params = MaropostApi.set_query_params({"product_ids" => product_ids.join(','), 'where[id]' => order_id})
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+      
+      private
+      
+      def full_resource_path(specifics = '', root_resource = 'orders')
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/#{root_resource}" << specifics
+      end
+    
+  end
+  
+end

data/lib/maropost_api/relational_tables.rb

@@ -0,0 +1,91 @@
+module MaropostApi 
+  class RelationalTables
+    
+    attr_accessor :table_name
+    
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"], table_name:)
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+      @table_name = table_name
+      
+      MaropostApi.base_uri "https://rdb.maropost.com/#{account}"
+    end
+    
+    def get
+      full_path = full_resource_path
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    def show(unique_field_name, value)
+      raise TypeError.new("#{unique_field_name.inspect} should be a string") unless unique_field_name.is_a? String
+      params = {:record => {}}
+      params[:record][unique_field_name.to_sym] = value
+      full_path = full_resource_path '/show'
+      
+      MaropostApi.post_result(full_path, params)
+    end
+    
+    def create(key_value_col, *key_value_cols)
+      raise TypeError.new("#{key_value_col.inspect} is not type of Hash") unless key_value_col.kind_of? Hash
+      if (key_value_cols)
+        invalid_cols = key_value_cols.select{|c| !c.is_a? Hash }
+        raise TypeError.new("#{invalid_cols.join(', ')} are not type of Hash") unless invalid_cols.size == 0
+      end
+      full_path = full_resource_path '/create'
+      all_key_values = [key_value_col] + key_value_cols
+      
+      MaropostApi.post_result(full_path, :record => all_key_values)
+    end
+    
+    def update(key_value_col, *key_value_cols)
+      raise TypeError.new("#{key_value_col.inspect} is not type of Hash") unless key_value_col.kind_of? Hash
+      if (key_value_cols)
+        invalid_cols = key_value_cols.select{|c| !c.is_a? Hash }
+        raise TypeError.new("#{invalid_cols.join(', ')} are not type of Hash") unless invalid_cols.size == 0
+      end
+      full_path = full_resource_path '/update'
+      all_key_values = [key_value_col] + key_value_cols
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.put_result(full_path, {:record => all_key_values}, query_params)
+    end
+    
+    def upsert(key_value_col, *key_value_cols)
+      raise TypeError.new("#{key_value_col.inspect} is not type of Hash") unless key_value_col.kind_of? Hash
+      if (key_value_cols)
+        invalid_cols = key_value_cols.select{|c| !c.is_a? Hash }
+        raise TypeError.new("#{invalid_cols.join(', ')} are not type of Hash") unless invalid_cols.size == 0
+      end
+      full_path = full_resource_path '/upsert'
+      all_key_values = [key_value_col] + key_value_cols
+
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.put_result(full_path, {:record => all_key_values}, query_params)
+    end
+    
+    def delete(unique_field_name, value)
+      raise TypeError.new("#{unique_field_name.inspect} is not a String") unless unique_field_name.is_a? String
+      record = {:record => {}}
+      record[:record][unique_field_name] = value
+      
+      # first check if key value exists
+      show_record = show(unique_field_name, value)
+      return show_record unless show_record.success
+      
+      full_path = full_resource_path '/delete'
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.delete_result(full_path, query_params, record)      
+    end
+    
+      private
+    
+      def full_resource_path(resource_name = '')
+        MaropostApi.base_uri + "/#{@table_name}" + "#{resource_name}"
+      end
+    
+  end
+end

data/lib/maropost_api/reports.rb

@@ -0,0 +1,176 @@
+module MaropostApi
+
+  ##
+  # Contains methods that get reports based on provided parameters.
+  # The method names themselves reveal the type of reports they are getting.
+  class Reports
+    ##
+    # Creates a new instance of Reports class.
+    # @param account [Integer] is authentic user account id (Integer) provided by maropost.com
+    # @param api_key [String] is the auth token (String) that is validated on the server to authenticate the user
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    ##
+    # gets all the reports grouped by +page+ (Integer)
+    def get(page)
+      full_path = full_resource_path
+      query_params = MaropostApi.set_query_params({'page' => page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+  
+    ##
+    # gets a report defined by its unique +id+ (Integer)
+    def get_report(id)
+      full_path = full_resource_path "/#{id}"
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all open reports described by 
+    # @param page [Integer] Integer that tells the service what page of report to retrieve
+    # @param fields [Array] that contains the name of the fields of the contact to retrieve
+    # @param from [Date] formatted string to add a constriant to our result
+    # @param to [Date] Part of date range of +from+. Determines the result retrieved is in between this range of date
+    # @param unique [Boolean] that indicates whether to get unique reports or not
+    # @param email [String] email to be equated while querying for reports
+    # @param uid [String] carrying unique identifier for the report.
+    # @param per [Integer] determining how many records to get for each page
+    def get_opens(page:, fields: [], from: nil, to: nil, unique: nil, email: nil, uid: nil, per: nil)
+      full_path = full_resource_path "/opens"
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+
+      query_params = MaropostApi.set_query_params(params)
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all click reports described by 
+    # @param page [Integer] that tells the service what page of report to retrieve
+    # @param fields [Array] that contains the name of the fields of the contact to retrieve
+    # @param from [Date] formatted string to add a constriant to our result
+    # @param to [Part] of date range of +from+. Determines the result retrieved is in between this range of date
+    # @param unique [Boolean] that indicates whether to get unique reports or not
+    # @param email [String] email to be equated while querying for reports
+    # @param uid [String] carrying unique identifier for the report.
+    # @param per [Integer] determining how many records to get for each page
+    def get_clicks(page:, fields: [], from: nil, to: nil, unique: nil, email: nil, uid: nil, per: nil)
+      full_path = full_resource_path "/clicks"
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+
+      query_params = MaropostApi.set_query_params(params)
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all bounce reports described by 
+    # @param page [Integer] that tells the service what page of report to retrieve
+    # @param fields [Array] that contains the name of the fields of the contact to retrieve
+    # @param from [Date] formatted string to add a constriant to our result
+    # @param to [Part] of date range of +from+. Determines the result retrieved is in between this range of date
+    # @param unique [Boolean] that indicates whether to get unique reports or not
+    # @param email [String] email to be equated while querying for reports
+    # @param uid [String] carrying unique identifier for the report.
+    # @param per [Integer] determining how many records to get for each page
+    # @param type [String] Set of values determining "soft" or "hard" bounces
+    def get_bounces(page:, fields: [], from: nil, to: nil, unique: nil, email: nil, uid: nil, per: nil, type: nil)
+      full_path = full_resource_path "/bounces"
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+
+      query_params = MaropostApi.set_query_params(params)
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all unsubscribe reports described by 
+    # @param page: [Integer] that tells the service what page of report to retrieve
+    # @param fields: [Array] that contains the name of the fields of the contact to retrieve
+    # @param from: [Date] formatted string to add a constriant to our result
+    # @param to: [Date] part of date range of +from+. Determines the result retrieved is in between this range of date
+    # @param unique: [Boolean] that indicates whether to get unique reports or not
+    # @param email: [String] email to be equated while querying for reports
+    # @param uid: [String] carrying unique identifier for the report.
+    # @param per: [Integer] determining how many records to get for each page
+    def get_unsubscribes(page:, fields: [], from: nil, to: nil, unique: nil, email: nil, uid: nil, per: nil)
+      full_path = full_resource_path "/unsubscribes"
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+
+      query_params = MaropostApi.set_query_params(params)
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all complaint reports described by 
+    # @param page [Integer] that tells the service what page of report to retrieve
+    # @param fields [Array] that contains the name of the fields of the contact to retrieve
+    # @param from [Date] formatted string to add a constriant to our result
+    # @param to [Date] part of date range of +from+. Determines the result retrieved is in between this range of date
+    # @param unique [Boolean] that indicates whether to get unique reports or not
+    # @param email [String] email to be equated while querying for reports
+    # @param uid [String] carrying unique identifier for the report.
+    # @param per [Integer] determining how many records to get for each page
+    def get_complaints(page:, fields: [], from: nil, to: nil, unique: nil, email: nil, uid: nil, per: nil)
+      full_path = full_resource_path "/unsubscribes"
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+
+      query_params = MaropostApi.set_query_params(params)
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets all ab reports described by 
+    # @param page [Integer] that tells the service what page of report to retrieve
+    # @param fields [Array] that contains the name of the fields of the contact to retrieve
+    # @param from [Date] formatted string to add a constriant to our result
+    # @param to [Date] part of date range of +from+. Determines the result retrieved is in between this range of date
+    # @param per [Integer] determining how many records to get for each page
+    def get_ab_reports(name:, page:, from: nil, to: nil, per: nil)
+      full_path = full_resource_path('', "ab_reports")
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+
+      query_params = MaropostApi.set_query_params(params)
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ## 
+    # gets all journey reports for the provided +page+
+    # @param page [Integer]
+    def get_journeys(page)
+      full_path = full_resource_path '/journeys'
+      query_params = MaropostApi.set_query_params({:page => page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    
+      private
+    
+      def full_resource_path(specifics = '', root_resource = 'reports')
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/#{root_resource}" << specifics
+      end
+  end
+end

data/lib/maropost_api/transactional_campaigns.rb

@@ -0,0 +1,80 @@
+module MaropostApi
+  class TransactionalCampaigns
+    
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    def get(page)
+      full_path = full_resource_path
+      query_params = MaropostApi.set_query_params({:page => page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    def create(name:, subject:, preheader:, from_name:, from_email:, reply_to:, content_id:, email_preview_link:, address:, language:, add_ctags: [])
+      params = {}
+      method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+      params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+      
+      full_path = full_resource_path
+      
+      MaropostApi.post_result(full_path, :campaign => params)
+    end
+    
+    def send_email(
+          campaign_id:,
+          content: {},
+          contact: {},
+          send_time: {},
+          ignore_dnm: nil,
+          bcc: nil,
+          from_name: nil,
+          from_email: nil,
+          subject: nil,
+          reply_to: nil,
+          address: nil,
+          tags: {},
+          add_ctags: []
+      )
+        email_regex = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+        # check for content field values or content id
+        raise ArgumentError.new('Content must be a type of Integer (content_id) or a Hash (content field values)') until content.kind_of? Hash or content.kind_of? Integer
+        if (content.kind_of? Hash)
+          content = content.slice(:name, :html_part, :text_part)
+          raise ArgumentError.new('Content field values must have all or some of :name, :html_part and :text_part as keys') until content.empty? || content.count > 0          
+        end
+        # check for contact field values or contact_id
+        raise ArgumentError.new('Contact must be a type of Integer (contact_id) or a Hash (contact field values)') until contact.kind_of? Hash or contact.kind_of? Integer
+        if (contact.kind_of? Hash)
+          contact = contact.slice(:email, :first_name, :last_name, :custom_field)
+          raise ArgumentError.new('Contact field values must have :email and any or all of :first_name and :last_name :custom_field as keys') if contact.empty? || contact[:email].nil?
+          raise ArgumentError.new("contact[:custom_field] must be a type of Hash - #{contact[:custom_field].class} given!") until contact[:custom_field].is_a?(Hash) || contact[:custom_field].nil?
+        end
+        raise ArgumentError.new('contact[:email] must be a valid email address') until contact.is_a? Integer or contact[:email].match? email_regex
+        raise ArgumentError.new('bcc must be a valid email address') until bcc.nil? or bcc.match? email_regex
+        raise ArgumentError.new('from_email must be a valid email address') until from_email.nil? or from_email.match? email_regex
+        raise ArgumentError.new('reply_to must be a valid email address') until reply_to.nil? or reply_to.match? email_regex
+        raise ArgumentError.new('add_ctags must be a valid Array of string') until add_ctags.is_a? Array and add_ctags.all?{|t| t.is_a? String }
+        
+        params = {}
+        method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
+        params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }
+        params[:content_id] = params.delete(:content) if params[:content].kind_of? Integer
+        params[:contact_id] = params.delete(:contact) if params[:contact].kind_of? Integer
+        
+        full_path = full_resource_path('/deliver', 'emails')
+        
+        MaropostApi.post_result(full_path, :email => params)
+    end
+    
+      private
+    
+      def full_resource_path(specifics = '', root_resource = 'transactional_campaigns')
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/#{root_resource}" << specifics
+      end
+    
+  end
+end

data/lib/maropost_api/version.rb

@@ -0,0 +1,3 @@
+module MaropostApi
+  VERSION = "0.1.0"
+end